radixdlt/babylon-gateway v1.3.0 on GitHub

Overview

This is the v1.3.0 release for the Gateway. API docs are on Redocly here: https://radix-babylon-gateway-api.redoc.ly/

License

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

Notes for Gateway runners

This Gateway version must read from nodes running v1.1.0 or above. Please see upgrade strategies below
This Gateway version has required migrations. Ensure that radixdlt/babylon-ng-database-migrations:v1.3.0 is run before the Gateway application containers are updated. The minor database changes are described below.

Possible upgrade strategies:

If you require 100% uptime, first upgrade the Gateway to v1.2.5. Then upgrade the fullnodes to v1.1.0, then upgrade the Gateway to v1.3.0 (this version).
If you are happy to have some downtime, you can skip updating the Gateway to v1.2.5 and update the Gateway to v1.3.0 at the same time as updating the node to v1.1.0. Any overlap of incompatible versions will cause some downtime.

What’s new?

Adds support for protocol updates (in general) and the anemone update in particular.

API Changes

Adds support for a new transaction type (flash transactions) that occur during protocol updates.
Extends well known addresses returned from /status/network-configuration to include the transaction tracker address.
DEPRECATION - Obsoletes the vm_type, code_hash_hex and code_hex properties of StateEntityDetailsResponsePackageDetails in favor of the codes collection. With the upcoming protocol upgrade it will be possible to have multiple codes per package. The obsoleted properties will contain an effective copy of the first element of the new collection for backwards compability.

Database changes

Moves vm_type to package_code_history table from package in entity table.
Creates new package_blueprint_aggregate_history table which will hold pointers to all package blueprints.
Creates new package_code_aggregate_history table which will hold pointers to all package codes.

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.3.0 on dockerhub, for the following images:

radixdlt/babylon-gateway v1.3.0 1.3.0 on GitHub