Merge pull request #44 from babylonchain/merge-dev-into-main-0.2.4

Merge dev into main 0.2.4

.circleci/config.yml

@@ -16,8 +16,36 @@ jobs:
           command: npm install
       - run:
           name: Run tests
-          command: npm run tests
-
+          command: npm run test
+  publish_canary:
+    machine:
+      image: ubuntu-2204:2024.01.1
+    steps:
+      - checkout
+      - node/install:
+          node-version: '21.7'
+      - run:
+          name: Install requirements
+          command: npm install
+      - run:
+          name: Authenticate with NPM registry
+          command: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc
+      - run:
+          name: Publish canary package
+          command: |
+            npm publish --tag canary
+            if [ $? -ne 0 ]; then
+              echo "npm publish failed, stopping the job."
+              exit 1
+            fi
+  validate_main_version:
+    machine:
+      image: ubuntu-2204:2024.01.1
+    steps:
+      - checkout
+      - run:
+          name: Validate version
+          command: ./bin/ci_validate_version.sh
   publish:
     machine:
       image: ubuntu-2204:2024.01.1
@@ -35,11 +63,31 @@ jobs:
       - run:
           name: Publish package
           command: npm publish
-
 workflows:
   CI:
     jobs:
       - build_and_test
+      - require_approval_for_canary:
+          type: approval
+          filters:
+            branches:
+              only:
+                - dev
+      - publish_canary:
+          requires:
+            - build_and_test
+            - require_approval_for_canary
+          filters:
+            branches:
+              only:
+                - dev
+      - validate_main_version:
+          requires:
+            - build_and_test
+          filters:
+            branches:
+              only:
+                - main
       - require_approval:
           type: approval
           filters:
@@ -50,6 +98,7 @@ workflows:
           requires:
             - build_and_test
             - require_approval
+            - validate_main_version
           filters:
             tags:
               only: /.*/

.husky/pre-commit

@@ -0,0 +1 @@
+npm test

.prettierignore

@@ -0,0 +1,10 @@
+node_modules
+dist
+build
+coverage
+.circleci
+.husky
+.next
+docs
+public
+README.md

.prettierrc.json

@@ -2,5 +2,8 @@
   "semi": true,
   "singleQuote": false,
   "tabWidth": 2,
-  "useTabs": false
-}
+  "useTabs": false,
+  "plugins": [
+    "prettier-plugin-organize-imports"
+  ]
+}

README.md

@@ -10,7 +10,7 @@
 <br/>
 
 ## Notice
-
+ 
 The library is in an experimental version and should not be used for production
 purposes and with real funds.
 
@@ -20,6 +20,20 @@ purposes and with real funds.
 npm i btc-staking-ts
 ```
 
+## Version Release
+
+### Stable version
+
+Stable release versions are manually released from the main branch.
+
+### Canary version
+
+A canary version is a pre-release version. Make sure all changes are added and committed before running the command below:
+
+```console
+npm run version:canary
+```
+
 ## Usage
 
 ### Define Staking Parameters

bin/ci_validate_version.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# Ensure jq is installed
+if ! command -v jq &> /dev/null; then
+  sudo apt-get update
+  sudo apt-get install -y jq
+fi
+
+# Check the version in package.json
+version=$(jq -r .version package.json)
+if [[ $version == *"canary"* ]]; then
+  echo "Error: main branch should not contain 'canary' versions in the version field."
+  exit 1
+fi