Enum GasFeesPaidBy 

pub enum GasFeesPaidBy {
    DocumentOwner = 0,
    ContractOwner = 1,
    PreferContractOwner = 2,
}

Who pays the gas (the storage and processing fee) of a document action that is paid for with a token.

The same enum is used on both sides of a token payment. On a document type’s token cost it is what the contract owner offers; on a transition’s token payment info it is what the document owner asks for. GasFeesPaidBy::resolve combines the two into the effective payer from protocol version 14 on: before it the field was carried but never acted on, and the signer always paid.

The contract owner can only be asked to pay when the action actually charges a token, so every sponsored transition is backed by a token the contract owner chose to hand out.

Variants

DocumentOwner = 0

The document owner pays the gas fees.

On the contract side this is the default and means the contract owner never pays. On the transition side it opts out of any sponsorship the contract offers.

ContractOwner = 1

The contract owner pays the gas fees.

On the contract side this offers to pay, and accepts every request. On the transition side this insists that the contract owner pays: the transition is refused, and nobody is charged, when the contract owner cannot cover the fee, and it is rejected outright when the contract offers less than that.

PreferContractOwner = 2

The contract owner pays the gas fees when their balance covers them; otherwise the document owner does.

On the contract side this offers to pay but refuses to be the reason a transition fails, so a transition insisting on ContractOwner is rejected. On the transition side it is the document owner stating their willingness to pay the fee themselves when the contract owner’s balance is insufficient, and it is accepted by every contract.

Implementations

impl GasFeesPaidBy

pub fn resolve(offered_by_contract: Self, requested: Self) -> Option<Self>

The effective gas payer of a document action, given what the document type’s token cost offers (offered_by_contract) and what the transition’s token payment info asks for (requested), or None when the request cannot be honoured.

offered \ requested	DocumentOwner	PreferContractOwner	ContractOwner
DocumentOwner	document owner	document owner	refused
PreferContractOwner	document owner	prefer contract owner	refused
ContractOwner	document owner	prefer contract owner	contract owner

An action without a token cost offers DocumentOwner, and a transition without token payment info requests it.

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for GasFeesPaidBy

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl<'__de, __Context> BorrowDecodeUntrusted<'__de, __Context> for GasFeesPaidBy

fn borrow_decode_untrusted<__D: BorrowUntrustedDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Borrow-decode with explicit untrusted field dispatch and resource handling.

impl Clone for GasFeesPaidBy

fn clone(&self) -> GasFeesPaidBy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for GasFeesPaidBy

impl Debug for GasFeesPaidBy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for GasFeesPaidBy

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl<__Context> DecodeUntrusted<__Context> for GasFeesPaidBy

fn decode_untrusted<__D: UntrustedDecoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Decode with explicit untrusted field dispatch and resource handling.

impl Default for GasFeesPaidBy

fn default() -> GasFeesPaidBy

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GasFeesPaidBy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for GasFeesPaidBy

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encode for GasFeesPaidBy

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl From<GasFeesPaidBy> for u8

fn from(value: GasFeesPaidBy) -> Self

Converts to this type from the input type.

impl JsonConvertible for GasFeesPaidBy

Available on crate features json-conversion and serde-conversion only.

fn to_json(&self) -> Result<JsonValue, ProtocolError>

fn from_json(json: JsonValue) -> Result<Self, ProtocolError>

impl JsonSafeFields for GasFeesPaidBy

impl PartialEq for GasFeesPaidBy

fn eq(&self, other: &GasFeesPaidBy) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for GasFeesPaidBy

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GasFeesPaidBy

impl TryFrom<u8> for GasFeesPaidBy

type Error = ProtocolError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for GasFeesPaidBy

type Error = ProtocolError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl ValueConvertible for GasFeesPaidBy

Available on crate features serde-conversion and value-conversion only.

fn to_object(&self) -> Result<Value, ProtocolError>

where Self: Sized,

fn into_object(self) -> Result<Value, ProtocolError>

where Self: Sized,

fn from_object(value: Value) -> Result<Self, ProtocolError>

where Self: Sized,

fn from_object_ref(value: &Value) -> Result<Self, ProtocolError>

where Self: Sized,