RCnet v3.1 (Revision 1)

Overview

This release brings the Gateway compatible with RCnet v3.1 of the Radix Babylon Network.

• API docs live on Redocly here: https://radix-rcnet-v3-gateway.redoc.ly/ (no changes from v3)
• The RCnet v3 public gateway root is here: https://rcnet-v3.radixdlt.com/
• Swagger is available on the public gateway here: https://rcnet-v3.radixdlt.com/swagger

Images

This release is available as tag rcnet-v3.1 on dockerhub, for the following images:

• radixdlt/babylon-ng-database-migrations
• radixdlt/babylon-ng-data-aggregator
• radixdlt/babylon-ng-gateway-api

Note to Integrators

Please note that the Babylon Core API on the Node is more powerful than on Olympia.

Integrators looking to prepare for the Radix Babylon launch should start by considering if running their own node and using the Core API would work instead of running a Gateway and using the Gateway API.

Please see the guide for integrators here.

Running just a node is simpler than running a node and Gateway, and the Core API has a "long term support" section of the API, designed for tracking fungible balances and accounts, which is guaranteed to be compatible with mainnet launch - enabling integrators to prepare for mainnet launch immediately.

Updating your Gateway

If running your own Gateway, as part of updating to this network, your Gateway database will need to be wiped, your Gateway updated, and then set to read from RCnet v3.1 node.

This will be fixed in the next release.

RCNet v3 to RCNet v3.1 Migration Guide

What’s New?

• Add from_state_version to validator_emission_statistics.
• Returning all possible role assignment keys in main module for all entity types (previously only for fungible and non fungible resources).
• Fixed broken pagination for NFIDs under /state/entity/details and /state/entity/page/non-fungible-vaults endpoints.
• Fixed invalid index_in_epoch and index_in_round for genesis TX.
• Fixed virtual identity and account details.
• Fixed how TX total fee paid is calculated.

Breaking Changes

None

Known Issues

We're aware of a few issues. Expect a new Gateway build early next week.

RCnet v3 (Revision 2)

• Fix data aggregator processing custom events starting on state version 613803 (doesn't require db wipe).

This release is available as tag rcnet-v3-r2 on dockerhub, for the following images:

• radixdlt/babylon-ng-database-migrations
• radixdlt/babylon-ng-data-aggregator
• radixdlt/babylon-ng-gateway-api

Please see RCnet v3 (Revision 1) for the full release / install notes.

RCnet v3 (Revision 1)

Overview

This release brings the Gateway compatible with RCnet v3 of the Radix Babylon Network.

• Updated API docs live on Redocly here: https://radix-rcnet-v3-gateway.redoc.ly/
• The RCnet v3 public gateway root is here: https://rcnet-v3.radixdlt.com/
• Swagger is available on the public gateway here: https://rcnet-v3.radixdlt.com/swagger

Images

This release is available as tag rcnet-v3-r1 on dockerhub, for the following images:

• radixdlt/babylon-ng-database-migrations
• radixdlt/babylon-ng-data-aggregator
• radixdlt/babylon-ng-gateway-api

Note to Integrators

Please note that the Babylon Core API on the Node is more powerful than on Olympia.

Integrators looking to prepare for the Radix Babylon launch should start by considering if running their own node and using the Core API would work instead of running a Gateway and using the Gateway API.

Please see the guide for integrators here.

Running just a node is simpler than running a node and Gateway, and the Core API has a "long term support" section of the API, designed for tracking fungible balances and accounts, which is guaranteed to be compatible with mainnet launch - enabling integrators to prepare for mainnet launch immediately.

Updating your Gateway

If running your own Gateway, as part of updating to this network, your Gateway database will need to be wiped, your Gateway updated, and then set to read from RCnet v3 node.

Known Issues

If (main module) component roles are assigned to delegate to Owner, they are not currently returned by the Gateway API - this only works for resources at present.

This will be fixed in the next release.

RCNet v2 to RCNet v3 Migration Guide

What’s New?

• state returned for access controller, pool components and account from /state/entity/details endpoint.
• access controller access rules returned from /state/entity/details endpoint.
• Added blueprint_version to StateEntityDetailsResponseComponentDetails response
• fixed total_supply, total_burned and total_minted for resources (i.e native XRD).
• new endpoint /state/non-fungible/location returns location of given non fungible id.
• Return programmatic json with type names for:
  • key-value key and data in /state/key-value/data endpoint
  • non fungible data in /state/non-fungible/data endpoint
  • events in /transaction/committed-details and /stream/transactions endpoints.
  • custom scrypto component state in /state/entity/details endpoint.
• New endpoint /statistics/validators/uptime returns validator uptime data.
• New endpoint /state/key-value/data returns entries of requested KeyValueStore.
• Rework in role_assignments. Returning all possible keys for native modules (AccessRules, Metadata, Royalty) and if no role is assigned pointer to owner role is returned. Same functionality applies to MainModule for FungibleResource and NonFungibleResource.

Breaking Changes

• Renamed access_rules to role_assignments. Included missing module to role assignment key.
• Deleted non fungible ids are also returned from /state/non-fungible/data with null data, marked as is_burned with state version when they got burned.
• Transaction hashes are now exposed as Bech32m hashes instead of hex-encoded binary sequences.
• Dropped previous_cursor altogether from all paginable collections.

Known Issues

• only assigned role_assignments keys for main module for non resource entities are returned. If key is not assigned it'll not be returned from API.

RCnet v2 (Revision 6)

• Fixes an issue when ingesting the ansharnet ledger (state version 13330480) when removing key value store data.

This release is available as tag rcnet-v2-phase2-r6 on dockerhub (for each of radixdlt/babylon-ng-database-migrations, radixdlt/babylon-ng-data-aggregator and radixdlt/babylon-ng-gateway-api).

Please see RCnet v2 (Revision 1) for the full release / install notes.

RCnet v2 (Revision 5)

• Fixes an issue when ingesting the ansharnet ledger (state version 10942327).
• Fixes issue with duplicate nfids in vault

The latter fix in this update requires that your Network Gateway database is wiped and that the Gateway resyncs.

This release is available as tag rcnet-v2-phase2-r5 on dockerhub (for each of radixdlt/babylon-ng-database-migrations, radixdlt/babylon-ng-data-aggregator and radixdlt/babylon-ng-gateway-api).

Please see RCnet v2 (Revision 1) for the full release / install notes.

RCnet v2 (Revision 4)

Some further small bug-fixes for RCnet v2 Phase 2. We recommend any Gateway runners run this version.

This release is available as tag rcnet-v2-phase2-r4 on dockerhub (for each of radixdlt/babylon-ng-database-migrations, radixdlt/babylon-ng-data-aggregator and radixdlt/babylon-ng-gateway-api).

Please see RCnet v2 (Revision 1) for the full release / install notes.

RCnet v2 (Revision 3)

Some further small bug-fixes for RCnet v2 Phase 2. We recommend any Gateway runners run this version.

This release is available as tag rcnet-v2-phase2-r3 on dockerhub (for each of radixdlt/babylon-ng-database-migrations, radixdlt/babylon-ng-data-aggregator and radixdlt/babylon-ng-gateway-api).

Please see RCnet v2 (Revision 1) for the full release / install notes.

RCnet v2 (Revision 2)

Some further small bug-fixes for RCnet v2 Phase 2. We recommend any Gateway runners run this version.

This release is available as tag rcnet-v2-phase2-r2 on dockerhub (for each of radixdlt/babylon-ng-database-migrations, radixdlt/babylon-ng-data-aggregator and radixdlt/babylon-ng-gateway-api).

Please see RCnet v2 (Revision 1) for the full release / install notes.

RCnet v2 (Revision 1)

Overview

This release brings the Gateway compatible with RCnet v2 phase 2 of the Radix Babylon Network.

• Updated API docs live on Redocly here: https://radix-rcnet-v2-gateway.redoc.ly/
• The RCnet v2 public gateway root is here: https://rcnet-v2.radixdlt.com/
• Swagger is available on the public gateway here: https://rcnet-v2.radixdlt.com/swagger

Note to Integrators

Please note that the Babylon Core API on the Node is more powerful than on Olympia.

Integrators looking to prepare for the Radix Babylon launch should start by considering if running their own node and using the Core API would work instead of running a Gateway and using the Gateway API.

Please see the guide for integrators here.

Running just a node is simpler than running a node and Gateway, and the Core API has a "long term support" section of the API, designed for tracking fungible balances and accounts, which is guaranteed to be compatible with mainnet launch - enabling integrators to prepare for mainnet launch immediately.

Updating your Gateway

If running your own Gateway, as part of updating to this network, your Gateway database will need to be wiped, your Gateway updated, and then set to read from RCnet v2 Phase 2 (Ansharnet) node.

Known Issues

The total supply, total minted and total burned figure for a resource is not accurate. This will be fixed for RCnet v3.

RCNet v1 to RCNet v2 Migration Guide

What’s New?

• Some properties are now annotated with an is_locked field indicating whether the value is locked or is still able to be updated.

• Strongly-typed metadata values. Each metadata property is now represented as raw SBOR value and one of sixteen possible typed values, as per the Entity Metadata docs

• Additional entity details are returned from the /state/entity/details endpoint:

  • Entity Role Assignments "access rules"
    • NOTE: Expect minor field renames at RCnet v3, to better align with the new role abstractions.
  • Total supply alongside overall number of minted and burned tokens for resources.
    • WARNING: Total supply is not currently accurate. This will be fixed at RCnet v3.
  • Package code, blueprints, schemas and royalty vaults

• New opt-in flags are supported for /state/entity/details endpoint:

  • explicit_metadata - allows to specify a collection of metadata keys you’d like to receive in the response,
  • ancestor_identities - to include parental entity identifiers,
  • component_royalty_vault_valance and package_royalty_vault_balance - to include royalty vaults and their respective balances where applicable,
  • non_fungible_include_nfids - to include a first chunk of NFIDs of a returned NF vaults.

• New opt-in flags supported for /stream/transactions endpoint:

  • raw_hex to include raw bytes of a TX,
  • receipt_state_changes to include low-level state changes,
  • receipt_fee_sumary to include TX fees,
  • receipt_events to include low-level events,
  • affected_global_entities to include list of entities affected by given TX,

• Additional transaction details in /stream/transactions endpoint: epoch, round, round_timestamp.

• New filters in /stream/transactions endpoint to limit search results:

  • manifest_accounts_withdrawn_from_filter - filter for TXs where given accounts have been withdrawn from,
  • manifest_accounts_deposited_into_filter - filter for TXs where given accounts have been deposited into,
  • manifest_resources_filter - filter for TXs where given resources have been used,
  • affected_global_entities_filter - filter for TXs where given entities have had internal updates,
  • events_filter - filter for TXs where the given event occurred (only Vault Deposit/Withdrawal events are currently supported)

• More validator details in /state/validators/list endpoint: state_vault, pending_xrd_withdraw_vault, locked_owner_stake_unit_vault, pending_owner_stake_unit_unlock_vault

Breaking Changes

• All addresses (including internal addresses) are now represented with a single Address type.
• No more as_string and as_string_collection metadata representations - they’ve been replaced with strongly-typed models.
• Minor property renames to reflect changes in upstream engine and Core APIs

Full changelog

Full technical changelog is here.

RCnet-V1.1

Overview

This release brings the Gateway compatible with the first release candidate of the Radix Babylon Network.

Integrators

Please note that the Babylon Core API on the Node is more powerful than on Olympia.

Integrators looking to prepare for the Radix Babylon launch should start by considering if running their own node and using the Core API would work instead of running a Gateway and using the Gateway API.

Running just a node is simpler than running a node and Gateway, and the Core API has a "long term support" section of the API, designed for tracking fungible balances and accounts, which is guaranteed to be compatible with mainnet launch - enabling integrators to prepare for mainnet launch immediately.

Key changes

Overview of Gateway changes since RCnet-V1.0:

• add binaries to Github Release
• fix DockerHub Image Tags

Overview of Gateway changes since Betanet-V2:

• /entity/overview and /entity/details endpoints replaced with single /state/entity/details.
• Fungible and non-fungible resources are now ordered by the most recently updated.
• /transaction/recent endpoint replaced with /stream/transactions returning user and non-user transactions.
• limit request parameter has been renamed to limit_per_page.
• All enum values use PascalCase naming.
• /gateway/information replaced with two separate endpoints /status/gateway-status and /status/network-configuration
• Added new configuration section CoreApiIntegration where you can configure integration with core API. For now only SubmitTransactionTimeout setting is supported.
• /stake/validator/list rework, added current stake value.
• /entity/resources merged into /state/entity/details endpoint
• new paginable endpoints /state/entity/page/{x} for metadata, fungibles, fungible-vaults, non-fungibles, non-fungible-vaults and non-fungible-vault/ids. Cursors returned from state/entity/details can be later used to query for next pages in specific endpoints.
• /transaction/committed-details endpoint operates on intent_hash_hex only now