@imtbl/sdk 1.43.2-alpha.8 → 1.43.2-alpha.9

package/dist/checkout.js

@@ -141,7 +141,7 @@ const flattenProperties$1 = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION$1 = '1.43.2-alpha.8';
+const SDK_VERSION$1 = '1.43.2-alpha.9';
 const getFrameParentDomain$1 = () => {
     if (isNode$1()) {
         return '';
@@ -14311,13 +14311,8 @@ async function getWithdrawRootToken(childToken, destinationChainId, childProvide
 }
 
 /* eslint-disable @typescript-eslint/naming-convention */
-// TODO generate a type for these state objects. Readability could be improved from the double nested Record
 /**
- * Submits tenderly simulations, returning an array of gas usage estimates
- * @param chainId ID of network to estimate transactions on
- * @param simulations Array of TenderlySimulation objects (transactions) to estimate gas usage for
- * @param state_objects A double-nested record which can be used to change the state of smart contracts in the simulation.
- * @returns Array of gas usage estimates.
+ * We want to convert a StateObject type to the following format (Record<string, Record<string, Record<string, string>>>):
  * @example An example of a state object that changes the state at slot 0xe1b959...2585e to 1 at address 0xe43215...8E31:
  *  {
  *    "0xe432150cce91c13a887f7D836923d5597adD8E31": {
@@ -14328,9 +14323,32 @@ async function getWithdrawRootToken(childToken, destinationChainId, childProvide
  *    }
  *  }
  */
-async function submitTenderlySimulations(chainId, simulations, state_objects) {
+function unwrapStateObjects(stateObjects) {
+    const unwrappedStateObjects = {};
+    stateObjects.forEach((stateObject) => {
+        const { contractAddress, stateDiff } = stateObject;
+        const { storageSlot, value } = stateDiff;
+        if (unwrappedStateObjects[contractAddress] === undefined) {
+            unwrappedStateObjects[contractAddress] = {
+                stateDiff: {},
+            };
+        }
+        unwrappedStateObjects[contractAddress].stateDiff[storageSlot] = value;
+    });
+    return unwrappedStateObjects;
+}
+/**
+ * Submits tenderly simulations, returning an array of gas usage estimates
+ * @param chainId ID of network to estimate transactions on
+ * @param simulations Array of TenderlySimulation objects (transactions) to estimate gas usage for
+ * @param stateObjects An array of `StateObject`s. Each `StateObject` represents one smart contract state change.
+ *                     These `StateObject`s get unwrapped into Tenderly's required format.
+ * @returns Array of gas usage estimates.
+ */
+async function submitTenderlySimulations(chainId, simulations, stateObjects) {
     let axiosResponse;
     const tenderlyAPI = getTenderlyEndpoint(chainId);
+    const state_objects = stateObjects ? unwrapStateObjects(stateObjects) : undefined;
     try {
         axiosResponse = await axios$1.post(tenderlyAPI, {
             jsonrpc: '2.0',
@@ -14370,6 +14388,54 @@ async function submitTenderlySimulations(chainId, simulations, state_objects) {
     return gas;
 }
 
+const trueInHex = '0x0000000000000000000000000000000000000000000000000000000000000001';
+
+/**
+ * @param sender Bridge depositer/withdrawer
+ * @param recipient Deposit or withdrawal recipient
+ * @param amount Amount to deposit or withdraw
+ * @param token Token to deposit or withdraw. NATIVE if native asset on the source chain.
+ * @param currentBridgeMethods A Record mapping bridge operation names to contract method names
+ * @param bridgeContract: The bridge contract to be interacting with dependinig on network and if it's a deposit or withdrawal
+ * @returns calldata for the requested bridge transaction (i.e. tx.data)
+ */
+async function getBridgeTxCalldata(sender, recipient, amount, token, currentBridgeMethods, bridgeContract) {
+    let functionName;
+    let parameters;
+    /**
+     * Handle bridge transaction for native token
+     */
+    if (token.toUpperCase() === NATIVE$1) {
+        if (sender === recipient) {
+            // Deposit or withdraw native token
+            functionName = currentBridgeMethods.native;
+            parameters = [amount];
+        }
+        else {
+            // Deposit or withdraw native token TO
+            functionName = currentBridgeMethods.nativeTo;
+            parameters = [recipient, amount];
+        }
+    }
+    else {
+        /**
+         * Handle bridge transaction for ERC20
+         */
+        const erc20Token = getAddress(token);
+        if (sender === recipient) {
+            // Deposit or withdraw ERC20
+            functionName = currentBridgeMethods.token;
+            parameters = [erc20Token, amount];
+        }
+        else {
+            // Deposit or withdraw ERC20 TO.
+            functionName = currentBridgeMethods.tokenTo;
+            parameters = [erc20Token, recipient, amount];
+        }
+    }
+    return await withBridgeError(async () => bridgeContract.interface.encodeFunctionData(functionName, parameters), BridgeErrorType.INTERNAL_ERROR);
+}
+
 const ROOT_ERC20_BRIDGE_FLOW_RATE = [
     {
         inputs: [
@@ -18210,43 +18276,10 @@ class TokenBridge {
      * @param sourceChainId Chain ID of the source chain
      * @returns calldata for the requested bridge transaction (i.e. tx.data)
      */
-    async getTxData(sender, recipient, amount, token, direction) {
+    async getConfigAndBridgeTxCalldata(sender, recipient, amount, token, direction) {
         const currentBridgeMethods = await this.getBridgeMethods(direction);
         const bridgeContract = await this.getBridgeContract(direction);
-        let functionName;
-        let parameters;
-        /**
-         * Handle bridge transaction for native token
-         */
-        if (token.toUpperCase() === NATIVE$1) {
-            if (sender === recipient) {
-                // Deposit or withdraw native token
-                functionName = currentBridgeMethods.native;
-                parameters = [amount];
-            }
-            else {
-                // Deposit or withdraw native token TO
-                functionName = currentBridgeMethods.nativeTo;
-                parameters = [recipient, amount];
-            }
-        }
-        else {
-            /**
-             * Handle bridge transaction for ERC20
-             */
-            const erc20Token = getAddress(token);
-            if (sender === recipient) {
-                // Deposit or withdraw ERC20
-                functionName = currentBridgeMethods.token;
-                parameters = [erc20Token, amount];
-            }
-            else {
-                // Deposit or withdraw ERC20 TO.
-                functionName = currentBridgeMethods.tokenTo;
-                parameters = [erc20Token, recipient, amount];
-            }
-        }
-        return await withBridgeError(async () => bridgeContract.interface.encodeFunctionData(functionName, parameters), BridgeErrorType.INTERNAL_ERROR);
+        return getBridgeTxCalldata(sender, recipient, amount, token, currentBridgeMethods, bridgeContract);
     }
     /**
      * Generates an unsigned deposit or withdrawal transaction for a user to sign and submit to the bridge.
@@ -18475,7 +18508,7 @@ class TokenBridge {
             unsignedApprovalTx = null;
         }
         // Deposit transaction & fees.
-        const txData = await this.getTxData(sender, recipient, amount, token, direction);
+        const txData = await this.getConfigAndBridgeTxCalldata(sender, recipient, amount, token, direction);
         const txValue = (token.toUpperCase() === NATIVE$1)
             ? amount.add(bridgeFee).toString() : bridgeFee.toString();
         const unsignedBridgeTx = {
@@ -18537,7 +18570,7 @@ class TokenBridge {
             unsignedApprovalTx = null;
         }
         // Withdraw transaction & fees.
-        const txData = await this.getTxData(sender, recipient, amount, token, direction);
+        const txData = await this.getConfigAndBridgeTxCalldata(sender, recipient, amount, token, direction);
         const txValue = (token.toUpperCase() === NATIVE$1)
             ? amount.add(bridgeFee).toString() : bridgeFee.toString();
         const unsignedBridgeTx = {
@@ -18586,7 +18619,7 @@ class TokenBridge {
             destinationChainId: this.config.bridgeInstance.childChainID,
         };
         // Get tx data
-        const txData = await this.getTxData(sender, recipient, amount, token, direction);
+        const txData = await this.getConfigAndBridgeTxCalldata(sender, recipient, amount, token, direction);
         // tx value for simulation mocked as amount + 1 wei for a native bridge and 1 wei for token bridges
         // hexValue() is required to remove leading zeros, which tenderly does not support.
         const txValue = (token.toUpperCase() !== NATIVE$1) ? '0x1' : hexValue(amount.add('1').toHexString());
@@ -18622,7 +18655,7 @@ class TokenBridge {
         // Calculate slot key for given command ID.
         const command = defaultAbiCoder.encode(['bytes32', 'bytes32', 'string', 'string', 'address', 'bytes32'], [SLOT_PREFIX_CONTRACT_CALL_APPROVED, commandId, sourceChain, sourceAddress, destinationAddress, payloadHash]);
         const commandHash = keccak256(command);
-        const slot = keccak256(concat([
+        const gatewayCallApprovedSlot = keccak256(concat([
             commandHash,
             hexlify(zeroPad(hexlify(SLOT_POS_CONTRACT_CALL_APPROVED), 32)),
         ]));
@@ -18637,14 +18670,14 @@ class TokenBridge {
                 to: destinationAddress,
                 data: executeData,
             }];
-        const gas = await submitTenderlySimulations(destinationChainId, simulations, {
-            [axelarGateway]: {
-                stateDiff: {
-                    // Override storage to approve this command.
-                    [slot]: '0x0000000000000000000000000000000000000000000000000000000000000001',
-                },
+        const stateObject = {
+            contractAddress: axelarGateway,
+            stateDiff: {
+                storageSlot: gatewayCallApprovedSlot,
+                value: trueInHex,
             },
-        });
+        };
+        const gas = await submitTenderlySimulations(destinationChainId, simulations, [stateObject]);
         return gas[0];
     }
     async getAllowance(direction, token, sender) {
@@ -19518,7 +19551,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.43.2-alpha.8';
+const SDK_VERSION = '1.43.2-alpha.9';
 const getFrameParentDomain = () => {
     if (isNode()) {
         return '';
@@ -31072,7 +31105,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.43.2-alpha.8',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.43.2-alpha.9',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -32604,7 +32637,7 @@ const IMMUTABLE_ZKVEM_GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(10e9),
 };
 
-const SDK_VERSION_MARKER = '1.43.2-alpha.8';
+const SDK_VERSION_MARKER = '1.43.2-alpha.9';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 

package/dist/config.js

@@ -128,7 +128,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.43.2-alpha.8';
+const SDK_VERSION = '1.43.2-alpha.9';
 const getFrameParentDomain = () => {
     if (isNode()) {
         return '';