@safe-global/sdk-starter-kit 2.0.0-alpha.2 → 2.0.0

package/dist/cjs/index.cjs

@@ -28,15 +28,15 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   SafeClient: () => SafeClient,
   createSafeClient: () => createSafeClient,
   offChainMessages: () => offChainMessages,
   onChainMessages: () => onChainMessages,
   safeOperations: () => safeOperations
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 var import_protocol_kit6 = __toESM(require("@safe-global/protocol-kit"));
 var import_api_kit = __toESM(require("@safe-global/api-kit"));
 
@@ -313,12 +313,23 @@ var SafeClient = class extends BaseClient {
    * @throws {Error} If the transaction confirmation fails.
    */
   async confirm({ safeTxHash }) {
-    let transactionResponse = await this.apiKit.getTransaction(safeTxHash);
     const safeAddress = await this.protocolKit.getAddress();
-    const signedTransaction = await this.protocolKit.signTransaction(transactionResponse);
-    await this.apiKit.confirmTransaction(safeTxHash, signedTransaction.encodedSignatures());
-    transactionResponse = await this.apiKit.getTransaction(safeTxHash);
-    if (transactionResponse.confirmations && transactionResponse.confirmationsRequired === transactionResponse.confirmations.length) {
+    let transactionResponse = await this.apiKit.getTransaction(safeTxHash);
+    if (transactionResponse.isExecuted) {
+      return createSafeClientResult({
+        status: "EXECUTED" /* EXECUTED */,
+        safeAddress,
+        txHash: transactionResponse.transactionHash || "",
+        safeTxHash
+      });
+    }
+    if (this.#needsConfirmation(transactionResponse)) {
+      const signedTransaction = await this.protocolKit.signTransaction(transactionResponse);
+      const signature = signedTransaction.encodedSignatures();
+      await this.apiKit.confirmTransaction(safeTxHash, signature);
+      transactionResponse = await this.apiKit.getTransaction(safeTxHash);
+    }
+    if (!this.#needsConfirmation(transactionResponse)) {
       const executedTransactionResponse = await this.protocolKit.executeTransaction(transactionResponse);
       await waitSafeTxReceipt(executedTransactionResponse);
       return createSafeClientResult({
@@ -447,6 +458,9 @@ var SafeClient = class extends BaseClient {
       safeTxHash
     });
   }
+  #needsConfirmation(transactionResponse) {
+    return (transactionResponse.confirmations?.length || 0) < transactionResponse.confirmationsRequired;
+  }
   async #reconnectSafe() {
     this.protocolKit = await this.protocolKit.connect({
       provider: this.protocolKit.getSafeProvider().provider,
@@ -728,14 +742,23 @@ var SafeOperationClient = class {
   }) {
     const safeAddress = await this.protocolKit.getAddress();
     const threshold = await this.protocolKit.getThreshold();
-    await this.apiKit.confirmSafeOperation(
-      safeOperationHash,
-      (0, import_protocol_kit5.buildSignatureBytes)([await this.protocolKit.signHash(safeOperationHash)])
-    );
-    const confirmedSafeOperation = await this.apiKit.getSafeOperation(safeOperationHash);
-    if (confirmedSafeOperation?.confirmations?.length === threshold) {
+    let safeOperationResponse = await this.apiKit.getSafeOperation(safeOperationHash);
+    if (safeOperationResponse.userOperation?.ethereumTxHash) {
+      return createSafeClientResult({
+        status: "SAFE_OPERATION_EXECUTED" /* SAFE_OPERATION_EXECUTED */,
+        safeAddress,
+        userOperationHash: safeOperationResponse.userOperation.userOperationHash,
+        safeOperationHash
+      });
+    }
+    if (this.#needsConfirmation(safeOperationResponse, threshold)) {
+      const signature = (0, import_protocol_kit5.buildSignatureBytes)([await this.protocolKit.signHash(safeOperationHash)]);
+      await this.apiKit.confirmSafeOperation(safeOperationHash, signature);
+      safeOperationResponse = await this.apiKit.getSafeOperation(safeOperationHash);
+    }
+    if (!this.#needsConfirmation(safeOperationResponse, threshold)) {
       const userOperationHash = await this.safe4337Pack.executeTransaction({
-        executable: confirmedSafeOperation
+        executable: safeOperationResponse
       });
       await this.#waitForOperationToFinish({ userOperationHash });
       return createSafeClientResult({
@@ -761,7 +784,10 @@ var SafeOperationClient = class {
    */
   async getPendingSafeOperations(options) {
     const safeAddress = await this.protocolKit.getAddress();
-    return this.apiKit.getPendingSafeOperations({ safeAddress, ...options });
+    return this.apiKit.getPendingSafeOperations(safeAddress, options);
+  }
+  #needsConfirmation(safeOperationResponse, threshold) {
+    return (safeOperationResponse.confirmations?.length || 0) < threshold;
   }
   /**
    * Helper method to wait for the operation to finish

package/dist/esm/index.mjs

@@ -275,12 +275,23 @@ var SafeClient = class extends BaseClient {
    * @throws {Error} If the transaction confirmation fails.
    */
   async confirm({ safeTxHash }) {
-    let transactionResponse = await this.apiKit.getTransaction(safeTxHash);
     const safeAddress = await this.protocolKit.getAddress();
-    const signedTransaction = await this.protocolKit.signTransaction(transactionResponse);
-    await this.apiKit.confirmTransaction(safeTxHash, signedTransaction.encodedSignatures());
-    transactionResponse = await this.apiKit.getTransaction(safeTxHash);
-    if (transactionResponse.confirmations && transactionResponse.confirmationsRequired === transactionResponse.confirmations.length) {
+    let transactionResponse = await this.apiKit.getTransaction(safeTxHash);
+    if (transactionResponse.isExecuted) {
+      return createSafeClientResult({
+        status: "EXECUTED" /* EXECUTED */,
+        safeAddress,
+        txHash: transactionResponse.transactionHash || "",
+        safeTxHash
+      });
+    }
+    if (this.#needsConfirmation(transactionResponse)) {
+      const signedTransaction = await this.protocolKit.signTransaction(transactionResponse);
+      const signature = signedTransaction.encodedSignatures();
+      await this.apiKit.confirmTransaction(safeTxHash, signature);
+      transactionResponse = await this.apiKit.getTransaction(safeTxHash);
+    }
+    if (!this.#needsConfirmation(transactionResponse)) {
       const executedTransactionResponse = await this.protocolKit.executeTransaction(transactionResponse);
       await waitSafeTxReceipt(executedTransactionResponse);
       return createSafeClientResult({
@@ -409,6 +420,9 @@ var SafeClient = class extends BaseClient {
       safeTxHash
     });
   }
+  #needsConfirmation(transactionResponse) {
+    return (transactionResponse.confirmations?.length || 0) < transactionResponse.confirmationsRequired;
+  }
   async #reconnectSafe() {
     this.protocolKit = await this.protocolKit.connect({
       provider: this.protocolKit.getSafeProvider().provider,
@@ -690,14 +704,23 @@ var SafeOperationClient = class {
   }) {
     const safeAddress = await this.protocolKit.getAddress();
     const threshold = await this.protocolKit.getThreshold();
-    await this.apiKit.confirmSafeOperation(
-      safeOperationHash,
-      buildSignatureBytes2([await this.protocolKit.signHash(safeOperationHash)])
-    );
-    const confirmedSafeOperation = await this.apiKit.getSafeOperation(safeOperationHash);
-    if (confirmedSafeOperation?.confirmations?.length === threshold) {
+    let safeOperationResponse = await this.apiKit.getSafeOperation(safeOperationHash);
+    if (safeOperationResponse.userOperation?.ethereumTxHash) {
+      return createSafeClientResult({
+        status: "SAFE_OPERATION_EXECUTED" /* SAFE_OPERATION_EXECUTED */,
+        safeAddress,
+        userOperationHash: safeOperationResponse.userOperation.userOperationHash,
+        safeOperationHash
+      });
+    }
+    if (this.#needsConfirmation(safeOperationResponse, threshold)) {
+      const signature = buildSignatureBytes2([await this.protocolKit.signHash(safeOperationHash)]);
+      await this.apiKit.confirmSafeOperation(safeOperationHash, signature);
+      safeOperationResponse = await this.apiKit.getSafeOperation(safeOperationHash);
+    }
+    if (!this.#needsConfirmation(safeOperationResponse, threshold)) {
       const userOperationHash = await this.safe4337Pack.executeTransaction({
-        executable: confirmedSafeOperation
+        executable: safeOperationResponse
       });
       await this.#waitForOperationToFinish({ userOperationHash });
       return createSafeClientResult({
@@ -723,7 +746,10 @@ var SafeOperationClient = class {
    */
   async getPendingSafeOperations(options) {
     const safeAddress = await this.protocolKit.getAddress();
-    return this.apiKit.getPendingSafeOperations({ safeAddress, ...options });
+    return this.apiKit.getPendingSafeOperations(safeAddress, options);
+  }
+  #needsConfirmation(safeOperationResponse, threshold) {
+    return (safeOperationResponse.confirmations?.length || 0) < threshold;
   }
   /**
    * Helper method to wait for the operation to finish

package/dist/src/SafeClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SafeClient.d.ts","sourceRoot":"","sources":["../../src/SafeClient.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,2BAA2B,CAAA;AAC5C,OAAO,UAAU,EAAE,EAAE,mCAAmC,EAAE,MAAM,sBAAsB,CAAA;AAUtF,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,oBAAoB,EACrB,MAAM,oCAAoC,CAAA;AAE3C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC;;;;;;;;;;GAUG;AACH,qBAAa,UAAW,SAAQ,UAAU;;gBAC5B,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU;IAIjD;;;;;;;;;;;;;;;;OAgBG;IACG,IAAI,CAAC,EACT,YAAY,EACZ,GAAG,kBAAkB,EACtB,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA2BnD;;;;;;;OAOG;IACG,OAAO,CAAC,EAAE,UAAU,EAAE,EAAE,uBAAuB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAiCjF;;;;;;OAMG;IACG,sBAAsB,IAAI,OAAO,CAAC,mCAAmC,CAAC;IAM5E;;;;;OAKG;IACH,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,MAAM,EAAE,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;IACtE,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,MAAM,EAAE,IAAI,KAAK,CAAC,GAAG,IAAI,GAAG,CAAC;CAiIrD"}
+{"version":3,"file":"SafeClient.d.ts","sourceRoot":"","sources":["../../src/SafeClient.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,2BAA2B,CAAA;AAC5C,OAAO,UAAU,EAAE,EAAE,mCAAmC,EAAE,MAAM,sBAAsB,CAAA;AAetF,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,oBAAoB,EACrB,MAAM,oCAAoC,CAAA;AAE3C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC;;;;;;;;;;GAUG;AACH,qBAAa,UAAW,SAAQ,UAAU;;gBAC5B,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU;IAIjD;;;;;;;;;;;;;;;;OAgBG;IACG,IAAI,CAAC,EACT,YAAY,EACZ,GAAG,kBAAkB,EACtB,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA2BnD;;;;;;;OAOG;IACG,OAAO,CAAC,EAAE,UAAU,EAAE,EAAE,uBAAuB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA2CjF;;;;;;OAMG;IACG,sBAAsB,IAAI,OAAO,CAAC,mCAAmC,CAAC;IAM5E;;;;;OAKG;IACH,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,MAAM,EAAE,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;IACtE,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,MAAM,EAAE,IAAI,KAAK,CAAC,GAAG,IAAI,GAAG,CAAC;CAuIrD"}

package/dist/src/extensions/messages/SafeMessageClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SafeMessageClient.d.ts","sourceRoot":"","sources":["../../../../src/extensions/messages/SafeMessageClient.ts"],"names":[],"mappings":"AAAA,OAAO,IAAyB,MAAM,2BAA2B,CAAA;AACjE,OAAO,UAAU,EAAE,EAEjB,WAAW,EACX,uBAAuB,EACxB,MAAM,sBAAsB,CAAA;AAI7B,OAAO,EACL,2BAA2B,EAC3B,gBAAgB,EAChB,wBAAwB,EACzB,MAAM,oCAAoC,CAAA;AAE3C;;;GAGG;AACH,qBAAa,iBAAiB;;IAC5B,WAAW,EAAE,IAAI,CAAA;IACjB,MAAM,EAAE,UAAU,CAAA;IAElB;;;;OAIG;gBACS,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU;IAKjD;;;;;;OAMG;IACG,WAAW,CAAC,EAAE,OAAO,EAAE,EAAE,wBAAwB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAWnF;;;;;;OAMG;IACG,cAAc,CAAC,EAAE,WAAW,EAAE,EAAE,2BAA2B,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAqB7F;;;;;OAKG;IACG,kBAAkB,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAiGlF"}
+{"version":3,"file":"SafeMessageClient.d.ts","sourceRoot":"","sources":["../../../../src/extensions/messages/SafeMessageClient.ts"],"names":[],"mappings":"AAAA,OAAO,IAAyB,MAAM,2BAA2B,CAAA;AACjE,OAAO,UAAU,EAAE,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAIvF,OAAO,EACL,2BAA2B,EAC3B,gBAAgB,EAChB,wBAAwB,EACzB,MAAM,oCAAoC,CAAA;AAE3C;;;GAGG;AACH,qBAAa,iBAAiB;;IAC5B,WAAW,EAAE,IAAI,CAAA;IACjB,MAAM,EAAE,UAAU,CAAA;IAElB;;;;OAIG;gBACS,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU;IAKjD;;;;;;OAMG;IACG,WAAW,CAAC,EAAE,OAAO,EAAE,EAAE,wBAAwB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAWnF;;;;;;OAMG;IACG,cAAc,CAAC,EAAE,WAAW,EAAE,EAAE,2BAA2B,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAqB7F;;;;;OAKG;IACG,kBAAkB,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAiGlF"}

package/dist/src/extensions/safe-operations/SafeOperationClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SafeOperationClient.d.ts","sourceRoot":"","sources":["../../../../src/extensions/safe-operations/SafeOperationClient.ts"],"names":[],"mappings":"AAAA,OAAO,IAA6B,MAAM,2BAA2B,CAAA;AACrE,OAAO,UAAU,EAAE,EAAE,WAAW,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAA;AAC5F,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAIrD,OAAO,EACL,yBAAyB,EACzB,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,oCAAoC,CAAA;AAE3C;;;;GAIG;AACH,qBAAa,mBAAmB;;IAC9B,WAAW,EAAE,IAAI,CAAA;IACjB,MAAM,EAAE,UAAU,CAAA;IAClB,YAAY,EAAE,YAAY,CAAA;gBAEd,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU;IAM1D;;;;;;;;;;;;;;OAcG;IACG,iBAAiB,CAAC,EACtB,YAAY,EACZ,GAAG,wBAAwB,EAC5B,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAoCrD;;;;;;;;OAQG;IACG,oBAAoB,CAAC,EACzB,iBAAiB,EAClB,EAAE,yBAAyB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAiCxD;;;;;;;OAOG;IACG,wBAAwB,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,4BAA4B,CAAC;CAsB7F"}
+{"version":3,"file":"SafeOperationClient.d.ts","sourceRoot":"","sources":["../../../../src/extensions/safe-operations/SafeOperationClient.ts"],"names":[],"mappings":"AAAA,OAAO,IAA6B,MAAM,2BAA2B,CAAA;AACrE,OAAO,UAAU,EAAE,EAAE,WAAW,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAA;AAC5F,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAIrD,OAAO,EACL,yBAAyB,EACzB,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,oCAAoC,CAAA;AAG3C;;;;GAIG;AACH,qBAAa,mBAAmB;;IAC9B,WAAW,EAAE,IAAI,CAAA;IACjB,MAAM,EAAE,UAAU,CAAA;IAClB,YAAY,EAAE,YAAY,CAAA;gBAEd,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU;IAM1D;;;;;;;;;;;;;;OAcG;IACG,iBAAiB,CAAC,EACtB,YAAY,EACZ,GAAG,wBAAwB,EAC5B,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAoCrD;;;;;;;;OAQG;IACG,oBAAoB,CAAC,EACzB,iBAAiB,EAClB,EAAE,yBAAyB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA4CxD;;;;;;;OAOG;IACG,wBAAwB,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,4BAA4B,CAAC;CA0B7F"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@safe-global/sdk-starter-kit",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0",
   "description": "SDK that provides the basic tools to interact with the Safe Smart Account.",
   "types": "dist/src/index.d.ts",
   "main": "dist/cjs/index.cjs",
@@ -19,7 +19,7 @@
     "SDK"
   ],
   "scripts": {
-    "unbuild": "rimraf dist",
+    "unbuild": "rimraf dist coverage",
     "build": "yarn unbuild && yarn build:esm && yarn build:cjs && yarn build:types",
     "build:esm": "esbuild ./src/index --format=esm --bundle --packages=external --outdir=dist/esm --out-extension:.js=.mjs",
     "build:cjs": "esbuild ./src/index --format=cjs --bundle --packages=external --outdir=dist/cjs --out-extension:.js=.cjs",
@@ -45,10 +45,10 @@
     "access": "public"
   },
   "dependencies": {
-    "@safe-global/api-kit": "^3.0.0-alpha.2",
-    "@safe-global/protocol-kit": "^6.0.0-alpha.2",
-    "@safe-global/relay-kit": "^4.0.0-alpha.2",
-    "@safe-global/types-kit": "^2.0.0-alpha.2",
+    "@safe-global/api-kit": "^3.0.0",
+    "@safe-global/protocol-kit": "^6.0.0",
+    "@safe-global/relay-kit": "^4.0.0",
+    "@safe-global/types-kit": "^2.0.0",
     "viem": "^2.21.8"
   }
 }