Struct cubist_sdk::Contract

source ·
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 */
}
Expand description

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§

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.)

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.)

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)

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

Full contract name + the target chain.

Contract name + deployed address + the target chain.

Contract address @ target chain.

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

The chain that this contract is targeting.

Whether this contract is deployed.

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

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.

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.

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).

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

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.

Call a method on this contract.

Send a transaction to this contract.

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

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Set the foreground color generically Read more
Set the background color generically. Read more
Change the foreground color to black
Change the background color to black
Change the foreground color to red
Change the background color to red
Change the foreground color to green
Change the background color to green
Change the foreground color to yellow
Change the background color to yellow
Change the foreground color to blue
Change the background color to blue
Change the foreground color to magenta
Change the background color to magenta
Change the foreground color to purple
Change the background color to purple
Change the foreground color to cyan
Change the background color to cyan
Change the foreground color to white
Change the background color to white
Change the foreground color to the terminal default
Change the background color to the terminal default
Change the foreground color to bright black
Change the background color to bright black
Change the foreground color to bright red
Change the background color to bright red
Change the foreground color to bright green
Change the background color to bright green
Change the foreground color to bright yellow
Change the background color to bright yellow
Change the foreground color to bright blue
Change the background color to bright blue
Change the foreground color to bright magenta
Change the background color to bright magenta
Change the foreground color to bright purple
Change the background color to bright purple
Change the foreground color to bright cyan
Change the background color to bright cyan
Change the foreground color to bright white
Change the background color to bright white
Make the text bold
Make the text dim
Make the text italicized
Make the text italicized
Make the text blink
Make the text blink (but fast!)
Swap the foreground and background colors
Hide the text
Cross out the text
Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Set the foreground color to a specific RGB value.
Set the background color to a specific RGB value.
Sets the foreground color to an RGB value.
Sets the background color to an RGB value.
Apply a runtime-determined style
The alignment of pointer.
The type for initializers.
Initializes a with the given initializer. Read more
Dereferences the given pointer. Read more
Mutably dereferences the given pointer. Read more
Drops the object pointed to by the given pointer. Read more
Should always be Self
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more