Struct ink_env::call::CreateBuilder

source ·
pub struct CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, RetType>where
    E: Environment,{ /* private fields */ }
Expand description

Builds up contract instantiations.

Implementations§

source§

impl<E, ContractRef, Limits, Endowment, Args, Salt, RetType> CreateBuilder<E, ContractRef, Unset<E::Hash>, Limits, Endowment, Args, Salt, RetType>where E: Environment,

source

pub fn code_hash( self, code_hash: E::Hash ) -> CreateBuilder<E, ContractRef, Set<E::Hash>, Limits, Endowment, Args, Salt, RetType>

Sets the used code hash for the contract instantiation.

source§

impl<E, ContractRef, CodeHash, Endowment, Args, Salt, RetType> CreateBuilder<E, ContractRef, CodeHash, Set<LimitParamsV1>, Endowment, Args, Salt, RetType>where E: Environment,

source

pub fn gas_limit(self, gas_limit: u64) -> Self

Sets the maximum allowed gas costs for the contract instantiation.

source§

impl<E, ContractRef, CodeHash, Endowment, Args, Salt, RetType> CreateBuilder<E, ContractRef, CodeHash, Set<LimitParamsV2<E>>, Endowment, Args, Salt, RetType>where E: Environment,

source

pub fn instantiate_v1( self ) -> CreateBuilder<E, ContractRef, CodeHash, Set<LimitParamsV1>, Endowment, Args, Salt, RetType>

Switch to the original instantiate host function API, which only allows the gas_limit limit parameter (equivalent to the ref_time_limit in the latest instantiate_v2).

This method instance is used to allow usage of the generated builder methods for constructors which initialize the builder with the new LimitParamsV2 type.

source

pub fn ref_time_limit(self, ref_time_limit: u64) -> Self

Sets the ref_time_limit part of the weight limit for the contract instantiation.

source

pub fn proof_size_limit(self, proof_size_limit: u64) -> Self

Sets the proof_size_limit part of the weight limit for the contract instantiation.

source

pub fn storage_deposit_limit(self, storage_deposit_limit: E::Balance) -> Self

Sets the storage_deposit_limit for the contract instantiation.

source§

impl<E, ContractRef, CodeHash, Limits, Args, Salt, RetType> CreateBuilder<E, ContractRef, CodeHash, Limits, Unset<E::Balance>, Args, Salt, RetType>where E: Environment,

source

pub fn endowment( self, endowment: E::Balance ) -> CreateBuilder<E, ContractRef, CodeHash, Limits, Set<E::Balance>, Args, Salt, RetType>

Sets the value transferred upon the execution of the call.

source§

impl<E, ContractRef, CodeHash, Limits, Endowment, Salt, RetType> CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Unset<ExecutionInput<EmptyArgumentList>>, Salt, RetType>where E: Environment,

source

pub fn exec_input<Args>( self, exec_input: ExecutionInput<Args> ) -> CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Set<ExecutionInput<Args>>, Salt, RetType>

Sets the value transferred upon the execution of the call.

source§

impl<E, ContractRef, CodeHash, Limits, Endowment, Args, RetType> CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Args, Unset<Salt>, RetType>where E: Environment,

source

pub fn salt_bytes<Salt>( self, salt: Salt ) -> CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Args, Set<Salt>, RetType>where Salt: AsRef<[u8]>,

Sets the value transferred upon the execution of the call.

source§

impl<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt> CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, Unset<ReturnType<()>>>where E: Environment,

source

pub fn returns<R>( self ) -> CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, Set<ReturnType<R>>>where ContractRef: FromAccountId<E>, R: ConstructorReturnType<ContractRef>,

Sets the type of the returned value upon the execution of the constructor.

Note

Constructors are not able to return arbitrary values. Instead a successful call to a constructor returns the address at which the contract was instantiated.

Therefore this must always be a reference (i.e ContractRef) to the contract you’re trying to instantiate.

source§

impl<E, ContractRef, Limits, Args, Salt, RetType> CreateBuilder<E, ContractRef, Set<E::Hash>, Set<Limits>, Set<E::Balance>, Set<ExecutionInput<Args>>, Set<Salt>, Set<ReturnType<RetType>>>where E: Environment,

source

pub fn params(self) -> CreateParams<E, ContractRef, Limits, Args, Salt, RetType>

Finalizes the create builder, allowing it to instantiate a contract.

source§

impl<E, ContractRef, Args, Salt, RetType> CreateBuilder<E, ContractRef, Set<E::Hash>, Set<LimitParamsV2<E>>, Set<E::Balance>, Set<ExecutionInput<Args>>, Set<Salt>, Set<ReturnType<RetType>>>where E: Environment, ContractRef: FromAccountId<E>, Args: Encode, Salt: AsRef<[u8]>, RetType: ConstructorReturnType<ContractRef>,

source

pub fn instantiate( self ) -> <RetType as ConstructorReturnType<ContractRef>>::Output

Instantiates the contract and returns its account ID back to the caller.

Panics

This method panics if it encounters an ink::env::Error or an [ink::primitives::LangError][ink_primitives::LangError]. If you want to handle those use the try_instantiate method instead.

source

pub fn try_instantiate( self ) -> Result<ConstructorResult<<RetType as ConstructorReturnType<ContractRef>>::Output>, Error>

Instantiates the contract and returns its account ID back to the caller.

Note

On failure this returns an outer ink::env::Error or inner [ink::primitives::LangError][ink_primitives::LangError], both of which can be handled by the caller.

source§

impl<E, ContractRef, Args, Salt, RetType> CreateBuilder<E, ContractRef, Set<E::Hash>, Set<LimitParamsV1>, Set<E::Balance>, Set<ExecutionInput<Args>>, Set<Salt>, Set<ReturnType<RetType>>>where E: Environment, ContractRef: FromAccountId<E>, Args: Encode, Salt: AsRef<[u8]>, RetType: ConstructorReturnType<ContractRef>,

source

pub fn instantiate( self ) -> <RetType as ConstructorReturnType<ContractRef>>::Output

Instantiates the contract and returns its account ID back to the caller.

Panics

This method panics if it encounters an ink::env::Error or an [ink::primitives::LangError][ink_primitives::LangError]. If you want to handle those use the try_instantiate method instead.

source

pub fn try_instantiate( self ) -> Result<ConstructorResult<<RetType as ConstructorReturnType<ContractRef>>::Output>, Error>

Instantiates the contract and returns its account ID back to the caller.

Note

On failure this returns an outer ink::env::Error or inner [ink::primitives::LangError][ink_primitives::LangError], both of which can be handled by the caller.

Trait Implementations§

source§

impl<E, ContractRef: Clone, CodeHash: Clone, Limits: Clone, Endowment: Clone, Args: Clone, Salt: Clone, RetType: Clone> Clone for CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, RetType>where E: Environment + Clone,

source§

fn clone( &self ) -> CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, RetType>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, RetType> RefUnwindSafe for CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, RetType>where Args: RefUnwindSafe, CodeHash: RefUnwindSafe, Endowment: RefUnwindSafe, Limits: RefUnwindSafe, RetType: RefUnwindSafe, Salt: RefUnwindSafe,

§

impl<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, RetType> Send for CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, RetType>where Args: Send, CodeHash: Send, Endowment: Send, Limits: Send, RetType: Send, Salt: Send,

§

impl<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, RetType> Sync for CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, RetType>where Args: Sync, CodeHash: Sync, Endowment: Sync, Limits: Sync, RetType: Sync, Salt: Sync,

§

impl<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, RetType> Unpin for CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, RetType>where Args: Unpin, CodeHash: Unpin, Endowment: Unpin, Limits: Unpin, RetType: Unpin, Salt: Unpin,

§

impl<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, RetType> UnwindSafe for CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, RetType>where Args: UnwindSafe, CodeHash: UnwindSafe, Endowment: UnwindSafe, Limits: UnwindSafe, RetType: UnwindSafe, Salt: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> DynClone for Twhere T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V