Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.canton.network/llms.txt

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

Templates

template AcceptedTransferOffer
Signatory: sender, receiver
FieldTypeDescription
senderParty
receiverParty
dsoParty
amountPaymentAmount
expiresAtTime
trackingIdText
  • Choice AcceptedTransferOffer_Abort
    Controller: sender Returns: AcceptedTransferOffer_AbortResult
    FieldTypeDescription
    reasonText
  • Choice AcceptedTransferOffer_Complete
    Controller: sender, walletProvider Returns: AcceptedTransferOffer_CompleteResult
    FieldTypeDescription
    inputs[TransferInput]
    transferContextPaymentTransferContext
    walletProviderParty
  • Choice AcceptedTransferOffer_Expire
    Controller: actor Returns: AcceptedTransferOffer_ExpireResult
    FieldTypeDescription
    actorParty
  • Choice AcceptedTransferOffer_Withdraw
    Controller: receiver Returns: AcceptedTransferOffer_WithdrawResult
    FieldTypeDescription
    reasonText
  • Choice Archive Controller: sender, receiver Returns: () (no fields)
template TransferOffer
Signatory: sender
FieldTypeDescription
senderParty
receiverParty
dsoParty
amountPaymentAmount
descriptionText
expiresAtTime
trackingIdText
  • Choice Archive Controller: sender Returns: () (no fields)
  • Choice TransferOffer_Accept
    Controller: receiver Returns: TransferOffer_AcceptResult (no fields)
  • Choice TransferOffer_Expire
    Controller: actor Returns: TransferOffer_ExpireResult
    FieldTypeDescription
    actorParty
  • Choice TransferOffer_Reject
    Controller: receiver Returns: TransferOffer_RejectResult (no fields)
  • Choice TransferOffer_Withdraw
    Controller: sender Returns: TransferOffer_WithdrawResult
    FieldTypeDescription
    reasonText

Data Types

data AcceptedTransferOffer_AbortResult
AcceptedTransferOffer_AbortResult
FieldTypeDescription
trackingInfoTransferOfferTrackingInfo
instance GetField “trackingInfo” AcceptedTransferOffer_AbortResult TransferOfferTrackingInfo instance SetField “trackingInfo” AcceptedTransferOffer_AbortResult TransferOfferTrackingInfo instance HasExercise AcceptedTransferOffer AcceptedTransferOffer_Abort AcceptedTransferOffer_AbortResult instance HasFromAnyChoice AcceptedTransferOffer AcceptedTransferOffer_Abort AcceptedTransferOffer_AbortResult instance HasToAnyChoice AcceptedTransferOffer AcceptedTransferOffer_Abort AcceptedTransferOffer_AbortResult
data AcceptedTransferOffer_CompleteResult
AcceptedTransferOffer_CompleteResult
FieldTypeDescription
transferResultTransferResult
trackingInfoTransferOfferTrackingInfo
senderChangeAmuletOptional (ContractId Amulet)
instance GetField “senderChangeAmulet” AcceptedTransferOffer_CompleteResult (Optional (ContractId Amulet)) instance GetField “trackingInfo” AcceptedTransferOffer_CompleteResult TransferOfferTrackingInfo instance GetField “transferResult” AcceptedTransferOffer_CompleteResult TransferResult instance SetField “senderChangeAmulet” AcceptedTransferOffer_CompleteResult (Optional (ContractId Amulet)) instance SetField “trackingInfo” AcceptedTransferOffer_CompleteResult TransferOfferTrackingInfo instance SetField “transferResult” AcceptedTransferOffer_CompleteResult TransferResult instance HasExercise AcceptedTransferOffer AcceptedTransferOffer_Complete AcceptedTransferOffer_CompleteResult instance HasFromAnyChoice AcceptedTransferOffer AcceptedTransferOffer_Complete AcceptedTransferOffer_CompleteResult instance HasToAnyChoice AcceptedTransferOffer AcceptedTransferOffer_Complete AcceptedTransferOffer_CompleteResult
data AcceptedTransferOffer_ExpireResult
AcceptedTransferOffer_ExpireResult
FieldTypeDescription
trackingInfoTransferOfferTrackingInfo
instance GetField “trackingInfo” AcceptedTransferOffer_ExpireResult TransferOfferTrackingInfo instance SetField “trackingInfo” AcceptedTransferOffer_ExpireResult TransferOfferTrackingInfo instance HasExercise AcceptedTransferOffer AcceptedTransferOffer_Expire AcceptedTransferOffer_ExpireResult instance HasFromAnyChoice AcceptedTransferOffer AcceptedTransferOffer_Expire AcceptedTransferOffer_ExpireResult instance HasToAnyChoice AcceptedTransferOffer AcceptedTransferOffer_Expire AcceptedTransferOffer_ExpireResult
data AcceptedTransferOffer_WithdrawResult
AcceptedTransferOffer_WithdrawResult
FieldTypeDescription
trackingInfoTransferOfferTrackingInfo
instance GetField “trackingInfo” AcceptedTransferOffer_WithdrawResult TransferOfferTrackingInfo instance SetField “trackingInfo” AcceptedTransferOffer_WithdrawResult TransferOfferTrackingInfo instance HasExercise AcceptedTransferOffer AcceptedTransferOffer_Withdraw AcceptedTransferOffer_WithdrawResult instance HasFromAnyChoice AcceptedTransferOffer AcceptedTransferOffer_Withdraw AcceptedTransferOffer_WithdrawResult instance HasToAnyChoice AcceptedTransferOffer AcceptedTransferOffer_Withdraw AcceptedTransferOffer_WithdrawResult
data TransferOfferTrackingInfo
TransferOfferTrackingInfo
FieldTypeDescription
trackingIdText
senderParty
receiverParty
instance Eq TransferOfferTrackingInfo instance Show TransferOfferTrackingInfo instance GetField “receiver” TransferOfferTrackingInfo Party instance GetField “sender” TransferOfferTrackingInfo Party instance GetField “trackingId” TransferOfferTrackingInfo Text instance GetField “trackingInfo” WalletAppInstall_AcceptedTransferOffer_AbortResult TransferOfferTrackingInfo instance GetField “trackingInfo” WalletAppInstall_AcceptedTransferOffer_ExpireResult TransferOfferTrackingInfo instance GetField “trackingInfo” WalletAppInstall_AcceptedTransferOffer_WithdrawResult TransferOfferTrackingInfo instance GetField “trackingInfo” WalletAppInstall_TransferOffer_ExpireResult TransferOfferTrackingInfo instance GetField “trackingInfo” WalletAppInstall_TransferOffer_RejectResult TransferOfferTrackingInfo instance GetField “trackingInfo” WalletAppInstall_TransferOffer_WithdrawResult TransferOfferTrackingInfo instance GetField “trackingInfo” AcceptedTransferOffer_AbortResult TransferOfferTrackingInfo instance GetField “trackingInfo” AcceptedTransferOffer_CompleteResult TransferOfferTrackingInfo instance GetField “trackingInfo” AcceptedTransferOffer_ExpireResult TransferOfferTrackingInfo instance GetField “trackingInfo” AcceptedTransferOffer_WithdrawResult TransferOfferTrackingInfo instance GetField “trackingInfo” TransferOffer_ExpireResult TransferOfferTrackingInfo instance GetField “trackingInfo” TransferOffer_RejectResult TransferOfferTrackingInfo instance GetField “trackingInfo” TransferOffer_WithdrawResult TransferOfferTrackingInfo instance SetField “receiver” TransferOfferTrackingInfo Party instance SetField “sender” TransferOfferTrackingInfo Party instance SetField “trackingId” TransferOfferTrackingInfo Text instance SetField “trackingInfo” WalletAppInstall_AcceptedTransferOffer_AbortResult TransferOfferTrackingInfo instance SetField “trackingInfo” WalletAppInstall_AcceptedTransferOffer_ExpireResult TransferOfferTrackingInfo instance SetField “trackingInfo” WalletAppInstall_AcceptedTransferOffer_WithdrawResult TransferOfferTrackingInfo instance SetField “trackingInfo” WalletAppInstall_TransferOffer_ExpireResult TransferOfferTrackingInfo instance SetField “trackingInfo” WalletAppInstall_TransferOffer_RejectResult TransferOfferTrackingInfo instance SetField “trackingInfo” WalletAppInstall_TransferOffer_WithdrawResult TransferOfferTrackingInfo instance SetField “trackingInfo” AcceptedTransferOffer_AbortResult TransferOfferTrackingInfo instance SetField “trackingInfo” AcceptedTransferOffer_CompleteResult TransferOfferTrackingInfo instance SetField “trackingInfo” AcceptedTransferOffer_ExpireResult TransferOfferTrackingInfo instance SetField “trackingInfo” AcceptedTransferOffer_WithdrawResult TransferOfferTrackingInfo instance SetField “trackingInfo” TransferOffer_ExpireResult TransferOfferTrackingInfo instance SetField “trackingInfo” TransferOffer_RejectResult TransferOfferTrackingInfo instance SetField “trackingInfo” TransferOffer_WithdrawResult TransferOfferTrackingInfo
data TransferOffer_AcceptResult
TransferOffer_AcceptResult
FieldTypeDescription
acceptedTransferOfferContractId AcceptedTransferOffer
instance GetField “acceptedTransferOffer” TransferOffer_AcceptResult (ContractId AcceptedTransferOffer) instance SetField “acceptedTransferOffer” TransferOffer_AcceptResult (ContractId AcceptedTransferOffer) instance HasExercise TransferOffer TransferOffer_Accept TransferOffer_AcceptResult instance HasFromAnyChoice TransferOffer TransferOffer_Accept TransferOffer_AcceptResult instance HasToAnyChoice TransferOffer TransferOffer_Accept TransferOffer_AcceptResult
data TransferOffer_ExpireResult
TransferOffer_ExpireResult
FieldTypeDescription
trackingInfoTransferOfferTrackingInfo
instance GetField “trackingInfo” TransferOffer_ExpireResult TransferOfferTrackingInfo instance SetField “trackingInfo” TransferOffer_ExpireResult TransferOfferTrackingInfo instance HasExercise TransferOffer TransferOffer_Expire TransferOffer_ExpireResult instance HasFromAnyChoice TransferOffer TransferOffer_Expire TransferOffer_ExpireResult instance HasToAnyChoice TransferOffer TransferOffer_Expire TransferOffer_ExpireResult
data TransferOffer_RejectResult
TransferOffer_RejectResult
FieldTypeDescription
trackingInfoTransferOfferTrackingInfo
instance GetField “trackingInfo” TransferOffer_RejectResult TransferOfferTrackingInfo instance SetField “trackingInfo” TransferOffer_RejectResult TransferOfferTrackingInfo instance HasExercise TransferOffer TransferOffer_Reject TransferOffer_RejectResult instance HasFromAnyChoice TransferOffer TransferOffer_Reject TransferOffer_RejectResult instance HasToAnyChoice TransferOffer TransferOffer_Reject TransferOffer_RejectResult
data TransferOffer_WithdrawResult
TransferOffer_WithdrawResult
FieldTypeDescription
trackingInfoTransferOfferTrackingInfo
instance GetField “trackingInfo” TransferOffer_WithdrawResult TransferOfferTrackingInfo instance SetField “trackingInfo” TransferOffer_WithdrawResult TransferOfferTrackingInfo instance HasExercise TransferOffer TransferOffer_Withdraw TransferOffer_WithdrawResult instance HasFromAnyChoice TransferOffer TransferOffer_Withdraw TransferOffer_WithdrawResult instance HasToAnyChoice TransferOffer TransferOffer_Withdraw TransferOffer_WithdrawResult