Multi-Party Computation Controller API

NestJS HTTP API for the multi-party computation controller. Exposes key generation and threshold signing endpoints, enqueues jobs via BullMQ, and dispatches them to the cryptographic engine over gRPC. Clients poll for job completion.

Compatibility

OS	Status
macOS	✅
Linux	✅
Windows (via WSL2)	✅
Native Windows	✅

Prerequisites

• Docker and Docker Compose
• Node.js
• Bun
• Act for local GitHub Actions testing

Key generation

The client submits a key generation request. The API enqueues the job and returns a job ID immediately. The worker calls the Rust engine via gRPC, which coordinates the multi-party computation protocol across nodes. On completion the public key and key package are stored in Redis and exposed through the polling endpoint.

sequenceDiagram
    autonumber
    participant Client

    box API
        participant HTTP
        participant Queue
        participant Worker
    end

    participant Redis
    participant Engine as Cryptographic engine

    Client->>HTTP: POST /key-generation
    HTTP->>Queue: Enqueue job
    HTTP-->>Client: 202 Accepted { jobId }

    Queue->>Worker: Dequeue job
    Worker->>Engine: GenerateKey RPC
    Engine-->>Worker: { publicKey, publicKeyPackage }

    Worker->>Redis: Store key metadata
    Worker->>Queue: Mark job completed

    Client->>HTTP: GET /jobs/:jobId
    HTTP-->>Client: 200 OK { status: "completed", result: { publicKey, publicKeyPackage } }

Loading

Signing

The client submits a signing request referencing a previously generated key. The worker retrieves the key metadata from Redis, then calls the Rust engine to produce a threshold signature. The client polls until the job completes.

sequenceDiagram
    autonumber
    participant Client

    box API
        participant HTTP
        participant Queue
        participant Worker
    end

    participant Redis
    participant Engine as Cryptographic engine

    Client->>HTTP: POST /signing { keyIdentifier, message }
    HTTP->>Queue: Enqueue job
    HTTP-->>Client: 202 Accepted { jobId }

    Queue->>Worker: Dequeue job
    Worker->>Redis: Retrieve key metadata
    Redis-->>Worker: { publicKeyPackage, algorithm, threshold, participants }

    Worker->>Engine: Sign RPC
    Engine-->>Worker: { signature }

    Worker->>Queue: Mark job completed

    Client->>HTTP: GET /jobs/:jobId
    HTTP-->>Client: 200 OK { status: "completed", result: { signature } }

Loading

API Reference

POST /key-generation

Enqueues a distributed key-generation job.

Request:

POST /key-generation
Authorization: Bearer <token>
Content-Type: application/json

{
  "keyIdentifier": "<key_identifier: string>",
  "algorithm": "<algorithm: Algorithm>",
  "threshold": "<threshold: number>",
  "participants": "<participants: number>"
}

Response: 202 Accepted

{
  "jobId": "<job_id: string[UUIDv4]>"
}

---

POST /signing

Enqueues a threshold-signature job. Requires a previously completed key-generation for the given keyIdentifier.

Request:

POST /signing
Authorization: Bearer <token>
Content-Type: application/json

{
  "keyIdentifier": "<key_identifier: string>",
  "message": "<message: string>"
}

Response: 202 Accepted

{
  "jobId": "<job_id: string[UUIDv4]>"
}

---

GET /jobs/:jobId

Returns the current status of a job. The :jobId must be a valid UUID.

Request:

GET /jobs/<job_id>
Authorization: Bearer <token>

Response: 200 OK

{
  "jobId": "<job_id: string[UUIDv4]>",
  "type": "<job_type: JobType>",
  "status": "<job_status: JobStatus>",
  "result": "<result: JobResult | null>",
  "error": "<error: string | null>",
  "createdAt": "<created_at: string[ISO8601]>",
  "updatedAt": "<updated_at: string[ISO8601]>"
}

• JobType: see documentation for possible enum values.
• JobStatus: see documentation for possible enum values.
• JobResult: see documentation for possible result structures.

Error response: 404 Not Found - job does not exist.

{
  "message": "<error_message: string>"
}