Skip to content
CCPEDIAby Unity Nodes
LEARN · DOCUMENTATION

Documentation

Pages from 29 sources, kept in sync: the official Canton Network and Digital Asset docs, documentation from teams building on Canton, and readmes from their code. Search all of it, or start from a path below.

3,253pages
synced 3h ago29 sources
This week489pages updated upstreamNewestLogical Synchronizer UpgradesNov 6, 2026Official1,638pages from Canton and Digital Asset

Recently updated

1,473 pages
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-amulet
Splice.AmuletConfig
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
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-amulet
Splice.ExternalPartyConfigState
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
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-amulet
Splice.AmuletRules
Templates template AmuletRules The rules governing how Amulet users can modify the Amulet state managed by the DSO party. Signatory: dso Field | Type | Description | dso | Party | configSchedule | Schedule Time (AmuletConfig USD) | isDevNet | Bool | contractStateSchemaVersion | Optional
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-amulet
Splice.Fees
Utility functions for different kinds of fees. Data Types data ExpiringAmount ExpiringAmount Field | Type | Description | initialAmount | Decimal | createdAt | Round | ratePerRound | RatePerRound | instance Eq ExpiringAmount instance Ord ExpiringAmount instance Show ExpiringAmount
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-amulet
Splice.AmuletTransferInstruction
Templates template AmuletTransferInstruction A transfer instruction for transferring Amulet tokens pending on receiver acceptance. Signatory: (DA.Internal.Record.getField @“admin” (DA.Internal.Record.getField @“instrumentId” transfer)), (DA.Internal.Record.getField @“sender” transfer) Field |
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-amulet
Splice.ExternalPartyAmuletRules
Templates template ExternalPartyAmuletRules Rules contract that can be used in transactions that require signatures from an external party. This is intended to get archived and recreated as rarely as possible to support long delays between preparing and signing a transaction. Signatory: dso Fi
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-amulet
Splice.DecentralizedSynchronizer
Types and contracts for managing synchronizer fees Templates template MemberTraffic The state of the extra synchronizer traffic purchases of a sequencer sv. Signatory: dso Field | Type | Description | dso | Party | memberId | Text | The id of the sequencer member (participant or mediator)
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-amulet-name-service
Splice.Ans.AmuletConversionRateFeed
Templates to communicate amulet conversion rates. This does not fit a narrow interpretation of “Amulet Name Service”, but it fits very well if we widen the role of the ANS to serve as a store for public data of high-value to network participants. Evolving ANS in this direction is a long-standing pl
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-amulet
Splice.Amulet.TokenApiUtils
Common utilities for implementing the token APIs for Amulet. Typeclasses class ToAnyValue a where Values that can be converted to AnyValue toAnyValue : a -> AnyValue instance ToAnyValue TimeLock instance ToAnyValue Bool instance ToAnyValue Decimal instance ToAnyValue Int instance ToAnyV
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-amulet
Splice.Amulet.TwoStepTransfer
Generic code for a two-step transfer of amulet. The first step is to lock the amulet, the second step is to transfer it. Data Types data TwoStepTransfer TwoStepTransfer Field | Type | Description | dso | Party | sender | Party | receiver | Party | amount | Decimal | lockContext | Te
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-amulet-name-service
Splice.Ans
Templates template AnsEntry A ans entry that needs to be renewed continuously. Renewal recreates this contract with an updated expiresAt field. Signatory: user, dso Field | Type | Description | user | Party | dso | Party | name | Text | url | Text | description | Text | expiresAt
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-amulet-name-service
splice
• Splice.Ans • Splice.Ans.AmuletConversionRateFeed
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages
Splice.Amulet
The contracts representing the long-term state of Splice. Templates template Amulet A amulet, which can be locked and whose amount expires over time. The expiry serves to charge an inactivity fee, and thereby ensures that the SVs can reclaim the corresponding storage space at some point in th
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › Token Standard v1
Splice.Api.Token.TransferInstructionV1
Instruct transfers of holdings between parties. Interfaces interface TransferFactory A factory contract to instruct transfers of holdings between parties. viewtype TransferFactoryView • Choice Archive Controller: Signatories of implementing template Returns: () (no fields) • Choice Tra
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › Token Standard v1
Splice.Api.Token.HoldingV1
Types and interfaces for retrieving an investor’s holdings. Interfaces interface Holding Holding interface. viewtype HoldingView • Choice Archive Controller: Signatories of implementing template Returns: () (no fields) Data Types data HoldingView View for Holding. HoldingView
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › Token Standard v1
Splice.Api.Token.AllocationV1
This module defines the Allocation interface and supporting types. Contracts implementing the Allocation interface represent a reservation of assets to transfer them as part of an atomic on-ledger settlement requested by an app. Interfaces interface Allocation A contract representing an a
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › Token Standard v1
Splice.Api.Token.MetadataV1
Types and interfaces for retrieving metadata about tokens. Interfaces interface AnyContract Interface used to represent arbitrary contracts. Note that this is not expected to be implemented by any template, so it should only be used in the form ContractId AnyContract and through coerceContr
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › Token Standard v1
Splice.Api.Token.BurnMintV1
An interface for registries to expose burn/mint operations in a generic way for bridges to use them, and for wallets to parse their use. Interfaces interface BurnMintFactory A factory for generic burn/mint operations. viewtype BurnMintFactoryView • Choice Archive Controller: Signatories of
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › Token Standard v1
Splice.Api.Token.AllocationRequestV1
This module defines the interface for an AllocationRequest, which is an interface that can be implemented by an app to request specific allocations from their users for the purpose of settling a DvP or a payment as part of an app’s workflow. Interfaces interface AllocationRequest A request b
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-api-featured-app-v2
Splice.Api.FeaturedAppRightV2
The API for featured apps to record their activity. This package extends FeaturedAppRightV1 with support for specifying a weight when creating a marker to improve efficiency. Interfaces interface FeaturedAppActivityMarker A marker created by a featured application for activity generated from t
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-api-featured-app-v1
Splice.Api.FeaturedAppRightV1
The API for featured apps to record their activity. Interfaces interface FeaturedAppActivityMarker A marker created by a featured application for activity generated from that app. This is used to record activity other than amulet transfers, which have built-in support for recording featured ap
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › Token Standard v1
Splice.Api.Token.AllocationInstructionV1
Interfaces to enable wallets to instruct the registry to create allocations. Interfaces interface AllocationFactory Contracts implementing AllocationFactory are retrieved from the registry app and are used by the wallet to create allocation instructions (or allocations directly). viewtype A
May 18, 2026
OfficialCanton Network docs · Module 3: Daml Smart Contracts
Testing Daml Contracts
Test Daml contracts This section is about testing and debugging the Daml contracts you’ve built using the tools from earlier chapters. You’ve already met Daml Script as a way of testing your code inside the IDE. In this chapter you’ll learn about more ways to run Daml Scripts, as well as other too
May 17, 2026
OfficialCanton Network docs · Module 2: Canton for Ethereum Developers
Migration Checklist
Use this checklist when planning and executing a migration from Ethereum to Canton. Each section covers a key area with specific action items. Before You Start Assess your application architecture • Identify state model dependencies : Does your app rely on global state queries? • Map multi-par
May 17, 2026
OfficialCanton Network docs · … › Splice Daml Packages › Token Standard v1 › splice-api-token-allocation-v1
splice
Modules • Splice.Api.Token.AllocationV1
May 17, 2026
OfficialCanton Network docs · … › Splice Daml Packages › Token Standard v1 › splice-api-token-transfer-instruction-v1
splice
Modules • Splice.Api.Token.TransferInstructionV1
May 17, 2026
OfficialCanton Network docs · … › Splice Daml Packages › Token Standard v1 › splice-api-token-holding-v1
splice
Modules • Splice.Api.Token.HoldingV1
May 17, 2026
OfficialCanton Network docs · … › Splice Daml Packages › Token Standard v1 › splice-api-token-burn-mint-v1
splice
Modules • Splice.Api.Token.BurnMintV1
May 17, 2026
OfficialCanton Network docs · … › Splice Daml Packages › Token Standard v1 › splice-api-token-metadata-v1
splice
Modules • Splice.Api.Token.MetadataV1
May 17, 2026
OfficialCanton Network docs · … › Splice Daml Packages › Token Standard v1 › splice-api-token-allocation-instruction-v1
splice-api
Modules • Splice.Api.Token.AllocationInstructionV1
May 17, 2026
Showing 1,381 to 1,410 of 1,473Search all sources →