[E2E] Call builders and extra gas margin option

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ## Changed
+- [E2E] E2E call builders and extra gas margin option - [#1917](https://github.com/paritytech/ink/pull/1917)
 - Make `set_code_hash` generic - [#1906](https://github.com/paritytech/ink/pull/1906)
 
 ## Version 5.0.0-alpha

crates/e2e/src/backend.rs

@@ -14,7 +14,9 @@
 
 use super::Keypair;
 use crate::{
+    backend_calls::InstantiateBuilder,
     builders::CreateBuilderPartial,
+    CallBuilder,
     CallBuilderFinal,
     CallDryRunResult,
     CallResult,
@@ -42,7 +44,7 @@ pub trait ChainBackend {
     /// Account type.
     type AccountId;
     /// Balance type.
-    type Balance: Send;
+    type Balance: Send + From<u32>;
     /// Error type.
     type Error;
     /// Event log type.
@@ -93,6 +95,18 @@ pub trait ContractsBackend<E: Environment> {
     /// Event log type.
     type EventLog;
 
+    fn create_instantiate_call<'a, Contract, Args: Send + scale::Encode, R>(
+        &'a mut self,
+        contract_name: &'a str,
+        caller: &'a Keypair,
+        constructor: CreateBuilderPartial<E, Contract, Args, R>,
+    ) -> InstantiateBuilder<'a, E, Contract, Args, R, Self>
+    where
+        Self: Sized,
+    {
+        InstantiateBuilder::new(self, caller, contract_name, constructor)
+    }
+
     /// The function subsequently uploads and instantiates an instance of the contract.
     ///
     /// This function extracts the metadata of the contract at the file path
@@ -107,6 +121,7 @@ pub trait ContractsBackend<E: Environment> {
         caller: &Keypair,
         constructor: CreateBuilderPartial<E, Contract, Args, R>,
         value: E::Balance,
+        extra_gas_portion: Option<usize>,
         storage_deposit_limit: Option<E::Balance>,
     ) -> Result<InstantiationResult<E, Self::EventLog>, Self::Error>;
 
@@ -134,6 +149,18 @@ pub trait ContractsBackend<E: Environment> {
         storage_deposit_limit: Option<E::Balance>,
     ) -> Result<UploadResult<E, Self::EventLog>, Self::Error>;
 
+    /// Creates a call builder then can later be submitted.
+    fn create_call<'a, Args: Sync + scale::Encode, RetType: Send + scale::Decode>(
+        &'a mut self,
+        caller: &'a Keypair,
+        message: &'a CallBuilderFinal<E, Args, RetType>,
+    ) -> CallBuilder<'a, E, Args, RetType, Self>
+    where
+        Self: Sized,
+    {
+        CallBuilder::new(self, caller, message)
+    }
+
     /// Executes a `call` for the contract at `account_id`.
     ///
     /// Returns when the transaction is included in a block. The return value
@@ -143,6 +170,7 @@ pub trait ContractsBackend<E: Environment> {
         caller: &Keypair,
         message: &CallBuilderFinal<E, Args, RetType>,
         value: E::Balance,
+        extra_gas_portion: Option<usize>,
         storage_deposit_limit: Option<E::Balance>,
     ) -> Result<CallResult<E, RetType, Self::EventLog>, Self::Error>
     where

crates/e2e/src/backend_calls.rs

@@ -0,0 +1,229 @@
+use ink_env::Environment;
+use pallet_contracts_primitives::ContractInstantiateResult;
+use scale::{
+    Decode,
+    Encode,
+};
+
+use crate::{
+    builders::CreateBuilderPartial,
+    CallBuilderFinal,
+    CallDryRunResult,
+    CallResult,
+    ContractsBackend,
+    InstantiationResult,
+};
+
+use super::Keypair;
+
+pub struct CallBuilder<'a, E, Args, RetType, CB>
+where
+    E: Environment,
+    Args: Sync + Encode,
+    RetType: Send + Decode,
+
+    CB: ContractsBackend<E>,
+{
+    client: &'a mut CB,
+    caller: &'a Keypair,
+    message: &'a CallBuilderFinal<E, Args, RetType>,
+    value: E::Balance,
+    extra_gas_portion: Option<usize>,
+    storage_deposit_limit: Option<E::Balance>,
+}
+
+impl<'a, E, Args, RetType, CB> CallBuilder<'a, E, Args, RetType, CB>
+where
+    E: Environment,
+    Args: Sync + Encode,
+    RetType: Send + Decode,
+    E::Balance: Clone,
+
+    CB: ContractsBackend<E>,
+{
+    /// Initialize a call builder with essential values.
+    pub fn new(
+        client: &'a mut CB,
+        caller: &'a Keypair,
+        message: &'a CallBuilderFinal<E, Args, RetType>,
+    ) -> CallBuilder<'a, E, Args, RetType, CB>
+    where
+        E::Balance: From<u32>,
+    {
+        Self {
+            client,
+            caller,
+            message,
+            value: 0u32.into(),
+            extra_gas_portion: None,
+            storage_deposit_limit: None,
+        }
+    }
+
+    /// Provide value with a call
+    pub fn value(&mut self, value: E::Balance) {
+        self.value = value;
+    }
+
+    /// Increases the gas limit marginally by a specified percent.
+    /// Useful when the message's gas usage depends on the runtime state
+    /// and the dry run does not produce an accurate gas estimate.
+    ///
+    /// # Example
+    ///
+    /// With dry run gas estimate of `100` units and `5`% extra gas portion specified,
+    /// the set gas limit becomes `105` units
+    pub fn extra_gas_portion(&mut self, per_cent: usize) {
+        if per_cent == 0 {
+            self.extra_gas_portion = None
+        } else {
+            self.extra_gas_portion = Some(per_cent)
+        }
+    }
+
+    /// Specify the max amount of funds that can be charged for storage.
+    pub fn storage_deposit_limit(&mut self, storage_deposit_limit: E::Balance) {
+        if storage_deposit_limit == 0u32.into() {
+            self.storage_deposit_limit = None
+        } else {
+            self.storage_deposit_limit = Some(storage_deposit_limit)
+        }
+    }
+
+    /// Submit the call for the on-chain execution.
+    pub async fn submit(
+        &mut self,
+    ) -> Result<CallResult<E, RetType, CB::EventLog>, CB::Error>
+    where
+        CallBuilderFinal<E, Args, RetType>: Clone,
+    {
+        CB::call(
+            self.client,
+            self.caller,
+            self.message,
+            self.value,
+            self.extra_gas_portion,
+            self.storage_deposit_limit,
+        )
+        .await
+    }
+
+    /// Dry run the call.
+    pub async fn submit_dry_run(&mut self) -> CallDryRunResult<E, RetType>
+    where
+        CallBuilderFinal<E, Args, RetType>: Clone,
+    {
+        CB::call_dry_run(
+            self.client,
+            self.caller,
+            self.message,
+            self.value,
+            self.storage_deposit_limit,
+        )
+        .await
+    }
+}
+
+pub struct InstantiateBuilder<'a, E, Contract, Args, R, CB>
+where
+    E: Environment,
+    Args: Send + Encode,
+
+    CB: ContractsBackend<E>,
+{
+    client: &'a mut CB,
+    caller: &'a Keypair,
+    contract_name: &'a str,
+    constructor: CreateBuilderPartial<E, Contract, Args, R>,
+    value: E::Balance,
+    extra_gas_portion: Option<usize>,
+    storage_deposit_limit: Option<E::Balance>,
+}
+
+impl<'a, E, Contract, Args, R, CB> InstantiateBuilder<'a, E, Contract, Args, R, CB>
+where
+    E: Environment,
+    Args: Send + Encode,
+
+    CB: ContractsBackend<E>,
+{
+    /// Initialize a call builder with essential values.
+    pub fn new(
+        client: &'a mut CB,
+        caller: &'a Keypair,
+        contract_name: &'a str,
+        constructor: CreateBuilderPartial<E, Contract, Args, R>,
+    ) -> InstantiateBuilder<'a, E, Contract, Args, R, CB>
+    where
+        E::Balance: From<u32>,
+    {
+        Self {
+            client,
+            caller,
+            contract_name,
+            constructor,
+            value: 0u32.into(),
+            extra_gas_portion: None,
+            storage_deposit_limit: None,
+        }
+    }
+
+    /// Provide value with a call
+    pub fn value(&mut self, value: E::Balance) {
+        self.value = value;
+    }
+
+    /// Increases the gas limit marginally by a specified percent.
+    /// Useful when the message's gas usage depends on the runtime state
+    /// and the dry run does not produce an accurate gas estimate.
+    ///
+    /// # Example
+    ///
+    /// With dry run gas estimate of `100` units and `5`% extra gas portion specified,
+    /// the set gas limit becomes `105` units
+    pub fn extra_gas_portion(&mut self, per_cent: usize) {
+        if per_cent == 0 {
+            self.extra_gas_portion = None
+        } else {
+            self.extra_gas_portion = Some(per_cent)
+        }
+    }
+
+    /// Specify the max amount of funds that can be charged for storage.
+    pub fn storage_deposit_limit(&mut self, storage_deposit_limit: E::Balance) {
+        if storage_deposit_limit == 0u32.into() {
+            self.storage_deposit_limit = None
+        } else {
+            self.storage_deposit_limit = Some(storage_deposit_limit)
+        }
+    }
+
+    /// Submit the instantiate call for the on-chain execution.
+    pub async fn submit(self) -> Result<InstantiationResult<E, CB::EventLog>, CB::Error> {
+        CB::instantiate(
+            self.client,
+            self.contract_name,
+            self.caller,
+            self.constructor,
+            self.value,
+            self.extra_gas_portion,
+            self.storage_deposit_limit,
+        )
+        .await
+    }
+
+    /// Dry run the instantiate call.
+    pub async fn submit_dry_run(
+        self,
+    ) -> ContractInstantiateResult<E::AccountId, E::Balance, ()> {
+        CB::instantiate_dry_run(
+            self.client,
+            self.contract_name,
+            self.caller,
+            self.constructor,
+            self.value,
+            self.storage_deposit_limit,
+        )
+        .await
+    }
+}

crates/e2e/src/drink_client.rs

@@ -195,18 +195,24 @@ where
         caller: &Keypair,
         constructor: CreateBuilderPartial<E, Contract, Args, R>,
         value: E::Balance,
+        extra_gas_portion: Option<usize>,
         storage_deposit_limit: Option<E::Balance>,
     ) -> Result<InstantiationResult<E, Self::EventLog>, Self::Error> {
         let code = self.contracts.load_code(contract_name);
         let data = constructor_exec_input(constructor);
 
+        let mut gas_limit = DEFAULT_GAS_LIMIT;
+        if let Some(gas_portion) = extra_gas_portion {
+            gas_limit += gas_limit / 100 * (gas_portion as u64);
+        }
+
         let result = self.sandbox.deploy_contract(
             code,
             value,
             data,
             salt(),
             keypair_to_account(caller),
-            DEFAULT_GAS_LIMIT,
+            gas_limit,
             storage_deposit_limit,
         );
 
@@ -291,6 +297,7 @@ where
         caller: &Keypair,
         message: &CallBuilderFinal<E, Args, RetType>,
         value: E::Balance,
+        extra_gas_portion: Option<usize>,
         storage_deposit_limit: Option<E::Balance>,
     ) -> Result<CallResult<E, RetType, Self::EventLog>, Self::Error>
     where
@@ -300,12 +307,17 @@ where
         let exec_input = Encode::encode(message.clone().params().exec_input());
         let account_id = (*account_id.as_ref()).into();
 
+        let mut gas_limit = DEFAULT_GAS_LIMIT;
+        if let Some(gas_portion) = extra_gas_portion {
+            gas_limit += gas_limit / 100 * (gas_portion as u64);
+        }
+
         let result = self.sandbox.call_contract(
             account_id,
             value,
             exec_input,
             keypair_to_account(caller),
-            DEFAULT_GAS_LIMIT,
+            gas_limit,
             storage_deposit_limit,
         );
 

crates/e2e/src/lib.rs

@@ -20,6 +20,7 @@
 )]
 
 mod backend;
+mod backend_calls;
 mod builders;
 mod client_utils;
 mod contract_build;
@@ -41,6 +42,10 @@ pub use backend::{
     ContractsBackend,
     E2EBackend,
 };
+pub use backend_calls::{
+    CallBuilder,
+    InstantiateBuilder,
+};
 pub use contract_results::{
     CallDryRunResult,
     CallResult,