@rabby-wallet/gnosis-sdk 1.3.7 → 1.3.9-alpha.0

package/dist/api.js

@@ -58,6 +58,10 @@ const HOST_MAP = {
      * linea
      */
     "59144": "https://safe-transaction-linea.safe.global/api/v1",
+    /**
+     * X Layer
+     */
+    "196": "https://safe-transaction-xlayer.safe.global/api/v1",
 };
 export default class RequestProvider {
     constructor(networkId, adapter) {

package/dist/index.d.ts

@@ -4,8 +4,11 @@ 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 SafeMessage from "@safe-global/protocol-kit/dist/src/utils/messages/SafeMessage";
 import RequestProvider, { SafeInfo } from "./api";
 import { AxiosAdapter } from "axios";
+import SafeApiKit from "@safe-global/api-kit";
+import { SafeClientResult } from "@safe-global/sdk-starter-kit";
 declare class Safe {
     contract: Contract;
     safeAddress: string;
@@ -15,6 +18,7 @@ declare class Safe {
     safeInfo: SafeInfo | null;
     request: RequestProvider;
     network: string;
+    apiKit: SafeApiKit;
     static adapter: AxiosAdapter;
     constructor(safeAddress: string, version: string, provider: providers.Web3Provider, network?: string);
     /**
@@ -54,6 +58,25 @@ declare class Safe {
     confirmTransaction(safeTransaction: SafeTransaction): Promise<void>;
     getBalance(): Promise<BigNumber>;
     executeTransaction(safeTransaction: SafeTransaction, options?: TransactionOptions): Promise<TransactionResult>;
+    /**
+     * Call the CompatibilityFallbackHandler getMessageHash method
+     *
+     * @param messageHash The hash of the message
+     * @returns Returns the Safe message hash to be signed
+     * @link https://github.com/safe-global/safe-contracts/blob/8ffae95faa815acf86ec8b50021ebe9f96abde10/contracts/handler/CompatibilityFallbackHandler.sol#L26-L28
+     */
+    getSafeMessageHash: (messageHash: string) => Promise<string>;
+    /**
+     * Add a new off-chain message using the Transaction service
+     * - If the threshold > 1, remember to confirmMessage() after sendMessage()
+     * - If the threshold = 1, then the message is confirmed and valid immediately
+     *
+     * @param {SafeMessage} safeMessage The message
+     * @returns {Promise<SafeClientResult>} The SafeClientResult
+     */
+    addMessage({ safeMessage }: {
+        safeMessage: SafeMessage;
+    }): Promise<SafeClientResult>;
 }
 export default Safe;
 export type BasicSafeInfo = Awaited<ReturnType<Safe["getBasicSafeInfo"]>>;

package/dist/index.js

@@ -4,8 +4,15 @@ 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 { hashSafeMessage, } from "@safe-global/protocol-kit";
 import RequestProvider from "./api";
 import { standardizeSafeTransactionData, sameString, generateSignature, generatePreValidatedSignature, estimateGasForTransactionExecution, } from "./utils";
+import { calculateSafeMessageHash, } from "@safe-global/protocol-kit/dist/src/utils";
+import SafeApiKit from "@safe-global/api-kit";
+import { SafeClientTxStatus } from "@safe-global/sdk-starter-kit/dist/src/constants";
+import { createSafeClientResult } from "@safe-global/sdk-starter-kit/dist/src/utils";
+const EQ_OR_GT_1_4_1 = ">=1.4.1";
+const EQ_OR_GT_1_3_0 = ">=1.3.0";
 class Safe {
     constructor(safeAddress, version, provider, network = "1") {
         this.owners = [];
@@ -24,6 +31,22 @@ class Safe {
                 owners,
             };
         };
+        /**
+         * Call the CompatibilityFallbackHandler getMessageHash method
+         *
+         * @param messageHash The hash of the message
+         * @returns Returns the Safe message hash to be signed
+         * @link https://github.com/safe-global/safe-contracts/blob/8ffae95faa815acf86ec8b50021ebe9f96abde10/contracts/handler/CompatibilityFallbackHandler.sol#L26-L28
+         */
+        this.getSafeMessageHash = async (messageHash) => {
+            if (this.contract.getMessageHash) {
+                return this.contract.getMessageHash(messageHash);
+            }
+            const safeAddress = this.safeAddress;
+            const safeVersion = this.version;
+            const chainId = BigInt(this.network);
+            return calculateSafeMessageHash(toChecksumAddress(safeAddress), messageHash, safeVersion, chainId);
+        };
         const contract = getSafeSingletonDeployment({
             version,
             network,
@@ -37,6 +60,9 @@ class Safe {
         this.safeAddress = safeAddress;
         this.network = network;
         this.request = new RequestProvider(network, Safe.adapter);
+        this.apiKit = new SafeApiKit({
+            chainId: BigInt(network),
+        });
         // this.init();
     }
     /**
@@ -204,5 +230,35 @@ class Safe {
         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;
     }
+    /**
+     * Add a new off-chain message using the Transaction service
+     * - If the threshold > 1, remember to confirmMessage() after sendMessage()
+     * - If the threshold = 1, then the message is confirmed and valid immediately
+     *
+     * @param {SafeMessage} safeMessage The message
+     * @returns {Promise<SafeClientResult>} The SafeClientResult
+     */
+    async addMessage({ safeMessage }) {
+        const safeAddress = this.safeAddress;
+        const threshold = await this.getThreshold();
+        const messageHash = await this.getSafeMessageHash(hashSafeMessage(safeMessage.data));
+        try {
+            await this.apiKit.addMessage(safeAddress, {
+                message: safeMessage.data,
+                signature: safeMessage.encodedSignatures(),
+            });
+        }
+        catch (error) {
+            throw new Error("Could not add a new off-chain message to the Safe account");
+        }
+        const message = await this.apiKit.getMessage(messageHash);
+        return createSafeClientResult({
+            safeAddress: this.safeAddress,
+            status: message.confirmations.length === threshold
+                ? SafeClientTxStatus.MESSAGE_CONFIRMED
+                : SafeClientTxStatus.MESSAGE_PENDING_SIGNATURES,
+            messageHash,
+        });
+    }
 }
 export default Safe;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rabby-wallet/gnosis-sdk",
-  "version": "1.3.7",
+  "version": "1.3.9-alpha.0",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -16,13 +16,17 @@
     "@ethersproject/solidity": "^5.5.0",
     "@gnosis.pm/safe-core-sdk": "^1.0.0",
     "@gnosis.pm/safe-core-sdk-types": "^0.1.1",
+    "@safe-global/api-kit": "^2.5.2",
+    "@safe-global/protocol-kit": "^5.0.2",
     "@safe-global/safe-deployments": "^1.37.2",
+    "@safe-global/sdk-starter-kit": "^1.0.2",
+    "@safe-global/types-kit": "^1.0.0",
     "axios": "^0.24.0",
     "bignumber.js": "^9.0.2",
     "ethereumjs-util": "^7.1.3",
     "ethers": "^5.5.1",
     "semver": "^7.5.4",
-    "typescript": "^4.5.0",
+    "typescript": "5.6.2",
     "web3-core": "^1.6.0"
   },
   "devDependencies": {

package/src/api.ts

@@ -104,6 +104,10 @@ const HOST_MAP = {
    * linea
    */
   "59144": "https://safe-transaction-linea.safe.global/api/v1",
+  /**
+   * X Layer
+   */
+  "196": "https://safe-transaction-xlayer.safe.global/api/v1",
 };
 
 export default class RequestProvider {

package/src/index.ts

@@ -13,6 +13,16 @@ import {
   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 SafeTransactionNew from "@safe-global/protocol-kit/dist/src/utils/transactions/SafeTransaction";
+import SafeMessage from "@safe-global/protocol-kit/dist/src/utils/messages/SafeMessage";
+import SafeProtocolKit, {
+  generateEIP712Signature,
+  hashSafeMessage,
+  preimageSafeMessageHash,
+  SafeProvider,
+  SigningMethod,
+  SigningMethodType,
+} from "@safe-global/protocol-kit";
 import RequestProvider, { SafeInfo } from "./api";
 import {
   standardizeSafeTransactionData,
@@ -22,6 +32,31 @@ import {
   estimateGasForTransactionExecution,
 } from "./utils";
 import { AxiosAdapter } from "axios";
+import semverSatisfies from "semver/functions/satisfies";
+import {
+  EIP712TypedData,
+  SafeEIP712Args,
+  SafeSignature as SafeSignatureNew,
+} from "@safe-global/types-kit";
+import {
+  calculateSafeMessageHash,
+  EthSafeSignature,
+  generateSignature as generateSignatureNew,
+  hasSafeFeature,
+  SAFE_FEATURES,
+} from "@safe-global/protocol-kit/dist/src/utils";
+import SafeApiKit, {
+  EIP712TypedData as ApiKitEIP712TypedData,
+} from "@safe-global/api-kit";
+import { SafeClientTxStatus } from "@safe-global/sdk-starter-kit/dist/src/constants";
+import { createSafeClientResult } from "@safe-global/sdk-starter-kit/dist/src/utils";
+import {
+  SafeClientResult,
+  SendOffChainMessageProps,
+} from "@safe-global/sdk-starter-kit";
+
+const EQ_OR_GT_1_4_1 = ">=1.4.1";
+const EQ_OR_GT_1_3_0 = ">=1.3.0";
 
 class Safe {
   contract: Contract;
@@ -32,6 +67,7 @@ class Safe {
   safeInfo: SafeInfo | null = null;
   request: RequestProvider;
   network: string;
+  apiKit: SafeApiKit;
 
   static adapter: AxiosAdapter;
 
@@ -54,6 +90,10 @@ class Safe {
     this.safeAddress = safeAddress;
     this.network = network;
     this.request = new RequestProvider(network, Safe.adapter);
+    this.apiKit = new SafeApiKit({
+      chainId: BigInt(network),
+    });
+
     // this.init();
   }
 
@@ -332,6 +372,68 @@ class Safe {
 
     return txResponse;
   }
+
+  /**
+   * Call the CompatibilityFallbackHandler getMessageHash method
+   *
+   * @param messageHash The hash of the message
+   * @returns Returns the Safe message hash to be signed
+   * @link https://github.com/safe-global/safe-contracts/blob/8ffae95faa815acf86ec8b50021ebe9f96abde10/contracts/handler/CompatibilityFallbackHandler.sol#L26-L28
+   */
+  getSafeMessageHash = async (messageHash: string): Promise<string> => {
+    if (this.contract.getMessageHash) {
+      return this.contract.getMessageHash(messageHash);
+    }
+
+    const safeAddress = this.safeAddress;
+    const safeVersion = this.version;
+    const chainId = BigInt(this.network);
+
+    return calculateSafeMessageHash(
+      toChecksumAddress(safeAddress),
+      messageHash,
+      safeVersion,
+      chainId
+    );
+  };
+
+  /**
+   * Add a new off-chain message using the Transaction service
+   * - If the threshold > 1, remember to confirmMessage() after sendMessage()
+   * - If the threshold = 1, then the message is confirmed and valid immediately
+   *
+   * @param {SafeMessage} safeMessage The message
+   * @returns {Promise<SafeClientResult>} The SafeClientResult
+   */
+  async addMessage({ safeMessage }: { safeMessage: SafeMessage }) {
+    const safeAddress = this.safeAddress;
+    const threshold = await this.getThreshold();
+    const messageHash = await this.getSafeMessageHash(
+      hashSafeMessage(safeMessage.data)
+    );
+
+    try {
+      await this.apiKit.addMessage(safeAddress, {
+        message: safeMessage.data as string | ApiKitEIP712TypedData,
+        signature: safeMessage.encodedSignatures(),
+      });
+    } catch (error) {
+      throw new Error(
+        "Could not add a new off-chain message to the Safe account"
+      );
+    }
+
+    const message = await this.apiKit.getMessage(messageHash);
+
+    return createSafeClientResult({
+      safeAddress: this.safeAddress,
+      status:
+        message.confirmations.length === threshold
+          ? SafeClientTxStatus.MESSAGE_CONFIRMED
+          : SafeClientTxStatus.MESSAGE_PENDING_SIGNATURES,
+      messageHash,
+    });
+  }
 }
 
 export default Safe;

package/tsconfig.json

@@ -11,9 +11,12 @@
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
     "allowJs": true,
-    "plugins": [{ "transform": "typescript-transform-paths", "afterDeclarations": true }],
+    "plugins": [
+      { "transform": "typescript-transform-paths", "afterDeclarations": true }
+    ],
     "outDir": "./dist",
-    "declaration": true
+    "declaration": true,
+    "skipLibCheck": true
   },
   "exclude": ["./node_modules"],
   "include": ["src", "__tests__"]