Trait SolCall 

pub trait SolCall: Sized {
    type Parameters<'a>: SolType<Token<'a> = Self::Token<'a>>;
    type Token<'a>: TokenSeq<'a>;
    type Return;
    type ReturnTuple<'a>: SolType<Token<'a> = Self::ReturnToken<'a>>;
    type ReturnToken<'a>: TokenSeq<'a>;

    const SIGNATURE: &'static str;
    const SELECTOR: [u8; 4];

    // Required methods
    fn new(tuple: <Self::Parameters<'_> as SolType>::RustType) -> Self;
    fn tokenize(&self) -> Self::Token<'_>;
    fn tokenize_returns(ret: &Self::Return) -> Self::ReturnToken<'_>;
    fn abi_decode_returns(data: &[u8]) -> Result<Self::Return, Error>;
    fn abi_decode_returns_validate(data: &[u8]) -> Result<Self::Return, Error>;

    // Provided methods
    fn abi_encoded_size(&self) -> usize { ... }
    fn abi_decode_raw(data: &[u8]) -> Result<Self, Error> { ... }
    fn abi_decode_raw_validate(data: &[u8]) -> Result<Self, Error> { ... }
    fn abi_decode(data: &[u8]) -> Result<Self, Error> { ... }
    fn abi_decode_validate(data: &[u8]) -> Result<Self, Error> { ... }
    fn abi_encode_raw(&self, out: &mut Vec<u8>) { ... }
    fn abi_encode(&self) -> Vec<u8>  { ... }
    fn abi_encode_returns(ret: &Self::Return) -> Vec<u8>  { ... }
    fn abi_encode_returns_tuple<'a, E>(e: &'a E) -> Vec<u8> 
       where E: SolTypeValue<Self::ReturnTuple<'a>> { ... }
}

Re-exported alloy ABI types for use with generated calls. A Solidity function call.

Implementer’s Guide

It should not be necessary to implement this trait manually. Instead, use the sol! procedural macro to parse Solidity syntax into types that implement this trait.

Required Associated Constants

const SIGNATURE: &'static str

The function’s ABI signature.

const SELECTOR: [u8; 4]

The function selector: keccak256(SIGNATURE)[0..4]

Required Associated Types

type Parameters<'a>: SolType<Token<'a> = Self::Token<'a>>

The underlying tuple type which represents this type’s arguments.

If this type has no arguments, this will be the unit type ().

type Token<'a>: TokenSeq<'a>

The arguments’ corresponding TokenSeq type.

type Return

The function’s return struct.

type ReturnTuple<'a>: SolType<Token<'a> = Self::ReturnToken<'a>>

The underlying tuple type which represents this type’s return values.

If this type has no return values, this will be the unit type ().

type ReturnToken<'a>: TokenSeq<'a>

The returns’ corresponding TokenSeq type.

Required Methods

fn new(tuple: <Self::Parameters<'_> as SolType>::RustType) -> Self

Convert from the tuple type used for ABI encoding and decoding.

fn tokenize(&self) -> Self::Token<'_>

Tokenize the call’s arguments.

fn tokenize_returns(ret: &Self::Return) -> Self::ReturnToken<'_>

Tokenize the call’s return values.

fn abi_decode_returns(data: &[u8]) -> Result<Self::Return, Error>

ABI decode this call’s return values from the given slice.

fn abi_decode_returns_validate(data: &[u8]) -> Result<Self::Return, Error>

ABI decode this call’s return values from the given slice, with validation.

This is the same as abi_decode_returns, but performs validation checks on the decoded return tuple.

Provided Methods

fn abi_encoded_size(&self) -> usize

The size of the encoded data in bytes, without its selector.

fn abi_decode_raw(data: &[u8]) -> Result<Self, Error>

ABI decode this call’s arguments from the given slice, without its selector.

fn abi_decode_raw_validate(data: &[u8]) -> Result<Self, Error>

ABI decode this call’s arguments from the given slice, without its selector, with validation.

This is the same as abi_decode_raw, but performs validation checks on the decoded parameters tuple.

fn abi_decode(data: &[u8]) -> Result<Self, Error>

ABI decode this call’s arguments from the given slice, with the selector.

fn abi_decode_validate(data: &[u8]) -> Result<Self, Error>

ABI decode this call’s arguments from the given slice, with the selector, with validation.

This is the same as abi_decode, but performs validation checks on the decoded parameters tuple.

fn abi_encode_raw(&self, out: &mut Vec<u8>)

ABI encode the call to the given buffer without its selector.

fn abi_encode(&self) -> Vec<u8>

ABI encode the call to the given buffer with its selector.

fn abi_encode_returns(ret: &Self::Return) -> Vec<u8>

ABI encode the call’s return value.

fn abi_encode_returns_tuple<'a, E>(e: &'a E) -> Vec<u8>

where E: SolTypeValue<Self::ReturnTuple<'a>>,

ABI encode the call’s return values.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl SolCall for allowanceCall

const SIGNATURE: &'static str = "allowance(address,address)"

const SELECTOR: [u8; 4]

type Parameters<'a> = (Address, Address)

type Token<'a> = <<allowanceCall as SolCall>::Parameters<'a> as SolType>::Token<'a>

type Return = Uint<256, 4>

type ReturnTuple<'a> = (Uint<256>,)

type ReturnToken<'a> = <<allowanceCall as SolCall>::ReturnTuple<'a> as SolType>::Token<'a>

impl SolCall for approveCall

const SIGNATURE: &'static str = "approve(address,uint256)"

const SELECTOR: [u8; 4]

type Parameters<'a> = (Address, Uint<256>)

type Token<'a> = <<approveCall as SolCall>::Parameters<'a> as SolType>::Token<'a>

type Return = bool

type ReturnTuple<'a> = (Bool,)

type ReturnToken<'a> = <<approveCall as SolCall>::ReturnTuple<'a> as SolType>::Token<'a>

impl SolCall for balanceOfCall

const SIGNATURE: &'static str = "balanceOf(address)"

const SELECTOR: [u8; 4]

type Parameters<'a> = (Address,)

type Token<'a> = <<balanceOfCall as SolCall>::Parameters<'a> as SolType>::Token<'a>

type Return = Uint<256, 4>

type ReturnTuple<'a> = (Uint<256>,)

type ReturnToken<'a> = <<balanceOfCall as SolCall>::ReturnTuple<'a> as SolType>::Token<'a>

impl SolCall for decimalsCall

const SIGNATURE: &'static str = "decimals()"

const SELECTOR: [u8; 4]

type Parameters<'a> = ()

type Token<'a> = <<decimalsCall as SolCall>::Parameters<'a> as SolType>::Token<'a>

type Return = u8

type ReturnTuple<'a> = (Uint<8>,)

type ReturnToken<'a> = <<decimalsCall as SolCall>::ReturnTuple<'a> as SolType>::Token<'a>

impl SolCall for nameCall

const SIGNATURE: &'static str = "name()"

const SELECTOR: [u8; 4]

type Parameters<'a> = ()

type Token<'a> = <<nameCall as SolCall>::Parameters<'a> as SolType>::Token<'a>

type Return = String

type ReturnTuple<'a> = (String,)

type ReturnToken<'a> = <<nameCall as SolCall>::ReturnTuple<'a> as SolType>::Token<'a>

impl SolCall for symbolCall

const SIGNATURE: &'static str = "symbol()"

const SELECTOR: [u8; 4]

type Parameters<'a> = ()

type Token<'a> = <<symbolCall as SolCall>::Parameters<'a> as SolType>::Token<'a>

type Return = String

type ReturnTuple<'a> = (String,)

type ReturnToken<'a> = <<symbolCall as SolCall>::ReturnTuple<'a> as SolType>::Token<'a>

impl SolCall for totalSupplyCall

const SIGNATURE: &'static str = "totalSupply()"

const SELECTOR: [u8; 4]

type Parameters<'a> = ()

type Token<'a> = <<totalSupplyCall as SolCall>::Parameters<'a> as SolType>::Token<'a>

type Return = Uint<256, 4>

type ReturnTuple<'a> = (Uint<256>,)

type ReturnToken<'a> = <<totalSupplyCall as SolCall>::ReturnTuple<'a> as SolType>::Token<'a>

impl SolCall for transferCall

const SIGNATURE: &'static str = "transfer(address,uint256)"

const SELECTOR: [u8; 4]

type Parameters<'a> = (Address, Uint<256>)

type Token<'a> = <<transferCall as SolCall>::Parameters<'a> as SolType>::Token<'a>

type Return = bool

type ReturnTuple<'a> = (Bool,)

type ReturnToken<'a> = <<transferCall as SolCall>::ReturnTuple<'a> as SolType>::Token<'a>

impl SolCall for transferFromCall

const SIGNATURE: &'static str = "transferFrom(address,address,uint256)"

const SELECTOR: [u8; 4]

type Parameters<'a> = (Address, Address, Uint<256>)

type Token<'a> = <<transferFromCall as SolCall>::Parameters<'a> as SolType>::Token<'a>

type Return = bool

type ReturnTuple<'a> = (Bool,)

type ReturnToken<'a> = <<transferFromCall as SolCall>::ReturnTuple<'a> as SolType>::Token<'a>