Enum ethers_contract_abigen::Source

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

A source of an Ethereum smart contract’s ABI.

See [parse][#method.parse] for more information.

Variants

String(String)

A raw ABI string.

Local(PathBuf)

An ABI located on the local file system.

Explorer(Explorer, Address)

Available on crate feature online and non-WebAssembly only.

An address of a smart contract address verified at a supported blockchain explorer.

Npm(String)

Available on crate feature online and non-WebAssembly only.

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

Http(Url)

Available on crate feature online and non-WebAssembly only.

An ABI to be retrieved over HTTP(S).

Implementations

impl Source

pub fn http(url: impl AsRef<str>) -> Result<Self>

Available on crate feature online and non-WebAssembly only.

Creates an HTTP source from a URL.

pub fn explorer(chain: Chain, address: Address) -> Result<Self>

Available on crate feature online and non-WebAssembly only.

Creates an Etherscan source from an address string.

pub fn npm(package_path: impl Into<String>) -> Self

Available on crate feature online and non-WebAssembly only.

Creates an Etherscan source from an address string.

impl Source

pub fn parse(source: impl AsRef<str>) -> Result<Self>

Parses an ABI from a source.

This method accepts the following:

• { ... } or [ ... ]: A raw or human-readable ABI object or array of objects.

• relative/path/to/Contract.json: a relative path to an ABI JSON file. This relative path is rooted in the current working directory.

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

If the online feature is enabled:

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

• http://...: an HTTP URL to a contract ABI.
  Note: either the rustls or openssl feature must be enabled to support HTTPS URLs.

• <name>:<address>, <chain>:<address> or <url>/.../<address>: an address or URL of a verified contract on a blockchain explorer.
  Supported explorers and their respective chain:

  • etherscan -> mainnet
  • bscscan -> bsc
  • polygonscan -> polygon
  • snowtrace -> avalanche

pub fn local(path: impl AsRef<str>) -> Result<Self>

Creates a local filesystem source from a path string.

pub fn is_string(&self) -> bool

Returns true if self is String.

pub fn as_string(&self) -> Option<&String>

Returns self as String.

pub fn is_local(&self) -> bool

Returns true if self is Local.

pub fn as_local(&self) -> Option<&PathBuf>

Returns self as Local.

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 Default for Source

fn default() -> Self

Returns the “default value” for a type.

impl FromStr for Source

type Err = Report

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 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: &Rhs) -> bool

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

impl Eq for Source

impl StructuralPartialEq for Source