Utility.Registry.App.V0.Service.Holder

Templates

template HolderService

Holder service.

Signatory: provider, holder

Field	Type	Description
operator	Party	Service operator.
provider	Party	Service provider.
holder	Party	Service holder.

• Choice Archive

  Controller: provider, holder

  Returns: ()

  (no fields)

• Choice HolderService_AcceptBurnOffer

  Accepts an offer to burn a holding.

  Controller: holder

  Returns: BurnOffer_Accept_Result

  Field	Type	Description
  cid	ContractId BurnOffer	Offer to accept.
  payload	BurnOffer_Accept	Choice payload.

• Choice HolderService_AcceptLockOffer

  Accepts a lock offer.

  Controller: holder

  Returns: LockOffer_Accept_Result

  Field	Type	Description
  cid	ContractId LockOffer	Lock offer to accept.
  payload	LockOffer_Accept	Choice payload.

• Choice HolderService_AcceptLockRequest

  Accepts a lock request.

  Controller: holder

  Returns: LockRequest_Accept_Result

  Field	Type	Description
  cid	ContractId LockRequest	Lock request to accept.
  payload	LockRequest_Accept	Choice payload.

• Choice HolderService_AcceptMintOffer

  Accepts an offer to mint a holding.

  Controller: holder

  Returns: MintOffer_Accept_Result

  Field	Type	Description
  cid	ContractId MintOffer	Offer to accept.
  payload	MintOffer_Accept	Choice payload.

• Choice HolderService_AcceptTransferOffer

  Accepts a transfer offer.

  Controller: holder

  Returns: TransferOffer_Accept_Result

  Field	Type	Description
  cid	ContractId TransferOffer	Transfer offer to accept.
  payload	TransferOffer_Accept	Choice payload.

• Choice HolderService_AcceptTransferRequest

  Accepts a transfer request.

  Controller: holder

  Returns: TransferRequest_Accept_Result

  Field	Type	Description
  cid	ContractId TransferRequest	Transfer request to accept.
  payload	TransferRequest_Accept	Choice payload.

• Choice HolderService_AcceptUnlockOffer

  Accepts an unlock offer.

  Controller: holder

  Returns: UnlockOffer_Accept_Result

  Field	Type	Description
  cid	ContractId UnlockOffer	Unlock offer to accept.
  payload	UnlockOffer_Accept	Choice payload.

• Choice HolderService_AcceptUnlockRequest

  Accepts an unlock request.

  Controller: holder

  Returns: UnlockRequest_Accept_Result

  Field	Type	Description
  cid	ContractId UnlockRequest	Unlock request to accept.
  payload	UnlockRequest_Accept	Choice payload.

• Choice HolderService_CancelBurnRequest

  Cancels a request to burn a holding.

  Controller: holder

  Returns: BurnRequest_Cancel_Result

  Field	Type	Description
  cid	ContractId BurnRequest	Request to cancel.
  payload	BurnRequest_Cancel	Choice payload.

• Choice HolderService_CancelEnforcementServiceRequest

  Cancels a request for a enforcement service. This choice is available starting from version 0.1.0 of this package.

  Controller: holder

  Returns: EnforcementServiceRequest_Cancel_Result

  Field	Type	Description
  cid	ContractId EnforcementServiceRequest	Request to cancel.
  payload	EnforcementServiceRequest_Cancel	Choice payload.

• Choice HolderService_CancelForceTransferRequest

  Cancels a request to force a transfer. This choice is available starting from version 0.1.0 of this package.

  Controller: holder

  Returns: ForceTransferRequest_Cancel_Result

  Field	Type	Description
  cid	ContractId ForceTransferRequest	Request to force transfer.
  payload	ForceTransferRequest_Cancel	Choice payload.

• Choice HolderService_CancelLockOffer

  Cancels a lock offer.

  Controller: holder

  Returns: LockOffer_Cancel_Result

  Field	Type	Description
  cid	ContractId LockOffer	Lock offer to cancel.
  payload	LockOffer_Cancel	Choice payload.

• Choice HolderService_CancelLockRequest

  Cancels a lock request.

  Controller: holder

  Returns: LockRequest_Cancel_Result

  Field	Type	Description
  cid	ContractId LockRequest	Lock request to cancel.
  payload	LockRequest_Cancel	Choice payload.

• Choice HolderService_CancelMintRequest

  Cancels a request to mint a holding.

  Controller: holder

  Returns: MintRequest_Cancel_Result

  Field	Type	Description
  cid	ContractId MintRequest	Request to cancel.
  payload	MintRequest_Cancel	Choice payload.

• Choice HolderService_CancelTransferOffer

  Cancels a transfer offer.

  Controller: holder

  Returns: TransferOffer_Cancel_Result

  Field	Type	Description
  cid	ContractId TransferOffer	Transfer offer to cancel.
  payload	TransferOffer_Cancel	Choice payload.

• Choice HolderService_CancelTransferRequest

  Cancels a transfer request.

  Controller: holder

  Returns: TransferRequest_Cancel_Result

  Field	Type	Description
  cid	ContractId TransferRequest	Transfer request to cancel.
  payload	TransferRequest_Cancel	Choice payload.

• Choice HolderService_CancelUnlockOffer

  Cancels an unlock offer.

  Controller: holder

  Returns: UnlockOffer_Cancel_Result

  Field	Type	Description
  cid	ContractId UnlockOffer	Unlock offer to cancel.
  payload	UnlockOffer_Cancel	Choice payload.

• Choice HolderService_CancelUnlockRequest

  Cancels an unlock request.

  Controller: holder

  Returns: UnlockRequest_Cancel_Result

  Field	Type	Description
  cid	ContractId UnlockRequest	Unlock request to cancel.
  payload	UnlockRequest_Cancel	Choice payload.

• Choice HolderService_OfferLock

  Creates an offer to lock a holding.

  Controller: holder

  Returns: HolderService_OfferLock_Result

  Field	Type	Description
  registrar	Party	Registrar of the holding.
  locker	Party	Locker.
  instrumentIdentifier	InstrumentIdentifier	Instrument to lock.
  amount	Decimal	Amount to lock.
  context	Text	Context for the lock.
  holdingLabel	Text	Label of the holding to lock.
  reference	Text	Reference for the lock.
  batch	Batch	Batch of the lock.

• Choice HolderService_OfferTransfer

  Creates an offer to transfer a holding.

  Controller: holder

  Returns: HolderService_OfferTransfer_Result

  Field	Type	Description
  registrar	Party	Registrar of the holding.
  receiver	Party	Holding receiver.
  instrumentIdentifier	InstrumentIdentifier	Instrument to transfer.
  amount	Decimal	Amount to transfer.
  senderLabel	Text	Label of the holding to send.
  reference	Text	Reference for the transfer.
  batch	Batch	Batch of the transfer.

• Choice HolderService_OfferUnlock

  Creates an offer to unlock a holding.

  Controller: holder

  Returns: HolderService_OfferUnlock_Result

  Field	Type	Description
  registrar	Party	Registrar of the holding.
  locker	Party	Locker.
  lockContext	Text	Context for the lock to unlock.
  instrumentIdentifier	InstrumentIdentifier	Instrument to unlock.
  amount	Decimal	Amount to unlock.
  holdingLabel	Text	Label of the holding to unlock.
  reference	Text	Reference for the unlock.
  batch	Batch	Batch of the unlock.

• Choice HolderService_RejectBurnOffer

  Rejects an offer to burn a holding.

  Controller: holder

  Returns: BurnOffer_Reject_Result

  Field	Type	Description
  cid	ContractId BurnOffer	Offer to reject.
  payload	BurnOffer_Reject	Choice payload.

• Choice HolderService_RejectLockOffer

  Rejects a lock offer.

  Controller: holder

  Returns: LockOffer_Reject_Result

  Field	Type	Description
  cid	ContractId LockOffer	Lock offer to reject.
  payload	LockOffer_Reject	Choice payload.

• Choice HolderService_RejectLockRequest

  Rejects a lock request.

  Controller: holder

  Returns: LockRequest_Reject_Result

  Field	Type	Description
  cid	ContractId LockRequest	Lock request to reject.
  payload	LockRequest_Reject	Choice payload.

• Choice HolderService_RejectMintOffer

  Rejects an offer to mint a holding.

  Controller: holder

  Returns: MintOffer_Reject_Result

  Field	Type	Description
  cid	ContractId MintOffer	Offer to reject.
  payload	MintOffer_Reject	Choice payload.

• Choice HolderService_RejectTransferOffer

  Rejects a transfer offer.

  Controller: holder

  Returns: TransferOffer_Reject_Result

  Field	Type	Description
  cid	ContractId TransferOffer	Transfer request to reject.
  payload	TransferOffer_Reject	Choice payload.

• Choice HolderService_RejectTransferRequest

  Rejects a transfer request.

  Controller: holder

  Returns: TransferRequest_Reject_Result

  Field	Type	Description
  cid	ContractId TransferRequest	Transfer request to reject.
  payload	TransferRequest_Reject	Choice payload.

• Choice HolderService_RejectUnlockOffer

  Rejects an unlock offer.

  Controller: holder

  Returns: UnlockOffer_Reject_Result

  Field	Type	Description
  cid	ContractId UnlockOffer	Unlock offer to reject.
  payload	UnlockOffer_Reject	Choice payload.

• Choice HolderService_RejectUnlockRequest

  Rejects an unlock request.

  Controller: holder

  Returns: UnlockRequest_Reject_Result

  Field	Type	Description
  cid	ContractId UnlockRequest	Unlock request to reject.
  payload	UnlockRequest_Reject	Choice payload.

• Choice HolderService_RequestBurn

  Creates a request to burn a holding.

  Controller: holder

  Returns: HolderService_RequestBurn_Result

  Field	Type	Description
  registrar	Party	Instrument registrar.
  instrumentIdentifier	InstrumentIdentifier	Instrument to burn.
  amount	Decimal	Amount to burn.
  holdingLabel	Text	Label of the holding.
  reference	Text	Reference for the burn.
  batch	Batch	Batch of the burn.

• Choice HolderService_RequestEnforcementService

  Creates a request to enter into an EnforcementService contract with a registrar. This grants the registrar party authority to force asset transfers under certain scenarios. This choice is available starting from version 0.1.0 of this package.

  Controller: holder

  Returns: HolderService_RequestEnforcementService_Result

  Field	Type	Description
  registrar	Party	Registrar party.
  registrarProvider	Optional Party	Provider of the registrar. This argument is available starting from version 0.2.0 of this package.

• Choice HolderService_RequestForceTransfer

  Create a request to force-transfer a holding. This choice is available starting from version 0.1.0 of this package.

  Controller: holder

  Returns: HolderService_RequestForceTransfer_Result

  Field	Type	Description
  requestorRationale	Text	Requestor’s rationale for accepting the request.
  registrar	Party	Instrument registrar.
  instrumentIdentifier	InstrumentIdentifier	Instrument to force transfer.
  amount	Decimal	Amount to force transfer.
  reference	Text	Reference for the force transfer.
  batch	Batch	Batch of the force transfer.
  sender	Party	Sender of the holding.
  senderLabel	Text	Label of the holding of the sender.
  receiver	Party	Receiver of the holding.
  receiverLabel	Text	Label of the holding of the receiver.

• Choice HolderService_RequestLock

  Creates a request to lock a holding.

  Controller: (DA.Internal.Record.getField @"holder" this)

  Returns: HolderService_RequestLock_Result

  Field	Type	Description
  registrar	Party	Registrar of the holding.
  holder	Party	Holder of the holding.
  instrumentIdentifier	InstrumentIdentifier	Instrument to lock.
  amount	Decimal	Amount to lock.
  context	Text	Context for the lock.
  reference	Text	Reference for the lock.
  batch	Batch	Batch of the lock.

• Choice HolderService_RequestMint

  Creates a request to mint a holding.

  Controller: holder

  Returns: HolderService_RequestMint_Result

  Field	Type	Description
  registrar	Party	Instrument registrar.
  instrumentIdentifier	InstrumentIdentifier	Instrument to mint.
  amount	Decimal	Amount to mint.
  reference	Text	Reference for the mint.
  batch	Batch	Batch of the mint.
  holdingLabel	Text	Label of the holding.

• Choice HolderService_RequestTransfer

  Creates a request to transfer a holding.

  Controller: holder

  Returns: HolderService_RequestTransfer_Result

  Field	Type	Description
  registrar	Party	Registrar of the holding.
  sender	Party	Holding sender.
  instrumentIdentifier	InstrumentIdentifier	Instrument to transfer.
  amount	Decimal	Amount to transfer.
  receiverLabel	Text	Label of the holding to receive.
  reference	Text	Reference for the transfer.
  batch	Batch	Batch of the transfer.

• Choice HolderService_RequestUnlock

  Creates a request to unlock a holding.

  Controller: (DA.Internal.Record.getField @"holder" this)

  Returns: HolderService_RequestUnlock_Result

  Field	Type	Description
  registrar	Party	Registrar of the holding.
  holder	Party	Holder of the holding to unlock.
  lockContext	Text	Context for the lock to unlock.
  instrumentIdentifier	InstrumentIdentifier	Instrument to unlock.
  amount	Decimal	Amount to unlock.
  holdingLabel	Text	Label of the holding to unlock.
  reference	Text	Reference for the unlock.
  batch	Batch	Batch of the unlock.

• Choice HolderService_Terminate

  Terminates the service.

  Controller: provider

  Returns: HolderService_Terminate_Result

  (no fields)

template HolderServiceRequest

A holder service request.

Signatory: holder

Field	Type	Description
operator	Party	Service operator.
provider	Party	Service provider.
holder	Party	Service holder.

• Choice Archive

  Controller: holder

  Returns: ()

  (no fields)

• Choice HolderServiceRequest_Accept

  Accept request.

  Controller: provider

  Returns: HolderServiceRequest_Accept_Result

  Field	Type	Description
  providerConfigurationCid	ContractId ProviderConfiguration	Provider configuration.
  credentialCids	[ContractId Credential]	Holder credentials.

• Choice HolderServiceRequest_Cancel

  Cancel request.

  Controller: holder

  Returns: HolderServiceRequest_Cancel_Result

  (no fields)

• Choice HolderServiceRequest_Reject

  Reject request.

  Controller: provider

  Returns: HolderServiceRequest_Reject_Result

  Field	Type	Description
  reason	Text	Rejection reason.

template RejectedHolderServiceRequest

A rejected holder service request.

Signatory: (DA.Internal.Record.getField @"provider" request), (DA.Internal.Record.getField @"holder" request)

Field	Type	Description
request	HolderServiceRequest	The rejected request payload.
reason	Text	The rejection reason.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"provider" request), (DA.Internal.Record.getField @"holder" request)

  Returns: ()

  (no fields)

• Choice RejectedHolderServiceRequest_Delete

  Deletes a rejected holder service request.

  Controller: (DA.Internal.Record.getField @"provider" request)

  Returns: RejectedHolderServiceRequest_Delete_Result

  (no fields)

Data Types

data HolderServiceRequest_Accept_Result

Result of HolderServiceRequest_Accept.

HolderServiceRequest_Accept_Result

Field	Type	Description
holderServiceCid	ContractId HolderService	Holder service contract.

data HolderServiceRequest_Cancel_Result

Result of HolderServiceRequest_Cancel.

HolderServiceRequest_Cancel_Result

(no fields)

data HolderServiceRequest_Reject_Result

Result of HolderServiceRequest_Reject.

HolderServiceRequest_Reject_Result

Field	Type	Description
rejectedHolderServiceRequestCid	ContractId RejectedHolderServiceRequest	Rejected holder service request contract.

data HolderService_AcceptTransferOffer_Result

Result of HolderService_AcceptTransferOfferr.

HolderService_AcceptTransferOffer_Result

Field	Type	Description
acceptedTransferCid	ContractId AcceptedTransfer	Accepted transfer.

data HolderService_OfferLock_Result

Result of HolderService_OfferLock.

HolderService_OfferLock_Result

Field	Type	Description
lockOfferCid	ContractId LockOffer	Lock offer.

data HolderService_OfferTransfer_Result

Result of HolderService_OfferTransfer.

HolderService_OfferTransfer_Result

Field	Type	Description
transferOfferCid	ContractId TransferOffer	Transfer offer.

data HolderService_OfferUnlock_Result

Result of HolderService_OfferUnlock.

HolderService_OfferUnlock_Result

Field	Type	Description
unlockOfferCid	ContractId UnlockOffer	Unlock offer.

data HolderService_RequestBurn_Result

Result of HolderService_RequestBurn.

HolderService_RequestBurn_Result

Field	Type	Description
burnRequestCid	ContractId BurnRequest	Burn request.

data HolderService_RequestEnforcementService_Result

Result of HolderService_RequestEnforcement_Result.

HolderService_RequestEnforcementService_Result

Field	Type	Description
enforcementServiceRequestCid	ContractId EnforcementServiceRequest	Request for a enforcement service.

data HolderService_RequestForceTransfer_Result

Result of HolderService_RequestForceTransfer.

HolderService_RequestForceTransfer_Result

Field	Type	Description
forceTransferRequestCid	ContractId ForceTransferRequest	Force transfer request.

data HolderService_RequestLock_Result

Result of HolderService_RequestLock.

HolderService_RequestLock_Result

Field	Type	Description
lockRequestCid	ContractId LockRequest	Lock request.

data HolderService_RequestMint_Result

Result of HolderService_RequestMint.

HolderService_RequestMint_Result

Field	Type	Description
mintRequestCid	ContractId MintRequest	Mint request.

data HolderService_RequestTransfer_Result

Result of HolderService_RequestTransfer.

HolderService_RequestTransfer_Result

Field	Type	Description
transferRequestCid	ContractId TransferRequest	Transfer request.

data HolderService_RequestUnlock_Result

Result of HolderService_RequestUnlock.

HolderService_RequestUnlock_Result

Field	Type	Description
unlockRequestCid	ContractId UnlockRequest	Unlock request.

data HolderService_Terminate_Result

Result of HolderService_Terminate.

HolderService_Terminate_Result

(no fields)

data RejectedHolderServiceRequest_Delete_Result

Result of RejectedHolderServiceRequest_Delete.

RejectedHolderServiceRequest_Delete_Result

(no fields)