- 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.Holding
- Utility.Registry
- Settlement Utility API
- Collateral Utility API
- Operator Backend API
Utility.Commercials.V0.Model.Offer¶
Templates¶
template CommercialAgreementOffer
An offer to create a commercial agreement for the Utility, including the fee per credential billing.
Signatory: operator
Field
Type
Description
operator
Utility operator.
user
Utility user.
feeReceiver
The party that will receive the fee for using the Utility services.
utilityFees
The fee that the user will pay for using the Utility services.
dso
DSO (Decentralized Synchronizer Operations) party.
initialDepositAmountCc
An initial deposit amount (in CC) proposed by the operator.
Choice Archive
Controller: operator
Returns: ()
(no fields)
Choice CommercialAgreementOffer_Accept
Accepts a commercial agreement offer.
Controller: user
Returns: CommercialAgreementOffer_Accept_Result
(no fields)
Choice CommercialAgreementOffer_AcceptAndTopup
Accepts and tops up a commercial agreement offer.
Controller: user
Returns: CommercialAgreementOffer_AcceptAndTopup_Result
Field
Type
Description
holderInputs
Amulet to be used to fund the deposit.
appTransferContext
Context for the deposit funding transfer (effectively it is a lock rather than a Transfer).
Choice CommercialAgreementOffer_Cancel
Cancels a commercial agreement offer.
Controller: operator
Returns: CommercialAgreementOffer_Cancel_Result
(no fields)
Choice CommercialAgreementOffer_Reject
Rejects a commercial agreement offer.
Controller: user
Returns: CommercialAgreementOffer_Reject_Result
Field
Type
Description
reason
Rejection reason.
Data Types¶
data CommercialAgreementOffer_AcceptAndTopup_Result
Result of accepting and topping up a commercial agreement.
CommercialAgreementOffer_AcceptAndTopup_Result
Field
Type
Description
commercialAgreementCid
The commercial agreement.
data CommercialAgreementOffer_Accept_Result
Result of accepting a commercial agreement.
CommercialAgreementOffer_Accept_Result
Field
Type
Description
commercialAgreementCid
The commercial agreement.
data CommercialAgreementOffer_Cancel_Result
Result of canceling a commercial agreement offer.
CommercialAgreementOffer_Cancel_Result
(no fields)
data CommercialAgreementOffer_Reject_Result
Result of rejecting a commercial agreement offer.
CommercialAgreementOffer_Reject_Result
Field
Type
Description
reason
The reason for rejection.