Utility.Registry.V0.Rule.Transfer

Templates

template TransferRule

Transfer rule. This rule needs to be explicitly disclosed to users.

Signatory: provider, registrar

Field	Type	Description
operator	Party	Rule operator.
provider	Party	Rule provider.
registrar	Party	Rule registrar.

• Choice Archive

  Controller: provider, registrar

  Returns: ()

  (no fields)

• Choice TransferRule_DirectTransfer

  Used for executing a direct transfer. This choice was added as of version 0.5.0 of this package.

  Controller: (DA.Internal.Record.getField @”sender” transfer), (DA.Internal.Record.getField @”receiver” transfer)

  Returns: TransferRule_DirectTransfer_Result

  Field	Type	Description
  transfer	Transfer	Transfer details.
  extraArgs	ExtraArgs	Extra args.
  expectedOperator	Party	Expected operator.
  expectedProvider	Optional Party	Expected provider.

• Choice TransferRule_ExecuteAllocation

  Used for executing an allocation. This choice was added as of version 0.6.0 of this package.

  Controller: (DA.Internal.Record.getField @”executor” (DA.Internal.Record.getField @”settlement” (DA.Internal.Record.getField @”allocation” allocation))), (DA.Internal.Record.getField @”sender” (DA.Internal.Record.getField @”transferLeg” (DA.Internal.Record.getField @”allocation” allocation))), (DA.Internal.Record.getField @”receiver” (DA.Internal.Record.getField @”transferLeg” (DA.Internal.Record.getField @”allocation” allocation)))

  Returns: TransferRule_ExecuteAllocation_Result

  Field	Type	Description
  allocation	AllocationView	Allocation view.
  extraArgs	ExtraArgs	Extra args.
  expectedOperator	Party	Expected operator.
  expectedProvider	Party	Expected provider.

• Choice TransferRule_Transfer

  Executes a transfer. Disabled as of version 0.5.0 of this package.

  Controller: (DA.Internal.Record.getField @”sender” transfer), (DA.Internal.Record.getField @”receiver” transfer)

  Returns: TransferRule_Transfer_Result

  Field	Type	Description
  transfer	Transfer	Transfer details.
  instrumentConfigurationCid	ContractId InstrumentConfiguration	Instrument configuration.
  senderCredentialCids	[ContractId Credential]	Sender credentials.
  receiverCredentialCids	[ContractId Credential]	Receiver credentials.
  appRewardConfigurationCid	Optional (ContractId AppRewardConfiguration)	App reward configuration. This field was added as of version 0.3.0 of this package.
  featuredAppRightCid	Optional (ContractId FeaturedAppRight)	Featured app right. This field was added as of version 0.3.0 of this package.

• Choice TransferRule_TwoStepTransfer

  Used for executing a two-step transfer. This choice was added as of version 0.6.0 of this package.

  Controller: (DA.Internal.Record.getField @”sender” transfer), (DA.Internal.Record.getField @”receiver” transfer)

  Returns: TransferRule_AcceptTransferOffer_Result

  Field	Type	Description
  transfer	Transfer	Transfer details.
  extraArgs	ExtraArgs	Extra args.
  expectedOperator	Party	Expected operator.
  expectedProvider	Party	Expected provider.

Data Types

data TransferRule_AcceptTransferOffer_Result

Result of TransferRule_AcceptTransferOffer.

TransferRule_AcceptTransferOffer_Result

Field	Type	Description
receiverHoldingCid	ContractId Holding	Receiver holding cid.
senderHoldingCid	Optional (ContractId Holding)	Sender holding cid.

data TransferRule_DirectTransfer_Result

Result of TransferRule_DirectTransfer.

TransferRule_DirectTransfer_Result

Field	Type	Description
receiverHoldingCid	ContractId Holding	Receiver holding cid.
senderHoldingCid	Optional (ContractId Holding)	Sender holding cid.

data TransferRule_ExecuteAllocation_Result

Result of TransferRule_ExecuteAllocation.

TransferRule_ExecuteAllocation_Result

Field	Type	Description
receiverHoldingCid	ContractId Holding	Receiver holding cid.
senderHoldingCid	Optional (ContractId Holding)	Sender holding cid.

Functions

toAllocationLockContext

: AllocationSpecification -> Text