Bump @radixdlt/babylon-gateway-api-sdk from 1.2.0 to 1.5.1

[dependabot]

Bumps @radixdlt/babylon-gateway-api-sdk from 1.2.0 to 1.5.1.

Release notes

Sourced from @​radixdlt/babylon-gateway-api-sdk's releases.

1.5.1

Overview

This is the v1.5.1 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

[!CAUTION] This release MUST NOT be upgraded onto your existing Network Gateway installation as it has an incompatible database schema. There’s no database migration available. What it means is that this release MUST be deployed with an empty (wiped out) database. This will result in a lengthy (approx. 4 - 16 hours depending on your infrastructure) process of resynchronization. During the resynchronization majority of the GW API endpoints will not be available.

[!CAUTION] It is MANDATORY to upgrade to v1.5.1 Gateway before upgrading node to v1.2.0 version (bottlenose protocol version support).

[!WARNING] There will be one more upcoming release (probably v1.6.0). It will be required to update Gateway to that version before bottlenose protocol version will be enacted on network.

What’s new?

[!CAUTION] Breaking Changes:

• Changed ordering of the collection returned by the /state/key-value-store/keys endpoint. Entries are no longer ordered by their last modification state version but rather by their first appearance on the network, descending.
• Property total_count of the /state/key-value-store/keys endpoint is no longer provided.
• Renamed state.recovery_role_recovery_attempt property from timed_recovery_allowed_after to allow_timed_recovery_after returned from /state/entity/details when querying for access controller.

• Fixed broken ledger state lookup (at_ledger_state) when using epoch-only constraint and given epoch did not result in any transactions at round 1.
• Fixed broken (missing) package blueprint & code, and schema pagination in the /state/entity/details endpoint.
• Fixed unstable package blueprint and code aggregation where changes could overwrite each other if they applied to the same blueprint/package within the same ingestion batch.
• Fixed validator public key and active set aggregation where unnecessary copy of the key was stored on each epoch change.
• Fixed pagination of the /state/validators/list endpoint where incorrect cursor was generated previously.
• Fixed invalid date-time format for some entity state properties (most notably access controllers and their recovery_role_recovery_attempt.allow_timed_recovery_after.date_time property) that was dependent on OS-level locale setup.
• Added ng_workers_global_loop_duration_seconds and ng_workers_node_loop_duration_seconds histogram metrics measuring the time it took to process a single iteration of a given worker.
• Changed MVC controller and action names. It has no effect on the API itself, but alters prometheus controler and action labels.
  • StateKeyValueStoreController.Items renamed to StateKeyValueStoreController.KeysPage,
  • StateNonFungibleController.Ids renamed to StateNonFungibleController.IdsPage,
  • StatisticsController.Uptime renamed to StatisticsController.ValidatorsUptime,
  • StateController renamed to StateEntityController,
  • ValidatorStateController renamed to StateValidatorsComponent.
• Upgraded to .NET 8:
  • Upgraded runtime and libraries
  • Dockerfiles no longer specify custom app user as it comes built-in with official base images.
  • Removed now-obsolete or no-longer-needed code.
  • Prometheus integration exposes new built-in metric httpclient_request_duration_seconds_bucket for all registered HTTP clients.
• Reworked internal data aggregation mechanism to ease up maintenance burden.
• Reworked KVStores storage and changed API surface of this area to improve overall performance.

... (truncated)

Changelog

Sourced from @​radixdlt/babylon-gateway-api-sdk's changelog.

1.5.1

Release built: 09.05.2024

[!CAUTION] Breaking Changes:

• Changed ordering of the collection returned by the /state/key-value-store/keys endpoint. Entries are no longer orderer by their last modification state version but rather by their first appearance on the network, descending.
• Property total_count of the /state/key-value-store/keys endpoint is no longer provided.
• Renamed state.recovery_role_recovery_attempt property from timed_recovery_allowed_after to allow_timed_recovery_after returned from /state/entity/details when querying for access controller.

• Fixed broken ledger state lookup (at_ledger_state) when using epoch-only constraint and given epoch did not result in any transactions at round 1.
• Fixed broken (missing) package blueprint & code, and schema pagination in the /state/entity/details endpoint.
• Fixed unstable package blueprint and code aggregation where changes could overwrite each other if they applied to the same blueprint/package within the same ingestion batch.
• Fixed validator public key and active set aggregation where unnecessary copy of the key was stored on each epoch change.
• Fixed pagination of the /state/validators/list endpoint where incorrect cursor was generated previously.
• Fixed invalid date-time format for some entity state properties (most notably access controllers and their recovery_role_recovery_attempt.allow_timed_recovery_after.date_time property) that was dependent on OS-level locale setup.
• Added ng_workers_global_loop_duration_seconds and ng_workers_node_loop_duration_seconds histogram metrics measuring the time it took to process a single iteration of a given worker.
• Changed MVC controller and action names. It has no effect on the API itself, but alters prometheus controler and action labels.
  • StateKeyValueStoreController.Items renamed to StateKeyValueStoreController.KeysPage,
  • StateNonFungibleController.Ids renamed to StateNonFungibleController.IdsPage,
  • StatisticsController.Uptime renamed to StatisticsController.ValidatorsUptime,
  • StateController renamed to StateEntityController,
  • ValidatorStateController renamed to StateValidatorsComponent.
• Upgraded to .NET 8:
  • Upgraded runtime and libraries
  • Dockerfiles no longer specify custom app user as it comes built-in with official base images.
  • Removed now-obsolete or no-longer-needed code.
  • Prometheus integration exposes new built-in metric httpclient_request_duration_seconds_bucket for all registered HTTP clients.
• Reworked internal data aggregation mechanism to ease up maintenance burden.
• Reworked KVStores storage and changed API surface of this area to improve overall performance.

API Changes

• Changed the MetadataInstantValue type and its array counterpart MetadataInstantArrayValue to clamp the value property within the RFC-3339 compatible date-time year range 1583 to 9999. Added a unix_timestamp_seconds property to these types to give the exact unclamped numerical timestamp value.
• Added role_assignments property to the StateEntityDetailsResponsePackageDetails. All global component details returned by the /state/entity/details endpoint contain role assignments now.
• Added owning_vault_parent_ancestor_address and owning_vault_global_ancestor_address properties to the response of the /state/non-fungible/location endpoint.
• Added new filter manifest_badges_presented_filter to the /stream/transactions endpoint which allows filtering transactions by badges presented.
• Added new opt-in component_royalty_config to the /state/entity/details endpoint. When enabled royalty_config will be returned for each component.
• Use strong type definition for the royalty_config property of package blueprint and general components details. This is a change to OAS definition only and does not impact returned data format.
• Introduced upper limit to the overall number of the filters used in the /stream/transactions endpoint, defaults to 10.
• Added new endpoint /state/account/page/resource-preferences which allows to read resource preferences for given account.
• Added new endpoint /state/account/page/authorized-depositors which allows to read authorized depositors for given account.
• Added new endpoint /state/package/page/blueprints returning paginable iterator over package blueprints.
• Added new endpoint /state/package/page/codes returning paginable iterator over package codes.
• Added new endpoint /state/entity/page/schemas returning paginable iterator over entity schemas.
• Added new endpoint /transaction/account-deposit-pre-validation which allows to pre-validate if deposits can succeed based on account deposit settings and badges presented, before submitting the transaction.
• Fixed wrong request validation logic for maximum number of items in /state/non-fungible/data, /state/non-fungible/data and /state/non-fungible/data endpoints.
• limit_per_page request parameter is no longer validated against *MaxPageSize API configuration parameters. In case requested limit exceeds API configuration maximum value is used. This change is meant to reduce clients need to understand and honor API configuration.

Database changes

• Added new BadgePresented to LedgerTransactionMarkerOperationType enum and started collecting transaction markers for badges presented in transactions.
• Column royalty_amount of component_method_royalty_entry_history table contains now the JSON payload representing the royalty amount without wrapping object.

... (truncated)

Commits

• ef7ed0d Regenerated TS SDK
• 27b2b1f Merge branch 'release/v1.5.1'
• 66ef0cf add release date for 1.5.1
• 2fbe375 regenerate typescript client.
• 0076a25 rename config keys.
• 99b607b limit heavy collections page size.
• 49684b0 Merge pull request #734 from radixdlt/postpone-variant-id-change
• 31be993 Revert "Fixed ProgrammaticScryptoSborValue OAS"
• f501768 Merge pull request #733 from radixdlt/datetime-format-fix
• b589b45 Fix Newtonsoft.Json automatic date-time reformatting
• Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)