@@ -71,13 +71,52 @@ Configuration is managed through environment variables with defaults defined in
7171- ` ENCLAVED_EXPRESS_URL ` - Required URL for the Enclaved Express server
7272- ` ENCLAVED_EXPRESS_CERT ` - Required path to Enclaved Express certificate
7373
74+
75+ ## Abbreviations and Nomenclature
76+ - (DKG) Distributed Key Generation
77+ - (DSG) Distributed Signing Generation
78+ - (HSM) Hardware Security Module
79+ - (WP) Wallet Platform
80+ - (SDK) Refers to the BitGoJs SDK https://github.com/BitGo/BitGoJS
81+
82+ ## Error Handling
83+
84+ The application uses consistent error handling patterns across both modes:
85+
86+ - ` BitgoExpressError ` - Base error class for all custom errors
87+ - ` ValidationError ` - 422 Unprocessable Entity errors for invalid input parameters
88+ - ` NotFoundError ` - 404 Not Found errors for resources that don't exist
89+ - ` BadRequestError ` - 400 Bad Request errors for invalid request format
90+ - ` UnauthorizedError ` - 401 Unauthorized errors for authentication failures
91+ - ` ForbiddenError ` - 403 Forbidden errors for authorization issues
92+ - ` ConflictError ` - 409 Conflict errors for state conflicts
93+
94+ API responses follow a standard error format with ` error ` and ` details ` fields.
95+
7496## API Endpoints
7597
7698### Enclaved Express (Port 3080)
99+
100+ #### Health and Information
77101- ` POST /ping ` - Health check
78102- ` GET /version ` - Version information
103+
104+ #### Key Management
79105- ` POST /:coin/key/independent ` - Generate independent keychain
80106
107+ #### Transaction Signing
108+ - ` POST /api/:coin/multisig/sign ` - Sign a multisig transaction
109+ - ` POST /api/:coin/multisig/recovery ` - Recover a multisig transaction
110+ - ` POST /api/:coin/mpc/recovery ` - Sign a recovery transaction with EdDSA user & backup keyshares
111+ - ` POST /api/:coin/mpc/sign/:shareType ` - Sign an MPC transaction
112+
113+ #### MPC Key Operations
114+ - ` POST /api/:coin/mpc/key/initialize ` - Initialize MPC for EdDSA key generation
115+ - ` POST /api/:coin/mpc/key/finalize ` - Finalize key generation
116+ - ` POST /api/:coin/mpcv2/initialize ` - Initialize MPC v2
117+ - ` POST /api/:coin/mpcv2/round ` - Perform a round in the MPC protocol
118+ - ` POST /api/:coin/mpcv2/finalize ` - Finalize the MPC DKG protocol
119+
81120### Master Express (Port 3081)
82121
83122#### Health and Status Endpoints
0 commit comments