Utility.Registry.App.V0.Service.Registrar

Templates

template RegistrarService

Registrar service.

Signatory: provider, registrar

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

• Choice Archive

  Controller: provider, registrar

  Returns: ()

  (no fields)

• Choice RegistrarService_AcceptBurnRequest

  Accepts a request to burn a holding.

  Controller: registrar

  Returns: BurnRequest_Accept_Result

  Field	Type	Description
  cid	ContractId BurnRequest	Request to accept.
  payload	BurnRequest_Accept	Choice payload.

• Choice RegistrarService_AcceptEnforcementServiceRequest

  Accepts an enforcement service request. This choice is available starting from version 0.1.0 of this package.

  Controller: registrar

  Returns: EnforcementServiceRequest_Accept_Result

  Field	Type	Description
  cid	ContractId EnforcementServiceRequest	Request to accept.
  payload	EnforcementServiceRequest_Accept	Choice payload.

• Choice RegistrarService_AcceptForceTransferRequest

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

  Controller: registrar

  Returns: ForceTransferRequest_Accept_Result

  Field	Type	Description
  senderEnforcementServiceCid	ContractId EnforcementService	Sender enforcement service.
  receiverEnforcementServiceCid	ContractId EnforcementService	Receiver enforcement service.
  cid	ContractId ForceTransferRequest	Force transfer request to reject.
  payload	ForceTransferRequest_Accept	Choice payload.

• Choice RegistrarService_AcceptMintRequest

  Accepts a request to mint a holding.

  Controller: registrar

  Returns: MintRequest_Accept_Result

  Field	Type	Description
  cid	ContractId MintRequest	Request to accept.
  payload	MintRequest_Accept	Choice payload.

• Choice RegistrarService_ArchiveAndCreateInstrumentConfiguration

  Modify an instrument configuration.

  Controller: registrar

  Returns: RegistrarService_ArchiveAndCreateInstrumentConfiguration_Result

  Field	Type	Description
  cid	ContractId InstrumentConfiguration	Instrument configuration to modify.
  payload	RegistrarService_CreateInstrumentConfiguration	Create payload.

• Choice RegistrarService_ArchiveAndCreateRegistrarConfiguration

  Modifies a registrar configuration. This choice is available starting from version 0.1.0 of this package.

  Controller: registrar

  Returns: RegistrarService_ArchiveAndCreateRegistrarConfiguration_Result

  Field	Type	Description
  cid	ContractId RegistrarConfiguration	Registrar configuration to modify.
  payload	RegistrarService_CreateRegistrarConfiguration	Create payload.

• Choice RegistrarService_ArchiveInstrumentConfiguration

  Archive an instrument configuration.

  Controller: registrar

  Returns: RegistrarService_ArchiveInstrumentConfiguration_Result

  Field	Type	Description
  cid	ContractId InstrumentConfiguration	Instrument configuration to archive.

• Choice RegistrarService_ArchiveRegistrarConfiguration

  Archives a registrar configuration. This choice is available starting from version 0.1.0 of this package.

  Controller: registrar

  Returns: RegistrarService_ArchiveRegistrarConfiguration_Result

  Field	Type	Description
  cid	ContractId RegistrarConfiguration	Registrar configuration to archive.

• Choice RegistrarService_CancelBurnOffer

  Cancels a burn offer.

  Controller: registrar

  Returns: BurnOffer_Cancel_Result

  Field	Type	Description
  cid	ContractId BurnOffer	Offer to cancel.
  payload	BurnOffer_Cancel

• Choice RegistrarService_CancelMintOffer

  Cancels a mint offer.

  Controller: registrar

  Returns: MintOffer_Cancel_Result

  Field	Type	Description
  cid	ContractId MintOffer	Offer to cancel.
  payload	MintOffer_Cancel	Choice payload.

• Choice RegistrarService_CreateInstrumentConfiguration

  Creates a request to configure an instrument.

  Controller: registrar

  Returns: RegistrarService_CreateInstrumentConfiguration_Result

  Field	Type	Description
  instrumentId	Text	Instrument id.
  additionalIdentifiers	[InstrumentIdentifier]	Additional instrument identifiers.
  issuerRequirements	[PartyCredentialRequirement]	Issuer credential requirements.
  holderRequirements	[PartyCredentialRequirement]	Holder credential requirements.
  forceTransferRequirements	Optional [PartyCredentialRequirement]	Force transfer credential requirements. This field is available starting from version 0.2.0 of this package.

• Choice RegistrarService_CreateRegistrarConfiguration

  Creates a registrar configuration. This choice is available starting from version 0.1.0 of this package.

  Controller: registrar

  Returns: RegistrarService_CreateRegistrarConfiguration_Result

  Field	Type	Description
  enforcementRequirements	[PartyCredentialRequirement]	Credential requirements for enforcement service.

• Choice RegistrarService_DeleteExecutedBurn

  Deletes an executed burn.

  Controller: operator

  Returns: ExecutedBurn_Delete_Result

  Field	Type	Description
  cid	ContractId ExecutedBurn	Executed burn to delete.
  payload	ExecutedBurn_Delete	Choice payload.

• Choice RegistrarService_DeleteExecutedLock

  Deletes an executed lock.

  Controller: operator

  Returns: ExecutedLock_Delete_Result

  Field	Type	Description
  cid	ContractId ExecutedLock	Executed lock to delete.
  payload	ExecutedLock_Delete	Choice payload.

• Choice RegistrarService_DeleteExecutedMint

  Deletes an executed mint.

  Controller: operator

  Returns: ExecutedMint_Delete_Result

  Field	Type	Description
  cid	ContractId ExecutedMint	Executed mint to delete.
  payload	ExecutedMint_Delete	Choice payload.

• Choice RegistrarService_DeleteExecutedTransfer

  Deletes an executed transfer.

  Controller: operator

  Returns: ExecutedTransfer_Delete_Result

  Field	Type	Description
  cid	ContractId ExecutedTransfer	Executed transfer to delete.
  payload	ExecutedTransfer_Delete	Choice payload.

• Choice RegistrarService_DeleteExecutedUnlock

  Deletes an executed unlock.

  Controller: operator

  Returns: ExecutedUnlock_Delete_Result

  Field	Type	Description
  cid	ContractId ExecutedUnlock	Executed unlock to delete.
  payload	ExecutedUnlock_Delete	Choice payload.

• Choice RegistrarService_DeleteFailedBurn

  Deletes a failed burn.

  Controller: operator

  Returns: FailedBurn_Delete_Result

  Field	Type	Description
  cid	ContractId FailedBurn	Failed burn to delete.
  payload	FailedBurn_Delete	Choice payload.

• Choice RegistrarService_DeleteFailedLock

  Deletes a failed lock.

  Controller: operator

  Returns: FailedLock_Delete_Result

  Field	Type	Description
  cid	ContractId FailedLock	Failed lock to delete.
  payload	FailedLock_Delete	Choice payload.

• Choice RegistrarService_DeleteFailedMint

  Deletes a failed mint.

  Controller: operator

  Returns: FailedMint_Delete_Result

  Field	Type	Description
  cid	ContractId FailedMint	Failed mint to delete.
  payload	FailedMint_Delete	Choice payload.

• Choice RegistrarService_DeleteFailedTransfer

  Deletes a failed transfer.

  Controller: operator

  Returns: FailedTransfer_Delete_Result

  Field	Type	Description
  cid	ContractId FailedTransfer	Failed transfer to delete.
  payload	FailedTransfer_Delete	Choice payload.

• Choice RegistrarService_DeleteFailedUnlock

  Deletes a failed unlock.

  Controller: operator

  Returns: FailedUnlock_Delete_Result

  Field	Type	Description
  cid	ContractId FailedUnlock	Failed unlock to delete.
  payload	FailedUnlock_Delete	Choice payload.

• Choice RegistrarService_DeleteRejectedBurn

  Deletes a rejected mint.

  Controller: operator

  Returns: RejectedBurn_Delete_Result

  Field	Type	Description
  cid	ContractId RejectedBurn	Rejected burn to delete.
  payload	RejectedBurn_Delete	Choice payload.

• Choice RegistrarService_DeleteRejectedLock

  Deletes a rejected lock.

  Controller: operator

  Returns: RejectedLock_Delete_Result

  Field	Type	Description
  cid	ContractId RejectedLock	Rejected lock to delete.
  payload	RejectedLock_Delete	Choice payload.

• Choice RegistrarService_DeleteRejectedMint

  Deletes a rejected mint.

  Controller: operator

  Returns: RejectedMint_Delete_Result

  Field	Type	Description
  cid	ContractId RejectedMint	Rejected mint to delete.
  payload	RejectedMint_Delete	Choice payload.

• Choice RegistrarService_DeleteRejectedTransfer

  Deletes a rejected transfer.

  Controller: operator

  Returns: RejectedTransfer_Delete_Result

  Field	Type	Description
  cid	ContractId RejectedTransfer	Rejected transfer to delete.
  payload	RejectedTransfer_Delete	Choice payload.

• Choice RegistrarService_DeleteRejectedUnlock

  Deletes a rejected unlock.

  Controller: operator

  Returns: RejectedUnlock_Delete_Result

  Field	Type	Description
  cid	ContractId RejectedUnlock	Rejected unlock to delete.
  payload	RejectedUnlock_Delete	Choice payload.

• Choice RegistrarService_ExecuteAcceptedBurn

  Executes an accepted burn.

  Controller: operator

  Returns: AcceptedBurn_Execute_Result

  Field	Type	Description
  cid	ContractId AcceptedBurn	Accepted burn to execute.
  payload	AcceptedBurn_Execute	Choice payload.

• Choice RegistrarService_ExecuteAcceptedForceTransfer

  Executes an accepted force transfer. This choice is available starting from version 0.1.0 of this package.

  Controller: actor `oneOf` [operator, registrar]

  Returns: AcceptedForceTransfer_Execute_Result

  Field	Type	Description
  cid	ContractId AcceptedForceTransfer	Accepted force transfer to execute.
  payload	AcceptedForceTransfer_Execute	Choice payload.
  actor	Party	Actor executing the transfer.

• Choice RegistrarService_ExecuteAcceptedLock

  Executes an accepted lock.

  Controller: operator

  Returns: AcceptedLock_Execute_Result

  Field	Type	Description
  cid	ContractId AcceptedLock	Accepted lock to execute.
  payload	AcceptedLock_Execute	Choice payload.

• Choice RegistrarService_ExecuteAcceptedMint

  Executes an accepted mint.

  Controller: operator

  Returns: AcceptedMint_Execute_Result

  Field	Type	Description
  cid	ContractId AcceptedMint	Accepted mint to execute.
  payload	AcceptedMint_Execute	Choice payload.

• Choice RegistrarService_ExecuteAcceptedTransfer

  Executes an accepted transfer.

  Controller: operator

  Returns: AcceptedTransfer_Execute_Result

  Field	Type	Description
  cid	ContractId AcceptedTransfer	Accepted transfer to execute.
  payload	AcceptedTransfer_Execute	Choice payload.

• Choice RegistrarService_ExecuteAcceptedUnlock

  Executes an accepted unlock.

  Controller: operator

  Returns: AcceptedUnlock_Execute_Result

  Field	Type	Description
  cid	ContractId AcceptedUnlock	Accepted unlock to execute.
  payload	AcceptedUnlock_Execute	Choice payload.

• Choice RegistrarService_FailAcceptedBurn

  Fails an accepted burn.

  Controller: operator

  Returns: AcceptedBurn_Fail_Result

  Field	Type	Description
  cid	ContractId AcceptedBurn	Accepted burn to fail.
  payload	AcceptedBurn_Fail	Choice payload.

• Choice RegistrarService_FailAcceptedForceTransfer

  Fails an accepted forced transfer. This choice is available starting from version 0.1.0 of this package.

  Controller: actor `oneOf` [operator, registrar]

  Returns: AcceptedForceTransfer_Fail_Result

  Field	Type	Description
  cid	ContractId AcceptedForceTransfer	Accepted force transfer to fail.
  payload	AcceptedForceTransfer_Fail	Choice payload.
  actor	Party	Actor executing the transfer.

• Choice RegistrarService_FailAcceptedLock

  Fails an accepted lock.

  Controller: operator

  Returns: AcceptedLock_Fail_Result

  Field	Type	Description
  cid	ContractId AcceptedLock	Accepted lock to fail.
  payload	AcceptedLock_Fail	Choice payload.

• Choice RegistrarService_FailAcceptedMint

  Fails an accepted mint.

  Controller: operator

  Returns: AcceptedMint_Fail_Result

  Field	Type	Description
  cid	ContractId AcceptedMint	Accepted mint to fail.
  payload	AcceptedMint_Fail	Choice payload.

• Choice RegistrarService_FailAcceptedTransfer

  Fails an accepted transfer.

  Controller: operator

  Returns: AcceptedTransfer_Fail_Result

  Field	Type	Description
  cid	ContractId AcceptedTransfer	Accepted transfer to fail.
  payload	AcceptedTransfer_Fail	Choice payload.

• Choice RegistrarService_FailAcceptedUnlock

  Fails an accepted unlock.

  Controller: operator

  Returns: AcceptedUnlock_Fail_Result

  Field	Type	Description
  cid	ContractId AcceptedUnlock	Accepted unlock to fail.
  payload	AcceptedUnlock_Fail	Choice payload.

• Choice RegistrarService_MergeHolding

  Merges multiple holdings into a single holding.

  Controller: operator

  Returns: Holding_Merge_Result

  Field	Type	Description
  cid	ContractId Holding	Holding to merge with others.
  payload	Holding_Merge	Choice payload.

• Choice RegistrarService_OfferBurn

  Offers to burn a holding.

  Controller: registrar

  Returns: RegistrarService_OfferBurn_Result

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

• Choice RegistrarService_OfferMint

  Offers to mint a holding.

  Controller: registrar

  Returns: RegistrarService_OfferMint_Result

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

• Choice RegistrarService_RejectBurnRequest

  Rejects a request to burn a holding.

  Controller: registrar

  Returns: BurnRequest_Reject_Result

  Field	Type	Description
  cid	ContractId BurnRequest	Request to reject.
  payload	BurnRequest_Reject	Choice payload.

• Choice RegistrarService_RejectEnforcementServiceRequest

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

  Controller: registrar

  Returns: EnforcementServiceRequest_Reject_Result

  Field	Type	Description
  cid	ContractId EnforcementServiceRequest	Request to reject.
  payload	EnforcementServiceRequest_Reject	Choice payload.

• Choice RegistrarService_RejectForceTransferRequest

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

  Controller: registrar

  Returns: ForceTransferRequest_Reject_Result

  Field	Type	Description
  cid	ContractId ForceTransferRequest	Force transfer request to reject.
  payload	ForceTransferRequest_Reject	Choice payload.

• Choice RegistrarService_RejectMintRequest

  Rejects a request to mint a holding.

  Controller: registrar

  Returns: MintRequest_Reject_Result

  Field	Type	Description
  cid	ContractId MintRequest	Request to reject.
  payload	MintRequest_Reject	Choice payload.

• Choice RegistrarService_SplitHolding

  Splits a holding into multiple holdings.

  Controller: operator

  Returns: Holding_Split_Result

  Field	Type	Description
  cid	ContractId Holding	Holding to split.
  payload	Holding_Split	Choice payload.

• Choice RegistrarService_Terminate

  Terminates the service.

  Controller: provider

  Returns: RegistrarService_Terminate_Result

  (no fields)

• Choice RegistrarService_TerminateEnforcementService

  Terminates an enforcement service. This choice is available starting from version 0.1.0 of this package.

  Controller: registrar

  Returns: EnforcementService_Terminate_Result

  Field	Type	Description
  cid	ContractId EnforcementService	Service to terminate.
  payload	EnforcementService_Terminate	Choice payload.

template RegistrarServiceRequest

A registrar service request.

Signatory: registrar

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

• Choice Archive

  Controller: registrar

  Returns: ()

  (no fields)

• Choice RegistrarServiceRequest_Accept

  Accept request.

  Controller: provider

  Returns: RegistrarServiceRequest_Accept_Result

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

• Choice RegistrarServiceRequest_Cancel

  Cancel request.

  Controller: registrar

  Returns: RegistrarServiceRequest_Cancel_Result

  (no fields)

• Choice RegistrarServiceRequest_Reject

  Reject request.

  Controller: provider

  Returns: RegistrarServiceRequest_Reject_Result

  Field	Type	Description
  reason	Text	Rejection reason.

template RejectedRegistrarServiceRequest

A rejected registrar service request.

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

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

• Choice Archive

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

  Returns: ()

  (no fields)

• Choice RejectedRegistrarServiceRequest_Delete

  Deletes a rejected registrar service request.

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

  Returns: RejectedRegistrarServiceRequest_Delete_Result

  (no fields)

Data Types

data RegistrarServiceRequest_Accept_Result

Result of RegistrarServiceRequest_Accept.

RegistrarServiceRequest_Accept_Result

Field	Type	Description
registrarServiceCid	ContractId RegistrarService	Registrar service.

data RegistrarServiceRequest_Cancel_Result

Result of RegistrarServiceRequest_Cancel.

RegistrarServiceRequest_Cancel_Result

(no fields)

data RegistrarServiceRequest_Reject_Result

Result of RegistrarServiceRequest_Reject.

RegistrarServiceRequest_Reject_Result

Field	Type	Description
rejectedRegistrarServiceRequestCid	ContractId RejectedRegistrarServiceRequest	Rejected registrar service request.

data RegistrarService_ArchiveAndCreateInstrumentConfiguration_Result

Result of RegistrarService_ArchiveAndCreateInstrumentConfiguration.

RegistrarService_ArchiveAndCreateInstrumentConfiguration_Result

Field	Type	Description
archiveResult	RegistrarService_ArchiveInstrumentConfiguration_Result	Archive result.
createResult	RegistrarService_CreateInstrumentConfiguration_Result	Create result.

data RegistrarService_ArchiveAndCreateRegistrarConfiguration_Result

Result of RegistrarService_ArchiveAndCreateRegistrarConfiguration.

RegistrarService_ArchiveAndCreateRegistrarConfiguration_Result

Field	Type	Description
archiveResult	RegistrarService_ArchiveRegistrarConfiguration_Result	Archive result.
createResult	RegistrarService_CreateRegistrarConfiguration_Result	Create result.

data RegistrarService_ArchiveInstrumentConfiguration_Result

Result of RegistrarService_ArchiveInstrumentConfiguration.

RegistrarService_ArchiveInstrumentConfiguration_Result

(no fields)

data RegistrarService_ArchiveRegistrarConfiguration_Result

Result of RegistrarService_ArchiveRegistrarConfiguration.

RegistrarService_ArchiveRegistrarConfiguration_Result

(no fields)

data RegistrarService_CreateInstrumentConfiguration_Result

Result of RegistrarService_RequestInstrumentConfiguration.

RegistrarService_CreateInstrumentConfiguration_Result

Field	Type	Description
instrumentConfigurationCid	ContractId InstrumentConfiguration	Instrument configuration request.

data RegistrarService_CreateRegistrarConfiguration_Result

Result of RegistrarService_CreateRegistrarConfiguration.

RegistrarService_CreateRegistrarConfiguration_Result

Field	Type	Description
registrarConfigurationCid	ContractId RegistrarConfiguration	Registrar configuration.

data RegistrarService_OfferBurn_Result

Result of RegistrarService_OfferBurn.

RegistrarService_OfferBurn_Result

Field	Type	Description
burnOfferCid	ContractId BurnOffer	Burn offer.

data RegistrarService_OfferMint_Result

Result of RegistrarService_OfferMint.

RegistrarService_OfferMint_Result

Field	Type	Description
mintOfferCid	ContractId MintOffer	Mint offer.

data RegistrarService_Terminate_Result

Result of RegistrarService_Terminate

RegistrarService_Terminate_Result

(no fields)

data RejectedRegistrarServiceRequest_Delete_Result

Result of RejectedRegistrarServiceRequest_Delete.

RejectedRegistrarServiceRequest_Delete_Result

(no fields)