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	Party	Utility operator.
user	Party	Utility user.
feeReceiver	Party	The party that will receive the fee for using the Utility services.
utilityFees	UtilityFees	The fee that the user will pay for using the Utility services.
dso	Party	DSO (Decentralized Synchronizer Operations) party.
initialDepositAmountCc	Optional Decimal	An initial deposit amount (in CC) proposed by the operator.
rewardReceiver	Optional Party	The party that will receive the rewards from the Utility service fees. This field is available starting from version 0.3.0 of this package.

• 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	[ContractId Amulet]	Amulet to be used to fund the deposit.
  appTransferContext	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	Text	Rejection reason.

Data Types

data CommercialAgreementOffer\_AcceptAndTopup\_Result

Result of accepting and topping up a commercial agreement.

CommercialAgreementOffer\_AcceptAndTopup\_Result

Field	Type	Description
commercialAgreementCid	ContractId CommercialAgreement	The commercial agreement.

data CommercialAgreementOffer\_Accept\_Result

Result of accepting a commercial agreement.

CommercialAgreementOffer\_Accept\_Result

Field	Type	Description
commercialAgreementCid	ContractId CommercialAgreement	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	Text	The reason for rejection.