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.

enableResultContracts

Optional Bool

Determines whether executed (and rejected) contracts should be created for 2-step mint, burn, and transfer flows. The contracts ExecutedMint, ExecutedBurn, and ExecutedTransfer act as on-ledger receipts confirming successful execution. Similarly, RejectedMint, RejectedBurn, and RejectedTransfer confirm that the respective requests were rejected. Registrars can opt in or out of creating these contracts. If None, these contracts are created by default. Note: This default will change after the HDM upgrade to 3.4, which will allow reconstructing transaction history directly from the ledger trees, eliminating the need for executed contracts. Introduced as of version 0.5.0 of this package.

  • Choice Archive

    Controller: provider, registrar

    Returns: ()

    (no fields)

  • Choice RegistrarService\_AcceptBurnRequest

    Accepts a request to burn a holding. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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 disabled as of version 0.2.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 disabled as of version 0.2.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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    Controller: registrar

    Returns: MintRequest_Accept_Result

    Field

    Type

    Description

    cid

    ContractId MintRequest

    Request to accept.

    payload

    MintRequest_Accept

    Choice payload.

  • Choice RegistrarService\_ArchiveRegistrarConfiguration

    Archives a registrar configuration. This choice is disabled as of version 0.2.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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    Controller: registrar

    Returns: MintOffer_Cancel_Result

    Field

    Type

    Description

    cid

    ContractId MintOffer

    Offer to cancel.

    payload

    MintOffer_Cancel

    Choice payload.

  • Choice RegistrarService\_CreateRegistrarConfiguration

    Creates a registrar configuration. This choice is disabled as of version 0.2.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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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. This choice is disabled as of version 0.6.0 of this package.

    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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    Controller: operator

    Returns: ExecutedMint_Delete_Result

    Field

    Type

    Description

    cid

    ContractId ExecutedMint

    Executed mint to delete.

    payload

    ExecutedMint_Delete

    Choice payload.

  • Choice RegistrarService\_DeleteExecutedUnlock

    Deletes an executed unlock. This choice is disabled as of version 0.6.0 of this package.

    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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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. This choice is disabled as of version 0.6.0 of this package.

    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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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. This choice is disabled as of version 0.6.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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. This choice is disabled as of version 0.6.0 of this package.

    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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead

    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. This choice is disabled as of version 0.7.0 of this package.

    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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    Controller: operator

    Returns: RejectedMint_Delete_Result

    Field

    Type

    Description

    cid

    ContractId RejectedMint

    Rejected mint to delete.

    payload

    RejectedMint_Delete

    Choice payload.

  • Choice RegistrarService\_DeleteRejectedUnlock

    Deletes a rejected unlock. This choice is disabled as of version 0.6.0 of this package.

    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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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 disabled as of version 0.2.0 of this package.

    Controller: actor

    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. This choice is disabled as of version 0.6.0 of this package.

    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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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. This choice is disabled as of version 0.6.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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. This choice is disabled as of version 0.6.0 of this package.

    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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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 disabled as of version 0.2.0 of this package.

    Controller: actor

    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. This choice is disabled as of version 0.6.0 of this package.

    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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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. This choice is disabled as of version 0.6.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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. This choice is disabled as of version 0.6.0 of this package.

    Controller: operator

    Returns: AcceptedUnlock_Fail_Result

    Field

    Type

    Description

    cid

    ContractId AcceptedUnlock

    Accepted unlock to fail.

    payload

    AcceptedUnlock_Fail

    Choice payload.

  • Choice RegistrarService\_OfferBurn

    Offers to burn a holding. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    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 disabled as of version 0.2.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 disabled as of version 0.2.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. This choice is disabled as of version 0.7.0 of this package. Use the recommended two-step flow initiated via the Utility.Registry.App.V0.Service.AllocationFactory.AllocationFactory contract instead.

    Controller: registrar

    Returns: MintRequest_Reject_Result

    Field

    Type

    Description

    cid

    ContractId MintRequest

    Request to reject.

    payload

    MintRequest_Reject

    Choice payload.

  • Choice RegistrarService\_TerminateEnforcementService

    Terminates an enforcement service. This choice is disabled as of version 0.2.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.

createTransferRule

Optional Bool

Whether to create a TransferRule.

createAllocationFactory

Optional Bool

Whether to create an AllocationFactory.

  • Choice Archive

    Controller: registrar

    Returns: ()

    (no fields)

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)

Data Types

data RegistrarServiceRequest\_Accept\_Result

Result of RegistrarServiceRequest_Accept.

RegistrarServiceRequest\_Accept\_Result

Field

Type

Description

registrarServiceCid

ContractId RegistrarService

Registrar service.

transferRuleCid

Optional (ContractId TransferRule)

Transfer rule, if created.

allocationFactoryCid

Optional (ContractId AllocationFactory)

Allocation factory, if created.

data RegistrarServiceRequest\_Cancel\_Result

Result of RegistrarServiceRequest_Cancel.

data RegistrarServiceRequest\_Reject\_Result

Result of RegistrarServiceRequest_Reject.

RegistrarServiceRequest\_Reject\_Result

Field

Type

Description

rejectedRegistrarServiceRequestCid

ContractId RejectedRegistrarServiceRequest

Rejected registrar service request.

data RegistrarService\_ArchiveAllocationFactory\_Result

Result of archiving allocation factory.

data RegistrarService\_ArchiveAndCreateInstrumentConfiguration\_Result

Result of RegistrarService_ArchiveAndCreateInstrumentConfiguration.

data RegistrarService\_ArchiveInstrumentConfiguration\_Result

Result of RegistrarService_ArchiveInstrumentConfiguration.

data RegistrarService\_ArchiveTransferRule\_Result

Result of RegistrarService_ArchiveTransferRule.

data RegistrarService\_CreateAllocationFactory\_Result

Result of creating allocation factory.

data RegistrarService\_CreateInstrumentConfiguration\_Result

Result of RegistrarService_CreateInstrumentConfiguration.

RegistrarService\_CreateInstrumentConfiguration\_Result

Field

Type

Description

instrumentConfigurationCid

ContractId InstrumentConfiguration

Instrument configuration request.

data RegistrarService\_CreateTransferRule\_Result

Result of RegistrarService_CreateTransferRule.

RegistrarService\_CreateTransferRule\_Result

Field

Type

Description

transferRuleCid

ContractId TransferRule

Transfer rule.

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

data RejectedRegistrarServiceRequest\_Delete\_Result

Result of RejectedRegistrarServiceRequest_Delete.