Token Standard integration

The Registry Utility supports the Canton Network Token Standard, as per the definitions in CIP-0056.

App providers

App providers wishing to transact Utility holdings as part of their application’s workflows must make sure that

  • the latest version of the utility-registry-v0 DAR is installed on their node

  • the application is configured to source off-ledger data from the token standard endpoints outlined below

The Utility UI supports the AllocationRequest standard to read allocation requests from other applications and create the corresponding Allocations.

You can download the bundle containing the DAR files from this page.

Wallet providers

Wallet providers wishing to support Utility holdings in their wallet application must make sure that

  • the latest version of the utility-registry-app-v0 DAR is installed on their node

  • the application is configured to source off-ledger data from the token standard endpoints outlined below

You can download the bundle containing the DAR files from this page.

Instrument admins

Instrument admins who wish to enable token-standard transfers for the Utility tokens they manage must ensure the following contracts have been created

Contract

Purpose

AllocationFactory

Enables users to lock holdings to transfer offers / allocations

TransferRule

Validates credential requirements upon transfer execution

Both contracts can be instantiated using the Utility UI.

Activity markers

If activity markers are configured, these will be created upon the successful execution of a transfer or an allocation. See the page on Featured Activity Markers for more information.

Token Standard endpoints

The Utility allows multiple instrument admins to manage tokens through the Registry module. The Token Standard endpoints for each instrument admin are exposed under the following URL prefixes:

Environment

Base Token Standard URL

Devnet

https://api.utilities.digitalasset-dev.com/api/token-standard/v0/registrars/<admin-party-id>

Testnet

https://api.utilities.digitalasset-staging.com/api/token-standard/v0/registrars/<admin-party-id>

Mainnet

https://api.utilities.digitalasset.com/api/token-standard/v0/registrars/<admin-party-id>

where <admin-party-id> is the party identifier of the corresponding instrument admin.

For instance, the list of instruments administered by the Utility operator party on Mainnet can be retrieved from https://api.utilities.digitalasset.com/api/token-standard/v0/registrars/auth0_007c6643538f2eadd3e573dd05b9::12205bcc106efa0eaa7f18dc491e5c6f5fb9b0cc68dc110ae66f4ed6467475d7c78e/registry/metadata/v1/instruments.

The full API specification for the Token Standard endpoints can be found in the Token Standard documentation.