Skip to main content

Invocation

Struct Invocation 

Source
pub struct Invocation { /* private fields */ }
Expand description

An active transaction invocation.

This structure represents a transaction that is being prepared for execution. It holds the transaction template (TIR), parameter definitions, and current argument values.

Use the builder methods (with_arg, with_args) to populate arguments, then convert to a TRP resolve request using into_resolve_request.

§Example

use serde_json::json;
use tx3_sdk::tii::Protocol;

let protocol = Protocol::from_file("protocol.tii")?;
let invocation = protocol.invoke("transfer", None)?;

// Set arguments
let invocation = invocation
    .with_arg("sender", json!("addr1..."))
    .with_arg("amount", json!(1000000));

// Check what's missing
for (name, ty) in invocation.unspecified_params() {
    println!("Need: {} ({:?})", name, ty);
}

// Convert to resolve request
let resolve_params = invocation.into_resolve_request()?;

Implementations§

Source§

impl Invocation

Source

pub fn params(&mut self) -> &ParamMap

Returns a reference to all parameters for this invocation.

§Returns

A reference to the map of parameter names to their types.

Source

pub fn unspecified_params( &mut self, ) -> impl Iterator<Item = (&String, &ParamType)>

Returns an iterator over parameters that haven’t been specified yet.

This is useful for checking which required arguments are still missing before submitting the transaction.

§Returns

An iterator over (name, type) pairs for unspecified parameters.

Source

pub fn set_arg(&mut self, name: &str, value: Value)

Sets a single argument value.

§Arguments
  • name - The parameter name (case-insensitive)
  • value - The JSON value to set
Source

pub fn set_args(&mut self, args: ArgMap)

Sets multiple argument values at once.

§Arguments
  • args - A map of argument names to values
Source

pub fn with_arg(self, name: &str, value: Value) -> Self

Sets a single argument value (builder pattern).

This is the builder-pattern variant of set_arg, allowing chained calls.

§Arguments
  • name - The parameter name (case-insensitive)
  • value - The JSON value to set
§Returns

Returns self for method chaining.

Source

pub fn with_args(self, args: ArgMap) -> Self

Sets multiple argument values at once (builder pattern).

This is the builder-pattern variant of set_args, allowing chained calls.

§Arguments
  • args - A map of argument names to values
§Returns

Returns self for method chaining.

Source

pub fn into_resolve_request(self) -> Result<ResolveParams, Error>

Converts this invocation into a TRP resolve request.

This method consumes the invocation and creates the parameters needed to call the TRP resolve method.

§Returns

Returns ResolveParams that can be passed to trp::Client::resolve.

§Errors

Currently this method always succeeds, but returns Result for future compatibility.

Trait Implementations§

Source§

impl Clone for Invocation

Source§

fn clone(&self) -> Invocation

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Invocation

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,