Deprecated

This Splice documentation site is deprecated. Use the current Canton Network docs.

Open current docs

Token Standard APIs

API References

Refer to CIP-0056 for more context on the APIs.

Note

TODO(#4582): adjust the text here and below to reflect that there is a V2 version of the token standard APIs.

Token Metadata

• Daml reference for V1
• OpenAPI reference for V1

Note that there is no V2 of the Token Metadata API, as the V1 API is reused across both V1 and V2 of the token standard.

Holding

This allows implementation of a Portfolio View.

• Daml reference for V1
• Daml reference for V2

Transfer Events

These are used by wallets to parse transfers from the Ledger API’s transaction history and display them in the wallet’s transaction history UI. They were newly added as part of the V2 token standard.

• Daml reference for V2

Transfer Instruction

This allows implementation of Direct Peer-to-Peer / Free of Payment (FOP) Transfers.

• Daml reference for V1
• Daml reference for V2
• OpenAPI reference for V1

Allocation

This allows implementation of Delivery versus Payment (DVP) Transfer Workflows, jointly with the Allocation Instruction and Allocation Request APIs below.

• Daml reference for V1
• Daml reference for V2
• OpenAPI reference for V1

Allocation Instruction

• Daml reference for V1
• Daml reference for V2
• OpenAPI reference for V1

Allocation Request

• Daml reference for V1
• Daml reference for V2

Implementation Utilities

See the following package for converting between V1 and V2 API versions, and for default implementations of token standard choices.

• Daml reference for both V1 and V2

Using token standard choices from custom Daml code

• splice-util-token-standard-wallet docs

Comments