@ckb-ccc/ssri 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @ckb-ccc/ssri
 
+## 0.2.0
+
+### Minor Changes
+
+- [`e4ea183`](https://github.com/ckb-devrel/ccc/commit/e4ea18359675877511550ac0b28f207550f907e4) Thanks [@Hanssen0](https://github.com/Hanssen0)! - feat(ssri): Trait.tryRun to handle expected error
+
+### Patch Changes
+
+- [`52ef11b`](https://github.com/ckb-devrel/ccc/commit/52ef11baa7bde8a73467683f5c44a863190aa1f1) Thanks [@Hanssen0](https://github.com/Hanssen0)! - fix(ssri): Trait.version() should throw if byteLength mismatch
+
+- Updated dependencies [[`3fdb2c4`](https://github.com/ckb-devrel/ccc/commit/3fdb2c477d0b2766b231e436b8f396f047b02634), [`f429087`](https://github.com/ckb-devrel/ccc/commit/f4290874dfab3fe58844e5169673c5d47bda64e3)]:
+  - @ckb-ccc/core@1.4.0
+
 ## 0.1.1
 
 ### Patch Changes

package/dist/trait.d.ts

@@ -12,6 +12,8 @@ export declare class Trait {
      * @param executor - The SSRI executor instance.
      */
     constructor(code: ccc.OutPointLike, executor?: Executor | null);
+    static tryRun<T>(call: Promise<ExecutorResponse<T>>): Promise<ExecutorResponse<T | undefined>>;
+    tryRun<T>(call: Promise<ExecutorResponse<T>>): Promise<ExecutorResponse<T | undefined>>;
     assertExecutor(): Executor;
     /**
      * Retrieves a list of methods.

package/dist/trait.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"trait.d.ts","sourceRoot":"","sources":["../src/trait.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAG3D;;GAEG;AACH,qBAAa,KAAK;IAChB,SAAgB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC;IACnC,SAAgB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpC;;;;OAIG;gBACS,IAAI,EAAE,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI;IAK9D,cAAc;IAQd;;;;;OAKG;IACG,UAAU,CACd,MAAM,GAAE,GAAG,CAAC,OAAW,EACvB,KAAK,GAAE,GAAG,CAAC,OAAW,GACrB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;IAUvC;;;;OAIG;IACG,UAAU,CACd,WAAW,EAAE,MAAM,EAAE,EACrB,gBAAgB,CAAC,EAAE,GAAG,CAAC,OAAO,EAAE,GAC/B,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC;IAcvC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CAQpD"}
+{"version":3,"file":"trait.d.ts","sourceRoot":"","sources":["../src/trait.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EACL,QAAQ,EAGR,gBAAgB,EACjB,MAAM,eAAe,CAAC;AAGvB;;GAEG;AACH,qBAAa,KAAK;IAChB,SAAgB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC;IACnC,SAAgB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpC;;;;OAIG;gBACS,IAAI,EAAE,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI;WAKjD,MAAM,CAAC,CAAC,EACnB,IAAI,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GACjC,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAcrC,MAAM,CAAC,CAAC,EACZ,IAAI,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GACjC,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAI3C,cAAc;IAQd;;;;;OAKG;IACG,UAAU,CACd,MAAM,GAAE,GAAG,CAAC,OAAW,EACvB,KAAK,GAAE,GAAG,CAAC,OAAW,GACrB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;IAUvC;;;;OAIG;IACG,UAAU,CACd,WAAW,EAAE,MAAM,EAAE,EACrB,gBAAgB,CAAC,EAAE,GAAG,CAAC,OAAO,EAAE,GAC/B,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC;IAcvC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CAcpD"}

package/dist/trait.js

@@ -1,4 +1,5 @@
 import { ccc } from "@ckb-ccc/core";
+import { ExecutorErrorDecode, ExecutorErrorExecutionFailed, ExecutorResponse, } from "./executor.js";
 import { getMethodPath } from "./utils.js";
 /**
  * Class representing an SSRI trait. Should be used as the base of all SSRI traits.
@@ -13,6 +14,21 @@ export class Trait {
         this.code = ccc.OutPoint.from(code);
         this.executor = executor ?? undefined;
     }
+    static async tryRun(call) {
+        try {
+            return await call;
+        }
+        catch (e) {
+            if (e instanceof ExecutorErrorExecutionFailed ||
+                e instanceof ExecutorErrorDecode) {
+                return ExecutorResponse.new(undefined);
+            }
+            throw e;
+        }
+    }
+    async tryRun(call) {
+        return Trait.tryRun(call);
+    }
     assertExecutor() {
         if (!this.executor) {
             throw new Error("SSRI executor is not set");
@@ -47,6 +63,11 @@ export class Trait {
      */
     async version() {
         const res = await this.assertExecutor().runScript(this.code, "SSRI.version", []);
-        return res.map((res) => ccc.numFrom(res));
+        return res.map((res) => {
+            if (res.length !== 4) {
+                throw new Error("Invalid U8");
+            }
+            return ccc.numFrom(res);
+        });
     }
 }

package/dist.commonjs/trait.d.ts

@@ -12,6 +12,8 @@ export declare class Trait {
      * @param executor - The SSRI executor instance.
      */
     constructor(code: ccc.OutPointLike, executor?: Executor | null);
+    static tryRun<T>(call: Promise<ExecutorResponse<T>>): Promise<ExecutorResponse<T | undefined>>;
+    tryRun<T>(call: Promise<ExecutorResponse<T>>): Promise<ExecutorResponse<T | undefined>>;
     assertExecutor(): Executor;
     /**
      * Retrieves a list of methods.

package/dist.commonjs/trait.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"trait.d.ts","sourceRoot":"","sources":["../src/trait.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAG3D;;GAEG;AACH,qBAAa,KAAK;IAChB,SAAgB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC;IACnC,SAAgB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpC;;;;OAIG;gBACS,IAAI,EAAE,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI;IAK9D,cAAc;IAQd;;;;;OAKG;IACG,UAAU,CACd,MAAM,GAAE,GAAG,CAAC,OAAW,EACvB,KAAK,GAAE,GAAG,CAAC,OAAW,GACrB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;IAUvC;;;;OAIG;IACG,UAAU,CACd,WAAW,EAAE,MAAM,EAAE,EACrB,gBAAgB,CAAC,EAAE,GAAG,CAAC,OAAO,EAAE,GAC/B,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC;IAcvC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CAQpD"}
+{"version":3,"file":"trait.d.ts","sourceRoot":"","sources":["../src/trait.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EACL,QAAQ,EAGR,gBAAgB,EACjB,MAAM,eAAe,CAAC;AAGvB;;GAEG;AACH,qBAAa,KAAK;IAChB,SAAgB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC;IACnC,SAAgB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpC;;;;OAIG;gBACS,IAAI,EAAE,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI;WAKjD,MAAM,CAAC,CAAC,EACnB,IAAI,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GACjC,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAcrC,MAAM,CAAC,CAAC,EACZ,IAAI,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GACjC,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAI3C,cAAc;IAQd;;;;;OAKG;IACG,UAAU,CACd,MAAM,GAAE,GAAG,CAAC,OAAW,EACvB,KAAK,GAAE,GAAG,CAAC,OAAW,GACrB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;IAUvC;;;;OAIG;IACG,UAAU,CACd,WAAW,EAAE,MAAM,EAAE,EACrB,gBAAgB,CAAC,EAAE,GAAG,CAAC,OAAO,EAAE,GAC/B,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC;IAcvC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CAcpD"}

package/dist.commonjs/trait.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Trait = void 0;
 const core_1 = require("@ckb-ccc/core");
+const executor_js_1 = require("./executor.js");
 const utils_js_1 = require("./utils.js");
 /**
  * Class representing an SSRI trait. Should be used as the base of all SSRI traits.
@@ -16,6 +17,21 @@ class Trait {
         this.code = core_1.ccc.OutPoint.from(code);
         this.executor = executor ?? undefined;
     }
+    static async tryRun(call) {
+        try {
+            return await call;
+        }
+        catch (e) {
+            if (e instanceof executor_js_1.ExecutorErrorExecutionFailed ||
+                e instanceof executor_js_1.ExecutorErrorDecode) {
+                return executor_js_1.ExecutorResponse.new(undefined);
+            }
+            throw e;
+        }
+    }
+    async tryRun(call) {
+        return Trait.tryRun(call);
+    }
     assertExecutor() {
         if (!this.executor) {
             throw new Error("SSRI executor is not set");
@@ -50,7 +66,12 @@ class Trait {
      */
     async version() {
         const res = await this.assertExecutor().runScript(this.code, "SSRI.version", []);
-        return res.map((res) => core_1.ccc.numFrom(res));
+        return res.map((res) => {
+            if (res.length !== 4) {
+                throw new Error("Invalid U8");
+            }
+            return core_1.ccc.numFrom(res);
+        });
     }
 }
 exports.Trait = Trait;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckb-ccc/ssri",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "SSRI",
   "author": "Alive24 <xct24@live.com>",
   "license": "MIT",
@@ -42,7 +42,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@ckb-ccc/core": "1.3.1"
+    "@ckb-ccc/core": "1.4.0"
   },
   "scripts": {
     "test": "jest",

package/src/trait.ts

@@ -1,5 +1,10 @@
 import { ccc } from "@ckb-ccc/core";
-import { Executor, ExecutorResponse } from "./executor.js";
+import {
+  Executor,
+  ExecutorErrorDecode,
+  ExecutorErrorExecutionFailed,
+  ExecutorResponse,
+} from "./executor.js";
 import { getMethodPath } from "./utils.js";
 
 /**
@@ -19,6 +24,28 @@ export class Trait {
     this.executor = executor ?? undefined;
   }
 
+  static async tryRun<T>(
+    call: Promise<ExecutorResponse<T>>,
+  ): Promise<ExecutorResponse<T | undefined>> {
+    try {
+      return await call;
+    } catch (e) {
+      if (
+        e instanceof ExecutorErrorExecutionFailed ||
+        e instanceof ExecutorErrorDecode
+      ) {
+        return ExecutorResponse.new(undefined);
+      }
+      throw e;
+    }
+  }
+
+  async tryRun<T>(
+    call: Promise<ExecutorResponse<T>>,
+  ): Promise<ExecutorResponse<T | undefined>> {
+    return Trait.tryRun(call);
+  }
+
   assertExecutor() {
     if (!this.executor) {
       throw new Error("SSRI executor is not set");
@@ -78,6 +105,12 @@ export class Trait {
       "SSRI.version",
       [],
     );
-    return res.map((res) => ccc.numFrom(res));
+
+    return res.map((res) => {
+      if (res.length !== 4) {
+        throw new Error("Invalid U8");
+      }
+      return ccc.numFrom(res);
+    });
   }
 }