- Overview
- Setup
- Tutorials
- How Tos
- Reference
- DAR Versions
- API Reference
- Commercials API
- Credential API
- Registry API
- Utility.Registry
- Utility.Registry.V0.Configuration.AppReward
- Utility.Registry.V0.Configuration.Instrument
- Utility.Registry.V0.Holding.Allocation
- Utility.Registry.V0.Holding.Burn
- Utility.Registry.V0.Holding.Lock
- Utility.Registry.V0.Holding.Mint
- Utility.Registry.V0.Holding.Transfer
- Utility.Registry.V0.Holding.Unlock
- Utility.Registry.V0.Rule.Transfer
- Utility.Registry.V0.Types
- Utility.Registry.V0.Util
- Utility.Registry.App
- Utility.Registry.App.V0.Configuration.Operator
- Utility.Registry.App.V0.Configuration.Provider
- Utility.Registry.App.V0.Model.Burn
- Utility.Registry.App.V0.Model.Mint
- Utility.Registry.App.V0.Model.Transfer
- Utility.Registry.App.V0.Service.AllocationFactory
- Utility.Registry.App.V0.Service.Holder
- Utility.Registry.App.V0.Service.Provider
- Utility.Registry.App.V0.Service.Registrar
- Utility.Holding
- Utility.Registry
- Settlement Utility API
- Collateral Utility API
- Operator Backend API
Utility.Registry.App.V0.Model.Mint¶
Templates¶
template ExecutedMint
An executed mint.
Signatory: (DA.Internal.Record.getField @"admin" (DA.Internal.Record.getField @"instrumentId" mint))
Field
Type
Description
operator
Operator party.
provider
Provider party.
mint
Mint payload.
Choice Archive
Controller: (DA.Internal.Record.getField @"admin" (DA.Internal.Record.getField @"instrumentId" mint))
Returns: ()
(no fields)
Choice ExecutedMint_Delete
Deletes an executed mint.
Controller: actor
Returns: ExecutedMint_Delete_Result
Field
Type
Description
actor
The party requesting the deletion, must be the operator.
template MintOffer
An offer to mint a holding.
Signatory: provider, (DA.Internal.Record.getField @"admin" (DA.Internal.Record.getField @"instrumentId" mint))
Field
Type
Description
operator
Operator party.
provider
Provider party.
mint
Mint offer payload.
Choice Archive
Controller: provider, (DA.Internal.Record.getField @"admin" (DA.Internal.Record.getField @"instrumentId" mint))
Returns: ()
(no fields)
Choice MintOffer_Accept
Accepts a mint offer.
Controller: (DA.Internal.Record.getField @"holder" mint)
Returns: MintOffer_Accept_Result
Field
Type
Description
extraArgs
Additional context required to exercise the choice.
extraArgs.context(provided by the backend) includes: * TheInstrumentConfigurationof the holding being minted * TheCredential``s of the holder that satisfy the issuer requirements * ``AppRewardConfigurationof the provider (if any) *FeaturedAppRightof the provider (if featured)extraArgs.metadatais reserved for extensibility.Choice MintOffer_Cancel
Cancels a mint offer.
Controller: (DA.Internal.Record.getField @"admin" (DA.Internal.Record.getField @"instrumentId" mint))
Returns: MintOffer_Cancel_Result
(no fields)
Choice MintOffer_Reject
Rejects a mint offer.
Controller: (DA.Internal.Record.getField @"holder" mint)
Returns: MintOffer_Reject_Result
Field
Type
Description
reason
Reason for rejection.
template MintRequest
A request to mint a holding.
Signatory: provider, (DA.Internal.Record.getField @"holder" mint)
Field
Type
Description
operator
Operator requesting the mint.
provider
Provider of the instrument to mint.
mint
Mint request payload.
Choice Archive
Controller: provider, (DA.Internal.Record.getField @"holder" mint)
Returns: ()
(no fields)
Choice MintRequest_Accept
Accepts a mint request.
Controller: (DA.Internal.Record.getField @"admin" (DA.Internal.Record.getField @"instrumentId" mint))
Returns: MintRequest_Accept_Result
Field
Type
Description
extraArgs
Additional context required to exercise the choice.
extraArgs.context(provided by the backend) includes: * TheInstrumentConfigurationof the holding being minted * TheCredential``s of the holder that satisfy the issuer requirements * ``AppRewardConfigurationof the provider (if any) *FeaturedAppRightof the provider (if featured)extraArgs.metadatais reserved for extensibility.Choice MintRequest_Cancel
Cancels a mint request.
Controller: (DA.Internal.Record.getField @"holder" mint)
Returns: MintRequest_Cancel_Result
(no fields)
Choice MintRequest_Reject
Rejects a mint request.
Controller: (DA.Internal.Record.getField @"admin" (DA.Internal.Record.getField @"instrumentId" mint))
Returns: MintRequest_Reject_Result
Field
Type
Description
reason
Reason for rejection.
template RejectedMint
A rejected mint.
Signatory: (DA.Internal.Record.getField @"admin" (DA.Internal.Record.getField @"instrumentId" mint)), (DA.Internal.Record.getField @"holder" mint)
Field
Type
Description
operator
Operator party.
provider
Provider party.
mint
Rejected mint payload.
reason
Reason for rejection.
Choice Archive
Controller: (DA.Internal.Record.getField @"admin" (DA.Internal.Record.getField @"instrumentId" mint)), (DA.Internal.Record.getField @"holder" mint)
Returns: ()
(no fields)
Choice RejectedMint_Delete
Deletes a rejected mint.
Controller: actor
Returns: RejectedMint_Delete_Result
Field
Type
Description
actor
The party requesting the deletion, must be the instrument admin or operator.
Data Types¶
data ExecutedMint_Delete_Result
data Mint
Mint payload.
Field
Type
Description
instrumentId
The identifier of the instrument to be minted. The
instrumentId.adminis the registrar in the utility.amount
The amount to mint.
holder
The party for whom the holding will be minted.
reference
A reference for the mint.
requestedAt
The time at which the mint was requested.
executeBefore
The time by which the mint must have been executed.
meta
Optional metadata to associate extra information throughout the workflow.
Result of
MintOffer_Accept.
Field
Type
Description
holdingCid
Minted holding.
executedMintCid
Executed mint.
meta
Choice output metadata.
Result of
MintOffer_Reject.
Field
Type
Description
rejectedMintCid
Rejected mint.
data MintRequest_Accept_Result
Result of
AcceptedMint_Execute.
Field
Type
Description
holdingCid
Minted holding.
executedMintCid
Executed mint.
meta
Choice output metadata.
data MintRequest_Cancel_Result
data MintRequest_Reject_Result
Result of
MintRequest_Reject.
Field
Type
Description
rejectedMintCid
Rejected mint.
data RejectedMint_Delete_Result