Enum ethers_contract_abigen::Source

pub enum Source {
    String(String),
    Local(PathBuf),
    Http(Url),
    Etherscan(Address),
    Npm(String),
}

A source of a Truffle artifact JSON.

Variants

String(String)

Tuple Fields

0: String

A raw ABI string

Local(PathBuf)

Tuple Fields

0: PathBuf

An ABI located on the local file system.

Http(Url)

Tuple Fields

0: Url

An ABI to be retrieved over HTTP(S).

Etherscan(Address)

Tuple Fields

0: Address

An address of a mainnet contract that has been verified on Etherscan.io.

Npm(String)

Tuple Fields

0: String

The package identifier of an npm package with a path to a Truffle artifact or ABI to be retrieved from unpkg.io.

Implementations

impl Source

pub fn parse<S>(source: S) -> Result<Self> where
    S: AsRef<str>, 

Parses an ABI from a source

Contract ABIs can be retrieved from the local filesystem or online from etherscan.io. They can also be provided in-line. This method parses ABI source URLs and accepts the following:

• raw ABI JSON

• relative/path/to/Contract.json: a relative path to an ABI JSON file. This relative path is rooted in the current working directory. To specify the root for relative paths, use Source::with_root.

• /absolute/path/to/Contract.json or file:///absolute/path/to/Contract.json: an absolute path or file URL to an ABI JSON file.

• http(s)://... an HTTP url to a contract ABI.

• etherscan:0xXX..XX or https://etherscan.io/address/0xXX..XX: a address or URL of a verified contract on Etherscan.

• npm:@org/package@1.0.0/path/to/contract.json an npmjs package with an optional version and path (defaulting to the latest version and index.js). The contract ABI will be retrieved through unpkg.io.

pub fn local<P>(path: P) -> Self where
    P: AsRef<Path>, 

Creates a local filesystem source from a path string.

pub fn http<S>(url: S) -> Result<Self> where
    S: AsRef<str>, 

Creates an HTTP source from a URL.

pub fn etherscan<S>(address: S) -> Result<Self> where
    S: AsRef<str>, 

Creates an Etherscan source from an address string.

pub fn npm<S>(package_path: S) -> Self where
    S: Into<String>, 

Creates an Etherscan source from an address string.

pub fn get(&self) -> Result<String>

Retrieves the source JSON of the artifact this will either read the JSON from the file system or retrieve a contract ABI from the network depending on the source type.

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl FromStr for Source

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl PartialEq<Source> for Source

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Source

impl StructuralEq for Source

impl StructuralPartialEq for Source