Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cantonfoundation-issue-365-details-history.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The APIs below are published by Splice to aid decoupling different Canton Network applications. Consider using them to decouple your code from the upgrading cycles of your dependencies, when building Daml code that interacts with workflows of other apps in the Canton Network. These APIs are not mandatory to use. Feel free to build your own Daml APIs, potentially using the APIs below as inspiration.

​
Canton Network Token Standard APIs (CIP-0056)

Refer to the Token Standard documentation section.
  • See the text of the CIP-0047 for its background on its design and its specification.
  • The Daml interfaces that are part of the Featured App Activity Markers API are defined in:
  • The utility package splice-util-featured-app-proxies provides templates that allow to delegate the usage of featured app rights to other parties for the purpose of executing token standard actions. Use these templates to earn app rewards on token standard operations, and to potentially share some of them with your users.
Assuming you are a wallet provider that runs a validator node for your users, then there are two options for you to earn featured app rewards for the activity of your wallet users. They are complementary, so you probably want to implement both of them:
  1. Have your wallet users request your featured wallet provider party to maintain Canton Coin transfer preapproval contracts for them. Whenever such a contract is used to directly transfer CC to one of your wallet users, a featured app coupon is created for your wallet provider party.
  2. Setup your wallet frontend such that the transactions submitted by your users create a featured app activity marker for your wallet provider party. For token standard interactions, we recommend to use the WalletUserProxy template as explained below. It enables you to earn featured app rewards on sending all CN tokens (including CC) and to earn featured app rewards when your users accept, reject, or withdraw a CN token transfer offer. It further provides the option to execute bulk transfers of CN tokens. If required, you can also write custom Daml code that creates the featured app activity markers for your wallet provider party on the relevant user actions. Feel free to reuse parts of the WalletUserProxy implementation for that purpose. Make sure to publish your code using a package name under your control to avoid upgrading conflicts.
Earning featured app rewards for direct transfers of non-CC tokens to your wallet users is currently not possible without special support from the app provider of the respective token.

​
Additional Splice Daml APIs

The app provider of an asset registry is not necessarily the same as the party controlling the minting and burning of tokens. A typical example are tokens that are bridged from another network. The splice-api-token-burn-mint-v1 package targets that use-case; and thus enables to decouple the upgrade cycles of an asset registry from the ones of the bridging app. The API is built in a similar style as the token standard APIs, but is not part of the token standard. In particular, implementors of the token standard are not required to implement this API. Nevertheless the API definition is guaranteed to be stable, and can be used by for the purpose explained above. If there were changes to the API, then they would be published as a new version of the API using a fresh package name, so that both the old and the new version can be used in parallel.