Utility.Registry.App.V0.Model.Burn

Templates

template BurnOffer

An offer to burn a holding

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

Field	Type	Description
operator	Party	Utility operator.
provider	Party	Utility provider.
burn	Burn	Burn offer payload.

• Choice Archive

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

  Returns: ()

  (no fields)

• Choice BurnOffer_Accept

  Accept and execute a burn offer.

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

  Returns: BurnOffer_Accept_Result

  Field	Type	Description
  holdingCids	[ContractId Holding]	Holdings to use for the burn.
  extraArgs	ExtraArgs	Additional context required to exercise the choice. extraArgs.context (provided by the backend) includes: * The InstrumentConfiguration of the holding being burned * The Credential``s of the holder that satisfy the issuer requirements * ``AppRewardConfiguration of the provider (if any) * FeaturedAppRight of the provider (if featured) extraArgs.metadata is reserved for extensibility.

• Choice BurnOffer_Cancel

  Cancels a burn offer.

  Controller: (DA.Internal.Record.getField @"admin" (DA.Internal.Record.getField @"instrumentId" 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: provider, (DA.Internal.Record.getField @"admin" (DA.Internal.Record.getField @"instrumentId" burn)), (DA.Internal.Record.getField @"holder" burn)

Field	Type	Description
operator	Party	Utility operator.
provider	Party	Utility provider.
burn	Burn	Burn request payload.
lockedHoldingCid	ContractId Holding	The holding locked for the burn.

• Choice Archive

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

  Returns: ()

  (no fields)

• Choice BurnRequest_Accept

  Accept and execute a burn request.

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

  Returns: BurnRequest_Accept_Result

  Field	Type	Description
  extraArgs	ExtraArgs	Additional context required to exercise the choice. extraArgs.context (provided by the backend) includes: * The InstrumentConfiguration of the holding being burned * The Credential``s of the holder that satisfy the issuer requirements * ``AppRewardConfiguration of the provider (if any) * FeaturedAppRight of the provider (if featured) extraArgs.metadata is reserved for extensibility.

• 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 @"admin" (DA.Internal.Record.getField @"instrumentId" burn))

  Returns: BurnRequest_Reject_Result

  Field	Type	Description
  reason	Text	Reason for rejection.

template ExecutedBurn

An executed burn.

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

Field	Type	Description
operator	Party	Utility operator.
provider	Party	Utility provider.
burn	Burn	Burn request payload.

• Choice Archive

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

  Returns: ()

  (no fields)

• Choice ExecutedBurn_Delete

  Deletes an executed burn.

  Controller: actor

  Returns: ExecutedBurn_Delete_Result

  Field	Type	Description
  actor	Party	The actor exercising the choice, must be the operator.

template RejectedBurn

A rejected burn.

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

Field	Type	Description
operator	Party	Utility operator.
provider	Party	Utility provider.
burn	Burn	Rejected burn payload.
reason	Text	Reason for rejection.

• Choice Archive

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

  Returns: ()

  (no fields)

• Choice RejectedBurn_Delete

  Deletes a rejected burn.

  Controller: actor

  Returns: RejectedBurn_Delete_Result

  Field	Type	Description
  actor	Party	The actor exercising the choice, must be the operator.

Data Types

data Burn

Burn payload.

Burn

Field	Type	Description
instrumentId	InstrumentId	The identifier of the instrument to be burned. The instrumentId.admin is the registrar in the utility.
amount	Decimal	The amount to burn.
holder	Party	The party whose holding will be burned.
reference	Text	A reference for the burn.
requestedAt	Time	The time at which the burn was requested.
executeBefore	Time	The time by which the burn must have been executed.
meta	Metadata	Optional metadata to associate extra information throughout the workflow.

data BurnOffer_Accept_Result

Result of BurnOffer_Accept.

BurnOffer_Accept_Result

Field	Type	Description
executedBurnCid	Optional (ContractId ExecutedBurn)	Executed burn.
remaining	Optional (ContractId Holding)	Remaining holding if the burned amount was less than the total holding amount provided.
meta	Metadata	Choice output metadata.

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	Optional (ContractId RejectedBurn)	Rejected burn.

data BurnRequest_Accept_Result

Result of BurnRequest_Accept.

BurnRequest_Accept_Result

Field	Type	Description
executedBurnCid	Optional (ContractId ExecutedBurn)	Executed burn.
meta	Metadata	Choice output metadata.

data BurnRequest_Cancel_Result

Result of BurnRequest_Cancel.

BurnRequest_Cancel_Result

Field	Type	Description
holdingCid	ContractId Holding	Unlocked holding.

data BurnRequest_Reject_Result

Result of BurnRequest_Reject.

BurnRequest_Reject_Result

Field	Type	Description
rejectedBurnCid	Optional (ContractId RejectedBurn)	Rejected burn.
holdingCid	ContractId Holding	Unlocked holding.

data ExecutedBurn_Delete_Result

Result of ExecutedBurn_Delete.

ExecutedBurn_Delete_Result

(no fields)

data RejectedBurn_Delete_Result

Result of RejectedBurn_Delete.

RejectedBurn_Delete_Result

(no fields)