Merge branch 'dev' into merge-main-into-dev-12

.eslintrc.json

@@ -1,4 +1,31 @@
 {
-  "extends": ["prettier"],
-  "sourceType": "module"
-}
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "parserOptions": {
+    "sourceType": "module",
+    "ecmaVersion": "latest"
+  },
+  "overrides": [
+    {
+      "files": [
+        "tests/**/*.ts"
+      ],
+      "parser": "@typescript-eslint/parser",
+      "rules": {
+        "@typescript-eslint/no-var-requires": "off",
+        "@typescript-eslint/no-explicit-any": "off"
+      }
+    },
+    {
+      "files": [
+        "jest.setup.js"
+      ],
+      "rules": {
+        "no-undef": "off"
+      }
+    },
+  ]
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@babylonlabs-io/btc-staking-ts",
-  "version": "0.3.0",
+  "version": "0.4.0-canary.1",
   "description": "Library exposing methods for the creation and consumption of Bitcoin transactions pertaining to Babylon's Bitcoin Staking protocol.",
   "module": "dist/index.js",
   "main": "dist/index.cjs",
@@ -49,10 +49,12 @@
   "devDependencies": {
     "@types/jest": "^29.5.12",
     "@types/node": "^20.11.30",
+    "@typescript-eslint/parser": "^7.4.0",
     "dts-bundle-generator": "^9.3.1",
     "ecpair": "^2.1.0",
     "esbuild": "^0.20.2",
     "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
     "husky": "^9.0.11",
     "jest": "^29.7.0",

src/constants/keys.ts

@@ -0,0 +1,2 @@
+// NO_COORD_PK_BYTE_LENGTH is the length of a BTC public key without the coordinate in bytes.
+export const NO_COORD_PK_BYTE_LENGTH = 32;

src/error/index.ts

@@ -0,0 +1,30 @@
+export enum StakingErrorCode {
+  UNKNOWN_ERROR = "UNKNOWN_ERROR",
+  INVALID_INPUT = "INVALID_INPUT",
+  INVALID_OUTPUT = "INVALID_OUTPUT",
+  SCRIPT_FAILURE = "SCRIPT_FAILURE",
+  BUILD_TRANSACTION_FAILURE = "BUILD_TRANSACTION_FAILURE",
+  INVALID_PARAMS = "INVALID_PARAMS",
+}
+
+export class StakingError extends Error {
+  public code: StakingErrorCode;
+  constructor(code: StakingErrorCode, message?: string) {
+    super(message);
+    this.code = code;
+  }
+
+  // Static method to safely handle unknown errors
+  static fromUnknown(
+    error: unknown, code: StakingErrorCode, fallbackMsg?: string
+  ): StakingError {
+    if (error instanceof StakingError) {
+      return error;
+    }
+
+    if (error instanceof Error) {
+      return new StakingError(code, error.message);
+    }
+    return new StakingError(code, fallbackMsg);
+  }
+}