Skip to content

doc(mbe): add documentation for recoveries and accelerations #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pranavjain97 merged 1 commit into from
Jul 29, 2025
Merged

doc(mbe): add documentation for recoveries and accelerations #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,52 @@ Configuration is managed through environment variables with defaults defined in
- `ENCLAVED_EXPRESS_URL` - Required URL for the Enclaved Express server
- `ENCLAVED_EXPRESS_CERT` - Required path to Enclaved Express certificate


## Abbreviations and Nomenclature
- (DKG) Distributed Key Generation
- (DSG) Distributed Signing Generation
- (HSM) Hardware Security Module
- (WP) Wallet Platform
- (SDK) Refers to the BitGoJs SDK https://github.com/BitGo/BitGoJS

## Error Handling

The application uses consistent error handling patterns across both modes:

- `BitgoExpressError` - Base error class for all custom errors
- `ValidationError` - 422 Unprocessable Entity errors for invalid input parameters
- `NotFoundError` - 404 Not Found errors for resources that don't exist
- `BadRequestError` - 400 Bad Request errors for invalid request format
- `UnauthorizedError` - 401 Unauthorized errors for authentication failures
- `ForbiddenError` - 403 Forbidden errors for authorization issues
- `ConflictError` - 409 Conflict errors for state conflicts

API responses follow a standard error format with `error` and `details` fields.

## API Endpoints

### Enclaved Express (Port 3080)

#### Health and Information
- `POST /ping` - Health check
- `GET /version` - Version information

#### Key Management
- `POST /:coin/key/independent` - Generate independent keychain

#### Transaction Signing
- `POST /api/:coin/multisig/sign` - Sign a multisig transaction
- `POST /api/:coin/multisig/recovery` - Recover a multisig transaction
- `POST /api/:coin/mpc/recovery` - Sign a recovery transaction with EdDSA user & backup keyshares
- `POST /api/:coin/mpc/sign/:shareType` - Sign an MPC transaction

#### MPC Key Operations
- `POST /api/:coin/mpc/key/initialize` - Initialize MPC for EdDSA key generation
- `POST /api/:coin/mpc/key/finalize` - Finalize key generation
- `POST /api/:coin/mpcv2/initialize` - Initialize MPC v2
- `POST /api/:coin/mpcv2/round` - Perform a round in the MPC protocol
- `POST /api/:coin/mpcv2/finalize` - Finalize the MPC DKG protocol

### Master Express (Port 3081)

#### Health and Status Endpoints
Expand Down
Loading