feat: SMR-3051 return withdrawal state (#2087)

packages/internal/bridge/sdk/src/lib/tenderly.test.ts

@@ -20,7 +20,7 @@ function generateAxiosData(
   return {
     jsonrpc: '2.0',
     id: 0,
-    method: 'tenderly_estimateGasBundle',
+    method: 'tenderly_simulateBundle',
     params: [
       simulations,
       'latest',
@@ -89,7 +89,7 @@ describe('Tenderly Utils', () => {
 
       mockedAxios.post.mockResolvedValueOnce({ data: expectedResponse });
 
-      const result = await submitTenderlySimulations(chainId, simulations);
+      const result = (await submitTenderlySimulations(chainId, simulations)).gas;
 
       expect(result.length).toEqual(1);
       expect(result[0]).toEqual(expectedResponse.result[0].gasUsed);
@@ -128,7 +128,7 @@ describe('Tenderly Utils', () => {
 
       mockedAxios.post.mockResolvedValueOnce({ data: expectedResponse });
 
-      const result = await submitTenderlySimulations(chainId, simulations);
+      const result = (await submitTenderlySimulations(chainId, simulations)).gas;
 
       expect(result.length).toEqual(2);
       expect(result[0]).toEqual(expectedResponse.result[0].gasUsed);
@@ -176,7 +176,7 @@ describe('Tenderly Utils', () => {
 
       mockedAxios.post.mockResolvedValueOnce({ data: expectedResponse });
 
-      const result = await submitTenderlySimulations(chainId, simulations, stateObjects);
+      const result = (await submitTenderlySimulations(chainId, simulations, stateObjects)).gas;
 
       expect(result.length).toEqual(2);
       expect(result[0]).toEqual(expectedResponse.result[0].gasUsed);

packages/internal/bridge/sdk/src/lib/tenderly.ts

@@ -2,7 +2,7 @@
 
 import axios, { AxiosResponse } from 'axios';
 import { BridgeError, BridgeErrorType } from '../errors';
-import { TenderlySimulation } from '../types/tenderly';
+import { TenderlySimulation, TenderlyResult } from '../types/tenderly';
 import { getTenderlyEndpoint } from './utils';
 
 // In the Tenderly API, state objects are mapping of contract address -> "stateDiff" -> slot -> value
@@ -17,6 +17,23 @@ export type StateDiff = {
   value: string;
 };
 
+type Input = {
+  name: string;
+  value: string | boolean;
+};
+
+type Event = {
+  name: string;
+  inputs: Array<Input>;
+};
+
+type Trace = {
+  method: string;
+  output: string | number;
+};
+
+const THRESHOLD_SELECTOR = '0x84a3291a0';
+
 /**
  * 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:
@@ -60,7 +77,7 @@ export async function submitTenderlySimulations(
   chainId: string,
   simulations: Array<TenderlySimulation>,
   stateObjects?: StateObject[],
-): Promise<Array<number>> {
+): Promise<TenderlyResult> {
   let axiosResponse: AxiosResponse;
   const tenderlyAPI = getTenderlyEndpoint(chainId);
   const state_objects = stateObjects ? unwrapStateObjects(stateObjects) : undefined;
@@ -70,7 +87,7 @@ export async function submitTenderlySimulations(
       {
         jsonrpc: '2.0',
         id: 0,
-        method: 'tenderly_estimateGasBundle',
+        method: 'tenderly_simulateBundle',
         params: [
           simulations,
           'latest',
@@ -103,7 +120,14 @@ export async function submitTenderlySimulations(
   }
 
   const gas: Array<number> = [];
+  let delayWithdrawalLargeAmount: boolean = false;
+  let delayWithdrawalUnknownToken: boolean = false;
+  let withdrawalQueueActivated: boolean = false;
+  let largeTransferThresholds: number = 0;
+  let skipReadOperation = false;
 
+  // Check if simulations are for token withdrawal
+  const withdrawal = simulations.find((e: TenderlySimulation) => e.data?.startsWith(THRESHOLD_SELECTOR)) !== undefined;
   for (let i = 0; i < simResults.length; i++) {
     if (simResults[i].error) {
       throw new BridgeError(
@@ -117,8 +141,34 @@ export async function submitTenderlySimulations(
         BridgeErrorType.TENDERLY_GAS_ESTIMATE_FAILED,
       );
     }
-    gas.push(simResults[i].gasUsed);
+    // Attempt to extract event.
+    if (withdrawal && simResults[i].logs !== undefined) {
+      const event = simResults[i].logs.find((e: Event) => e.name === 'QueuedWithdrawal');
+      if (event !== undefined) {
+        const inputs: Map<string, string | boolean> = new Map(event.inputs.map((c: Input) => [c.name, c.value]));
+        delayWithdrawalLargeAmount = inputs.get('delayWithdrawalLargeAmount') as boolean || false;
+        delayWithdrawalUnknownToken = inputs.get('delayWithdrawalUnknownToken') as boolean || false;
+        withdrawalQueueActivated = inputs.get('withdrawalQueueActivated') as boolean || false;
+      }
+    }
+    // Check read operation.
+    if (withdrawal && simResults[i].trace !== undefined) {
+      const trace: Trace = simResults[i].trace.find((e: Trace) => e.method === 'largeTransferThresholds');
+      if (trace !== undefined) {
+        largeTransferThresholds = trace.output as number;
+        skipReadOperation = true;
+      }
+    }
+    if (!skipReadOperation) {
+      gas.push(simResults[i].gasUsed);
+    }
   }
 
-  return gas;
+  return {
+    gas,
+    delayWithdrawalLargeAmount,
+    delayWithdrawalUnknownToken,
+    withdrawalQueueActivated,
+    largeTransferThresholds,
+  };
 }

packages/internal/bridge/sdk/src/tokenBridge.ts

@@ -17,7 +17,7 @@ import {
   isWrappedIMX,
   shouldBeDepositOrFinaliseWithdraw,
 } from './lib/utils';
-import { TenderlySimulation } from './types/tenderly';
+import { TenderlyResult, TenderlySimulation } from './types/tenderly';
 import { calculateGasFee } from './lib/gas';
 import { createContract } from './contracts/createContract';
 import { getWithdrawRootToken, genAxelarWithdrawPayload, genUniqueAxelarCommandId } from './lib/axelarUtils';
@@ -679,6 +679,10 @@ export class TokenBridge {
       contractToApprove,
       unsignedApprovalTx,
       unsignedBridgeTx,
+      delayWithdrawalLargeAmount: null,
+      delayWithdrawalUnknownToken: null,
+      withdrawalQueueActivated: null,
+      largeTransferThresholds: null,
     };
   }
 
@@ -690,7 +694,7 @@ export class TokenBridge {
     amount: ethers.BigNumber,
     gasMultiplier: number | string,
   ): Promise<BridgeBundledTxResponse> {
-    const [allowance, feeData, rootGas] = await Promise.all([
+    const [allowance, feeData, tenderlyRes] = await Promise.all([
       this.getAllowance(direction, token, sender),
       this.config.childProvider.getFeeData(),
       await this.getDynamicWithdrawGasRootChain(
@@ -701,6 +705,7 @@ export class TokenBridge {
         amount,
       ),
     ]);
+    const rootGas = tenderlyRes.gas[0];
     // Get axelar fee
     const axelarFee = await this.getAxelarFee(
       this.config.bridgeInstance.childChainID,
@@ -770,6 +775,10 @@ export class TokenBridge {
       contractToApprove,
       unsignedApprovalTx,
       unsignedBridgeTx,
+      delayWithdrawalLargeAmount: tenderlyRes.delayWithdrawalLargeAmount,
+      delayWithdrawalUnknownToken: tenderlyRes.delayWithdrawalUnknownToken,
+      withdrawalQueueActivated: tenderlyRes.withdrawalQueueActivated,
+      largeTransferThresholds: tenderlyRes.largeTransferThresholds,
     };
   }
 
@@ -828,7 +837,7 @@ export class TokenBridge {
     });
 
     // TODO this specific branch does not have tests written
-    const gas = await submitTenderlySimulations(sourceChainId, simulations);
+    const { gas } = await submitTenderlySimulations(sourceChainId, simulations);
     const tenderlyGasEstimatesRes = {} as DynamicGasEstimatesResponse;
     if (gas.length === 1) {
       tenderlyGasEstimatesRes.approvalGas = 0;
@@ -848,7 +857,7 @@ export class TokenBridge {
     recipient: string,
     token: FungibleToken,
     amount: ethers.BigNumber,
-  ): Promise<number> {
+  ): Promise<TenderlyResult> {
     const rootToken = await getWithdrawRootToken(token, destinationChainId, this.config.childProvider);
     const payload = genAxelarWithdrawPayload(
       rootToken,
@@ -893,6 +902,23 @@ export class TokenBridge {
       data: executeData,
     }];
 
+    // Read large transfer threshold for given token
+    const bridgeAddress = this.config.bridgeContracts.rootERC20BridgeFlowRate;
+    const bridgeContract = await createContract(
+      bridgeAddress,
+      ROOT_ERC20_BRIDGE_FLOW_RATE,
+      this.config.rootProvider,
+    );
+    // Get current bucket state
+    const readData = await withBridgeError<string>(async () => bridgeContract.interface.encodeFunctionData(
+      'largeTransferThresholds',
+      [rootToken],
+    ), BridgeErrorType.INTERNAL_ERROR);
+    simulations.push({
+      from: sender,
+      to: bridgeAddress,
+      data: readData,
+    });
     const stateObject: StateObject = {
       contractAddress: axelarGateway,
       stateDiff: {
@@ -901,8 +927,7 @@ export class TokenBridge {
       },
     };
 
-    const gas = await submitTenderlySimulations(destinationChainId, simulations, [stateObject]);
-    return gas[0];
+    return await submitTenderlySimulations(destinationChainId, simulations, [stateObject]);
   }
 
   private async getAllowance(direction: BridgeDirection, token: string, sender: string): Promise<ethers.BigNumber> {

packages/internal/bridge/sdk/src/types/index.ts

@@ -308,12 +308,20 @@ export interface BridgeBundledTxRequest {
  * @property {ethers.providers.TransactionRequest | null} unsignedApprovalTx - The unsigned transaction for the token approval, or null
  * if no approval is required.
  * @property {ethers.providers.TransactionRequest} unsignedBridgeTx - The unsigned transaction for the deposit / withdrawal.
+ * @property {boolean | null} delayWithdrawalLargeAmount - If withdrawal gets queued due to large amount.
+ * @property {boolean | null} delayWithdrawalUnknownToken - If withdrawal gets queued due to unknown token.
+ * @property {boolean | null} withdrawalQueueActivated - If withdrawal gets queued due to activated queue.
+ * @property {number | null} largeTransferThresholds - The configured large transfer threshold for given withdrawal token.
  */
 export interface BridgeBundledTxResponse {
   feeData: BridgeFeeResponse,
   contractToApprove: string | null,
   unsignedApprovalTx: ethers.providers.TransactionRequest | null;
   unsignedBridgeTx: ethers.providers.TransactionRequest;
+  delayWithdrawalLargeAmount: boolean | null;
+  delayWithdrawalUnknownToken: boolean | null;
+  withdrawalQueueActivated: boolean | null;
+  largeTransferThresholds: number | null;
 }
 
 /**

packages/internal/bridge/sdk/src/types/tenderly.ts

@@ -5,3 +5,11 @@ export type TenderlySimulation = {
   data?: string;
   value?: string;
 };
+
+export type TenderlyResult = {
+  gas: Array<number>;
+  delayWithdrawalLargeAmount: boolean;
+  delayWithdrawalUnknownToken: boolean;
+  withdrawalQueueActivated: boolean;
+  largeTransferThresholds: number;
+};