Struct cubist_sdk::Contract

pub struct Contract<M: Middleware = HttpStack> {
    pub is_shim: bool,
    pub project: Arc<TargetProject<M>>,
    pub meta: ContractInfo,
    pub shims: HashMap<Target, Arc<Contract<M>>>,
    pub deps: Vec<Arc<Contract<M>>>,
    /* private fields */
}

Re-export some very commonly used types. Deployable contract.

Fields

is_shim: bool

Whether this is a shim.

project: Arc<TargetProject<M>>

Project for the target chain (where this contract is deployed)

meta: ContractInfo

Contract metadata

shims: HashMap<Target, Arc<Contract<M>>>

Generated shims interfaces of this contract (one per other chain).

Deploying a contract implies deploying all of its shims. Bridging is done only between the contracts within the same deployment cluster.

If this contract is a shim itself, this map is empty.

deps: Vec<Arc<Contract<M>>>

Shims of other contracts (on this target) that this contract is allowed to call.

Implementations

impl<M: Middleware> Contract<M>

pub fn shim(project: Arc<TargetProject<M>>, meta: ContractInfo) -> Self

Create new shim contract for a given chain project.

Arguments

• project - TargetProject corresponding to the chain where this shim is to be deployed.
• meta - contract metadata (name, abi, bytecode, etc.)

pub fn new(
    project: Arc<TargetProject<M>>,
    shims: HashMap<Target, Arc<Contract<M>>>,
    deps: Vec<Arc<Contract<M>>>,
    meta: ContractInfo
) -> Self

Create new (non-shim) contract for a given chain project.

Arguments

• project - TargetProject corresponding to the chain for which this contract is defined.
• shims - shims (interfaces) of this contract auto-generated for other chains.
• deps - shims (interfaces) of other contract (on this target) that this contract is allowed to call.
• meta - contract metadata (name, abi, bytecode, etc.)

pub async fn when_bridged(&self, delays: &Vec<Duration>) -> bool

Returns a future that completes once this contract has been bridged (in which case the result is true) or when the timeout expires (in which case the result is false).

Arguments

• delays - how long to wait between retries

Panics

• if address is not initialized (either by calling at or deploy)

pub fn full_name(&self) -> String

Full contract name in the format of {file_name}:{contract_name}

pub fn full_name_with_target(&self) -> String

Full contract name + the target chain.

pub fn name_with_target_and_address(&self) -> String

Contract name + deployed address + the target chain.

pub fn address_and_target(&self) -> String

Contract address @ target chain.

pub fn address(&self) -> Option<Address>

Address if the contract has been deployed (or loaded from disk), None otherwise.

pub fn target(&self) -> Target

The chain that this contract is targeting.

pub fn is_deployed(&self) -> bool

Whether this contract is deployed.

pub fn try_address_on(&self, target: Target) -> Option<Address>

Try to find deployed address of this contract or one of its shims corresponding to the given chain target.

pub fn address_on(&self, target: Target) -> Address

Same as Self::try_address_on except that it panics instead of returning None.

Panics

If this contract has not been deployed on target target.

pub async fn deploy<T>(&self, args: T) -> Result<(Address, Arc<M>)>where
    T: Tokenize,

First deploy all generated shims to their chains; then deploy this contract to its target chain.

May be called multiple times; once deployed, subsequent calls become no-op.

pub async fn deploy_shims(&self) -> Result<()>

Deploy only this contract’s shims. May be called multiple times; once deployed, subsequent calls become no-op (this is true because deploy_self has this property).

pub async fn at(&self, addr: Address) -> Result<()>

Set address of this contract. Returns an error if address is already set and is different from addr.

pub async fn deployed(&self) -> Result<Address>

Initialize this contract from its deployment receipt. No-op if the contract is already deployed/initialized. Otherwise, succeeds only if there is exactly one corresponding deployment receipt found. The return value is the contract address.

pub async fn call<TArgs, TRet>(&self, name: &str, args: TArgs) -> Result<TRet>where
    TArgs: Tokenize,
    TRet: Detokenize,

Call a method on this contract.

pub async fn send<TArgs>(
    &self,
    name: &str,
    args: TArgs
) -> Result<Option<TransactionReceipt>>where
    TArgs: Tokenize,

Send a transaction to this contract.

pub fn inner(&self) -> Result<&Contract<M>>

Return the inner (ethers) contract implementation if the contract has been deployed.