Deprecated

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

Open current docs

Splice.AmuletAllocation

V1 amulet allocation.

Templates

template AmuletAllocation

V1 amulet allocation, which was created using a V1 allocation factory and can be settled on its own using V1.Allocation_ExecuteTransfer or by providing it as an input to a batch settlement executed using V2.SettlementFactory_SettleBatch.

Signatory: allocationInstrumentAdmin allocation, (DA.Internal.Record.getField @"sender" (DA.Internal.Record.getField @"transferLeg" allocation))

Field

Type

Description

lockedAmulet

ContractId LockedAmulet

Locked amulet that holds the funds for the allocation

allocation

AllocationSpecification

expiresAt

Optional Time

When this allocation and its locked amulet expire, which can be earlier than the settlement deadline specified in the allocation. This is used as a DoS protection mechanism.

  • Choice AmuletAllocation_DsoExpire

    Controller: allocationInstrumentAdmin allocation

    Returns: AmuletAllocation_DsoExpireResult

    Field

    Type

    Description

    expireLock

    Bool

  • Choice Archive

    Controller: allocationInstrumentAdmin allocation, (DA.Internal.Record.getField @"sender" (DA.Internal.Record.getField @"transferLeg" allocation))

    Returns: ()

    (no fields)

Data Types

data AmuletAllocation_DsoExpireResult

instance Eq AmuletAllocation_DsoExpireResult

instance Show AmuletAllocation_DsoExpireResult

instance GetField "meta" AmuletAllocation_DsoExpireResult Metadata

instance GetField "results" ExternalPartyAmuletRules_ExpireAmuletAllocationsResult [AmuletAllocation_DsoExpireResult]

instance GetField "senderHoldingCids" AmuletAllocation_DsoExpireResult [ContractId Holding]

instance SetField "meta" AmuletAllocation_DsoExpireResult Metadata

instance SetField "results" ExternalPartyAmuletRules_ExpireAmuletAllocationsResult [AmuletAllocation_DsoExpireResult]

instance SetField "senderHoldingCids" AmuletAllocation_DsoExpireResult [ContractId Holding]

instance HasExercise AmuletAllocation AmuletAllocation_DsoExpire AmuletAllocation_DsoExpireResult

instance HasFromAnyChoice AmuletAllocation AmuletAllocation_DsoExpire AmuletAllocation_DsoExpireResult

instance HasToAnyChoice AmuletAllocation AmuletAllocation_DsoExpire AmuletAllocation_DsoExpireResult

Functions

mkAllocationLockContext

: Reference -> Text

Brief description of lock context.

Comments