@layerzerolabs/common-error-utils 0.2.8

package/.turbo/turbo-build.log

@@ -0,0 +1,18 @@
+
+> @layerzerolabs/common-error-utils@0.0.0 build /home/runner/work/monorepo-internal/monorepo-internal/packages/common/common-error-utils
+> tsup
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.1
+CLI Using tsup config: /home/runner/work/monorepo-internal/monorepo-internal/packages/common/common-error-utils/tsup.config.ts
+CLI Target: ES2023
+CLI Cleaning output folder
+CJS Build start
+ESM Build start
+ESM dist/index.js     4.54 KB
+ESM dist/index.js.map 9.77 KB
+ESM ⚡️ Build success in 111ms
+CJS dist/index.cjs     4.80 KB
+CJS dist/index.cjs.map 9.77 KB
+CJS ⚡️ Build success in 111ms

package/.turbo/turbo-lint.log

@@ -0,0 +1,8 @@
+
+> @layerzerolabs/common-error-utils@0.0.0 lint /home/runner/work/monorepo-internal/monorepo-internal/packages/common/common-error-utils
+> eslint . --max-warnings 0 || (eslint . --fix --max-warnings 0 && false)
+
+(node:26639) [MODULE_TYPELESS_PACKAGE_JSON] Warning: Module type of file:///home/runner/work/monorepo-internal/monorepo-internal/eslint.config.js?mtime=1766517510509 is not specified and it doesn't parse as CommonJS.
+Reparsing as ES module because module syntax was detected. This incurs a performance overhead.
+To eliminate this warning, add "type": "module" to /home/runner/work/monorepo-internal/monorepo-internal/package.json.
+(Use `node --trace-warnings ...` to show where the warning was created)

package/.turbo/turbo-test.log

@@ -0,0 +1,32 @@
+
+> @layerzerolabs/common-error-utils@0.0.0 test /home/runner/work/monorepo-internal/monorepo-internal/packages/common/common-error-utils
+> vitest --run --pass-with-no-tests --typecheck
+
+Testing types with tsc and vue-tsc is an experimental feature.
+Breaking changes might not follow SemVer, please pin Vitest's version when using it.
+
+ RUN  v3.2.4 /home/runner/work/monorepo-internal/monorepo-internal/packages/common/common-error-utils
+
+stdout | tests/error.test.ts > SerializableError > wraps simple error
+SomeError constructor called {
+  cause: Error: Some error 2
+      at /home/runner/work/monorepo-internal/monorepo-internal/packages/common/common-error-utils/tests/error.test.ts:33:21
+      at file:///home/runner/work/monorepo-internal/monorepo-internal/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:155:11
+      at file:///home/runner/work/monorepo-internal/monorepo-internal/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:752:26
+      at file:///home/runner/work/monorepo-internal/monorepo-internal/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1897:20
+      at new Promise (<anonymous>)
+      at runWithTimeout (file:///home/runner/work/monorepo-internal/monorepo-internal/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1863:10)
+      at runTest (file:///home/runner/work/monorepo-internal/monorepo-internal/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1574:12)
+      at processTicksAndRejections (node:internal/process/task_queues:105:5)
+      at runSuite (file:///home/runner/work/monorepo-internal/monorepo-internal/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1729:8)
+      at runSuite (file:///home/runner/work/monorepo-internal/monorepo-internal/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1729:8)
+}
+
+ ✓ tests/error.test.ts (3 tests) 8ms
+
+ Test Files  1 passed (1)
+      Tests  3 passed (3)
+Type Errors  no errors
+   Start at  19:23:31
+   Duration  334ms (transform 44ms, setup 0ms, collect 40ms, tests 8ms, environment 0ms, prepare 73ms)
+

package/dist/index.cjs

@@ -0,0 +1,174 @@
+'use strict';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/index.ts
+var extractMessageFromJsonRpcError = /* @__PURE__ */ __name((err) => {
+  try {
+    if (typeof err.body === "object" && err.body.message) {
+      return err.body.message;
+    }
+    const parsedBody = JSON.parse(err.body);
+    return parsedBody?.error?.message;
+  } catch {
+    return "unknown";
+  }
+}, "extractMessageFromJsonRpcError");
+function convertErrorToObject(err) {
+  return JSON.parse(JSON.stringify(err, Object.getOwnPropertyNames(err)));
+}
+__name(convertErrorToObject, "convertErrorToObject");
+function normalizeError(err) {
+  const error = convertErrorToObject(err);
+  return {
+    // Normal Error properties
+    ...error.name ? {
+      name: error.name
+    } : {},
+    ...error.message ? {
+      message: error.message
+    } : {},
+    ...error.stack ? {
+      stack: error.stack
+    } : {},
+    // Rpc properties
+    ...error.reason ? {
+      reason: error.reason
+    } : {},
+    ...error.code ? {
+      code: error.code
+    } : {},
+    ...error.event ? {
+      event: error.event
+    } : {},
+    ...error.body ? {
+      body: extractMessageFromJsonRpcError(error)
+    } : {}
+  };
+}
+__name(normalizeError, "normalizeError");
+var SerializableError = class extends Error {
+  static {
+    __name(this, "SerializableError");
+  }
+  details;
+  /*
+   * The instance of the error that was wrapped, if any.
+   * Creates a linked list of error objects.
+   * Only exists if the error hasn't been serialized and deserialized.
+   */
+  cause;
+  constructor(message, options) {
+    super(message, options);
+    this.cause = options?.cause;
+    this.name = this.constructor.name;
+    this.details = [
+      this.constructor.name,
+      "SerializableError"
+    ];
+  }
+  /*
+   * Checks if the error is an instance of the current class or a subclass. Returns the error if it is.
+   * We can't type the error as more than SerializableError because it could have been serialized and deserialized,
+   * which could make it lose extra fields.
+   */
+  static inStackOf(error) {
+    if (error?.details?.includes(this.name)) {
+      return error;
+    } else if (error?.cause?.details?.includes(this.name)) {
+      return error.cause;
+    }
+    return void 0;
+  }
+  // We could limit this to only wrap serializable errors, but that could limit the flexibility of the error system.
+  static wrap(error, ...args) {
+    const wrappedError = new this(...args, {
+      cause: error
+    });
+    wrappedError.details = error?.details ? [
+      wrappedError.name,
+      ...error.details
+    ] : [
+      wrappedError.name,
+      "SerializableError",
+      error?.name ?? "UnknownError"
+    ];
+    wrappedError.message = `${wrappedError.message} > ${error?.message ?? String(error)}`;
+    return wrappedError;
+  }
+};
+var NonRetryableError = class extends SerializableError {
+  static {
+    __name(this, "NonRetryableError");
+  }
+  constructor(message, options) {
+    super(message, options);
+  }
+};
+var NotFoundError = class extends SerializableError {
+  static {
+    __name(this, "NotFoundError");
+  }
+  constructor(message, options) {
+    super(message ? `Not found: ${message}` : "Not found", options);
+  }
+};
+var ProviderError = class _ProviderError extends SerializableError {
+  static {
+    __name(this, "ProviderError");
+  }
+  constructor(providerUri, options) {
+    super(`Provider error at host '${_ProviderError.parseHost(providerUri)}'`, options);
+  }
+  static parseHost(providerUri) {
+    try {
+      const url = new URL(providerUri);
+      return url.host;
+    } catch {
+      return "UNKNOWN_HOST";
+    }
+  }
+};
+var NonEmittableError = class extends SerializableError {
+  static {
+    __name(this, "NonEmittableError");
+  }
+  constructor(message, options) {
+    super(message, options);
+    this.name = "NonEmittableError";
+  }
+};
+var QuorumNotAchievedYet = class extends SerializableError {
+  static {
+    __name(this, "QuorumNotAchievedYet");
+  }
+  constructor(options) {
+    super("The quorum was not achieved yet", options);
+  }
+};
+var MultiError = class extends Error {
+  static {
+    __name(this, "MultiError");
+  }
+  errs;
+  constructor(errs) {
+    super(errs.map((err) => err.message).join(", ")), this.errs = errs;
+  }
+};
+var throwError = /* @__PURE__ */ __name((message, error) => {
+  throw error?.(message) ?? new Error(message);
+}, "throwError");
+
+exports.MultiError = MultiError;
+exports.NonEmittableError = NonEmittableError;
+exports.NonRetryableError = NonRetryableError;
+exports.NotFoundError = NotFoundError;
+exports.ProviderError = ProviderError;
+exports.QuorumNotAchievedYet = QuorumNotAchievedYet;
+exports.SerializableError = SerializableError;
+exports.convertErrorToObject = convertErrorToObject;
+exports.normalizeError = normalizeError;
+exports.throwError = throwError;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":["extractMessageFromJsonRpcError","err","body","message","parsedBody","JSON","parse","error","convertErrorToObject","stringify","Object","getOwnPropertyNames","normalizeError","name","stack","reason","code","event","SerializableError","Error","details","cause","options","inStackOf","includes","undefined","wrap","args","wrappedError","String","NonRetryableError","NotFoundError","ProviderError","providerUri","parseHost","url","URL","host","NonEmittableError","QuorumNotAchievedYet","MultiError","errs","map","join","throwError"],"mappings":";;;;;;AAAA,IAAMA,8BAAAA,2BAAkCC,GAAAA,KAAAA;AACpC,EAAA,IAAI;AACA,IAAA,IAAI,OAAOA,GAAAA,CAAIC,IAAAA,KAAS,QAAA,IAAYD,GAAAA,CAAIC,KAAKC,OAAAA,EAAS;AAClD,MAAA,OAAOF,IAAIC,IAAAA,CAAKC,OAAAA;AACpB,IAAA;AACA,IAAA,MAAMC,UAAAA,GAAaC,IAAAA,CAAKC,KAAAA,CAAML,GAAAA,CAAIC,IAAI,CAAA;AACtC,IAAA,OAAOE,YAAYG,KAAAA,EAAOJ,OAAAA;EAC9B,CAAA,CAAA,MAAQ;AACJ,IAAA,OAAO,SAAA;AACX,EAAA;AACJ,CAAA,EAVuC,gCAAA,CAAA;AAYhC,SAASK,qBAAqBP,GAAAA,EAAQ;AACzC,EAAA,OAAOI,IAAAA,CAAKC,MAAMD,IAAAA,CAAKI,SAAAA,CAAUR,KAAKS,MAAAA,CAAOC,mBAAAA,CAAoBV,GAAAA,CAAAA,CAAAA,CAAAA;AACrE;AAFgBO,MAAAA,CAAAA,oBAAAA,EAAAA,sBAAAA,CAAAA;AAIT,SAASI,eAAeX,GAAAA,EAAQ;AACnC,EAAA,MAAMM,KAAAA,GAAQC,qBAAqBP,GAAAA,CAAAA;AACnC,EAAA,OAAO;;AAEH,IAAA,GAAIM,MAAMM,IAAAA,GAAO;AAAEA,MAAAA,IAAAA,EAAMN,KAAAA,CAAMM;AAAK,KAAA,GAAI,EAAC;AACzC,IAAA,GAAIN,MAAMJ,OAAAA,GAAU;AAAEA,MAAAA,OAAAA,EAASI,KAAAA,CAAMJ;AAAQ,KAAA,GAAI,EAAC;AAClD,IAAA,GAAII,MAAMO,KAAAA,GAAQ;AAAEA,MAAAA,KAAAA,EAAOP,KAAAA,CAAMO;AAAM,KAAA,GAAI,EAAC;;AAE5C,IAAA,GAAIP,MAAMQ,MAAAA,GAAS;AAAEA,MAAAA,MAAAA,EAAQR,KAAAA,CAAMQ;AAAO,KAAA,GAAI,EAAC;AAC/C,IAAA,GAAIR,MAAMS,IAAAA,GAAO;AAAEA,MAAAA,IAAAA,EAAMT,KAAAA,CAAMS;AAAK,KAAA,GAAI,EAAC;AACzC,IAAA,GAAIT,MAAMU,KAAAA,GAAQ;AAAEA,MAAAA,KAAAA,EAAOV,KAAAA,CAAMU;AAAM,KAAA,GAAI,EAAC;AAC5C,IAAA,GAAIV,MAAML,IAAAA,GAAO;AAAEA,MAAAA,IAAAA,EAAMF,+BAA+BO,KAAAA;AAAO,KAAA,GAAI;AACvE,GAAA;AACJ;AAbgBK,MAAAA,CAAAA,cAAAA,EAAAA,gBAAAA,CAAAA;AAwBT,IAAeM,iBAAAA,GAAf,cAAyCC,KAAAA,CAAAA;EAxChD;;;AAyCIC,EAAAA,OAAAA;;;;;;AAMAC,EAAAA,KAAAA;AACA,EAAA,WAAA,CAAYlB,SAAiBmB,OAAAA,EAAwB;AACjD,IAAA,KAAA,CAAMnB,SAASmB,OAAAA,CAAAA;AAEf,IAAA,IAAA,CAAKD,QAAQC,OAAAA,EAASD,KAAAA;AACtB,IAAA,IAAA,CAAKR,IAAAA,GAAO,KAAK,WAAA,CAAYA,IAAAA;AAC7B,IAAA,IAAA,CAAKO,OAAAA,GAAU;AAAC,MAAA,IAAA,CAAK,WAAA,CAAYP,IAAAA;AAAM,MAAA;;AAC3C,EAAA;;;;;;AAOA,EAAA,OAAOU,UAEHhB,KAAAA,EAC6B;AAC7B,IAAA,IAAIA,KAAAA,EAAOa,OAAAA,EAASI,QAAAA,CAAS,IAAA,CAAKX,IAAI,CAAA,EAAG;AACrC,MAAA,OAAON,KAAAA;AACX,IAAA,CAAA,MAAA,IAAWA,OAAOc,KAAAA,EAAOD,OAAAA,EAASI,QAAAA,CAAS,IAAA,CAAKX,IAAI,CAAA,EAAG;AACnD,MAAA,OAAON,KAAAA,CAAMc,KAAAA;AACjB,IAAA;AACA,IAAA,OAAOI,MAAAA;AACX,EAAA;;EAGA,OAAOC,IAAAA,CAEHnB,UAEGoB,IAAAA,EACY;AACf,IAAA,MAAMC,YAAAA,GAAe,IAAI,IAAA,CAAI,GAAID,IAAAA,EAAM;MAAEN,KAAAA,EAAOd;KAAM,CAAA;AAEtDqB,IAAAA,YAAAA,CAAaR,OAAAA,GAAUb,OAAOa,OAAAA,GACxB;MAACQ,YAAAA,CAAaf,IAAAA;SAASN,KAAAA,CAAMa;AAC7B,KAAA,GAAA;MAACQ,YAAAA,CAAaf,IAAAA;AAAM,MAAA,mBAAA;AAAqBN,MAAAA,KAAAA,EAAOM,IAAAA,IAAQ;;AAE9De,IAAAA,YAAAA,CAAazB,OAAAA,GAAU,GAAGyB,YAAAA,CAAazB,OAAO,MAAMI,KAAAA,EAAOJ,OAAAA,IAAW0B,MAAAA,CAAOtB,KAAAA,CAAAA,CAAAA,CAAAA;AAE7E,IAAA,OAAOqB,YAAAA;AACX,EAAA;AACJ;AAEO,IAAME,iBAAAA,GAAN,cAAgCZ,iBAAAA,CAAAA;EA5FvC;;;AA6FI,EAAA,WAAA,CAAYf,SAAiBmB,OAAAA,EAAwB;AACjD,IAAA,KAAA,CAAMnB,SAASmB,OAAAA,CAAAA;AACnB,EAAA;AACJ;AAEO,IAAMS,aAAAA,GAAN,cAA4Bb,iBAAAA,CAAAA;EAlGnC;;;AAmGI,EAAA,WAAA,CAAYf,SAAkBmB,OAAAA,EAAwB;AAClD,IAAA,KAAA,CAAMnB,OAAAA,GAAU,CAAA,WAAA,EAAcA,OAAAA,CAAAA,CAAAA,GAAY,aAAamB,OAAAA,CAAAA;AAC3D,EAAA;AACJ;AAGO,IAAMU,aAAAA,GAAN,MAAMA,cAAAA,SAAsBd,iBAAAA,CAAAA;EAzGnC;;;AA0GI,EAAA,WAAA,CAAYe,aAAqBX,OAAAA,EAAwB;AACrD,IAAA,KAAA,CAAM,2BAA2BU,cAAAA,CAAcE,SAAAA,CAAUD,WAAAA,CAAAA,KAAiBX,OAAAA,CAAAA;AAC9E,EAAA;AAEA,EAAA,OAAeY,UAAUD,WAAAA,EAA6B;AAClD,IAAA,IAAI;AACA,MAAA,MAAME,GAAAA,GAAM,IAAIC,GAAAA,CAAIH,WAAAA,CAAAA;AACpB,MAAA,OAAOE,GAAAA,CAAIE,IAAAA;IACf,CAAA,CAAA,MAAQ;AACJ,MAAA,OAAO,cAAA;AACX,IAAA;AACJ,EAAA;AACJ;AAEO,IAAMC,iBAAAA,GAAN,cAAgCpB,iBAAAA,CAAAA;EAxHvC;;;AAyHI,EAAA,WAAA,CAAYf,SAAiBmB,OAAAA,EAAwB;AACjD,IAAA,KAAA,CAAMnB,SAASmB,OAAAA,CAAAA;AACf,IAAA,IAAA,CAAKT,IAAAA,GAAO,mBAAA;AAChB,EAAA;AACJ;AAEO,IAAM0B,oBAAAA,GAAN,cAAmCrB,iBAAAA,CAAAA;EA/H1C;;;AAgII,EAAA,WAAA,CAAYI,OAAAA,EAAwB;AAChC,IAAA,KAAA,CAAM,mCAAmCA,OAAAA,CAAAA;AAC7C,EAAA;AACJ;AAEO,IAAMkB,UAAAA,GAAN,cAAyBrB,KAAAA,CAAAA;EArIhC;;;;AAsII,EAAA,WAAA,CAA4BsB,IAAAA,EAAa;AACrC,IAAA,KAAA,CAAMA,IAAAA,CAAKC,GAAAA,CAAI,CAACzC,GAAAA,KAAQA,GAAAA,CAAIE,OAAO,CAAA,CAAEwC,IAAAA,CAAK,IAAA,CAAA,CAAA,EAAA,IAAA,CADlBF,IAAAA,GAAAA,IAAAA;AAE5B,EAAA;AACJ;AAEO,IAAMG,UAAAA,mBAAa,MAAA,CAAA,CACtBzC,OAAAA,EACAI,KAAAA,KAAAA;AAEA,EAAA,MAAMA,KAAAA,GAAQJ,OAAAA,CAAAA,IAAY,IAAIgB,MAAMhB,OAAAA,CAAAA;AACxC,CAAA,EAL0B,YAAA","file":"index.cjs","sourcesContent":["const extractMessageFromJsonRpcError = (err: any): string => {\n    try {\n        if (typeof err.body === 'object' && err.body.message) {\n            return err.body.message;\n        }\n        const parsedBody = JSON.parse(err.body);\n        return parsedBody?.error?.message;\n    } catch {\n        return 'unknown';\n    }\n};\n\nexport function convertErrorToObject(err: any): any {\n    return JSON.parse(JSON.stringify(err, Object.getOwnPropertyNames(err)));\n}\n\nexport function normalizeError(err: any) {\n    const error = convertErrorToObject(err);\n    return {\n        // Normal Error properties\n        ...(error.name ? { name: error.name } : {}),\n        ...(error.message ? { message: error.message } : {}),\n        ...(error.stack ? { stack: error.stack } : {}),\n        // Rpc properties\n        ...(error.reason ? { reason: error.reason } : {}),\n        ...(error.code ? { code: error.code } : {}),\n        ...(error.event ? { event: error.event } : {}),\n        ...(error.body ? { body: extractMessageFromJsonRpcError(error) } : {}),\n    };\n}\n\n// Removes the last argument if it is an ErrorOptions\ntype RemoveErrorOptions<T extends any[]> = T extends [...infer U, ErrorOptions?] ? U : never;\n\n/**\n * Base class for all serializable errors.\n * This class is designed to be extended by other error classes.\n * It provides a way to wrap errors and a way to check if an error is in the stack of a specific error class.\n * All errors that extend this class *must* have error options as the last argument in their constructor.\n */\nexport abstract class SerializableError extends Error {\n    details: string[];\n    /*\n     * The instance of the error that was wrapped, if any.\n     * Creates a linked list of error objects.\n     * Only exists if the error hasn't been serialized and deserialized.\n     */\n    cause: unknown;\n    constructor(message: string, options?: ErrorOptions) {\n        super(message, options);\n        // for some reason, we need to set the cause directly on the instance, even after calling super\n        this.cause = options?.cause;\n        this.name = this.constructor.name;\n        this.details = [this.constructor.name, 'SerializableError'];\n    }\n\n    /*\n     * Checks if the error is an instance of the current class or a subclass. Returns the error if it is.\n     * We can't type the error as more than SerializableError because it could have been serialized and deserialized,\n     * which could make it lose extra fields.\n     */\n    static inStackOf<T extends abstract new (...args: any) => any>(\n        this: T,\n        error: any,\n    ): SerializableError | undefined {\n        if (error?.details?.includes(this.name)) {\n            return error as SerializableError;\n        } else if (error?.cause?.details?.includes(this.name)) {\n            return error.cause as SerializableError;\n        }\n        return undefined;\n    }\n\n    // We could limit this to only wrap serializable errors, but that could limit the flexibility of the error system.\n    static wrap<T extends new (...args: any) => SerializableError>(\n        this: T,\n        error: any,\n        // Remove the optional error arguments\n        ...args: RemoveErrorOptions<ConstructorParameters<T>>\n    ): InstanceType<T> {\n        const wrappedError = new this(...args, { cause: error });\n\n        wrappedError.details = error?.details\n            ? [wrappedError.name, ...error.details]\n            : [wrappedError.name, 'SerializableError', error?.name ?? 'UnknownError'];\n\n        wrappedError.message = `${wrappedError.message} > ${error?.message ?? String(error)}`;\n\n        return wrappedError as InstanceType<T>;\n    }\n}\n\nexport class NonRetryableError extends SerializableError {\n    constructor(message: string, options?: ErrorOptions) {\n        super(message, options);\n    }\n}\n\nexport class NotFoundError extends SerializableError {\n    constructor(message?: string, options?: ErrorOptions) {\n        super(message ? `Not found: ${message}` : 'Not found', options);\n    }\n}\n\n// TODO: extend this for chain specific providers\nexport class ProviderError extends SerializableError {\n    constructor(providerUri: string, options?: ErrorOptions) {\n        super(`Provider error at host '${ProviderError.parseHost(providerUri)}'`, options);\n    }\n\n    private static parseHost(providerUri: string): string {\n        try {\n            const url = new URL(providerUri);\n            return url.host;\n        } catch {\n            return 'UNKNOWN_HOST';\n        }\n    }\n}\n\nexport class NonEmittableError extends SerializableError {\n    constructor(message: string, options?: ErrorOptions) {\n        super(message, options);\n        this.name = 'NonEmittableError';\n    }\n}\n\nexport class QuorumNotAchievedYet extends SerializableError {\n    constructor(options?: ErrorOptions) {\n        super('The quorum was not achieved yet', options);\n    }\n}\n\nexport class MultiError extends Error {\n    constructor(public readonly errs: any[]) {\n        super(errs.map((err) => err.message).join(', '));\n    }\n}\n\nexport const throwError = <Err extends Error>(\n    message: string,\n    error?: (message: string) => Err,\n): never => {\n    throw error?.(message) ?? new Error(message);\n};\n"]}

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+export declare function convertErrorToObject(err: any): any;
+export declare function normalizeError(err: any): {
+    body?: string | undefined;
+    event?: any;
+    code?: any;
+    reason?: any;
+    stack?: any;
+    message?: any;
+    name?: any;
+};
+type RemoveErrorOptions<T extends any[]> = T extends [...infer U, ErrorOptions?] ? U : never;
+/**
+ * Base class for all serializable errors.
+ * This class is designed to be extended by other error classes.
+ * It provides a way to wrap errors and a way to check if an error is in the stack of a specific error class.
+ * All errors that extend this class *must* have error options as the last argument in their constructor.
+ */
+export declare abstract class SerializableError extends Error {
+    details: string[];
+    cause: unknown;
+    constructor(message: string, options?: ErrorOptions);
+    static inStackOf<T extends abstract new (...args: any) => any>(this: T, error: any): SerializableError | undefined;
+    static wrap<T extends new (...args: any) => SerializableError>(this: T, error: any, ...args: RemoveErrorOptions<ConstructorParameters<T>>): InstanceType<T>;
+}
+export declare class NonRetryableError extends SerializableError {
+    constructor(message: string, options?: ErrorOptions);
+}
+export declare class NotFoundError extends SerializableError {
+    constructor(message?: string, options?: ErrorOptions);
+}
+export declare class ProviderError extends SerializableError {
+    constructor(providerUri: string, options?: ErrorOptions);
+    private static parseHost;
+}
+export declare class NonEmittableError extends SerializableError {
+    constructor(message: string, options?: ErrorOptions);
+}
+export declare class QuorumNotAchievedYet extends SerializableError {
+    constructor(options?: ErrorOptions);
+}
+export declare class MultiError extends Error {
+    readonly errs: any[];
+    constructor(errs: any[]);
+}
+export declare const throwError: <Err extends Error>(message: string, error?: (message: string) => Err) => never;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAYA,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAElD;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG;;;;;;;;EAatC;AAGD,KAAK,kBAAkB,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,EAAE,YAAY,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAE7F;;;;;GAKG;AACH,8BAAsB,iBAAkB,SAAQ,KAAK;IACjD,OAAO,EAAE,MAAM,EAAE,CAAC;IAMlB,KAAK,EAAE,OAAO,CAAC;gBACH,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;IAanD,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,EACzD,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,GAAG,GACX,iBAAiB,GAAG,SAAS;IAUhC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,KAAK,iBAAiB,EACzD,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,GAAG,EAEV,GAAG,IAAI,EAAE,kBAAkB,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,GACtD,YAAY,CAAC,CAAC,CAAC;CAWrB;AAED,qBAAa,iBAAkB,SAAQ,iBAAiB;gBACxC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAGtD;AAED,qBAAa,aAAc,SAAQ,iBAAiB;gBACpC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAGvD;AAGD,qBAAa,aAAc,SAAQ,iBAAiB;gBACpC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;IAIvD,OAAO,CAAC,MAAM,CAAC,SAAS;CAQ3B;AAED,qBAAa,iBAAkB,SAAQ,iBAAiB;gBACxC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAItD;AAED,qBAAa,oBAAqB,SAAQ,iBAAiB;gBAC3C,OAAO,CAAC,EAAE,YAAY;CAGrC;AAED,qBAAa,UAAW,SAAQ,KAAK;aACL,IAAI,EAAE,GAAG,EAAE;gBAAX,IAAI,EAAE,GAAG,EAAE;CAG1C;AAED,eAAO,MAAM,UAAU,GAAI,GAAG,SAAS,KAAK,EACxC,SAAS,MAAM,EACf,QAAQ,CAAC,OAAO,EAAE,MAAM,KAAK,GAAG,KACjC,KAEF,CAAC"}

package/dist/index.js

@@ -0,0 +1,163 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/index.ts
+var extractMessageFromJsonRpcError = /* @__PURE__ */ __name((err) => {
+  try {
+    if (typeof err.body === "object" && err.body.message) {
+      return err.body.message;
+    }
+    const parsedBody = JSON.parse(err.body);
+    return parsedBody?.error?.message;
+  } catch {
+    return "unknown";
+  }
+}, "extractMessageFromJsonRpcError");
+function convertErrorToObject(err) {
+  return JSON.parse(JSON.stringify(err, Object.getOwnPropertyNames(err)));
+}
+__name(convertErrorToObject, "convertErrorToObject");
+function normalizeError(err) {
+  const error = convertErrorToObject(err);
+  return {
+    // Normal Error properties
+    ...error.name ? {
+      name: error.name
+    } : {},
+    ...error.message ? {
+      message: error.message
+    } : {},
+    ...error.stack ? {
+      stack: error.stack
+    } : {},
+    // Rpc properties
+    ...error.reason ? {
+      reason: error.reason
+    } : {},
+    ...error.code ? {
+      code: error.code
+    } : {},
+    ...error.event ? {
+      event: error.event
+    } : {},
+    ...error.body ? {
+      body: extractMessageFromJsonRpcError(error)
+    } : {}
+  };
+}
+__name(normalizeError, "normalizeError");
+var SerializableError = class extends Error {
+  static {
+    __name(this, "SerializableError");
+  }
+  details;
+  /*
+   * The instance of the error that was wrapped, if any.
+   * Creates a linked list of error objects.
+   * Only exists if the error hasn't been serialized and deserialized.
+   */
+  cause;
+  constructor(message, options) {
+    super(message, options);
+    this.cause = options?.cause;
+    this.name = this.constructor.name;
+    this.details = [
+      this.constructor.name,
+      "SerializableError"
+    ];
+  }
+  /*
+   * Checks if the error is an instance of the current class or a subclass. Returns the error if it is.
+   * We can't type the error as more than SerializableError because it could have been serialized and deserialized,
+   * which could make it lose extra fields.
+   */
+  static inStackOf(error) {
+    if (error?.details?.includes(this.name)) {
+      return error;
+    } else if (error?.cause?.details?.includes(this.name)) {
+      return error.cause;
+    }
+    return void 0;
+  }
+  // We could limit this to only wrap serializable errors, but that could limit the flexibility of the error system.
+  static wrap(error, ...args) {
+    const wrappedError = new this(...args, {
+      cause: error
+    });
+    wrappedError.details = error?.details ? [
+      wrappedError.name,
+      ...error.details
+    ] : [
+      wrappedError.name,
+      "SerializableError",
+      error?.name ?? "UnknownError"
+    ];
+    wrappedError.message = `${wrappedError.message} > ${error?.message ?? String(error)}`;
+    return wrappedError;
+  }
+};
+var NonRetryableError = class extends SerializableError {
+  static {
+    __name(this, "NonRetryableError");
+  }
+  constructor(message, options) {
+    super(message, options);
+  }
+};
+var NotFoundError = class extends SerializableError {
+  static {
+    __name(this, "NotFoundError");
+  }
+  constructor(message, options) {
+    super(message ? `Not found: ${message}` : "Not found", options);
+  }
+};
+var ProviderError = class _ProviderError extends SerializableError {
+  static {
+    __name(this, "ProviderError");
+  }
+  constructor(providerUri, options) {
+    super(`Provider error at host '${_ProviderError.parseHost(providerUri)}'`, options);
+  }
+  static parseHost(providerUri) {
+    try {
+      const url = new URL(providerUri);
+      return url.host;
+    } catch {
+      return "UNKNOWN_HOST";
+    }
+  }
+};
+var NonEmittableError = class extends SerializableError {
+  static {
+    __name(this, "NonEmittableError");
+  }
+  constructor(message, options) {
+    super(message, options);
+    this.name = "NonEmittableError";
+  }
+};
+var QuorumNotAchievedYet = class extends SerializableError {
+  static {
+    __name(this, "QuorumNotAchievedYet");
+  }
+  constructor(options) {
+    super("The quorum was not achieved yet", options);
+  }
+};
+var MultiError = class extends Error {
+  static {
+    __name(this, "MultiError");
+  }
+  errs;
+  constructor(errs) {
+    super(errs.map((err) => err.message).join(", ")), this.errs = errs;
+  }
+};
+var throwError = /* @__PURE__ */ __name((message, error) => {
+  throw error?.(message) ?? new Error(message);
+}, "throwError");
+
+export { MultiError, NonEmittableError, NonRetryableError, NotFoundError, ProviderError, QuorumNotAchievedYet, SerializableError, convertErrorToObject, normalizeError, throwError };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":["extractMessageFromJsonRpcError","err","body","message","parsedBody","JSON","parse","error","convertErrorToObject","stringify","Object","getOwnPropertyNames","normalizeError","name","stack","reason","code","event","SerializableError","Error","details","cause","options","inStackOf","includes","undefined","wrap","args","wrappedError","String","NonRetryableError","NotFoundError","ProviderError","providerUri","parseHost","url","URL","host","NonEmittableError","QuorumNotAchievedYet","MultiError","errs","map","join","throwError"],"mappings":";;;;AAAA,IAAMA,8BAAAA,2BAAkCC,GAAAA,KAAAA;AACpC,EAAA,IAAI;AACA,IAAA,IAAI,OAAOA,GAAAA,CAAIC,IAAAA,KAAS,QAAA,IAAYD,GAAAA,CAAIC,KAAKC,OAAAA,EAAS;AAClD,MAAA,OAAOF,IAAIC,IAAAA,CAAKC,OAAAA;AACpB,IAAA;AACA,IAAA,MAAMC,UAAAA,GAAaC,IAAAA,CAAKC,KAAAA,CAAML,GAAAA,CAAIC,IAAI,CAAA;AACtC,IAAA,OAAOE,YAAYG,KAAAA,EAAOJ,OAAAA;EAC9B,CAAA,CAAA,MAAQ;AACJ,IAAA,OAAO,SAAA;AACX,EAAA;AACJ,CAAA,EAVuC,gCAAA,CAAA;AAYhC,SAASK,qBAAqBP,GAAAA,EAAQ;AACzC,EAAA,OAAOI,IAAAA,CAAKC,MAAMD,IAAAA,CAAKI,SAAAA,CAAUR,KAAKS,MAAAA,CAAOC,mBAAAA,CAAoBV,GAAAA,CAAAA,CAAAA,CAAAA;AACrE;AAFgBO,MAAAA,CAAAA,oBAAAA,EAAAA,sBAAAA,CAAAA;AAIT,SAASI,eAAeX,GAAAA,EAAQ;AACnC,EAAA,MAAMM,KAAAA,GAAQC,qBAAqBP,GAAAA,CAAAA;AACnC,EAAA,OAAO;;AAEH,IAAA,GAAIM,MAAMM,IAAAA,GAAO;AAAEA,MAAAA,IAAAA,EAAMN,KAAAA,CAAMM;AAAK,KAAA,GAAI,EAAC;AACzC,IAAA,GAAIN,MAAMJ,OAAAA,GAAU;AAAEA,MAAAA,OAAAA,EAASI,KAAAA,CAAMJ;AAAQ,KAAA,GAAI,EAAC;AAClD,IAAA,GAAII,MAAMO,KAAAA,GAAQ;AAAEA,MAAAA,KAAAA,EAAOP,KAAAA,CAAMO;AAAM,KAAA,GAAI,EAAC;;AAE5C,IAAA,GAAIP,MAAMQ,MAAAA,GAAS;AAAEA,MAAAA,MAAAA,EAAQR,KAAAA,CAAMQ;AAAO,KAAA,GAAI,EAAC;AAC/C,IAAA,GAAIR,MAAMS,IAAAA,GAAO;AAAEA,MAAAA,IAAAA,EAAMT,KAAAA,CAAMS;AAAK,KAAA,GAAI,EAAC;AACzC,IAAA,GAAIT,MAAMU,KAAAA,GAAQ;AAAEA,MAAAA,KAAAA,EAAOV,KAAAA,CAAMU;AAAM,KAAA,GAAI,EAAC;AAC5C,IAAA,GAAIV,MAAML,IAAAA,GAAO;AAAEA,MAAAA,IAAAA,EAAMF,+BAA+BO,KAAAA;AAAO,KAAA,GAAI;AACvE,GAAA;AACJ;AAbgBK,MAAAA,CAAAA,cAAAA,EAAAA,gBAAAA,CAAAA;AAwBT,IAAeM,iBAAAA,GAAf,cAAyCC,KAAAA,CAAAA;EAxChD;;;AAyCIC,EAAAA,OAAAA;;;;;;AAMAC,EAAAA,KAAAA;AACA,EAAA,WAAA,CAAYlB,SAAiBmB,OAAAA,EAAwB;AACjD,IAAA,KAAA,CAAMnB,SAASmB,OAAAA,CAAAA;AAEf,IAAA,IAAA,CAAKD,QAAQC,OAAAA,EAASD,KAAAA;AACtB,IAAA,IAAA,CAAKR,IAAAA,GAAO,KAAK,WAAA,CAAYA,IAAAA;AAC7B,IAAA,IAAA,CAAKO,OAAAA,GAAU;AAAC,MAAA,IAAA,CAAK,WAAA,CAAYP,IAAAA;AAAM,MAAA;;AAC3C,EAAA;;;;;;AAOA,EAAA,OAAOU,UAEHhB,KAAAA,EAC6B;AAC7B,IAAA,IAAIA,KAAAA,EAAOa,OAAAA,EAASI,QAAAA,CAAS,IAAA,CAAKX,IAAI,CAAA,EAAG;AACrC,MAAA,OAAON,KAAAA;AACX,IAAA,CAAA,MAAA,IAAWA,OAAOc,KAAAA,EAAOD,OAAAA,EAASI,QAAAA,CAAS,IAAA,CAAKX,IAAI,CAAA,EAAG;AACnD,MAAA,OAAON,KAAAA,CAAMc,KAAAA;AACjB,IAAA;AACA,IAAA,OAAOI,MAAAA;AACX,EAAA;;EAGA,OAAOC,IAAAA,CAEHnB,UAEGoB,IAAAA,EACY;AACf,IAAA,MAAMC,YAAAA,GAAe,IAAI,IAAA,CAAI,GAAID,IAAAA,EAAM;MAAEN,KAAAA,EAAOd;KAAM,CAAA;AAEtDqB,IAAAA,YAAAA,CAAaR,OAAAA,GAAUb,OAAOa,OAAAA,GACxB;MAACQ,YAAAA,CAAaf,IAAAA;SAASN,KAAAA,CAAMa;AAC7B,KAAA,GAAA;MAACQ,YAAAA,CAAaf,IAAAA;AAAM,MAAA,mBAAA;AAAqBN,MAAAA,KAAAA,EAAOM,IAAAA,IAAQ;;AAE9De,IAAAA,YAAAA,CAAazB,OAAAA,GAAU,GAAGyB,YAAAA,CAAazB,OAAO,MAAMI,KAAAA,EAAOJ,OAAAA,IAAW0B,MAAAA,CAAOtB,KAAAA,CAAAA,CAAAA,CAAAA;AAE7E,IAAA,OAAOqB,YAAAA;AACX,EAAA;AACJ;AAEO,IAAME,iBAAAA,GAAN,cAAgCZ,iBAAAA,CAAAA;EA5FvC;;;AA6FI,EAAA,WAAA,CAAYf,SAAiBmB,OAAAA,EAAwB;AACjD,IAAA,KAAA,CAAMnB,SAASmB,OAAAA,CAAAA;AACnB,EAAA;AACJ;AAEO,IAAMS,aAAAA,GAAN,cAA4Bb,iBAAAA,CAAAA;EAlGnC;;;AAmGI,EAAA,WAAA,CAAYf,SAAkBmB,OAAAA,EAAwB;AAClD,IAAA,KAAA,CAAMnB,OAAAA,GAAU,CAAA,WAAA,EAAcA,OAAAA,CAAAA,CAAAA,GAAY,aAAamB,OAAAA,CAAAA;AAC3D,EAAA;AACJ;AAGO,IAAMU,aAAAA,GAAN,MAAMA,cAAAA,SAAsBd,iBAAAA,CAAAA;EAzGnC;;;AA0GI,EAAA,WAAA,CAAYe,aAAqBX,OAAAA,EAAwB;AACrD,IAAA,KAAA,CAAM,2BAA2BU,cAAAA,CAAcE,SAAAA,CAAUD,WAAAA,CAAAA,KAAiBX,OAAAA,CAAAA;AAC9E,EAAA;AAEA,EAAA,OAAeY,UAAUD,WAAAA,EAA6B;AAClD,IAAA,IAAI;AACA,MAAA,MAAME,GAAAA,GAAM,IAAIC,GAAAA,CAAIH,WAAAA,CAAAA;AACpB,MAAA,OAAOE,GAAAA,CAAIE,IAAAA;IACf,CAAA,CAAA,MAAQ;AACJ,MAAA,OAAO,cAAA;AACX,IAAA;AACJ,EAAA;AACJ;AAEO,IAAMC,iBAAAA,GAAN,cAAgCpB,iBAAAA,CAAAA;EAxHvC;;;AAyHI,EAAA,WAAA,CAAYf,SAAiBmB,OAAAA,EAAwB;AACjD,IAAA,KAAA,CAAMnB,SAASmB,OAAAA,CAAAA;AACf,IAAA,IAAA,CAAKT,IAAAA,GAAO,mBAAA;AAChB,EAAA;AACJ;AAEO,IAAM0B,oBAAAA,GAAN,cAAmCrB,iBAAAA,CAAAA;EA/H1C;;;AAgII,EAAA,WAAA,CAAYI,OAAAA,EAAwB;AAChC,IAAA,KAAA,CAAM,mCAAmCA,OAAAA,CAAAA;AAC7C,EAAA;AACJ;AAEO,IAAMkB,UAAAA,GAAN,cAAyBrB,KAAAA,CAAAA;EArIhC;;;;AAsII,EAAA,WAAA,CAA4BsB,IAAAA,EAAa;AACrC,IAAA,KAAA,CAAMA,IAAAA,CAAKC,GAAAA,CAAI,CAACzC,GAAAA,KAAQA,GAAAA,CAAIE,OAAO,CAAA,CAAEwC,IAAAA,CAAK,IAAA,CAAA,CAAA,EAAA,IAAA,CADlBF,IAAAA,GAAAA,IAAAA;AAE5B,EAAA;AACJ;AAEO,IAAMG,UAAAA,mBAAa,MAAA,CAAA,CACtBzC,OAAAA,EACAI,KAAAA,KAAAA;AAEA,EAAA,MAAMA,KAAAA,GAAQJ,OAAAA,CAAAA,IAAY,IAAIgB,MAAMhB,OAAAA,CAAAA;AACxC,CAAA,EAL0B,YAAA","file":"index.js","sourcesContent":["const extractMessageFromJsonRpcError = (err: any): string => {\n    try {\n        if (typeof err.body === 'object' && err.body.message) {\n            return err.body.message;\n        }\n        const parsedBody = JSON.parse(err.body);\n        return parsedBody?.error?.message;\n    } catch {\n        return 'unknown';\n    }\n};\n\nexport function convertErrorToObject(err: any): any {\n    return JSON.parse(JSON.stringify(err, Object.getOwnPropertyNames(err)));\n}\n\nexport function normalizeError(err: any) {\n    const error = convertErrorToObject(err);\n    return {\n        // Normal Error properties\n        ...(error.name ? { name: error.name } : {}),\n        ...(error.message ? { message: error.message } : {}),\n        ...(error.stack ? { stack: error.stack } : {}),\n        // Rpc properties\n        ...(error.reason ? { reason: error.reason } : {}),\n        ...(error.code ? { code: error.code } : {}),\n        ...(error.event ? { event: error.event } : {}),\n        ...(error.body ? { body: extractMessageFromJsonRpcError(error) } : {}),\n    };\n}\n\n// Removes the last argument if it is an ErrorOptions\ntype RemoveErrorOptions<T extends any[]> = T extends [...infer U, ErrorOptions?] ? U : never;\n\n/**\n * Base class for all serializable errors.\n * This class is designed to be extended by other error classes.\n * It provides a way to wrap errors and a way to check if an error is in the stack of a specific error class.\n * All errors that extend this class *must* have error options as the last argument in their constructor.\n */\nexport abstract class SerializableError extends Error {\n    details: string[];\n    /*\n     * The instance of the error that was wrapped, if any.\n     * Creates a linked list of error objects.\n     * Only exists if the error hasn't been serialized and deserialized.\n     */\n    cause: unknown;\n    constructor(message: string, options?: ErrorOptions) {\n        super(message, options);\n        // for some reason, we need to set the cause directly on the instance, even after calling super\n        this.cause = options?.cause;\n        this.name = this.constructor.name;\n        this.details = [this.constructor.name, 'SerializableError'];\n    }\n\n    /*\n     * Checks if the error is an instance of the current class or a subclass. Returns the error if it is.\n     * We can't type the error as more than SerializableError because it could have been serialized and deserialized,\n     * which could make it lose extra fields.\n     */\n    static inStackOf<T extends abstract new (...args: any) => any>(\n        this: T,\n        error: any,\n    ): SerializableError | undefined {\n        if (error?.details?.includes(this.name)) {\n            return error as SerializableError;\n        } else if (error?.cause?.details?.includes(this.name)) {\n            return error.cause as SerializableError;\n        }\n        return undefined;\n    }\n\n    // We could limit this to only wrap serializable errors, but that could limit the flexibility of the error system.\n    static wrap<T extends new (...args: any) => SerializableError>(\n        this: T,\n        error: any,\n        // Remove the optional error arguments\n        ...args: RemoveErrorOptions<ConstructorParameters<T>>\n    ): InstanceType<T> {\n        const wrappedError = new this(...args, { cause: error });\n\n        wrappedError.details = error?.details\n            ? [wrappedError.name, ...error.details]\n            : [wrappedError.name, 'SerializableError', error?.name ?? 'UnknownError'];\n\n        wrappedError.message = `${wrappedError.message} > ${error?.message ?? String(error)}`;\n\n        return wrappedError as InstanceType<T>;\n    }\n}\n\nexport class NonRetryableError extends SerializableError {\n    constructor(message: string, options?: ErrorOptions) {\n        super(message, options);\n    }\n}\n\nexport class NotFoundError extends SerializableError {\n    constructor(message?: string, options?: ErrorOptions) {\n        super(message ? `Not found: ${message}` : 'Not found', options);\n    }\n}\n\n// TODO: extend this for chain specific providers\nexport class ProviderError extends SerializableError {\n    constructor(providerUri: string, options?: ErrorOptions) {\n        super(`Provider error at host '${ProviderError.parseHost(providerUri)}'`, options);\n    }\n\n    private static parseHost(providerUri: string): string {\n        try {\n            const url = new URL(providerUri);\n            return url.host;\n        } catch {\n            return 'UNKNOWN_HOST';\n        }\n    }\n}\n\nexport class NonEmittableError extends SerializableError {\n    constructor(message: string, options?: ErrorOptions) {\n        super(message, options);\n        this.name = 'NonEmittableError';\n    }\n}\n\nexport class QuorumNotAchievedYet extends SerializableError {\n    constructor(options?: ErrorOptions) {\n        super('The quorum was not achieved yet', options);\n    }\n}\n\nexport class MultiError extends Error {\n    constructor(public readonly errs: any[]) {\n        super(errs.map((err) => err.message).join(', '));\n    }\n}\n\nexport const throwError = <Err extends Error>(\n    message: string,\n    error?: (message: string) => Err,\n): never => {\n    throw error?.(message) ?? new Error(message);\n};\n"]}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@layerzerolabs/common-error-utils",
+  "version": "0.2.8",
+  "private": false,
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "require": "./dist/index.cjs",
+    "import": "./dist/index.js",
+    "default": "./dist/index.cjs"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "devDependencies": {
+    "tsup": "^8.4.0",
+    "vitest": "^3.2.3",
+    "@layerzerolabs/tsup-configuration": "0.2.8",
+    "@layerzerolabs/typescript-configuration": "0.2.8"
+  },
+  "publishConfig": {
+    "access": "restricted",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "lint": "eslint . --max-warnings 0 || (eslint . --fix --max-warnings 0 && false)",
+    "test": "vitest --run --pass-with-no-tests --typecheck"
+  }
+}

package/src/index.ts

@@ -0,0 +1,145 @@
+const extractMessageFromJsonRpcError = (err: any): string => {
+    try {
+        if (typeof err.body === 'object' && err.body.message) {
+            return err.body.message;
+        }
+        const parsedBody = JSON.parse(err.body);
+        return parsedBody?.error?.message;
+    } catch {
+        return 'unknown';
+    }
+};
+
+export function convertErrorToObject(err: any): any {
+    return JSON.parse(JSON.stringify(err, Object.getOwnPropertyNames(err)));
+}
+
+export function normalizeError(err: any) {
+    const error = convertErrorToObject(err);
+    return {
+        // Normal Error properties
+        ...(error.name ? { name: error.name } : {}),
+        ...(error.message ? { message: error.message } : {}),
+        ...(error.stack ? { stack: error.stack } : {}),
+        // Rpc properties
+        ...(error.reason ? { reason: error.reason } : {}),
+        ...(error.code ? { code: error.code } : {}),
+        ...(error.event ? { event: error.event } : {}),
+        ...(error.body ? { body: extractMessageFromJsonRpcError(error) } : {}),
+    };
+}
+
+// Removes the last argument if it is an ErrorOptions
+type RemoveErrorOptions<T extends any[]> = T extends [...infer U, ErrorOptions?] ? U : never;
+
+/**
+ * Base class for all serializable errors.
+ * This class is designed to be extended by other error classes.
+ * It provides a way to wrap errors and a way to check if an error is in the stack of a specific error class.
+ * All errors that extend this class *must* have error options as the last argument in their constructor.
+ */
+export abstract class SerializableError extends Error {
+    details: string[];
+    /*
+     * The instance of the error that was wrapped, if any.
+     * Creates a linked list of error objects.
+     * Only exists if the error hasn't been serialized and deserialized.
+     */
+    cause: unknown;
+    constructor(message: string, options?: ErrorOptions) {
+        super(message, options);
+        // for some reason, we need to set the cause directly on the instance, even after calling super
+        this.cause = options?.cause;
+        this.name = this.constructor.name;
+        this.details = [this.constructor.name, 'SerializableError'];
+    }
+
+    /*
+     * Checks if the error is an instance of the current class or a subclass. Returns the error if it is.
+     * We can't type the error as more than SerializableError because it could have been serialized and deserialized,
+     * which could make it lose extra fields.
+     */
+    static inStackOf<T extends abstract new (...args: any) => any>(
+        this: T,
+        error: any,
+    ): SerializableError | undefined {
+        if (error?.details?.includes(this.name)) {
+            return error as SerializableError;
+        } else if (error?.cause?.details?.includes(this.name)) {
+            return error.cause as SerializableError;
+        }
+        return undefined;
+    }
+
+    // We could limit this to only wrap serializable errors, but that could limit the flexibility of the error system.
+    static wrap<T extends new (...args: any) => SerializableError>(
+        this: T,
+        error: any,
+        // Remove the optional error arguments
+        ...args: RemoveErrorOptions<ConstructorParameters<T>>
+    ): InstanceType<T> {
+        const wrappedError = new this(...args, { cause: error });
+
+        wrappedError.details = error?.details
+            ? [wrappedError.name, ...error.details]
+            : [wrappedError.name, 'SerializableError', error?.name ?? 'UnknownError'];
+
+        wrappedError.message = `${wrappedError.message} > ${error?.message ?? String(error)}`;
+
+        return wrappedError as InstanceType<T>;
+    }
+}
+
+export class NonRetryableError extends SerializableError {
+    constructor(message: string, options?: ErrorOptions) {
+        super(message, options);
+    }
+}
+
+export class NotFoundError extends SerializableError {
+    constructor(message?: string, options?: ErrorOptions) {
+        super(message ? `Not found: ${message}` : 'Not found', options);
+    }
+}
+
+// TODO: extend this for chain specific providers
+export class ProviderError extends SerializableError {
+    constructor(providerUri: string, options?: ErrorOptions) {
+        super(`Provider error at host '${ProviderError.parseHost(providerUri)}'`, options);
+    }
+
+    private static parseHost(providerUri: string): string {
+        try {
+            const url = new URL(providerUri);
+            return url.host;
+        } catch {
+            return 'UNKNOWN_HOST';
+        }
+    }
+}
+
+export class NonEmittableError extends SerializableError {
+    constructor(message: string, options?: ErrorOptions) {
+        super(message, options);
+        this.name = 'NonEmittableError';
+    }
+}
+
+export class QuorumNotAchievedYet extends SerializableError {
+    constructor(options?: ErrorOptions) {
+        super('The quorum was not achieved yet', options);
+    }
+}
+
+export class MultiError extends Error {
+    constructor(public readonly errs: any[]) {
+        super(errs.map((err) => err.message).join(', '));
+    }
+}
+
+export const throwError = <Err extends Error>(
+    message: string,
+    error?: (message: string) => Err,
+): never => {
+    throw error?.(message) ?? new Error(message);
+};

package/tests/error.test.ts

@@ -0,0 +1,40 @@
+import { describe, expect, it } from 'vitest';
+
+import { NotFoundError, SerializableError } from './../src/';
+
+describe('SerializableError', () => {
+    it('should check if error is in stack', () => {
+        const err = new NotFoundError('User');
+        expect(err.name).toBe('NotFoundError');
+        expect(err.message).toBe('Not found: User');
+        expect(err.cause).toBeUndefined();
+        expect(err.details).toEqual(['NotFoundError', 'SerializableError']);
+        expect(NotFoundError.inStackOf(err)).toBe(err);
+    });
+
+    it('should wrap an error', () => {
+        const originalError = new Error('No rows returned');
+        const wrappedError = NotFoundError.wrap(originalError, 'User');
+
+        expect(wrappedError.name).toBe('NotFoundError');
+        expect(wrappedError.message).toBe('Not found: User > No rows returned');
+        expect(wrappedError.cause).toBe(originalError);
+        expect(wrappedError.details).toEqual(['NotFoundError', 'SerializableError', 'Error']);
+    });
+
+    it('wraps simple error', () => {
+        class SomeError extends SerializableError {
+            constructor(opts: ErrorOptions) {
+                console.log('SomeError constructor called', opts);
+                super('Some error', opts);
+            }
+        }
+
+        const err = new Error('Some error 2');
+        const wrapped = SomeError.wrap(err);
+        expect(wrapped.name).toBe('SomeError');
+        expect(wrapped.message).toBe('Some error > Some error 2');
+        expect(wrapped.cause).toBe(err);
+        expect(wrapped.details).toEqual(['SomeError', 'SerializableError', 'Error']);
+    });
+});

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "extends": "@layerzerolabs/typescript-configuration/tsconfig.base.json",
+    "compilerOptions": {
+        "rootDir": "./src",
+        "outDir": "./dist",
+        "strictPropertyInitialization": false,
+        "noUnusedLocals": false,
+        "noUnusedParameters": false,
+        "jsx": "react-jsx"
+    },
+    "exclude": [
+        "node_modules",
+        "**/__mocks__/*",
+        "**/__tests__/*",
+        "**/*.spec.ts",
+        "**/*.test.ts",
+        "dist"
+    ],
+    "include": ["src/**/*"]
+}

package/tsup.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'tsup';
+
+import { createPackageTsupConfig } from '@layerzerolabs/tsup-configuration';
+
+export default defineConfig(({ watch }) => ({
+    ...createPackageTsupConfig(),
+    clean: !watch,
+}));