@kshan0515/cggmp-node-binding 0.1.0

package/README.md

@@ -0,0 +1,148 @@
+# cggmp-node-binding
+
+Node.js native binding for **CGGMP24 MPC ECDSA protocol** - Distributed key generation and threshold signing without exposing private keys.
+
+Based on [cggmp21](https://github.com/LFDT-Lockness/cggmp21) Rust implementation.
+
+## Features
+
+- **Distributed Key Generation (DKG)**: Generate ECDSA key shares across multiple parties
+- **Threshold Signing**: Sign messages with a subset of parties (t-of-n)
+- **Auxiliary Info Generation**: Generate pre-computation data for efficient signing
+- **State Machine API**: Round-based protocol execution with `CggmpExecutor`
+- **Cross-platform**: Pre-built binaries for macOS, Linux, and Windows
+
+## Installation
+
+```bash
+npm install @kshan0515/cggmp-node-binding
+# or
+pnpm add @kshan0515/cggmp-node-binding
+# or
+yarn add @kshan0515/cggmp-node-binding
+```
+
+## Supported Platforms
+
+| Platform | Architecture |
+|----------|-------------|
+| macOS | x64, arm64 (Apple Silicon) |
+| Linux | x64 (glibc, musl), arm64 (glibc) |
+| Windows | x64 |
+
+## Usage
+
+```typescript
+import { CggmpExecutor, generatePrimes } from '@kshan0515/cggmp-node-binding';
+
+// Create executor for party 0 in a 2-of-3 threshold setup
+const executor = new CggmpExecutor(
+  'session-id',
+  'execution-id',
+  0,  // party index
+  2,  // threshold
+  3   // total parties
+);
+
+// Start auxiliary info generation
+executor.startAuxGen();
+
+// Process protocol rounds
+const outgoing = executor.step([]);
+// ... exchange messages with other parties ...
+
+// Check status
+const snapshot = JSON.parse(executor.snapshot());
+console.log(snapshot.status);
+
+// After aux gen, start keygen
+executor.startKeygen();
+// ... continue processing rounds ...
+
+// After keygen, export key share
+const keyShare = executor.exportKeyshare();
+
+// For signing, import key share and start signing
+executor.importKeyshare(keyShare);
+executor.setSigners('[0, 1]');  // Select signers
+executor.startSigning('0x...');  // Message hash (32 bytes hex)
+```
+
+## API
+
+### `CggmpExecutor`
+
+Main class for MPC protocol execution.
+
+#### Constructor
+```typescript
+new CggmpExecutor(
+  sessionId: string,
+  executionId: string,
+  partyIndex: number,
+  threshold: number,
+  partiesCount: number
+)
+```
+
+#### Methods
+
+| Method | Description |
+|--------|-------------|
+| `startAuxGen()` | Start auxiliary info generation |
+| `startAuxGenWithPrimes(primes: Buffer)` | Start aux gen with pre-generated primes |
+| `startKeygen()` | Start distributed key generation |
+| `startSigning(txHex: string)` | Start signing (32-byte hash as hex) |
+| `step(inputs: Buffer[]): Buffer[]` | Process incoming messages and return outgoing |
+| `snapshot(): string` | Get current state as JSON |
+| `setSigners(json: string)` | Set signer indices for signing |
+| `importKeyshare(data: Buffer)` | Import key share |
+| `exportKeyshare(): Buffer` | Export key share |
+| `importAuxInfo(data: Buffer)` | Import auxiliary info |
+| `exportAuxInfo(): Buffer` | Export auxiliary info |
+
+### `generatePrimes(): Buffer`
+
+Pre-generate safe primes for faster auxiliary info generation.
+
+## Protocol Flow
+
+1. **Auxiliary Info Generation**: Generate Paillier keys and ring-Pedersen parameters
+2. **Key Generation**: Generate ECDSA key shares using VSS
+3. **Signing**: Create threshold signatures with selected signers
+
+## Building from Source
+
+Requirements:
+- Node.js >= 18
+- Rust (stable)
+- pnpm
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build native binary
+pnpm build
+
+# Run tests
+pnpm test
+```
+
+## Security
+
+This library implements the CGGMP24 protocol which provides:
+- UC-secure key generation
+- Identifiable abort in case of malicious behavior
+- Threshold security (t-of-n)
+
+**Warning**: This is a cryptographic library. Use with caution in production environments.
+
+## License
+
+MIT
+
+## References
+
+- [CGGMP24 Paper](https://eprint.iacr.org/2021/060)
+- [cggmp21 Rust Implementation](https://github.com/LFDT-Lockness/cggmp21)

package/index.d.ts

@@ -0,0 +1,22 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+export function generatePrimes(): Buffer
+export class CggmpExecutor {
+  constructor(sessionId: string, executionId: string, partyIndex: number, threshold: number, partiesCount: number)
+  exportKeyshare(): Buffer
+  exportAuxInfo(): Buffer
+  importKeyshare(data: Buffer): void
+  importAuxInfo(data: Buffer): void
+  startKeygen(): void
+  startAuxGen(): void
+  startAuxGenWithPrimes(primesBuf: Buffer): void
+  setSigners(json: string): void
+  startSigning(txHex: string): void
+  step(inputs: Array<Buffer>): Array<Buffer>
+  snapshot(): string
+  exportKeyshareBin(): Buffer
+  exportAuxInfoBin(): Buffer
+}

package/index.js

@@ -0,0 +1,16 @@
+const { existsSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localBind = join(__dirname, 'cggmp-node-binding.node')
+
+if (existsSync(localBind)) {
+  nativeBinding = require(localBind)
+} else {
+  // 폴백 로직 (필요시 추가)
+  throw new Error(`Failed to load native binding from ${localBind}`)
+}
+
+module.exports = nativeBinding

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@kshan0515/cggmp-node-binding",
+  "version": "0.1.0",
+  "description": "Node.js native binding for CGGMP24 MPC ECDSA protocol - Distributed key generation and threshold signing",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/anthropics/cggmp-node-binding"
+  },
+  "keywords": [
+    "mpc",
+    "ecdsa",
+    "cggmp24",
+    "threshold-signature",
+    "dkg",
+    "signing",
+    "cryptography",
+    "napi",
+    "native"
+  ],
+  "author": "",
+  "license": "MIT",
+  "engines": {
+    "node": ">= 18"
+  },
+  "napi": {
+    "binaryName": "cggmp-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",
+    "ts-proto": "^1.181.0",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "protobufjs": "^7.5.4",
+    "rxjs": "^7.8.2"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "optionalDependencies": {
+    "@kshan0515/cggmp-node-binding-darwin-arm64": "0.1.0",
+    "@kshan0515/cggmp-node-binding-darwin-x64": "0.1.0",
+    "@kshan0515/cggmp-node-binding-linux-x64-gnu": "0.1.0",
+    "@kshan0515/cggmp-node-binding-linux-x64-musl": "0.1.0",
+    "@kshan0515/cggmp-node-binding-linux-arm64-gnu": "0.1.0",
+    "@kshan0515/cggmp-node-binding-win32-x64-msvc": "0.1.0"
+  }
+}