Struct ethers::contract::Abigen

pub struct Abigen { /* fields omitted */ }

Builder struct for generating type-safe bindings from a contract’s ABI

Note: Your contract’s ABI must contain the stateMutability field. This is still not supported by Vyper, so you must adjust your ABIs and replace constant functions with view or pure.

Example

Running the command below will generate a file called token.rs containing the bindings inside, which exports an ERC20Token struct, along with all its events.

Abigen::new("ERC20Token", "./abi.json")?.generate()?.write_to_file("token.rs")?;

Implementations

impl Abigen

pub fn new<S>(contract_name: &str, abi_source: S) -> Result<Abigen, Error> where
    S: AsRef<str>, 

Creates a new builder with the given ABI JSON source.

pub fn add_event_alias<S1, S2>(self, signature: S1, alias: S2) -> Abigen where
    S1: Into<String>,
    S2: Into<String>, 

Manually adds a solidity event alias to specify what the event struct and function name will be in Rust.

pub fn add_method_alias<S1, S2>(self, signature: S1, alias: S2) -> Abigen where
    S1: Into<String>,
    S2: Into<String>, 

Manually adds a solidity method alias to specify what the method name will be in Rust. For solidity methods without an alias, the snake cased method name will be used.

pub fn rustfmt(self, rustfmt: bool) -> Abigen

Specify whether or not to format the code using a locally installed copy of rustfmt.

Note that in case rustfmt does not exist or produces an error, the unformatted code will be used.

pub fn add_event_derive<S>(self, derive: S) -> Abigen where
    S: Into<String>, 

Add a custom derive to the derives for event structs and enums.

This makes it possible to for example derive serde::Serialize and serde::Deserialize for events.

pub fn generate(self) -> Result<ContractBindings, Error>

Generates the contract bindings.