> ## 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.

# Splice.AmuletAllocation

> Documentation for Splice.AmuletAllocation

## Templates

<div id="type-splice-amuletallocation-amuletallocation-39850">
  **template** AmuletAllocation
</div>

> 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](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-contractid-95282) LockedAmulet | Locked amulet that holds the funds for the allocation |
> | allocation   | AllocationSpecification                                                                                         |                                                       |
>
> * <div id="type-splice-amuletallocation-amuletallocationdsoexpire-72174">
>     **Choice** AmuletAllocation\_DsoExpire
>   </div>
>
>   Controller: allocationInstrumentAdmin allocation
>
>   Returns: AmuletAllocation\_DsoExpireResult
>
>   | Field      | Type                                                                              | Description |
>   | ---------- | --------------------------------------------------------------------------------- | ----------- |
>   | expireLock | [Bool](/appdev/reference/daml-standard-library/prelude#type-ghc-types-bool-66265) |             |
>
> * **Choice** Archive
>
>   Controller: allocationInstrumentAdmin allocation, (DA.Internal.Record.getField @"sender" (DA.Internal.Record.getField @"transferLeg" allocation))
>
>   Returns: ()
>
>   (no fields)

## Data Types

<div id="type-splice-amuletallocation-amuletallocationdsoexpireresult-36603">
  **data** AmuletAllocation\_DsoExpireResult
</div>

> **instance** [Eq](/appdev/reference/daml-standard-library/prelude#class-ghc-classes-eq-22713) AmuletAllocation\_DsoExpireResult
>
> **instance** [Show](/appdev/reference/daml-standard-library/prelude#class-ghc-show-show-65360) AmuletAllocation\_DsoExpireResult
>
> **instance** GetField "meta" AmuletAllocation\_DsoExpireResult Metadata
>
> **instance** GetField "results" ExternalPartyAmuletRules\_ExpireAmuletAllocationsResult \[AmuletAllocation\_DsoExpireResult]
>
> **instance** GetField "senderHoldingCids" AmuletAllocation\_DsoExpireResult \[[ContractId](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-contractid-95282) Holding]
>
> **instance** SetField "meta" AmuletAllocation\_DsoExpireResult Metadata
>
> **instance** SetField "results" ExternalPartyAmuletRules\_ExpireAmuletAllocationsResult \[AmuletAllocation\_DsoExpireResult]
>
> **instance** SetField "senderHoldingCids" AmuletAllocation\_DsoExpireResult \[[ContractId](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-contractid-95282) Holding]
>
> **instance** [HasExercise](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hasexercise-70422) AmuletAllocation AmuletAllocation\_DsoExpire AmuletAllocation\_DsoExpireResult
>
> **instance** [HasFromAnyChoice](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hasfromanychoice-81184) AmuletAllocation AmuletAllocation\_DsoExpire AmuletAllocation\_DsoExpireResult
>
> **instance** [HasToAnyChoice](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hastoanychoice-82571) AmuletAllocation AmuletAllocation\_DsoExpire AmuletAllocation\_DsoExpireResult

## Functions

<div id="function-splice-amuletallocation-allocationtotwosteptransfer-63709">
  allocationToTwoStepTransfer
  : AllocationSpecification -> TwoStepTransfer
</div>
