Struct ethcontract::contract::Instance

pub struct Instance<T: Transport> {
    pub defaults: MethodDefaults,
    // some fields omitted
}

Represents a contract instance at an address. Provides methods for contract interaction.

Fields

defaults: MethodDefaults

Default method parameters to use when sending method transactions or querying method calls.

Methods

impl<T: Transport> Instance<T>

pub fn at(web3: Web3<T>, abi: Abi, address: Address) -> Self

Creates a new contract instance with the specified web3 provider with the given Abi at the given Address.

Note that this does not verify that a contract with a matchin Abi is actually deployed at the given address.

pub fn deployed(web3: Web3<T>, artifact: Artifact) -> DeployedFuture<T, Self>

Locates a deployed contract based on the current network ID reported by the web3 provider from the given Artifact's ABI and networks.

Note that this does not verify that a contract with a matchin Abi is actually deployed at the given address.

pub fn builder<P>(
    web3: Web3<T>,
    artifact: Artifact,
    params: P
) -> Result<DeployBuilder<T, Self>, DeployError> where
    P: Tokenize, 

Creates a contract builder with the specified web3 provider and the given Artifact byte code. This allows the contract deployment transaction to be configured before deploying the contract.

pub fn link_and_deploy<'a, P, I>(
    web3: Web3<T>,
    artifact: Artifact,
    params: P,
    libraries: I
) -> Result<DeployBuilder<T, Self>, DeployError> where
    P: Tokenize,
    I: Iterator<Item = (&'a str, Address)>, 

Deploys a contract with the specified web3 provider with the given Artifact byte code and linking libraries.

pub fn web3(&self) -> Web3<T>

Retrieve the underlying web3 provider used by this contract instance.

pub fn abi(&self) -> &Abi

Retrieves the contract ABI for this instance.

pub fn address(&self) -> Address

Returns the contract address being used by this instance.

pub fn method<S, P, R>(
    &self,
    name: S,
    params: P
) -> AbiResult<MethodBuilder<T, R>> where
    S: AsRef<str>,
    P: Tokenize, 

Returns a method builder to setup a call or transaction on a smart contract method. Note that calls just get evaluated on a node but do not actually commit anything to the block chain.

pub fn view_method<S, P, R>(
    &self,
    name: S,
    params: P
) -> AbiResult<ViewMethodBuilder<T, R>> where
    S: AsRef<str>,
    P: Tokenize,
    R: Detokenize, 

Returns a view method builder to setup a call to a smart contract. View method builders can't actually send transactions and only query contract state.

pub fn event<S>(&self, name: S) -> AbiResult<LogStream<T>> where
    S: AsRef<str>, 

Returns a log stream for the specified event that emits a new log for every new event emitted after the stream was created.

Trait Implementations

impl<T: Clone + Transport> Clone for Instance<T>

fn clone(&self) -> Instance<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Transport> Debug for Instance<T>

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

Formats the value using the given formatter.

impl<T: Transport> Deploy<T> for Instance<T>

type Context = Linker

The type of the contract instance being created.

fn abi(cx: &Self::Context) -> &Abi

Gets a reference the contract ABI.

fn bytecode(cx: &Self::Context) -> &Bytecode

Gets a reference to the contract bytecode.

fn at_address(web3: Web3<T>, address: Address, cx: Self::Context) -> Self

Create a contract instance from the specified address.

impl<T: Transport> FromNetwork<T> for Instance<T>

type Context = Deployments

Context passed to the Deployments.

fn from_network(
    web3: Web3<T>,
    network_id: &str,
    cx: Self::Context
) -> Option<Self>

Create a contract instance for the specified network. This method should return None when no deployment can be found for the specified network ID.