Enum Source

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

A source of an artifact JSON.

Variants

Local(PathBuf)

File on the local file system.

Http(Url)

Resource in the internet, available via HTTP(S).

Etherscan(Address)

An address of a mainnet contract, available via Etherscan.

Artifacts loaded from etherstan can be parsed using the truffle loader.

Note that Etherscan rate-limits requests to their API, to avoid this, provide an Etherscan API key via the ETHERSCAN_API_KEY environment variable.

Npm(String)

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

Implementations

impl Source

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

Parses an artifact source from a string.

This method accepts the following:

• relative path to a contract JSON file on the local filesystem, for example build/IERC20.json. This relative path is rooted in the current working directory. To specify the root for relative paths, use [with_root] function;

• absolute path to a contract JSON file on the local filesystem, or a file URL, for example /build/IERC20.json, or the same path using URL: file:///build/IERC20.json;

• an HTTP(S) URL pointing to artifact JSON or contract ABI JSON;

• a URL with etherscan scheme and a mainnet contract address. For example etherscan:0xC02AA.... Alternatively, specify an etherscan URL: https://etherscan.io/address/0xC02AA.... The contract artifact or ABI will be retrieved through [Etherscan];

• a URL with npm scheme, NPM package name, an optional version and a path (defaulting to the latest version and index.js). For example npm:@openzeppelin/contracts/build/contracts/IERC20.json. The contract artifact or ABI will be retrieved through [unpkg].

pub fn with_root(root: impl AsRef<Path>, source: &str) -> Result<Self>

Parses an artifact source from a string and uses the specified root directory for resolving relative paths. See [parse] for more details on supported source strings.

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

Creates a local filesystem source from a path string.

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

Creates an HTTP source from a URL.

pub fn etherscan(address: &str) -> Result<Self>

Creates an Etherscan source from contract address on mainnet.

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

Creates an NPM source from a package path.

pub fn artifact_json(&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.

Contract ABIs will be wrapped into a JSON object, so that you can load them using the truffle loader.

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a duplicate 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 for Source

fn eq(&self, other: &Source) -> 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 Eq for Source

impl StructuralPartialEq for Source