Utility.Registry.V0.Holding.Burn

Templates

template AcceptedBurn

An accepted burn.

Signatory: (DA.Internal.Record.getField @"registrar" burn), (DA.Internal.Record.getField @"holder" burn)

Field	Type	Description
burn	Burn	Accepted burn payload.
holdingLabel	Text	Label of the holding to burn.

• Choice AcceptedBurn_Execute

  Execute an accepted burn.

  Controller: (DA.Internal.Record.getField @"registrar" burn)

  Returns: AcceptedBurn_Execute_Result

  Field	Type	Description
  instrumentConfigurationCid	ContractId InstrumentConfiguration	Instrument configuration.
  credentialCids	[ContractId Credential]	Issuer credential cids.
  holdingCid	ContractId Holding	Holding to burn.

• Choice AcceptedBurn_Fail

  Fail an accepted burn.

  Controller: (DA.Internal.Record.getField @"registrar" burn)

  Returns: AcceptedBurn_Fail_Result

  Field	Type	Description
  reason	Text	Reason for failure.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"registrar" burn), (DA.Internal.Record.getField @"holder" burn)

  Returns: ()

  (no fields)

template BurnOffer

An offer to burn a holding

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

Field	Type	Description
burn	Burn	Burn offer payload.

• Choice Archive

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

  Returns: ()

  (no fields)

• Choice BurnOffer_Accept

  Accepts a burn offer.

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

  Returns: BurnOffer_Accept_Result

  Field	Type	Description
  holdingLabel	Text	Label of the holding to burn.

• Choice BurnOffer_Cancel

  Cancels a burn offer.

  Controller: (DA.Internal.Record.getField @"registrar" burn)

  Returns: BurnOffer_Cancel_Result

  (no fields)

• Choice BurnOffer_Reject

  Rejects a burn offer.

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

  Returns: BurnOffer_Reject_Result

  Field	Type	Description
  reason	Text	Reason for rejection.

template BurnRequest

A request to burn a holding

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

Field	Type	Description
burn	Burn	Burn request payload.
holdingLabel	Text	Label of the holding to burn.

• Choice Archive

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

  Returns: ()

  (no fields)

• Choice BurnRequest_Accept

  Accepts a burn request.

  Controller: (DA.Internal.Record.getField @"registrar" burn)

  Returns: BurnRequest_Accept_Result

  (no fields)

• Choice BurnRequest_Cancel

  Cancels a burn request.

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

  Returns: BurnRequest_Cancel_Result

  (no fields)

• Choice BurnRequest_Reject

  Rejects a burn request.

  Controller: (DA.Internal.Record.getField @"registrar" burn)

  Returns: BurnRequest_Reject_Result

  Field	Type	Description
  reason	Text	Reason for rejection.

template ExecutedBurn

An executed burn.

Signatory: (DA.Internal.Record.getField @"registrar" burn)

Field	Type	Description
burn	Burn	Burn request payload.
holdingLabel	Text	Label of the holding to burn.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"registrar" burn)

  Returns: ()

  (no fields)

• Choice ExecutedBurn_Delete

  Deletes an executed burn.

  Controller: (DA.Internal.Record.getField @"registrar" burn)

  Returns: ExecutedBurn_Delete_Result

  (no fields)

template FailedBurn

A failed burn.

Signatory: (DA.Internal.Record.getField @"registrar" burn)

Field	Type	Description
burn	Burn	Rejected burn payload.
reason	Text	Reason for failure.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"registrar" burn)

  Returns: ()

  (no fields)

• Choice FailedBurn_Delete

  Deletes a rejected burn.

  Controller: (DA.Internal.Record.getField @"registrar" burn)

  Returns: FailedBurn_Delete_Result

  (no fields)

template RejectedBurn

A rejected burn.

Signatory: (DA.Internal.Record.getField @"registrar" burn), (DA.Internal.Record.getField @"holder" burn)

Field	Type	Description
burn	Burn	Rejected burn payload.
reason	Text	Reason for rejection.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"registrar" burn), (DA.Internal.Record.getField @"holder" burn)

  Returns: ()

  (no fields)

• Choice RejectedBurn_Delete

  Deletes a rejected burn.

  Controller: (DA.Internal.Record.getField @"registrar" burn)

  Returns: RejectedBurn_Delete_Result

  (no fields)

Data Types

data AcceptedBurn_Execute_Result

Result of AcceptedBurn_Execute.

AcceptedBurn_Execute_Result

Field	Type	Description
executedBurnCid	ContractId ExecutedBurn	Executed burn.

data AcceptedBurn_Fail_Result

Result of AcceptedBurn_Fail.

AcceptedBurn_Fail_Result

Field	Type	Description
failedBurnCid	ContractId FailedBurn	Failed burn.

data Burn

Burn payload.

Burn

Field	Type	Description
operator	Party	Utility operator.
provider	Party	Provider of the initiator of the burn.
registrar	Party	Instrument registrar.
instrumentIdentifier	InstrumentIdentifier	Instrument to burn.
amount	Decimal	Amount to burn.
holder	Party	Owner of the holding to burn.
reference	Text	Reference for the burn.
batch	Batch	Batch the burn belongs to.

data BurnOffer_Accept_Result

Result of BurnOffer_Accept.

BurnOffer_Accept_Result

Field	Type	Description
acceptedBurnCid	ContractId AcceptedBurn	Accepted burn.

data BurnOffer_Cancel_Result

Result of BurnOffer_Cancel.

BurnOffer_Cancel_Result

(no fields)

data BurnOffer_Reject_Result

Result of BurnOffer_Reject.

BurnOffer_Reject_Result

Field	Type	Description
rejectedBurnCid	ContractId RejectedBurn	Rejected burn.

data BurnRequest_Accept_Result

Result of BurnRequest_Accept.

BurnRequest_Accept_Result

Field	Type	Description
acceptedBurnCid	ContractId AcceptedBurn	Accepted burn.

data BurnRequest_Cancel_Result

Result of BurnRequest_Cancel.

BurnRequest_Cancel_Result

(no fields)

data BurnRequest_Reject_Result

Result of BurnRequest_Reject.

BurnRequest_Reject_Result

Field	Type	Description
rejectedBurnCid	ContractId RejectedBurn	Rejected burn.

data ExecutedBurn_Delete_Result

Result of ExecutedBurn_Delete.

ExecutedBurn_Delete_Result

(no fields)

data FailedBurn_Delete_Result

Result of FailedBurn_Delete.

FailedBurn_Delete_Result

(no fields)

data RejectedBurn_Delete_Result

Result of RejectedBurn_Delete.

RejectedBurn_Delete_Result

(no fields)