Struct TransactionPayloadBuilder

pub struct TransactionPayloadBuilder { /* private fields */ }

Builder for payload to be used with TxHandler (primarily for SimpleWallet).

Decoding can be done with TransactionPayloadDecoder

Implementations

impl TransactionPayloadBuilder

pub fn with_method_call<Args>( &mut self, contract: &Address, external_args: &Args, method_context: TransactionMethodContext, slot_output_index: &[Option<u8>], input_output_index: &[Option<u8>], ) -> Result<(), TransactionPayloadBuilderError<'static>>

where Args: ExternalArgs,

Add method call to the payload.

The wallet will call this method in addition order.

slot_output_index and input_output_index are used for referencing earlier outputs as slots or inputs of this method, its values are optional, see TransactionInput for more details.

pub unsafe fn with_method_call_untyped<'a>( &mut self, contract: &Address, external_args: &NonNull<*const c_void>, method_metadata: &'a [u8], method_fingerprint: &MethodFingerprint, method_context: TransactionMethodContext, slot_output_index: &[Option<u8>], input_output_index: &[Option<u8>], ) -> Result<(), TransactionPayloadBuilderError<'a>>

Other than unsafe API, this method is identical to Self::with_method_call().

Safety

external_args must correspond to method_metadata and method_fingerprint. Outputs are never read from external_args and inputs that have corresponding input_output_index are not read either.

pub fn into_aligned_bytes(self) -> Vec<u128>

Returns 16-byte aligned bytes.

The contents is a concatenated sequence of method calls with their arguments. All data structures are correctly aligned in the returned byte buffer with 0 used as padding when necessary.

Each method is serialized in the following way:

• Contract to call: Address
• Fingerprint of the method to call: MethodFingerprint
• Method context: TransactionMethodContext
• Number of #[slot] arguments: u8
• For each #[slot] argument:
  • TransactionSlot as u8
• Number of #[input] arguments: u8
• For each #[input] argument:
  • TransactionInput for each #[input] argument as u8
• Number of #[output] arguments: u8
• For each TransactionSlot, whose type is TransactionSlotType::Address:
  • Address
• For each TransactionInput, whose type is TransactionInputType::Value:
  • Input size as little-endian u32 followed by the input itself
• For each #[output]:
  • recommended capacity as little-endian u32 followed by alignment power as u8 (NonZeroU8::ilog2(alignment))

Trait Implementations

impl Clone for TransactionPayloadBuilder

fn clone(&self) -> TransactionPayloadBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionPayloadBuilder

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

Formats the value using the given formatter.

impl Default for TransactionPayloadBuilder

fn default() -> Self

Returns the “default value” for a type.