@rabby-wallet/gnosis-sdk 1.3.2 → 1.3.4

package/dist/index.d.ts

@@ -1,11 +1,11 @@
-import { Contract } from 'ethers';
-import { BigNumber } from '@ethersproject/bignumber';
-import { providers } from 'ethers';
-import { SafeTransactionDataPartial, SafeSignature } from '@gnosis.pm/safe-core-sdk-types';
-import { TransactionResult, TransactionOptions } from '@gnosis.pm/safe-core-sdk/dist/src/utils/transactions/types';
-import SafeTransaction from '@gnosis.pm/safe-core-sdk/dist/src/utils/transactions/SafeTransaction';
-import RequestProvider, { SafeInfo } from './api';
-import { AxiosAdapter } from 'axios';
+import { Contract } from "ethers";
+import { BigNumber } from "@ethersproject/bignumber";
+import { providers } from "ethers";
+import { SafeTransactionDataPartial, SafeSignature } from "@gnosis.pm/safe-core-sdk-types";
+import { TransactionResult, TransactionOptions } from "@gnosis.pm/safe-core-sdk/dist/src/utils/transactions/types";
+import SafeTransaction from "@gnosis.pm/safe-core-sdk/dist/src/utils/transactions/SafeTransaction";
+import RequestProvider, { SafeInfo } from "./api";
+import { AxiosAdapter } from "axios";
 declare class Safe {
     contract: Contract;
     safeAddress: string;
@@ -17,14 +17,34 @@ declare class Safe {
     network: string;
     static adapter: AxiosAdapter;
     constructor(safeAddress: string, version: string, provider: providers.Web3Provider, network?: string);
+    /**
+     * @deprecated
+     * @param safeAddress
+     * @param network
+     * @returns
+     */
     static getSafeInfo(safeAddress: string, network: string): Promise<SafeInfo>;
-    static getPendingTransactions(safeAddress: string, network: string): Promise<{
+    static getPendingTransactions(safeAddress: string, network: string, nonce: number): Promise<{
         results: import("./api").SafeTransactionItem[];
     }>;
+    getPendingTransactions(): Promise<{
+        results: import("./api").SafeTransactionItem[];
+    }>;
+    static getSafeVersion({ address, provider, }: {
+        address: any;
+        provider: providers.Web3Provider;
+    }): Promise<string>;
     init(): Promise<void>;
     getOwners(): Promise<string[]>;
-    getThreshold(): Promise<any>;
+    getThreshold(): Promise<number>;
     getNonce(): Promise<number>;
+    getBasicSafeInfo: () => Promise<{
+        address: string;
+        version: string;
+        threshold: number;
+        nonce: number;
+        owners: string[];
+    }>;
     buildTransaction(data: SafeTransactionDataPartial): Promise<SafeTransaction>;
     getTransactionHash(transaction: SafeTransaction): Promise<any>;
     signTransactionHash(hash: string): Promise<SafeSignature>;
@@ -36,3 +56,4 @@ declare class Safe {
     executeTransaction(safeTransaction: SafeTransaction, options?: TransactionOptions): Promise<TransactionResult>;
 }
 export default Safe;
+export type BasicSafeInfo = Awaited<ReturnType<Safe["getBasicSafeInfo"]>>;

package/dist/index.js

@@ -1,21 +1,35 @@
-import { Contract } from 'ethers';
-import { BigNumber } from '@ethersproject/bignumber';
-import BN from 'bignumber.js';
-import { getSafeSingletonDeployment } from '@gnosis.pm/safe-deployments';
-import { toChecksumAddress } from 'web3-utils';
-import SafeTransaction from '@gnosis.pm/safe-core-sdk/dist/src/utils/transactions/SafeTransaction';
-import RequestProvider from './api';
-import { standardizeSafeTransactionData, sameString, generateSignature, generatePreValidatedSignature, estimateGasForTransactionExecution } from './utils';
+import { Contract } from "ethers";
+import { BigNumber } from "@ethersproject/bignumber";
+import BN from "bignumber.js";
+import { getSafeSingletonDeployment } from "@safe-global/safe-deployments";
+import { toChecksumAddress } from "web3-utils";
+import SafeTransaction from "@gnosis.pm/safe-core-sdk/dist/src/utils/transactions/SafeTransaction";
+import RequestProvider from "./api";
+import { standardizeSafeTransactionData, sameString, generateSignature, generatePreValidatedSignature, estimateGasForTransactionExecution, } from "./utils";
 class Safe {
-    constructor(safeAddress, version, provider, network = '1') {
+    constructor(safeAddress, version, provider, network = "1") {
         this.owners = [];
         this.safeInfo = null;
+        this.getBasicSafeInfo = async () => {
+            const [threshold, nonce, owners] = await Promise.all([
+                this.getThreshold(),
+                this.getNonce(),
+                this.getOwners(),
+            ]);
+            return {
+                address: this.safeAddress,
+                version: this.version,
+                threshold,
+                nonce,
+                owners,
+            };
+        };
         const contract = getSafeSingletonDeployment({
             version,
-            network
+            network,
         });
         if (!contract) {
-            throw new Error('Wrong version or network');
+            throw new Error("Wrong version or network");
         }
         this.provider = provider;
         this.contract = new Contract(safeAddress, contract.abi, this.provider);
@@ -23,19 +37,49 @@ class Safe {
         this.safeAddress = safeAddress;
         this.network = network;
         this.request = new RequestProvider(network, Safe.adapter);
-        this.init();
-    }
+        // this.init();
+    }
+    /**
+     * @deprecated
+     * @param safeAddress
+     * @param network
+     * @returns
+     */
     static getSafeInfo(safeAddress, network) {
         const request = new RequestProvider(network, Safe.adapter);
         return request.getSafeInfo(toChecksumAddress(safeAddress));
     }
-    static async getPendingTransactions(safeAddress, network) {
+    static async getPendingTransactions(safeAddress, network, nonce) {
         const request = new RequestProvider(network, Safe.adapter);
-        const nonce = (await request.getSafeInfo(toChecksumAddress(safeAddress)))
-            .nonce;
         const transactions = await request.getPendingTransactions(safeAddress, nonce);
         return transactions;
     }
+    async getPendingTransactions() {
+        const nonce = await this.getNonce();
+        const transactions = await this.request.getPendingTransactions(this.safeAddress, nonce);
+        return transactions;
+    }
+    static async getSafeVersion({ address, provider, }) {
+        const contract = new Contract(address, [
+            {
+                constant: true,
+                inputs: [],
+                name: "VERSION",
+                outputs: [
+                    {
+                        internalType: "string",
+                        name: "",
+                        type: "string",
+                    },
+                ],
+                payable: false,
+                stateMutability: "view",
+                type: "function",
+            },
+        ], provider);
+        const version = await contract.VERSION();
+        return version;
+    }
     async init() {
         const safeInfo = await Safe.getSafeInfo(this.safeAddress, this.network);
         this.safeInfo = safeInfo;
@@ -71,7 +115,7 @@ class Safe {
         const signerAddress = await signer.getAddress();
         const addressIsOwner = owners.find((owner) => signerAddress && sameString(owner, signerAddress));
         if (!addressIsOwner) {
-            throw new Error('Transactions can only be signed by Safe owners');
+            throw new Error("Transactions can only be signed by Safe owners");
         }
         return generateSignature(this.provider, hash);
     }
@@ -109,7 +153,7 @@ class Safe {
             nonce: transaction.data.nonce,
             contractTransactionHash: hash,
             sender: toChecksumAddress(signerAddress),
-            signature: transaction.encodedSignatures()
+            signature: transaction.encodedSignatures(),
         });
     }
     async confirmTransaction(safeTransaction) {
@@ -142,20 +186,20 @@ class Safe {
         const threshold = await this.getThreshold();
         if (threshold > safeTransaction.signatures.size) {
             const signaturesMissing = threshold - safeTransaction.signatures.size;
-            throw new Error(`There ${signaturesMissing > 1 ? 'are' : 'is'} ${signaturesMissing} signature${signaturesMissing > 1 ? 's' : ''} missing`);
+            throw new Error(`There ${signaturesMissing > 1 ? "are" : "is"} ${signaturesMissing} signature${signaturesMissing > 1 ? "s" : ""} missing`);
         }
         const value = BigNumber.from(safeTransaction.data.value);
         if (!value.isZero()) {
             const balance = await this.getBalance();
             if (value.gt(BigNumber.from(balance))) {
-                throw new Error('Not enough Ether funds');
+                throw new Error("Not enough Ether funds");
             }
         }
         const gasLimit = await estimateGasForTransactionExecution(contract, signerAddress, safeTransaction);
         const executionOptions = {
             gasLimit,
             gasPrice: options === null || options === void 0 ? void 0 : options.gasPrice,
-            from: signerAddress
+            from: signerAddress,
         };
         const txResponse = await contract.execTransaction(safeTransaction.data.to, safeTransaction.data.value, safeTransaction.data.data, safeTransaction.data.operation, safeTransaction.data.safeTxGas, safeTransaction.data.baseGas, safeTransaction.data.gasPrice, safeTransaction.data.gasToken, safeTransaction.data.refundReceiver, safeTransaction.encodedSignatures(), executionOptions);
         return txResponse;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rabby-wallet/gnosis-sdk",
-  "version": "1.3.2",
+  "version": "1.3.4",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -16,12 +16,15 @@
     "@ethersproject/solidity": "^5.5.0",
     "@gnosis.pm/safe-core-sdk": "^1.0.0",
     "@gnosis.pm/safe-core-sdk-types": "^0.1.1",
-    "@gnosis.pm/safe-deployments": "^1.15.0",
+    "@safe-global/safe-deployments": "^1.25.0",
     "axios": "^0.24.0",
     "bignumber.js": "^9.0.2",
     "ethereumjs-util": "^7.1.3",
     "ethers": "^5.5.1",
-    "typescript": "^4.4.4",
+    "typescript": "^4.5.0",
     "web3-core": "^1.6.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.3.3"
   }
 }

package/src/index.ts

@@ -1,27 +1,27 @@
-import { Contract } from 'ethers';
-import { BigNumber } from '@ethersproject/bignumber';
-import BN from 'bignumber.js';
-import { getSafeSingletonDeployment } from '@gnosis.pm/safe-deployments';
-import { providers } from 'ethers';
-import { toChecksumAddress } from 'web3-utils';
+import { Contract, ethers } from "ethers";
+import { BigNumber } from "@ethersproject/bignumber";
+import BN from "bignumber.js";
+import { getSafeSingletonDeployment } from "@safe-global/safe-deployments";
+import { providers } from "ethers";
+import { toChecksumAddress } from "web3-utils";
 import {
   SafeTransactionDataPartial,
-  SafeSignature
-} from '@gnosis.pm/safe-core-sdk-types';
+  SafeSignature,
+} from "@gnosis.pm/safe-core-sdk-types";
 import {
   TransactionResult,
-  TransactionOptions
-} from '@gnosis.pm/safe-core-sdk/dist/src/utils/transactions/types';
-import SafeTransaction from '@gnosis.pm/safe-core-sdk/dist/src/utils/transactions/SafeTransaction';
-import RequestProvider, { SafeInfo } from './api';
+  TransactionOptions,
+} from "@gnosis.pm/safe-core-sdk/dist/src/utils/transactions/types";
+import SafeTransaction from "@gnosis.pm/safe-core-sdk/dist/src/utils/transactions/SafeTransaction";
+import RequestProvider, { SafeInfo } from "./api";
 import {
   standardizeSafeTransactionData,
   sameString,
   generateSignature,
   generatePreValidatedSignature,
-  estimateGasForTransactionExecution
-} from './utils';
-import { AxiosAdapter } from 'axios';
+  estimateGasForTransactionExecution,
+} from "./utils";
+import { AxiosAdapter } from "axios";
 
 class Safe {
   contract: Contract;
@@ -39,14 +39,14 @@ class Safe {
     safeAddress: string,
     version: string,
     provider: providers.Web3Provider,
-    network = '1'
+    network = "1"
   ) {
     const contract = getSafeSingletonDeployment({
       version,
-      network
+      network,
     });
     if (!contract) {
-      throw new Error('Wrong version or network');
+      throw new Error("Wrong version or network");
     }
     this.provider = provider;
     this.contract = new Contract(safeAddress, contract.abi, this.provider);
@@ -54,18 +54,26 @@ class Safe {
     this.safeAddress = safeAddress;
     this.network = network;
     this.request = new RequestProvider(network, Safe.adapter);
-    this.init();
+    // this.init();
   }
 
+  /**
+   * @deprecated
+   * @param safeAddress
+   * @param network
+   * @returns
+   */
   static getSafeInfo(safeAddress: string, network: string) {
     const request = new RequestProvider(network, Safe.adapter);
     return request.getSafeInfo(toChecksumAddress(safeAddress));
   }
 
-  static async getPendingTransactions(safeAddress: string, network: string) {
+  static async getPendingTransactions(
+    safeAddress: string,
+    network: string,
+    nonce: number
+  ) {
     const request = new RequestProvider(network, Safe.adapter);
-    const nonce = (await request.getSafeInfo(toChecksumAddress(safeAddress)))
-      .nonce;
     const transactions = await request.getPendingTransactions(
       safeAddress,
       nonce
@@ -74,6 +82,50 @@ class Safe {
     return transactions;
   }
 
+  async getPendingTransactions() {
+    const nonce = await this.getNonce();
+    const transactions = await this.request.getPendingTransactions(
+      this.safeAddress,
+      nonce
+    );
+
+    return transactions;
+  }
+
+  static async getSafeVersion({
+    address,
+    provider,
+  }: {
+    address;
+    provider: providers.Web3Provider;
+  }): Promise<string> {
+    const contract = new Contract(
+      address,
+      [
+        {
+          constant: true,
+          inputs: [],
+          name: "VERSION",
+          outputs: [
+            {
+              internalType: "string",
+              name: "",
+              type: "string",
+            },
+          ],
+          payable: false,
+          stateMutability: "view",
+          type: "function",
+        },
+      ],
+      provider
+    );
+
+    const version = await contract.VERSION();
+
+    return version;
+  }
+
   async init() {
     const safeInfo = await Safe.getSafeInfo(this.safeAddress, this.network);
     this.safeInfo = safeInfo;
@@ -92,7 +144,7 @@ class Safe {
     return owners;
   }
 
-  async getThreshold() {
+  async getThreshold(): Promise<number> {
     const threshold = await this.contract.getThreshold();
     return threshold.toNumber();
   }
@@ -102,6 +154,21 @@ class Safe {
     return nonce.toNumber();
   }
 
+  getBasicSafeInfo = async () => {
+    const [threshold, nonce, owners] = await Promise.all([
+      this.getThreshold(),
+      this.getNonce(),
+      this.getOwners(),
+    ]);
+    return {
+      address: this.safeAddress,
+      version: this.version,
+      threshold,
+      nonce,
+      owners,
+    };
+  };
+
   async buildTransaction(data: SafeTransactionDataPartial) {
     const transaction = await standardizeSafeTransactionData(
       this.safeAddress,
@@ -136,7 +203,7 @@ class Safe {
       (owner: string) => signerAddress && sameString(owner, signerAddress)
     );
     if (!addressIsOwner) {
-      throw new Error('Transactions can only be signed by Safe owners');
+      throw new Error("Transactions can only be signed by Safe owners");
     }
     return generateSignature(this.provider, hash);
   }
@@ -177,7 +244,7 @@ class Safe {
       nonce: transaction.data.nonce,
       contractTransactionHash: hash,
       sender: toChecksumAddress(signerAddress),
-      signature: transaction.encodedSignatures()
+      signature: transaction.encodedSignatures(),
     });
   }
 
@@ -221,9 +288,9 @@ class Safe {
       const signaturesMissing = threshold - safeTransaction.signatures.size;
       throw new Error(
         `There ${
-          signaturesMissing > 1 ? 'are' : 'is'
+          signaturesMissing > 1 ? "are" : "is"
         } ${signaturesMissing} signature${
-          signaturesMissing > 1 ? 's' : ''
+          signaturesMissing > 1 ? "s" : ""
         } missing`
       );
     }
@@ -232,7 +299,7 @@ class Safe {
     if (!value.isZero()) {
       const balance = await this.getBalance();
       if (value.gt(BigNumber.from(balance))) {
-        throw new Error('Not enough Ether funds');
+        throw new Error("Not enough Ether funds");
       }
     }
 
@@ -244,7 +311,7 @@ class Safe {
     const executionOptions: TransactionOptions = {
       gasLimit,
       gasPrice: options?.gasPrice,
-      from: signerAddress
+      from: signerAddress,
     };
 
     const txResponse = await contract.execTransaction(
@@ -266,3 +333,5 @@ class Safe {
 }
 
 export default Safe;
+
+export type BasicSafeInfo = Awaited<ReturnType<Safe["getBasicSafeInfo"]>>;