Struct TokenPaymentInfoV1 

pub struct TokenPaymentInfoV1 {
    pub payment_token_contract_id: Option<Identifier>,
    pub token_contract_position: TokenContractPosition,
    pub minimum_token_cost: Option<TokenAmount>,
    pub maximum_token_cost: Option<TokenAmount>,
    pub gas_fees_paid_by: GasFeesPaidBy,
    pub shielded_payment: Box<TokenShieldedPayment>,
}

Format version 1 of the token payment info: the V0 fields plus a shielded payment. The document action’s token cost is paid out of the token’s shielded pool by shielded_payment instead of the document owner’s token balance; the identity signing the batch still pays the credit fee and receives nothing.

Fields

payment_token_contract_id: Option<Identifier>

By default, we use a token in the same contract, this field must be set if the document requires payment using another contracts token.

token_contract_position: TokenContractPosition

Which token (by position) on the contract the payment uses.

minimum_token_cost: Option<TokenAmount>

Minimum token cost, this most often should not be set.

maximum_token_cost: Option<TokenAmount>

Maximum token cost, this most often should be set.

gas_fees_paid_by: GasFeesPaidBy

Who pays the gas fees, this needs to match what the contract allows.

shielded_payment: Box<TokenShieldedPayment>

The spend bundle paying the token cost from the token’s shielded pool. Boxed so a payment info without one stays small.

Implementations

impl TokenPaymentInfoV1

pub fn from_v0( v0: TokenPaymentInfoV0, shielded_payment: TokenShieldedPayment, ) -> Self

Builds a V1 from a V0 and the shielded payment that pays its cost.

pub fn into_v0(self) -> TokenPaymentInfoV0

Drops the shielded payment, leaving the V0 fields.

pub fn shielded_payment(&self) -> &TokenShieldedPayment

The spend bundle paying the token cost from the token’s shielded pool.

Trait Implementations

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

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 TokenPaymentInfoV1

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 TokenPaymentInfoV1

fn clone(&self) -> TokenPaymentInfoV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenPaymentInfoV1

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for TokenPaymentInfoV1

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 TokenPaymentInfoV1

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 TokenPaymentInfoV1

fn default() -> TokenPaymentInfoV1

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TokenPaymentInfoV1

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TokenPaymentInfoV1

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

Formats the value using the given formatter.

impl Encode for TokenPaymentInfoV1

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

Encode a given type.

impl From<TokenPaymentInfoV1> for TokenPaymentInfo

fn from(value: TokenPaymentInfoV1) -> Self

Converts to this type from the input type.

impl JsonSafeFields for TokenPaymentInfoV1

impl PartialEq for TokenPaymentInfoV1

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TokenPaymentInfoV1

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 TokenPaymentInfoV1

impl TokenPaymentInfoAccessorsV0 for TokenPaymentInfoV1

fn payment_token_contract_id(&self) -> Option<Identifier>

Returns a cloned copy of the payment_token_contract_id field.

fn payment_token_contract_id_ref(&self) -> &Option<Identifier>

Returns a reference to the payment_token_contract_id field.

fn token_contract_position(&self) -> TokenContractPosition

Returns the token_contract_position field.

fn minimum_token_cost(&self) -> Option<TokenAmount>

Returns a copy of the minimum_token_cost field.

fn maximum_token_cost(&self) -> Option<TokenAmount>

Returns a copy of the maximum_token_cost field.

fn set_payment_token_contract_id(&mut self, id: Option<Identifier>)

Sets the payment_token_contract_id field to the given value.

fn set_token_contract_position(&mut self, position: TokenContractPosition)

Sets the token_contract_position field to the given value.

fn set_minimum_token_cost(&mut self, cost: Option<TokenAmount>)

Sets the minimum_token_cost field to the given value.

fn set_maximum_token_cost(&mut self, cost: Option<TokenAmount>)

Sets the maximum_token_cost field to the given value.

fn gas_fees_paid_by(&self) -> GasFeesPaidBy

Returns the gas_fees_paid_by strategy.

fn set_gas_fees_paid_by(&mut self, payer: GasFeesPaidBy)

Sets the gas_fees_paid_by strategy.

impl TryFrom<BTreeMap<String, Value>> for TokenPaymentInfoV1

type Error = ProtocolError

The type returned in the event of a conversion error.

fn try_from(map: BTreeMap<String, Value>) -> Result<Self, Self::Error>

Performs the conversion.