Documentation

Utility functions shared across all splice apps. Typeclasses class ( Show t, Eq cgid, Show cgid) => HasCheckedFetch t cgid where Contracts typically come in groups. For example, all contracts managed by a specific DSO party. We aim to always fetch with a specific contract group identifier to

Delegation from users to wallet operators allowing them to merge their token standard holdings; and optionally transfer tokens from the operator to the user as part of the merge operation, e.g., for efficiently implementing extraTransfers. The main reasons for using this merge delegation infrastruc

• Splice.Util

Daml script tests showing that the token standard can be used to execute DvP settlements of Amulet tokens; and how to do so. See this test and the ‘Splice.Testing.TradingApp’ module for an example of how to integrate with the allocation APIs of the token standard to execute DvP settlements. Note a

Copy the code of this package from https://github.com/canton-network/splice to gain access to test infrastructure for: • building apps that use the token standard • implementing a token standard compliant registry Note that a copy of the source code is required , as at the time of writing Daml S

Default configuration paramaters for the amulet registry used for testing. Functions defaultTransferConfig : TransferConfig USD Somewhat realistic fees to be used in test-code. defaultAmuletDecentralizedSynchronizerConfig : AmuletDecentralizedSynchronizerConfig Decentralized synchronizer confi

Daml script functions for initializing and using an amulet registry via the token standard and the amulet specific functions. Data Types data AmuletRegistry A reference to a mock amulet registry. Use it via the the token standard functions provided by the “Splice.Testing.RegistryApi” module an

Templates template SvOnboardingConfirmed A confirmation for approval of a candidate SV. Once this contract is created, the workflows to onboard that SVs node starts. Signatory: dso Field | Type | Description | svParty | Party | svName | Text | svRewardWeight | Int | svParticipantId | T

Support for using a token compliant registry API in tests. These simulate the OpenAPI endpoints that would be served by the backend of the registry implementation. Typeclasses class RegistryApi app where Type-class for simulating calls to the off-ledger API of a registry. The function names

Daml script tests showing that the token standard can be used to execute free-of-payment transfers of Amulet tokens; and how to do so. Data Types data TestSetup TestSetup Field | Type | Description | registry | AmuletRegistry | alice | Party | aliceValidator | Party | bob | Party |

A trading app example built on top of the allocation APIs of the Canton Network Token Standard. Serves both as an example as well as a test suite for the token standard APIs. See splice-token-standard-test-docs for the test harness that uses this trading app example for testing allocation usage a

Daml script test utilities for simulating the actions of wallet client based on the token standard. NOTE: there are likely more functions that could/should be added to this module. PRs welcome. Functions listHoldings : Party -> InstrumentId -> Script [( ContractId Holding, HoldingView)] List th

Testing utilities to simplify testing token standard usage and implementation. Data Types data Disclosures’ A set of disclosures. Used to work around the fact that duplicate disclosures for the same contract are not allowed. Disclosures’ Field | Type | Description | disclosures | Map AnyCo

Templates and code for the SVs to agree on a amulet price using median-based voting. Every sv can change its desired amulet price at any time they like provided they wait at least one tick duration (2.5 minutes by default) between changes. New OpenMiningRounds are always openened with the median

Templates to track per-sv state. Templates template SvNodeState State of a node managed by an SV operator party. There is exactly one such state per SV operator party. Even though every SV can operate at most one node at any one time, there can though be multiple SV node states per SV, as the

Data Types data CometBftConfig Config for all CometBFT nodes and keys under the control of a single SV node operator. CometBftConfig Field | Type | Description | nodes | Map Text CometBftNodeConfig | A map from CometBft node-ids to their configuration. | governanceKeys | [GovernanceKeyConfi

Templates template DsoBootstrap A template for bootstrapping DsoRules and AmuletRules. Signatory: dso Field | Type | Description | dso | Party | sv1Party | Party | the SV that bootstraps the network | sv1Name | Text | human-readable name of SV1 | sv1RewardWeight | Int | the weight of SV1

Data structures and contracts related managing the decentralized synchronizer. Data Types data DsoDecentralizedSynchronizerConfig The decentralized synchronizer consists of a series of actual synchronizers. New synchronizers are created by the SVs for the rare case of needing to roll-out a BFT

Templates template BootstrapExternalPartyConfigStateInstruction Instruction to bootstrap the external party config state. This exists so that the ActionRequiringConfirmation for this is independent of the current rounds which we need so that we can do deduplication by action hash in our automa

• Splice.CometBft • Splice.DSO.AmuletPrice • Splice.DSO.DecentralizedSynchronizer • Splice.DSO.SvState • Splice.DsoBootstrap • Splice.DsoRules • Splice.SvOnboarding

Data Types data ForDso The group of contracts managed by the DSO party. Used for checked fetches. ForDso Field | Type | Description | dso | Party | instance Eq ForDso instance Show ForDso instance GetField “dso” ForDso Party instance SetField “dso” ForDso Party instance HasCheckedFet

Data Types data Schedule t a A schedule of values that change over time. Schedule Field | Type | Description | initialValue | a | Initial value to use until the future values come into effect. | futureValues | [(t, a)] | sorted in ascending order | instance Functor (Schedule t) instance

Templates template ClosedMiningRound A record that a specific mining round has been closed, which can be used to archive expired rewards. Signatory: dso Field | Type | Description | dso | Party | round | Round | issuancePerValidatorRewardCoupon | Decimal | issuancePerFeaturedAppRewardCo

Templates template ValidatorFaucetCoupon Deprecated : use ValidatorLicense_RecordValidatorLivenessActivity instead, as that one can be expired without requiring a confirmation from the validator node. Signatory: dso, validator Field | Type | Description | dso | Party | validator | Party |

Data Types data RelRound The equivalent of RelTime for rounds, i.e., a delta between two rounds RelRound Field | Type | Description | diff | Int | instance Eq RelRound instance Ord RelRound instance Show RelRound instance GetField “diff” RelRound Int instance SetField “diff” RelRound

Amulet rewards issuance configuration and computation. Data Types data IssuanceConfig IssuanceConfig Field | Type | Description | amuletToIssuePerYear | Decimal | validatorRewardPercentage | Decimal | appRewardPercentage | Decimal | validatorRewardCap | Decimal | featuredAppRewardCa

Functions for computing amulet and lock expiry times and conditions. Data Types data BoundedSet a A symbolic representation of a set of values of type a useful for computing upper-bounds. Singleton a Singleton x represents the singleton set {x} AfterMaxBound AfterMaxBound repres

Templates template AmuletAllocation Amulet allocated in locked form to a trade. Signatory: allocationInstrumentAdmin allocation, (DA.Internal.Record.getField @“sender” (DA.Internal.Record.getField @“transferLeg” allocation)) Field | Type | Description | lockedAmulet | ContractId LockedAmulet

Data Types data Amulet Deprecated type for specifying amounts and fees in units of Amulet. Use Splice.Amulet.Amulet directly instead. Amulet instance Eq Amulet instance Show Amulet data AmuletConfig unit Configuration includes TransferConfig, issuance curve and tickDuration See Splice.S

Templates template ExternalPartyConfigState ExternalPartyConfigState stores the configuration required for transfer, allocations, traffic purchases and taps. While it exposes a subset of the information also available on OpenMiningRound, ExternalPartyConfigState contracts are active much l