Koios 1.0.10rc

Koios 1.0.10rc

This release primarily focuses on ability to support better DeFi projects alongwith some value addition for existing clients by bringing in 10 new endpoints (paired with 2 deprecations), few additional optional input parameters , and some additional output columns to existing endpoints. The only breaking change/fix is for output returned for tx_info.

Also, dbsync 13.1.0.x has been released and is recommended to be used for this release. It is recommended you shutdown services temporarily while you upgrade, and perhaps better off re-synching from genesis for preview/preprod as the recreation of indexes are not as optimal as fresh-ly created ones for postgres tiling point of view.

This release is meant to be used for non-mainnet (guild,preview and preprod) networks. Mainnet release will be almost the same but tag to be used will be 1.0.10.

API Docs and Schedule for release:

The schedule for monitoring layers to apply update , as well as live documentation can be browsed as per table below:

Network	Date	URL	Specs Release	gRest Instance Release	DBSync	Node
GuildNet	19-02-2023 08:00 UTC	https://guild.koios.rest/	v1.0.10rc	koios-1.0.10rc	13.1.0.[0-2]	1.35.[4-5]
Preview	19-02-2023 08:00 UTC	https://preview.koios.rest/	v1.0.10rc	koios-1.0.10rc	13.1.0.[0-2]	1.35.[4-5]
PreProd	04-03-2023 08:00 UTC	https://preprod.koios.rest/	v1.0.10rc	koios-1.0.10rc	13.1.0.[0-2]	1.35.[4-5]
Mainnet*	12-03-2023 20:00 UTC	https://api.koios.rest/	v1.0.10	koios-1.0.10	13.1.0.[0-2]	1.35.[4-5]

Mainnet* - The tags for mainnet are dependent on testing, will be tagged in the final week seperately depending on outcome of testing, will not include any breaking changes from v1.0.10rc . The entry is only included here to answer common query

Known Issue(s)

• The pool metadata ticker list might still be missing a few entries - see linked issue on dbsync [here]
• There is a known issue with datum CBOR mismatch, expecting a new release to be marked soon - see linked issue on dbsync here

Changes for API

Deprecations

• /asset_address_list - Renamed to asset_addresses keeping naming line with other endpoints (old endpoint will be retired in future release) #149
• /asset_policy_info - Renamed to policy_asset_info keeping naming line with other endpoints (old endpoint will be retired in future release) #149

New endpoints added

• /asset_addresses - Equivalent of deprecated /asset_address_list #149
• /asset_nft_address - Returns address where the specified NFT sits on #149
• /account_utxos - Returns brief details on non-empty UTxOs associated with a given stake address #149
• /asset_info_bulk - Bulk version of /asset_info #142
• /asset_token_registry - Returns assets registered via token registry on github #145
• /credential_utxos - Returns UTxOs associated with a payment credential #149
• /param_updates - Returns list of parameter update proposals applied to the network #149
• /policy_asset_addresses - Returns addresses with quantity for each asset on a given policy #149
• /policy_asset_info - Equivalent of deprecated /asset_policy_info but with more details in output #149
• /policy_asset_list - Returns list of asset under the given policy (including supply) #142, #149

Data Input/Output Changes

• Input - /account_addresses - Add optional _first_only and _empty flags to show only first address with tx or to include empty addresses to output #149
• Input - /epoch_info - Add optional _include_next_epoch field to show next epoch stats if available (eg: nonce, active stake) #143
• Output (addition) - /account_assets , /address_assets , /address_info, /tx_info, /tx_utxos - Add decimals to output #142
• Output (addition) - /policy_asset_info - Add minting_tx_hash, total_supply, mint_cnt, burn_cnt and creation_time fields to the output #149
• Output (breaking) - /tx_info - Change _invalid_before and _invalid_after to text field #141
• Output (breaking/removal) - tx_info - Remove the field plutus_contracts > [array] > outputs as there is no logic to connect it to inputs spending #163

Chores:

• /epoch_info, /epoch_params - Restrict output to current epoch #149
• /block_info - Use /previous_id field to show previous/next blocks (previously was using block_id/height) #145
• /asset_info/asset_policy_info - Fix mint tx data to be latest #141
• Support new guild scripts revamp #1572
• Add asset token registry check 1606
• New cache table grest.asset_info_cache to hold mint/burn counts alongwith first/last mint tx/keys #142
• Bump to Koios 1.0.10rc #149
• Fix typo in specs for /pool_delegators output column latest_delegation_tx_hash #149
• Add indexes for ones missing after configuring cardano-db-sync 13.1.0.0 #149
• Update PostgREST to be run as authenticator user, whose default statement_timeout is set to 65s and update configs accordingly #1606

Full Changelog can be found here for Specs , and here for scripts and SQL queries.

Instructions for Instance Providers

If you're setting up as a new instance provider, you can find instructions here. The tag to use for setup-grest.sh would be koios-1.0.10rc - for which you can visit the SQL queries used here.

If you're an existing instance provider using koios-1.0.9, the update process would be executing below:

./setup-grest.sh -b koios-1.0.10rc -i pcd -r
sudo systemctl restart cnode-haproxy

Bug Reports/Feature Requests

Everyone is invited to create future feature requests here to help us triage issues.

Support/Discussions Group

Please ensure to join the Koios Support/Discussions group.
There are bi-weekly meetings held for development activities on Koios gRest project at every 2nd and 4th Thursday of the month, the details for which can be found in the group above.

Koios 1.0.9

Koios 1.0.9

The release introduces changes that are non-breaking for existing GET/POST methods and inputs, but they are breaking for output objects reported using those endpoints.

One of the important behind-the-scenes changes is we've now moved the SQL files used by Koios to koios-artifacts repo instead of guild-operators , this allows us higher flexibility in supporting array of tool versions against koios query versions, and simplifies the Issue/PR-linking across the repositories.

Also, this release starts introducing preview and preprod network support.

Note that as per prior announcements and release notes in v1.0.9rc , the public monitoring instances for Koios legacy testnet instances have now retired as of 18th November 2022. That would not prevent folks to run Koios testnet instance themselves as the scripts still recognize testnet network!!

API Docs and Schedule for release:

The schedule for monitoring layers to apply update, as well as live documentation can be browsed as per table below:

Network	Date	URL	Specs Release	gRest Instance Release	DBSync	Node
GuildNet	18-11-2022 08:00 UTC	https://guild.koios.rest/	v1.0.9	koios-1.0.9	13.0.5	1.35.[3-4]
Preview	18-11-2022 08:00 UTC	https://preview.koios.rest/	v1.0.9	koios-1.0.9	13.0.5	1.35.4
PreProd	18-11-2022 08:00 UTC	https://preprod.koios.rest/	v1.0.9	koios-1.0.9	13.0.5	1.35.[3-4]
Mainnet	19-11-2022 20:00 UTC	https://api.koios.rest/	v1.0.9	koios-1.0.9	13.0.5	1.35.[3-4]
Testnet	< Retired >	-	-	-	-	-

Known Issue(s)

• As part of issue in dbsync 13.0.5 (fixed on master , but not yet part of a release), the pool metadata might be missing a few entries , tho this would typically be for those who might have done multiple updates to their pool metadata, should be sorted with next dbsync release
• (For instance providers only) - cardano-db-sync v13.0.5 will require resync from genesis (see issue here ) to avoid data consistency issue for datum table

Changes for API

New endpoints added

• datum_info - List of datum information for given datum hashes
• account_info_cached - Same as account_info, but serves cached information instead of live one

Data Input/Output changes

• address_info, address_assets, account_assets, tx_info, asset_list asset_summary to align output asset_list object to return array of policy_id, asset_name, fingerprint (and quantity, minting_txs where applicable) #120
• asset_history - Fix metadata to wrap in array to refer to right object #122
• asset_txs - Add optional boolean parameter _history (default: false) to toggle between querying current UTxO set vs entire history for asset #122
• pool_history - fixed_cost, pool_fees, deleg_rewards, epoch_ros will be returned as 0 when null #122
• tx_info - plutus_contracts->outputs can be null #122

Changes for Instance Providers

• SQL queries have been moved from guild-operators repository to koios-artifacts repository. This is to ensure that the updates made to scripts and other tooling do not have a dependency on Koios query versioning #122
• block_info - Use block_no instead of id to check for previous/next block hash #122
• Add topology for preprod and preview networks #122
• setup-grest.sh - Minor bug fixes that caused getmetrics.sh to be not downloaded from github #1575

Full Changelog can be found here for Specs , and here for scripts and SQL queries.

Instructions for Instance Providers

If you're setting up as a new instance provider, you can find instructions here. The tag to use for setup-grest.sh would be koios-1.0.9 - for which you can visit the SQL queries used here.

If you're an existing instance provider using koios-1.0.8, the update process would be executing :

./setup-grest.sh -r -q -b koios-1.0.9
sudo systemctl restart cnode-haproxy

If you had recently updated your instance to use koios-1.0.9rc, the update process would be executing:

./setup-grest.sh -q -b koios-1.0.9

Bug Reports/Feature Requests

Everyone is invited to create future feature requests here to help us triage issues.

Support/Discussions Group

Please ensure to join the Koios Support/Discussions group.
There are bi-weekly meetings held for development activities on Koios gRest project at every 2nd and 4th Thursday of the month, the details for which can be found in the group above.

Koios 1.0.9 Release Candidate

Koios 1.0.9rc

This is a release candidate for Koios 1.0.9 to initiate testing and allowing consumers/developers to start updating their endpoints prior to updates passed for mainnet. The changes introduced are non-breaking for existing GET/POST methods and inputs, but they are breaking for output objects reported using those endpoints.

One of the important behind-the-scenes changes is we've now moved the SQL files used by Koios to koios-artifacts repo instead of guild-operators , this allows us higher flexibility in supporting array of tool versions against koios query versions, and simplifies the Issue/PR-linking across the repositories.

Also, this release starts introducing preview and preprod network support.

Note that the public monitoring instances for Koios legacy testnet instances will retire on 18th November 2022. That would not prevent folks to run Koios testnet instance themselves, if - however - you would need more time for public instances on testnet, please reach out on Koios discussions group !!

API Docs and Schedule for release:

The schedule for monitoring layers to apply update, as well as live documentation can be browsed as per table below:

Network	Date	URL	Specs Release	gRest Instance Release	DBSync	Node
GuildNet	08-11-2022 08:00 UTC	https://guild.koios.rest/	v1.0.9rc	koios-1.0.9rc	13.0.5	1.35.[3-4]
Preview	08-11-2022 08:00 UTC	https://preview.koios.rest/	v1.0.9rc	koios-1.0.9rc	13.0.5	1.35.[3-4]
Testnet	< Retiring.. >	https://testnet.koios.rest/	v1.0.8	koios-1.0.8	13.0.5	1.35.2
PreProd	08-11-2022 08:00 UTC	https://preprod.koios.rest/	v1.0.9rc	koios-1.0.9rc	13.0.5	1.35.[3-4]
Mainnet	19-11-2022 20:00 UTC	https://api.koios.rest/	v1.0.9rc	koios-1.0.9rc	13.0.5	1.35.3

Known Issue(s)

• As part of issue in dbsync 13.0.5 (fixed on master , but not yet part of a release), the pool metadata might be missing a few entries , tho this would typically be for those who might have done multiple updates to their pool metadata, should be sorted with next dbsync release
• (For instance providers only) - cardano-db-sync v13.0.5 will require resync from genesis (see issue here ) to avoid data consistency issue for datum table

Changes for API

New endpoints added

• datum_info - List of datum information for given datum hashes
• account_info_cached - Same as account_info, but serves cached information instead of live one

Data Input/Output changes

• address_info, address_assets, account_assets, tx_info, asset_list asset_summary to align output asset_list object to return array of policy_id, asset_name, fingerprint (and quantity, minting_txs where applicable) #120
• asset_history - Fix metadata to wrap in array to refer to right object #122
• asset_txs - Add optional boolean parameter _history (default: false) to toggle between querying current UTxO set vs entire history for asset #122
• pool_history - fixed_cost, pool_fees, deleg_rewards, epoch_ros will be returned as 0 when null #122
• tx_info - plutus_contracts->outputs can be null #122

Changes for Instance Providers

• SQL queries have been moved from guild-operators repository to koios-artifacts repository. This is to ensure that the updates made to scripts and other tooling do not have a dependency on Koios query versioning #122
• block_info - Use block_no instead of id to check for previous/next block hash #122
• Add topology for preprod and preview networks #122

Full Changelog can be found here for Specs , and here for scripts and SQL queries.

Instructions for Instance Providers

If you're setting up as a new instance provider, you can find instructions here. The tag to use for setup-grest.sh would be koios-1.0.9rc - for which you can visit the SQL queries used here.

If you're an existing instance provider using koios-1.0.8, the update process would be executing :

./setup-grest.sh -r -q -b koios-1.0.9rc
sudo systemctl restart cnode-haproxy

Bug Reports/Feature Requests

Everyone is invited to create future feature requests here to help us triage issues.

Support/Discussions Group

Please ensure to join the Koios Support/Discussions group.
There are bi-weekly meetings held for development activities on Koios gRest project at every 2nd and 4th Thursday of the month at 8pm UTC, the details for which can be found in the group above.

Koios gRest v1.0.8

Koios 1.0.8

This is a minor update that primarily focuses on bugfixes for changes introduced in koios-1.0.7 - thanks to reports from excellent community ⭐.

API Docs and Schedule for release:

The schedule for monitoring layers to apply update, as well as live documentation can be browsed as per table below:

Network	Date	URL	Specs Release	gRest Instance Release	DBSync	Node
GuildNet	05-10-2022 08:00 UTC	https://guild.koios.rest/	v1.0.8	koios-1.0.8	13.0.5	1.35.3
Testnet	06-10-2022 20:00 UTC	https://testnet.koios.rest/	v1.0.8	koios-1.0.8	13.0.5	1.35.2
Mainnet	08-10-2022 20:00 UTC	https://api.koios.rest/	v1.0.8	koios-1.0.8	13.0.5	1.35.3
PreProd	< Awaiting reset date from IO>
Preview	< Awaiting reset date from IO>

Known Issue(s)

• As part of issue in dbsync 13.0.5 (fixed on master , but not yet part of a release), the pool metadata might be missing a few entries , tho this would typically be for those who might have done multiple updates to their pool metadata, should be sorted with next dbsync release
• (For instance providers only) - cardano-db-sync v13.0.5 will require resync from genesis (see issue here ) to avoid data consistency issue for datum table

Changes for API

New endpoints added

• None

Data Input/Output changes

• tx_info and tx_metadata - Align metadata for JSON output format #1542
• blocks - Query Output aligned to specs (epoch => epoch_no)
• epoch_block_protocols - [ ** Specs only ** ] Fix Documentation schema , which was accidentally showing wrong output
• pool_delegators_history - List all epochs instead of current, if no _epoch_no is specified #1545

Changes for Instance Providers

• asset_info - Fix metadata aggregaton for minting transactions with multiple metadata keys #1543
• stake_distribution_new_accounts - Leftover reference for account_info which now accepts array, resulted in error to populate stake distribution cache for new accounts #1541
• grest-poll.sh - Remove query view section from polling script, and remove grestrpcs re-creation per hour (it's already updated when setup-grest.sh is run) , in preparation for #1545

Full Changelog can be found here for Specs , and here for scripts and SQL queries.

Instructions for Instance Providers

If you're setting up as a new instance provider, you can find instructions here. The tag to use for setup-grest.sh would be koios-1.0.8 - for which you can visit the SQL queries used here.

If you're an existing instance provider using koios-1.0.7, the update process would be executing :

./setup-grest.sh -q -b koios-1.0.8
sudo systemctl restart cnode-postgrest
sudo systemctl restart cnode-haproxy

Bug Reports/Feature Requests

Everyone is invited to create future feature requests here to help us triage issues.

Support/Discussions Group

Please ensure to join the Koios Support/Discussions group.
There are bi-weekly meetings held for development activities on Koios gRest project at every 2nd and 4th Thursday of the month at 8am UTC, the details for which can be found in the group above.

Koios gRest v1.0.7

Koios 1.0.7

This update brings major transformation of single-object GET queries to bulk object POST request as detailed below, alongwith other additional enhancements to help working with larger amount of Vasil data from chain. Additionally, we start making use of previously implemented stake snapshots (which gives us mark, set and go snapshots for each account).

API Docs and Schedule for release:

The OpenAPI specs for release are attached in the release notes. The schedule for monitoring layers to apply update, as well as live documentation can be browsed as per table below:

Network	Date	URL	Specs Release	gRest Instance Release	DBSync	Node
GuildNet	23-09-2022 08:00 UTC	https://guild.koios.rest/	v1.0.7	koios-1.0.7	13.0.5	1.35.3
Testnet	24-09-2022 20:00 UTC	https://testnet.koios.rest/	v1.0.7	koios-1.0.7	13.0.5	1.35.3
Mainnet	01-10-2022 20:00 UTC	https://api.koios.rest/	v1.0.7	koios-1.0.7	13.0.5	1.35.3
PreProd	< Awaiting reset date from IO>
Preview	< Awaiting reset date from IO>

Changes for API

New endpoints added

• pool_delegators_history - Provides historical record for pool's delegators #1486
• pool_stake_snapshot - Provides mark, set and go snapshot values for pool being queried. #1489

Data Input/Output changes

• pool_delegators - No longer accepts _epoch_no as parameter, as it only returns live delegators. Additionally provides latest_delegation_hash in output. #1486
• tx_info - epoch => epoch_no #1494
• tx_info - Change collateral_outputs (array) to collateral_output (object) as collateral output is only singular in current implementation #1496
• address_info - Add inline_datum and reference_script to output #1500
• pool_info - Add sigma field to output #1511
• pool_updates - Add historical metadata information to output #1503
• Change block/address/account endpoints to accept bulk input where applicable. This resulted in GET requests changing to POST accepting payload of multiple blocks, addresses or accounts for respective endpoints as input (eg: _stake_address text becomes _stake_addresses text[]). The additional changes in output as below:
  • block_txs - Now returns block_hash and array of tx_hashes
  • address_info - Additional field address returned in output
  • address_assets - Now returns address and an array of assets JSON
  • account_addresses - Accepts stake_addresses array and outputs stake_address and array of addresses
  • account_assets - Accepts stake_addresses array and outputs stake_address and array of assets JSON
  • account_history - Accepts stake_addresses array alongwith epoch_no integer and outputs stake_address and array of history JSON
  • account_info - Accepts stake_addresses array and returns additional field stake_address to output
  • account_rewards - Now returns stake_address and an array of rewards JSON
  • account_updates - Now returns stake_address and an array of updates JSON

Changes for Instance Providers

• epoch_info_cache - Only update last_tx_id of previous epoch on epoch transition #1490 and #1502
• epoch_info_cache / stake_snapshot_cache - Store total snapshot stake to epoch stake cache, and active pool stake to stake snapshot cache #1485

Full Changelog can be found here for Specs , and here for scripts and SQL queries.

Instructions for Instance Providers

If you're setting up as a new instance provider, you can find instructions here. The tag to use for setup-grest.sh would be koios-1.0.7 - for which you can visit the SQL queries used here.

If you're an existing instance provider using koios-1.0.6, the update process would be executing :

./setup-grest.sh -q -r -b koios-1.0.7
sudo systemctl restart cnode-postgrest

Bug Reports/Feature Requests

Everyone is invited to create future feature requests here to help us triage issues.

Support/Discussions Group

Please ensure to join the Koios Support/Discussions group.
There are bi-weekly meetings held for development activities on Koios gRest project at every 2nd and 4th Thursday of the month at 8am UTC, the details for which can be found in the group above.

Koios gRest v1.0.6

Koios 1.0.6 - Interim release for all networks to upgrade to dbsync v13

This update brings major updates to extracting Vasil information for transactions, as well as starts accumulating a stake snapshots (which gives us mark, set and go snapshots for each account) - a useful foundation for next update that should follow in coming week(s).

The backlog of items not being added to mainnet was increasing due to delays with Vasil HFC event to Mainnet. As such we had to come up with a split update approach to ensure mainnet instances are not too far behind.
While the mainnet nodes are still not qualified to be Vasil-ready (in our opinion) for 1.35.x , dbsync v13.0.4-rc1 can be used against node 1.34.1 fine.

Time for update for Monitoring instance: 13-08-2022 20:00 UTC

API Docs:

The OpenAPI specs for release are attached in the release notes. The live documentation can be browsed as per table below:

Network	URL	Specs Release	gRest Instance Release
Mainnet	https://api.koios.rest/	v1.0.6	koios-1.0.6
Testnet	https://testnet.koios.rest/	v1.0.6	koios-1.0.6
Guildnet	https://guild.koios.rest/	v1.0.6	koios-1.0.6

Changes for API

Data Output Changes

• pool_delegators - epoch_no => active_epoch_no #1454
• asset_history - Add block_time and metadata fields for all previous mint transactions #1468
• asset_info - Retain latest mint transaction instead of first (in line with most CIPs as well as pool metadata - latest valid meta being live) #1468
• Ensure all output date formats is integer to keep in line with UNIX timestamps - to be revised in future if/when there are milliseconds #1460
  • /tip , /blocks, /block_info => block_time
  • /genesis => systemStart
  • /epoch_info => start_time, first_block_time, last_block_time, end_time
  • /tx_info => tx_timestamp
  • /asset_info => creation_time
• tx_info - Add Vasil data #1464
  • collaterals => collateral_inputs
  • Add collateral_outputs, reference_inputs to tx_info
  • Add datum_hash, inline_datum, reference_script to collateral input/outputs, reference inputs & inputs/outputs JSON.
  • Add complete cost_model instead of cost_model_id reference
• epoch_params - Update leftover lovelace references to text for consistency: #1484
  • key_deposit
  • pool_deposit
  • min_utxo_value
  • min_pool_cost
  • coins_per_utxo_size

Full Changelog can be found here for Specs , and here for scripts and SQL queries.

Changes for Instance Providers

• get-metrics.sh - Add active/idle connections to database #1459
• grest-poll.sh: Bump haproxy to 2.6.1 and set default value of API_STRUCT_DEFINITION to be dependent on network used. #1450
• Lighten grest.account_active_stake_cache - optimise code and delete historical view (beyond 4 epochs). [#1451(https://github.com/cardano-community/guild-operators/pull/1451)
• tx_metalabels - Move metalabels from view to RPC using lose indexscan (much better performance) #1474
• Major re-work to artificially add last epoch's active stake cache data (brings in latest snapshot information without depending on node), not used in endpoints for this release #1452
• grest.stake_snapshot_cache - Fix rewards for new accounts #1476

Instructions for Instance Providers

For mainnet instances, be sure to checkout instructions from koios-1.0.5 (wrt upgrade of dbsync to v13 and postgres 14)

If you're setting up as a new instance provider, you can find instructions here. The tag to use for setup-grest.sh would be koios-1.0.6 - for which you can visit the SQL queries used here.

If you're an existing instance provider using koios-1.0.5, the update process would be:
Mainnet : ./setup-grest.sh -q -r -b koios-1.0.6
Testnet/Guildnet : ./setup-grest.sh -q -r -b koios-1.0.6

Bug Reports/Feature Requests

Everyone is invited to create future feature requests here to help us triage issues.

Support/Discussions Group

Please ensure to join the Koios Support/Discussions group.
There are bi-weekly meetings held for development activities on Koios gRest project at every 2nd and 4th Thursday of the month at 8am UTC, the details for which can be found in the group above.

Koios gRest v1.0.5

WARN: This is pre-release with initial support with dbsync v13 for guildnet and public testnet instances ONLY. Not to be used for mainnet

Koios v1.0.5

This is an initial release to start supporting dbsync v13, and thereby - also allow instances to progress post Vasil HF. We do expect some bugs to leak out as part of changes, and understand that there will be new tables we can fetch information from - this version intends to simply provide continuity of old endpoints with minimal breaking changes to consumers, while upgrading to use Postgres v14 and DBSync v13 as baseline.

Time for update for Monitoring instance: 02-07-2022 08:00 UTC

API Docs:

The OpenAPI specs for release are attached in the release notes. The live documentation can be browsed as per table below:

Network	URL	Release	gRest Instance Release
Mainnet	https://api.koios.rest/	v1.0.1	koios-1.0.1
Testnet	https://testnet.koios.rest/	v1.0.1 => v1.0.5	koios-1.0.5
Guildnet	https://guild.koios.rest/	v1.0.5	koios-1.0.5

Changes relevant to Consumers of API

Outputs

• /epoch_info - Add total_rewards and avg_block_reward for a given epoch (#43)
• Update all date output formats to return UNIX timestamp (as per poll held in discussions group): (#45)
  • /tip , /blocks, /block_info => block_time
  • /genesis => systemStart
  • /epoch_info => start_time, first_block_time, last_block_time, end_time
  • /tx_info => tx_timestamp
  • /asset_info => creation_time
• /blocks, /block_info => Add proto_major and proto_minor for a given block to output (#55)

Inputs

• None

Instructions for Instance Providers

For consistency between date formats, we highly recommend you to upgrade your instance to use Postgres 14 (prolly a good time, since you would already need to recreate DB for dbsync v13). You can find sample instructions to do so here

If you're setting up as a new instance provider, you can find instructions here. The tag to use for setup-grest.sh would be koios-1.0.5 - for which you can visit the SQL queries used here. If you're an existing instance provider using older version, a small reminder of process below:

The rest of the upgrade process should be usual for major release:

• You can download binary for dbsync v13 from IO Hydra build here.
• Update your git folder references to new tag and recreate DB as usual (sample instructions below):

cd ~/git/cardano-db-sync
git pull
git clone 13.0.0
export PGPASSFILE="${CNODE_HOME}"/priv/.pgpass
./scripts/postgresql-setup.sh --createdb

You can use snapshots too, but at the time of writing - the dbsync snapshots were only available until rc3 (while rc4 was in progress).

• Wait for your dbsync to sync to tip
• Time to upgrade your koios instance, to do so - use:

cd ~/tmp
curl -sS -o prereqs.sh https://raw.githubusercontent.com/cardano-community/guild-operators/koios-1.0.5/scripts/cnode-helper-scripts/prereqs.sh
chmod 755 prereqs.sh
./prereqs.sh -b koios-1.0.5 -n testnet # Replace testnet with guild if using for guildnet, also add any other options, eg: -t if used before.
cd $CNODE_HOME/scripts
grep sync-extended dbsync.sh # Ensure there are no references to -extended, as the `extended` version was expired

• Test your new dbsync by running ./dbsync.sh (ensure it doesnt give any errors after waiting for 30 seconds or so). If all good, stop and start it back as a service.

Full Changelog can be found here for Specs , and here for scripts and SQL queries.

Bug Reports/Feature Requests

Everyone is invited to create future feature requests here to help us triage issues.

Support/Discussions Group

Please ensure to join the Koios Support/Discussions group.
There are bi-weekly meetings held for development activities on Koios gRest project at every 2nd and 4th Thursday of the month at 8am UTC, the details for which can be found in the group above.

Koios gRest v1.0.0

Koios v1.0.0

After months of collaboration and effort across builders in cardano community, a lot of discussions/considerations about handling future updates - transparency, and capturing feedback from users over a 1-month freeze period for API requests, we're happy to announce the first release for Koios gRest project.

Changelog: Changelog for the project can be found here

API Docs:

The OpenAPI specs for release are attached in the release notes. The live documentation can be browsed as per table below:

Network	URL
Mainnet	https://api.koios.rest/
Testnet	https://testnet.koios.rest/
Guildnet	https://guild.koios.rest/

Build Instructions

As an instance provider, you can find instructions here. The tag to use for setup-grest.sh would be koios-1.0.0 - for which you can visit the SQL queries used here.

Bug Reports/Feature Requests

Everyone is invited to create future feature requests here to help us triage issues.

Support/Discussions Group

Please ensure to join the Koios Support/Discussions group.
There are bi-weekly meetings held for development activities on Koios gRest project at every 2nd and 4th Thursday of the month at 8am UTC, the details for which can be found in the group above.