Babylon (v1.0.0-rc3)

Overview

This is a v1.0.0 release candidate for the Gateway. There will likely be another build before mainnet launch next week, but we are not expecting any changes to the Gateway API schema. API docs are on Redocly here: https://radix-babylon-gateway-api.redoc.ly/

If updating your zabanet gateway, upgrading to this release will require a database wipe.

License

The Babylon Gateway code is released under the Radix License. Binaries/Executable components are licensed under the Radix Software EULA.

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.

Docker Images

This release is available as tag v1.0.0-rc3 on dockerhub, for the following images:

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

Stokenet Gateway

• The Stokenet public gateway is here: https://babylon-stokenet-gateway.radixdlt.com/
• Swagger is available on the Stokenet gateway here: https://babylon-stokenet-gateway.radixdlt.com/swagger

RCNet v3.1 to v1.0.0 Migration Guide

Breaking changes

• Instead of returning only the event data payload from /stream/transactions and /transaction/committed-details, the event data is now a complex object, wrapping the data payload, but also containing the emitter and event name. This allows you to properly determine which entity emitted the event.

What’s new?

• Fixed epoch in from_state_version forward querying for migrated environments where lowest epoch number isn't 1.
• Fixed the validator_active_set_history table which contains data about validator active set history. It was wrongly attached to future epoch not current one.
• Pending transaction handling has been reworked, and /transaction/status returns some additional fields with a lot more information regarding the status of the intent and submitted payloads. Check out the intent_status and payload_status fields. Each status is also associated with a description to help developers understand the meaning of the returned status.

RCnet v3.1 (Revision 4)

• fix /state/entity/details endpoint when querying for multiple components with same schema.

That release doesn't requires db wipe.

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

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

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

RCnet v3.1 (Revision 3)

• Fix event schema lookup in /stream/transactions and /transaction/committed-details.
• Add non_fungible_id_location_history table to improve NFID lookup performance.
• Add missing index to entity_vault_history table to improve royalty vault lookup performance.

That release requires db wipe.

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

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

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

RCnet v3.1 (Revision 2)

• Fix incomplete entity type mapping.
• Fix non-fungible resource aggregation.
• Add key_json property to StateKeyValueStoreDataRequestKeyItem enabling JSON-based KVStore lookup.
• support remote schema assignment for generic (key value store, non fungible data) substitution.

That release requires db wipe.

This release is available as tag rcnet-v3.1-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.1 (Revision 1) for the full release / install notes.

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.