@rabby-wallet/gnosis-sdk 1.3.5 → 1.3.6

package/dist/api.d.ts

@@ -1,4 +1,5 @@
-import { Axios, AxiosAdapter } from 'axios';
+import { SafeTransactionDataPartial } from "@gnosis.pm/safe-core-sdk-types";
+import { Axios, AxiosAdapter } from "axios";
 export interface SafeInfo {
     address: string;
     fallbackHandler: string;
@@ -50,5 +51,6 @@ export default class RequestProvider {
     postTransactions(safeAddres: string, data: any): Promise<void>;
     getSafeInfo(safeAddress: string): Promise<SafeInfo>;
     confirmTransaction(hash: string, data: any): Promise<void>;
+    getSafeTxGas(safeAddress: string, safeVersion: string, safeTxData: SafeTransactionDataPartial): Promise<number | undefined>;
 }
 export {};

package/dist/api.js

@@ -1,25 +1,65 @@
-import axios from 'axios';
-import { toChecksumAddress } from 'web3-utils';
+import { isLegacyVersion } from "./utils";
+import axios from "axios";
+import { toChecksumAddress } from "web3-utils";
 const HOST_MAP = {
-    '1': 'https://safe-transaction-mainnet.safe.global/api/v1',
-    '137': 'https://safe-transaction-polygon.safe.global/api/v1',
-    '56': 'https://safe-transaction-bsc.safe.global/api/v1',
-    '100': 'https://safe-transaction-gnosis-chain.safe.global/api/v1',
-    '43114': 'https://safe-transaction-avalanche.safe.global/api/v1',
-    '42161': 'https://safe-transaction-arbitrum.safe.global/api/v1',
-    '10': 'https://safe-transaction-optimism.safe.global/api/v1',
-    '1313161554': 'https://safe-transaction-aurora.safe.global/api/v1',
+    /**
+     * eth
+     */
+    "1": "https://safe-transaction-mainnet.safe.global/api/v1",
+    /**
+     * polygon
+     */
+    "137": "https://safe-transaction-polygon.safe.global/api/v1",
+    /**
+     * bsc
+     */
+    "56": "https://safe-transaction-bsc.safe.global/api/v1",
+    /**
+     * Gnosis Chain
+     */
+    "100": "https://safe-transaction-gnosis-chain.safe.global/api/v1",
+    /**
+     * avalanche
+     */
+    "43114": "https://safe-transaction-avalanche.safe.global/api/v1",
+    /**
+     * arbitrum
+     */
+    "42161": "https://safe-transaction-arbitrum.safe.global/api/v1",
+    /**
+     * Optimism
+     */
+    "10": "https://safe-transaction-optimism.safe.global/api/v1",
+    /**
+     * Aurora
+     */
+    "1313161554": "https://safe-transaction-aurora.safe.global/api/v1",
+    /**
+     * Base
+     */
     "8453": "https://safe-transaction-base.safe.global/api/v1",
+    /**
+     * Celo
+     */
+    "42220": "https://safe-transaction-celo.safe.global/api/v1",
+    /**
+     * Polygon zkEVM
+     */
+    "1101": "https://safe-transaction-zkevm.safe.global/api/v1",
+    /**
+     * zksync era
+     */
+    "324": "https://safe-transaction-zksync.safe.global/api/v1",
 };
 export default class RequestProvider {
     constructor(networkId, adapter) {
         if (!(networkId in HOST_MAP)) {
-            throw new Error('Wrong networkId');
+            throw new Error("Wrong networkId");
         }
         this.host = HOST_MAP[networkId];
         this.request = axios.create({
             baseURL: this.host,
-            adapter
+            adapter,
         });
         this.request.interceptors.response.use((response) => {
             return response.data;
@@ -29,8 +69,8 @@ export default class RequestProvider {
         return this.request.get(`/safes/${toChecksumAddress(safeAddress)}/multisig-transactions/`, {
             params: {
                 executed: false,
-                nonce__gte: nonce
-            }
+                nonce__gte: nonce,
+            },
         });
     }
     postTransactions(safeAddres, data) {
@@ -42,4 +82,24 @@ export default class RequestProvider {
     confirmTransaction(hash, data) {
         return this.request.post(`/multisig-transactions/${hash}/confirmations/`, data);
     }
+    // https://github.com/safe-global/safe-wallet-web/blob/dev/src/services/tx/tx-sender/recommendedNonce.ts#L24
+    async getSafeTxGas(safeAddress, safeVersion, safeTxData) {
+        const isSafeTxGasRequired = isLegacyVersion(safeVersion);
+        // For 1.3.0+ Safes safeTxGas is not required
+        if (!isSafeTxGasRequired)
+            return 0;
+        const address = toChecksumAddress(safeAddress);
+        try {
+            const estimation = await this.request.post(`/safes/${address}/multisig-transactions/estimations/`, {
+                to: toChecksumAddress(safeTxData.to),
+                value: +safeTxData.value || 0,
+                data: safeTxData.data,
+                operation: safeTxData.operation,
+            });
+            return Number(estimation.safeTxGas);
+        }
+        catch (e) {
+            console.error(e);
+        }
+    }
 }

package/dist/index.js

@@ -102,7 +102,7 @@ class Safe {
         return nonce.toNumber();
     }
     async buildTransaction(data) {
-        const transaction = await standardizeSafeTransactionData(this.safeAddress, this.contract, this.provider, data);
+        const transaction = await standardizeSafeTransactionData(this.safeAddress, this.contract, this.provider, data, this.network, this.version);
         return new SafeTransaction(transaction);
     }
     async getTransactionHash(transaction) {

package/dist/utils.d.ts

@@ -3,8 +3,9 @@ import { OperationType, SafeTransactionData, SafeTransactionDataPartial, SafeSig
 import EthSignSignature from "@gnosis.pm/safe-core-sdk/dist/src/utils/signatures/SafeSignature";
 export declare function sameString(str1: string, str2: string): boolean;
 export declare function isRestrictedAddress(address: string): boolean;
+export declare const isLegacyVersion: (safeVersion: string) => boolean;
 export declare function estimateTxGas(safeAddress: string, safeContract: Contract, provider: providers.Web3Provider, to: string, valueInWei: string, data: string, operation: OperationType): Promise<number>;
-export declare function standardizeSafeTransactionData(safeAddress: string, safeContract: Contract, provider: any, tx: SafeTransactionDataPartial): Promise<SafeTransactionData>;
+export declare function standardizeSafeTransactionData(safeAddress: string, safeContract: Contract, provider: any, tx: SafeTransactionDataPartial, network: string, version: string): Promise<SafeTransactionData>;
 export declare function generatePreValidatedSignature(ownerAddress: string): SafeSignature;
 export declare function isTxHashSignedWithPrefix(txHash: string, signature: string, ownerAddress: string): boolean;
 export declare function adjustVInSignature(signature: string, hasPrefix: boolean): string;

package/dist/utils.js

@@ -3,6 +3,9 @@ import { OperationType, } from "@gnosis.pm/safe-core-sdk-types";
 import { bufferToHex, ecrecover, pubToAddress } from "ethereumjs-util";
 import { ZERO_ADDRESS, SENTINEL_ADDRESS } from "./constants";
 import EthSignSignature from "@gnosis.pm/safe-core-sdk/dist/src/utils/signatures/SafeSignature";
+import semverSatisfies from "semver/functions/satisfies";
+import RequestProvider from "./api";
+import Safe from "./index";
 function estimateDataGasCosts(data) {
     const reducer = (accumulator, currentValue) => {
         if (currentValue === "0x") {
@@ -27,6 +30,10 @@ function isSentinelAddress(address) {
 export function isRestrictedAddress(address) {
     return isZeroAddress(address) || isSentinelAddress(address);
 }
+export const isLegacyVersion = (safeVersion) => {
+    const LEGACY_VERSION = "<1.3.0";
+    return semverSatisfies(safeVersion, LEGACY_VERSION);
+};
 export async function estimateTxGas(safeAddress, safeContract, provider, to, valueInWei, data, operation) {
     let txGasEstimation = 0;
     const estimateData = safeContract.interface.encodeFunctionData("requiredTxGas", [to, valueInWei, data, operation]);
@@ -78,7 +85,7 @@ export async function estimateTxGas(safeAddress, safeContract, provider, to, val
         return Promise.reject(error);
     }
 }
-export async function standardizeSafeTransactionData(safeAddress, safeContract, provider, tx) {
+export async function standardizeSafeTransactionData(safeAddress, safeContract, provider, tx, network, version) {
     var _a, _b, _c, _d, _e;
     const standardizedTxs = {
         to: tx.to,
@@ -91,10 +98,11 @@ export async function standardizeSafeTransactionData(safeAddress, safeContract,
         refundReceiver: tx.refundReceiver || ZERO_ADDRESS,
         nonce: (_d = tx.nonce) !== null && _d !== void 0 ? _d : (await safeContract.nonce()).toNumber(),
     };
-    const safeTxGas = (_e = tx.safeTxGas) !== null && _e !== void 0 ? _e : (await estimateTxGas(safeAddress, safeContract, provider, standardizedTxs.to, standardizedTxs.value, standardizedTxs.data, standardizedTxs.operation));
+    const request = new RequestProvider(network, Safe.adapter);
+    const safeTxGas = (_e = tx.safeTxGas) !== null && _e !== void 0 ? _e : (await request.getSafeTxGas(safeAddress, version, standardizedTxs));
     return {
         ...standardizedTxs,
-        safeTxGas,
+        safeTxGas: safeTxGas || 0,
     };
 }
 export function generatePreValidatedSignature(ownerAddress) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rabby-wallet/gnosis-sdk",
-  "version": "1.3.5",
+  "version": "1.3.6",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -21,6 +21,7 @@
     "bignumber.js": "^9.0.2",
     "ethereumjs-util": "^7.1.3",
     "ethers": "^5.5.1",
+    "semver": "^7.5.4",
     "typescript": "^4.5.0",
     "web3-core": "^1.6.0"
   },

package/src/api.ts

@@ -1,5 +1,7 @@
-import axios, { Axios, AxiosAdapter } from 'axios';
-import { toChecksumAddress } from 'web3-utils';
+import { SafeTransactionDataPartial } from "@gnosis.pm/safe-core-sdk-types";
+import { isLegacyVersion } from "./utils";
+import axios, { Axios, AxiosAdapter } from "axios";
+import { toChecksumAddress } from "web3-utils";
 
 export interface SafeInfo {
   address: string;
@@ -46,15 +48,54 @@ export interface SafeTransactionItem {
 }
 
 const HOST_MAP = {
-  '1': 'https://safe-transaction-mainnet.safe.global/api/v1',
-  '137': 'https://safe-transaction-polygon.safe.global/api/v1',
-  '56': 'https://safe-transaction-bsc.safe.global/api/v1',
-  '100': 'https://safe-transaction-gnosis-chain.safe.global/api/v1',
-  '43114': 'https://safe-transaction-avalanche.safe.global/api/v1',
-  '42161': 'https://safe-transaction-arbitrum.safe.global/api/v1',
-  '10': 'https://safe-transaction-optimism.safe.global/api/v1',
-  '1313161554': 'https://safe-transaction-aurora.safe.global/api/v1',
+  /**
+   * eth
+   */
+  "1": "https://safe-transaction-mainnet.safe.global/api/v1",
+  /**
+   * polygon
+   */
+  "137": "https://safe-transaction-polygon.safe.global/api/v1",
+  /**
+   * bsc
+   */
+  "56": "https://safe-transaction-bsc.safe.global/api/v1",
+  /**
+   * Gnosis Chain
+   */
+  "100": "https://safe-transaction-gnosis-chain.safe.global/api/v1",
+  /**
+   * avalanche
+   */
+  "43114": "https://safe-transaction-avalanche.safe.global/api/v1",
+  /**
+   * arbitrum
+   */
+  "42161": "https://safe-transaction-arbitrum.safe.global/api/v1",
+  /**
+   * Optimism
+   */
+  "10": "https://safe-transaction-optimism.safe.global/api/v1",
+  /**
+   * Aurora
+   */
+  "1313161554": "https://safe-transaction-aurora.safe.global/api/v1",
+  /**
+   * Base
+   */
   "8453": "https://safe-transaction-base.safe.global/api/v1",
+  /**
+   * Celo
+   */
+  "42220": "https://safe-transaction-celo.safe.global/api/v1",
+  /**
+   * Polygon zkEVM
+   */
+  "1101": "https://safe-transaction-zkevm.safe.global/api/v1",
+  /**
+   * zksync era
+   */
+  "324": "https://safe-transaction-zksync.safe.global/api/v1",
 };
 
 export default class RequestProvider {
@@ -63,14 +104,14 @@ export default class RequestProvider {
 
   constructor(networkId: string, adapter?: AxiosAdapter) {
     if (!(networkId in HOST_MAP)) {
-      throw new Error('Wrong networkId');
+      throw new Error("Wrong networkId");
     }
 
     this.host = HOST_MAP[networkId];
 
     this.request = axios.create({
       baseURL: this.host,
-      adapter
+      adapter,
     });
 
     this.request.interceptors.response.use((response) => {
@@ -87,8 +128,8 @@ export default class RequestProvider {
       {
         params: {
           executed: false,
-          nonce__gte: nonce
-        }
+          nonce__gte: nonce,
+        },
       }
     );
   }
@@ -110,4 +151,33 @@ export default class RequestProvider {
       data
     );
   }
+
+  // https://github.com/safe-global/safe-wallet-web/blob/dev/src/services/tx/tx-sender/recommendedNonce.ts#L24
+  async getSafeTxGas(
+    safeAddress: string,
+    safeVersion: string,
+    safeTxData: SafeTransactionDataPartial
+  ): Promise<number | undefined> {
+    const isSafeTxGasRequired = isLegacyVersion(safeVersion);
+
+    // For 1.3.0+ Safes safeTxGas is not required
+    if (!isSafeTxGasRequired) return 0;
+
+    const address = toChecksumAddress(safeAddress);
+
+    try {
+      const estimation: { safeTxGas: string } = await this.request.post(
+        `/safes/${address}/multisig-transactions/estimations/`,
+        {
+          to: toChecksumAddress(safeTxData.to),
+          value: +safeTxData.value || 0,
+          data: safeTxData.data,
+          operation: safeTxData.operation,
+        }
+      );
+      return Number(estimation.safeTxGas);
+    } catch (e) {
+      console.error(e);
+    }
+  }
 }

package/src/index.ts

@@ -174,7 +174,9 @@ class Safe {
       this.safeAddress,
       this.contract,
       this.provider,
-      data
+      data,
+      this.network,
+      this.version
     );
     return new SafeTransaction(transaction);
   }

package/src/utils.ts

@@ -10,6 +10,9 @@ import {
 import { bufferToHex, ecrecover, pubToAddress } from "ethereumjs-util";
 import { ZERO_ADDRESS, SENTINEL_ADDRESS } from "./constants";
 import EthSignSignature from "@gnosis.pm/safe-core-sdk/dist/src/utils/signatures/SafeSignature";
+import semverSatisfies from "semver/functions/satisfies";
+import RequestProvider from "./api";
+import Safe from "./index";
 
 function estimateDataGasCosts(data: string): number {
   const reducer = (accumulator: number, currentValue: string) => {
@@ -40,6 +43,11 @@ export function isRestrictedAddress(address: string): boolean {
   return isZeroAddress(address) || isSentinelAddress(address);
 }
 
+export const isLegacyVersion = (safeVersion: string): boolean => {
+  const LEGACY_VERSION = "<1.3.0";
+  return semverSatisfies(safeVersion, LEGACY_VERSION);
+};
+
 export async function estimateTxGas(
   safeAddress: string,
   safeContract: Contract,
@@ -109,7 +117,9 @@ export async function standardizeSafeTransactionData(
   safeAddress: string,
   safeContract: Contract,
   provider: any,
-  tx: SafeTransactionDataPartial
+  tx: SafeTransactionDataPartial,
+  network: string,
+  version: string
 ): Promise<SafeTransactionData> {
   const standardizedTxs = {
     to: tx.to,
@@ -122,20 +132,13 @@ export async function standardizeSafeTransactionData(
     refundReceiver: tx.refundReceiver || ZERO_ADDRESS,
     nonce: tx.nonce ?? (await safeContract.nonce()).toNumber(),
   };
+  const request = new RequestProvider(network, Safe.adapter);
   const safeTxGas =
     tx.safeTxGas ??
-    (await estimateTxGas(
-      safeAddress,
-      safeContract,
-      provider,
-      standardizedTxs.to,
-      standardizedTxs.value,
-      standardizedTxs.data,
-      standardizedTxs.operation
-    ));
+    (await request.getSafeTxGas(safeAddress, version, standardizedTxs));
   return {
     ...standardizedTxs,
-    safeTxGas,
+    safeTxGas: safeTxGas || 0,
   };
 }