@kynesyslabs/demosdk 2.3.25 → 2.3.27

package/README.md

@@ -1,7 +1,12 @@
 # Demos SDK
 
+![npm version](https://img.shields.io/npm/v/@kynesyslabs/demosdk)
+![License](https://img.shields.io/badge/license-MIT-blue.svg)
+
 A JavaScript/TypeScript SDK providing a unified interface for interacting with the Demos network and cross-chain operations.
 
+***IMPORTANT*** This SDK is built with bun and performs the best with bun
+
 ## Requirements
 
 - Node.js 18.0 or higher
@@ -9,9 +14,19 @@ A JavaScript/TypeScript SDK providing a unified interface for interacting with t
 
 ## Installation
 
+```sh
+bun install @kynesyslabs/demosdk
+```
+
+or
+
 ```sh
 npm install @kynesyslabs/demosdk
-# or
+```
+
+or
+
+```sh
 yarn add @kynesyslabs/demosdk
 ```
 
@@ -139,7 +154,11 @@ const result = await demos.broadcast(validityData)
 ### Building from Source
 
 ```sh
-yarn build
+# Install dependencies first
+bun install  # or npm install, or yarn install
+
+# Then build
+bun run build  # or npm run build, or yarn build
 ```
 
 ### Local Development
@@ -148,36 +167,48 @@ To use the SDK from a local source:
 
 ```sh
 # Build the SDK
-yarn build
+bun run build  # or yarn build, or npm run build
 
 # In your project
-yarn add file:../path/to/sdks
+bun add file:../path/to/sdks  # or yarn/npm add file:../path/to/sdks
 ```
 
 ### Testing
 
-Run specific test suites:
+Run specific test suites (works with both bun and yarn):
 
 ```sh
-yarn test:multichain    # Cross-chain SDK payload generation
-yarn test:tx           # Cross-chain transaction tests
-yarn test:demoswork    # DemosWork operations
-yarn test:native       # Native payment transactions
-yarn test:identities   # Identity management
-yarn test:web2         # Web2 proxy functionality
-yarn test:bridge       # Bridge service tests
-yarn test:btc          # Bitcoin-specific tests
-yarn test:evm          # EVM chain tests
-yarn test:pqc          # Post-quantum cryptography
+bun test:multichain    # Cross-chain SDK payload generation
+bun test:tx           # Cross-chain transaction tests
+bun test:demoswork    # DemosWork operations
+bun test:native       # Native payment transactions
+bun test:identities   # Identity management
+bun test:web2         # Web2 proxy functionality
+bun test:bridge       # Bridge service tests
+bun test:btc          # Bitcoin-specific tests
+bun test:evm          # EVM chain tests
+bun test:pqc          # Post-quantum cryptography
+
+# Or with yarn/npm:
+yarn test:multichain
+npm run test:multichain
 ```
 
-### Pre-push Hook Setup
+### Automatic Build Validation
 
-Ensure code quality before pushing:
+The repository includes a pre-commit hook that automatically validates the build before allowing commits. This hook is installed automatically when you run `bun install` (or npm/yarn install).
 
-```sh
-yarn setup:pre-push
-```
+#### Features
+- Automatically runs `build` command before each commit
+- Works with bun, npm, or yarn (auto-detects available package manager)
+- Prevents commits if the build fails
+- Installs automatically on `bun/npm/yarn install`
+
+#### Bypassing the Check
+For debugging or temporary commits, you can skip the build check:
+1. Start your commit message with 'DEBUG' or 'TEMP'
+2. Use `git commit --no-verify`
+3. Use `GIT_SKIP_BUILD=true git commit`
 
 ## Publishing
 
@@ -189,10 +220,12 @@ The SDK is automatically published to NPM when:
 
 Example:
 ```sh
-git commit -m "release v2.3.9"
+git commit -m "release v2.3.25"
 git push
 ```
 
+For simplicity, a `publish.sh` script is included. By default it will ask to forward the version, but you can re-publish the same version number with `./publish.sh -r`.
+
 ## Documentation
 
 - **API Reference**: [https://kynesyslabs.github.io/demosdk-api-ref/](https://kynesyslabs.github.io/demosdk-api-ref/)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kynesyslabs/demosdk",
-    "version": "2.3.25",
+    "version": "2.3.27",
     "description": "Demosdk is a JavaScript/TypeScript SDK that provides a unified interface for interacting with Demos network",
     "main": "build/index.js",
     "types": "build/index.d.ts",
@@ -26,10 +26,13 @@
         "./bridge": "./build/bridge/index.js"
     },
     "scripts": {
+        "postinstall": "cp .github/hooks/pre-commit .git/hooks/pre-commit 2>/dev/null && chmod +x .git/hooks/pre-commit 2>/dev/null || true",
         "build": "rm -rf build && tsc --skipLibCheck && resolve-tspaths && mv build/src/* build/ && rm -rf build/src",
         "typedoc": "typedoc",
         "test": "jest",
         "setup:pre-push": "cp .github/hooks/pre-push .git/hooks/pre-push && chmod +x .git/hooks/pre-push && echo \"Pre-push hook installed\"",
+        "setup:pre-commit": "cp .github/hooks/pre-commit .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit && echo \"Pre-commit hook installed\"",
+        "setup:hooks": "bun run setup:pre-push && bun run setup:pre-commit",
         "test:multichain": "rm -rf build && jest --testMatch '**/tests/**/{coin,evm}*.ts' --testPathIgnorePatterns **/tests/**/chainProvider* **/tests/utils/* **/tests/**/template*  --verbose",
         "test:tx": "rm -rf build && jest --testMatch '**/tests/multichain**/fulltx*.ts' --testPathIgnorePatterns **/tests/**/chainProvider* **/tests/utils/* **/tests/**/template*  --verbose",
         "test:demoswork": "rm -rf build && jest --testMatch '**/tests/**/demoswork*.ts' --testPathIgnorePatterns **/tests/**/chainProvider* **/tests/utils/* **/tests/**/template*  --verbose",