@kshan0515/frost-node-binding 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 kshan0515
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,88 @@
+# @kshan0515/frost-node-binding
+
+Node.js native binding for FROST (Flexible Round-Optimized Schnorr Threshold Signatures) on Ed25519 curve.
+
+## 개요 (Overview)
+
+`@kshan0515/frost-node-binding`은 Zcash Foundation의 [frost-core](https://github.com/ZcashFoundation/frost) 및 `frost-ed25519` 라이브러리를 기반으로 구현된 고성능 N-API(napi-rs) Node.js 네이티브 바인딩 모듈입니다.
+
+- **지원 곡선**: Ed25519 (EdDSA)
+- **주요 기능**:
+  - 분산 키 생성 (DKG: Distributed Key Generation) - 3 Round
+  - 임계치 서명 (Threshold Signing) - 2 Round + Aggregation
+  - 세션 기반 실행기 (`FrostExecutor`) 제공
+  - 무상태(Stateless) API (`FrostDkgState`, `FrostSigningState`) 제공
+  - SoftHSM 및 Key-Registry 연동을 위한 KeyShare 직렬화/역직렬화 지원
+
+## 설치 (Installation)
+
+```bash
+npm install @kshan0515/frost-node-binding
+# 또는
+pnpm add @kshan0515/frost-node-binding
+```
+
+## 사용법 (Usage)
+
+### FrostExecutor (Stateful Session Runner) 예시
+
+```typescript
+import { FrostExecutor } from '@kshan0515/frost-node-binding';
+
+const n = 3; // 전체 참여자 수
+const t = 2; // 임계치 (Threshold)
+const partyId = 1; // 1-based Party ID
+
+// 1. DKG 세션 초기화
+const executor = new FrostExecutor(partyId, n, t);
+
+// 2. Round 1 시작 (Broadcast 패키지 생성)
+const r1Package = executor.startKeygen();
+
+// 3. Round 2 진행 (다른 노드들의 R1 패키지 수신 후 step 실행)
+// inputs 포맷: [Sender PID(2바이트 BE) + Payload]
+const r2DirectedOutputs = executor.step(r1Inputs);
+
+// 4. DKG 완료 (다른 노드들의 R2 Direct 패키지 수신 후 step 실행)
+executor.step(r2Inputs);
+
+// 그룹 공개키 조회
+const pubKeyBytes = executor.getPublicKeyBytes();
+console.log('그룹 Ed25519 공개키:', Buffer.from(pubKeyBytes).toString('hex'));
+
+// 5. 서명 세션 시작
+const message = Buffer.from('Hello FROST');
+const signers = [1, 2]; // 서명 참여 노드 목록
+const commitPayload = executor.startSigning(message, signers);
+
+// 6. 서명 Round 2 및 집약(Aggregation)
+const sigShareOutput = executor.step(commitmentInputs);
+executor.step(signatureShareInputs);
+
+// 최종 Ed25519 서명 조회 (64 바이트)
+const signature = executor.getSignature();
+console.log('최종 서명:', Buffer.from(signature).toString('hex'));
+```
+
+## 개발 및 빌드 (Development & Build)
+
+### 요구 사항
+- Rust 1.81 이상
+- Node.js 18 이상
+- pnpm
+
+### 빌드 및 테스트
+```bash
+# 디버그 빌드
+pnpm run build:debug
+
+# 릴리즈 빌드
+pnpm run build
+
+# 단위 테스트 실행
+pnpm test
+```
+
+## 라이선스 (License)
+
+MIT License

package/index.d.ts

@@ -0,0 +1,69 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+export interface DkgPart1Output {
+  secretPackage: Array<number>
+  round1Package: Array<number>
+}
+export interface DkgPart2Output {
+  secretPackage: Array<number>
+  round2Packages: Record<string, Array<number>>
+}
+export interface DkgPart3Output {
+  keyPackage: Array<number>
+  pubkeyPackage: Array<number>
+}
+export interface SignPart1Output {
+  nonces: Array<number>
+  commitments: Array<number>
+}
+export declare class FrostDkgState {
+  /**
+   * DKG 1단계: Round 1 패키지(Commitment) 생성
+   * { secret_package, round1_package } 반환 (둘 다 bincode로 직렬화됨)
+   */
+  static dkgPart1(partyId: number, maxSigners: number, minSigners: number): DkgPart1Output
+  /**
+   * DKG 2단계: Round 2 패키지(Secret Shares) 생성
+   * 입력: secret_package (1단계), round1_packages (party_id -> package 맵)
+   * 반환: { secret_package, round2_packages_map }
+   */
+  static dkgPart2(secretPackageBin: Array<number>, round1PackagesMap: Record<string, Array<number>>): DkgPart2Output
+  /** DKG 3단계: 최종 완료 */
+  static dkgPart3(secretPackageBin: Array<number>, round1PackagesMap: Record<string, Array<number>>, round2PackagesMap: Record<string, Array<number>>): DkgPart3Output
+  /** PublicKeyPackage에서 공개키 바이트(32바이트)를 추출하는 헬퍼 함수 */
+  static getPublicKeyBytes(pubkeyPackageBin: Array<number>): Array<number>
+  /** 주어진 파티 ID에 대한 직렬화된 식별자(hex)를 가져오는 헬퍼 함수 */
+  static getIdentifier(partyId: number): string
+}
+export declare class FrostSigningState {
+  /**
+   * 서명 1단계: Preprocessing (Nonce 생성)
+   * 입력: key_package (bincode)
+   * 반환: { nonces (Secret), commitments (Public) }
+   */
+  static signPart1(keyPackageBin: Array<number>): SignPart1Output
+  /**
+   * 서명 2단계: 부분 서명 생성 (Partial Sign)
+   * 입력: signing_package (Public), nonces (Secret), key_package (Secret)
+   * 반환: signature_share
+   */
+  static signPart2(signingPackageBin: Array<number>, noncesBin: Array<number>, keyPackageBin: Array<number>): Array<number>
+  /** 메시지와 Commitments 맵으로부터 SigningPackage를 생성하는 헬퍼 함수 */
+  static createSigningPackage(message: Array<number>, commitmentsMap: Record<string, Array<number>>): Array<number>
+  /** 서명 조각들을 합쳐서 최종 서명 생성 (Aggregate) */
+  static aggregate(signingPackageBin: Array<number>, signatureSharesMap: Record<string, Array<number>>, pubkeyPackageBin: Array<number>): Array<number>
+}
+export declare class FrostExecutor {
+  constructor(partyId: number, numSigners: number, threshold: number)
+  startKeygen(): Buffer
+  startSigning(message: Buffer, signers?: Array<number> | undefined | null): Buffer
+  step(inputs: Array<Buffer>): Array<Buffer>
+  getPublicKeyBytes(): Buffer
+  getSignature(): Buffer
+  exportKeyshare(): Buffer
+  importKeyshare(data: Buffer): void
+  static getIdentifierBytes(partyId: number): Buffer
+}

package/index.js

@@ -0,0 +1,317 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'frost-node-binding.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frost-node-binding.android-arm64.node')
+          } else {
+            nativeBinding = require('@kshan0515/frost-node-binding-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'frost-node-binding.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frost-node-binding.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('@kshan0515/frost-node-binding-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'frost-node-binding.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frost-node-binding.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('@kshan0515/frost-node-binding-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'frost-node-binding.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frost-node-binding.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('@kshan0515/frost-node-binding-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'frost-node-binding.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frost-node-binding.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('@kshan0515/frost-node-binding-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'frost-node-binding.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./frost-node-binding.darwin-universal.node')
+      } else {
+        nativeBinding = require('@kshan0515/frost-node-binding-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'frost-node-binding.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frost-node-binding.darwin-x64.node')
+          } else {
+            nativeBinding = require('@kshan0515/frost-node-binding-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'frost-node-binding.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frost-node-binding.darwin-arm64.node')
+          } else {
+            nativeBinding = require('@kshan0515/frost-node-binding-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'frost-node-binding.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./frost-node-binding.freebsd-x64.node')
+      } else {
+        nativeBinding = require('@kshan0515/frost-node-binding-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'frost-node-binding.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frost-node-binding.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('@kshan0515/frost-node-binding-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'frost-node-binding.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frost-node-binding.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('@kshan0515/frost-node-binding-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'frost-node-binding.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frost-node-binding.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('@kshan0515/frost-node-binding-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'frost-node-binding.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frost-node-binding.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('@kshan0515/frost-node-binding-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'frost-node-binding.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frost-node-binding.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('@kshan0515/frost-node-binding-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'frost-node-binding.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frost-node-binding.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('@kshan0515/frost-node-binding-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'frost-node-binding.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frost-node-binding.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('@kshan0515/frost-node-binding-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'frost-node-binding.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frost-node-binding.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('@kshan0515/frost-node-binding-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'frost-node-binding.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frost-node-binding.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('@kshan0515/frost-node-binding-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { FrostDkgState, FrostSigningState, FrostExecutor } = nativeBinding
+
+module.exports.FrostDkgState = FrostDkgState
+module.exports.FrostSigningState = FrostSigningState
+module.exports.FrostExecutor = FrostExecutor

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@kshan0515/frost-node-binding",
+  "version": "0.1.0",
+  "description": "Node.js native binding for FROST Ed25519 MPC protocol - Distributed key generation and threshold signing",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kshan0515/frost-node-binding"
+  },
+  "keywords": [
+    "mpc",
+    "eddsa",
+    "ed25519",
+    "frost",
+    "threshold-signature",
+    "dkg",
+    "signing",
+    "cryptography",
+    "napi",
+    "native"
+  ],
+  "author": "",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">= 18"
+  },
+  "napi": {
+    "binaryName": "frost-node-binding",
+    "targets": [
+      "aarch64-apple-darwin",
+      "x86_64-apple-darwin",
+      "x86_64-unknown-linux-gnu",
+      "x86_64-unknown-linux-musl",
+      "aarch64-unknown-linux-gnu",
+      "x86_64-pc-windows-msvc"
+    ]
+  },
+  "scripts": {
+    "artifacts": "napi artifacts",
+    "build": "napi build --platform --release",
+    "build:debug": "napi build --platform",
+    "prepublishOnly": "napi prepublish -t npm",
+    "test": "jest",
+    "universal": "napi universal",
+    "version": "napi version"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^3.0.0-alpha.60",
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.10.4",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.3.3"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "optionalDependencies": {
+    "@kshan0515/frost-node-binding-darwin-arm64": "0.1.0",
+    "@kshan0515/frost-node-binding-darwin-x64": "0.1.0",
+    "@kshan0515/frost-node-binding-linux-x64-gnu": "0.1.0",
+    "@kshan0515/frost-node-binding-linux-x64-musl": "0.1.0",
+    "@kshan0515/frost-node-binding-linux-arm64-gnu": "0.1.0",
+    "@kshan0515/frost-node-binding-win32-x64-msvc": "0.1.0"
+  }
+}