Struct casper_client::PaymentStrParams

pub struct PaymentStrParams<'a> { /* fields omitted */ }

Container for payment-related arguments used while constructing a Deploy.

payment_args_simple

For methods taking payment_args_simple, this parameter is the payment contract arguments, in the form <NAME:TYPE='VALUE'> or <NAME:TYPE=null>.

It can only be used with the following simple CLTypes: bool, i32, i64, u8, u32, u64, u128, u256, u512, unit, string, key, account_hash, uref, public_key and Option of each of these.

Example inputs are:

name_01:bool='false'
name_02:i32='-1'
name_03:i64='-2'
name_04:u8='3'
name_05:u32='4'
name_06:u64='5'
name_07:u128='6'
name_08:u256='7'
name_09:u512='8'
name_10:unit=''
name_11:string='a value'
key_account_name:key='account-hash-0102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f20'
key_hash_name:key='hash-0102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f20'
key_uref_name:key='uref-0102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f20-000'
account_hash_name:account_hash='account-hash-0102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f20'
uref_name:uref='uref-0102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f20-007'
public_key_name:public_key='0119bf44096984cdfe8541bac167dc3b96c85086aa30b6b6cb0c5c38ad703166e1'

For optional values of any these types, prefix the type with "opt_" and use the term "null" without quotes to specify a None value:

name_01:opt_bool='true'       # Some(true)
name_02:opt_bool='false'      # Some(false)
name_03:opt_bool=null         # None
name_04:opt_i32='-1'          # Some(-1)
name_05:opt_i32=null          # None
name_06:opt_unit=''           # Some(())
name_07:opt_unit=null         # None
name_08:opt_string='a value'  # Some("a value".to_string())
name_09:opt_string='null'     # Some("null".to_string())
name_10:opt_string=null       # None

To get a list of supported types, call supported_cl_type_list(). To get this list of examples for supported types, call supported_cl_type_examples().

payment_args_complex

For methods taking payment_args_complex, this parameter is the payment contract arguments, in the form of a ToBytes-encoded file.

---

Note while multiple payment args can be specified for a single payment code instance, only one of payment_args_simple and payment_args_complex may be used.

Implementations

impl<'a> PaymentStrParams<'a>

pub fn with_path(
    payment_path: &'a str,
    payment_args_simple: Vec<&'a str>,
    payment_args_complex: &'a str
) -> Self

Constructs a PaymentStrParams using a payment smart contract file.

• payment_path is the path to the compiled Wasm payment code.
• See the struct docs for a description of payment_args_simple and payment_args_complex.

pub fn with_amount(payment_amount: &'a str) -> Self

Constructs a PaymentStrParams using a payment amount.

payment_amount uses the standard-payment system contract rather than custom payment Wasm. The value is the 'amount' arg of the standard-payment contract.

pub fn with_name(
    payment_name: &'a str,
    payment_entry_point: &'a str,
    payment_args_simple: Vec<&'a str>,
    payment_args_complex: &'a str
) -> Self

Constructs a PaymentStrParams using a stored contract's name.

• payment_name is the name of the stored contract (associated with the executing account) to be called as the payment.
• payment_entry_point is the name of the method that will be used when calling the payment contract.
• See the struct docs for a description of payment_args_simple and payment_args_complex.

pub fn with_hash(
    payment_hash: &'a str,
    payment_entry_point: &'a str,
    payment_args_simple: Vec<&'a str>,
    payment_args_complex: &'a str
) -> Self

Constructs a PaymentStrParams using a stored contract's hex-encoded hash.

• payment_hash is the hex-encoded hash of the stored contract to be called as the payment.
• payment_entry_point is the name of the method that will be used when calling the payment contract.
• See the struct docs for a description of payment_args_simple and payment_args_complex.

pub fn with_package_name(
    payment_package_name: &'a str,
    payment_version: &'a str,
    payment_entry_point: &'a str,
    payment_args_simple: Vec<&'a str>,
    payment_args_complex: &'a str
) -> Self

Constructs a PaymentStrParams using a stored contract's package name.

• payment_package_name is the name of the stored package to be called as the payment.
• payment_version is the version of the called payment contract. The latest will be used if payment_version is empty.
• payment_entry_point is the name of the method that will be used when calling the payment contract.
• See the struct docs for a description of payment_args_simple and payment_args_complex.

pub fn with_package_hash(
    payment_package_hash: &'a str,
    payment_version: &'a str,
    payment_entry_point: &'a str,
    payment_args_simple: Vec<&'a str>,
    payment_args_complex: &'a str
) -> Self

Constructs a PaymentStrParams using a stored contract's package hash.

• payment_package_hash is the hex-encoded hash of the stored package to be called as the payment.
• payment_version is the version of the called payment contract. The latest will be used if payment_version is empty.
• payment_entry_point is the name of the method that will be used when calling the payment contract.
• See the struct docs for a description of payment_args_simple and payment_args_complex.

Trait Implementations

impl<'a> Default for PaymentStrParams<'a>

fn default() -> PaymentStrParams<'a>

Returns the "default value" for a type.

impl<'a> TryInto<ExecutableDeployItem> for PaymentStrParams<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<ExecutableDeployItem, Error>

Performs the conversion.