Struct EVMContractSpec

pub struct EVMContractSpec(/* private fields */);

Contract specification for an EVM smart contract

This structure represents the parsed specification of an EVM smart contract, following the Ethereum Contract ABI format. It contains information about all callable functions in the contract.

Methods from Deref<Target = JsonAbi>

pub fn len(&self) -> usize

Returns the total number of items (of any type).

pub fn is_empty(&self) -> bool

Returns true if the ABI contains no items.

pub fn items(&self) -> Items<'_>

Returns an iterator over all of the items in the ABI.

pub fn to_sol(&self, name: &str, config: Option<ToSolConfig>) -> String

Formats this JSON ABI as a Solidity interface.

The order of the definitions is not guaranteed.

Generates:

interface <name> {
    <enums>...
    <UDVTs>...
    <structs>...
    <errors>...
    <events>...
    <fallback>
    <receive>
    <functions>...
}

Note that enums are going to be identical to uint8 UDVTs, since no other information about enums is present in the ABI.

pub fn to_sol_raw( &self, name: &str, out: &mut String, config: Option<ToSolConfig>, )

Formats this JSON ABI as a Solidity interface into the given string.

See to_sol for more information.

pub fn constructor(&self) -> Option<&Constructor>

Returns an immutable reference to the constructor.

pub fn function(&self, name: &str) -> Option<&Vec<Function>>

Returns an immutable reference to the list of all the functions with the given name.

pub fn event(&self, name: &str) -> Option<&Vec<Event>>

Returns an immutable reference to the list of all the events with the given name.

pub fn error(&self, name: &str) -> Option<&Vec<Error>>

Returns an immutable reference to the list of all the errors with the given name.

pub fn functions(&self) -> Flatten<Values<'_, String, Vec<Function>>>

Returns an iterator over immutable references to the functions.

pub fn function_by_selector(&self, selector: FixedBytes<4>) -> Option<&Function>

Returns the first [Function] with a matching selector.

pub fn events(&self) -> Flatten<Values<'_, String, Vec<Event>>>

Returns an iterator over immutable references to the events.

pub fn errors(&self) -> Flatten<Values<'_, String, Vec<Error>>>

Returns an iterator over immutable references to the errors.

Trait Implementations

impl Clone for ContractSpec

fn clone(&self) -> ContractSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractSpec

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

Formats the value using the given formatter.

impl Default for ContractSpec

fn default() -> ContractSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ContractSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ContractSpec

Display a ContractSpec

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

Formats the value using the given formatter.

impl From<ContractSpec> for ContractSpec

Convert a ContractSpec to an EVMContractSpec

fn from(spec: ContractSpec) -> Self

Converts to this type from the input type.

impl From<JsonAbi> for ContractSpec

Convert a JsonAbi to a ContractSpec

fn from(spec: JsonAbi) -> Self

Converts to this type from the input type.

impl From<Value> for ContractSpec

Convert a serde_json::Value to a ContractSpec

fn from(spec: Value) -> Self

Converts to this type from the input type.

impl PartialEq for ContractSpec

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ContractSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Deref for ContractSpec

Dereference a ContractSpec

type Target = JsonAbi

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl StructuralPartialEq for ContractSpec