Skip to content

Commit d34523c

Browse files
authored
Merge pull request #194 from BitGo/WAL-806/fix-api-paths-in-docs
Update README and sync API paths
2 parents e1c6019 + b96567c commit d34523c

2 files changed

Lines changed: 20 additions & 10 deletions

File tree

CLAUDE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ API responses follow a standard error format with `error` and `details` fields.
113113
- `GET /version` - Version information
114114

115115
#### Key Management
116-
- `POST /:coin/key/independent` - Generate independent keychain
116+
- `POST /api/:coin/key/independent` - Generate independent keychain
117117

118118
#### Transaction Signing
119119
- `POST /api/:coin/multisig/sign` - Sign a multisig transaction
@@ -127,15 +127,15 @@ API responses follow a standard error format with `error` and `details` fields.
127127
- `POST /api/:coin/mpcv2/initialize` - Initialize MPC v2
128128
- `POST /api/:coin/mpcv2/round` - Perform a round in the MPC protocol
129129
- `POST /api/:coin/mpcv2/finalize` - Finalize the MPC DKG protocol
130+
- `POST /api/:coin/mpcv2/recovery` - Recover an MPC v2 wallet
130131

131132
### Master Express (Port 3081)
132133

133134
#### Health and Status Endpoints
134135

135-
- `POST /ping` - Health check
136-
- `GET /version` - Version information
136+
- `POST /advancedwallet/ping` - Health check
137+
- `GET /advancedwallet/version` - Version information
137138
- `POST /ping/advancedWalletManager` - Test connection to Advanced Wallet Manager
138-
- `GET /version/advancedWalletManager` - Get Advanced Wallet Manager version information
139139

140140
#### Wallet Management
141141

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ npm start
143143
curl -X POST http://localhost:3080/ping
144144

145145
# Test Master Express
146-
curl -X POST http://localhost:3081/ping
146+
curl -X POST http://localhost:3081/advancedwallet/ping
147147

148148
# Test connection between services
149149
curl -X POST http://localhost:3081/ping/advancedWalletManager
@@ -309,7 +309,7 @@ podman logs -f <container_id>
309309
curl -k --cert certs/test-ssl-cert.pem --key certs/advanced-wallet-manager-key.pem -X POST https://localhost:3080/ping
310310

311311
# For Master Express
312-
curl -k --cert certs/test-ssl-cert.pem --key certs/test-ssl-key.pem -X POST https://localhost:3081/ping
312+
curl -k --cert certs/test-ssl-cert.pem --key certs/test-ssl-key.pem -X POST https://localhost:3081/advancedwallet/ping
313313

314314
# Test the connection
315315
curl -k -X POST https://localhost:3081/ping/advancedWalletManager
@@ -378,12 +378,22 @@ docker-compose down
378378

379379
- `POST /ping` - Health check.
380380
- `GET /version` - Version information.
381-
- `POST /:coin/key/independent` - Generate independent keychain.
381+
- `POST /api/:coin/key/independent` - Generate independent keychain.
382+
- `POST /api/:coin/multisig/sign` - Sign a multisig transaction.
383+
- `POST /api/:coin/multisig/recovery` - Recover a multisig transaction.
384+
- `POST /api/:coin/mpc/recovery` - Sign a recovery transaction with EdDSA user & backup keyshares.
385+
- `POST /api/:coin/mpc/sign/:shareType` - Sign an MPC transaction.
386+
- `POST /api/:coin/mpc/key/initialize` - Initialize MPC for EdDSA key generation.
387+
- `POST /api/:coin/mpc/key/finalize` - Finalize key generation.
388+
- `POST /api/:coin/mpcv2/initialize` - Initialize MPC v2.
389+
- `POST /api/:coin/mpcv2/round` - Perform a round in the MPC protocol.
390+
- `POST /api/:coin/mpcv2/finalize` - Finalize the MPC DKG protocol.
391+
- `POST /api/:coin/mpcv2/recovery` - Recover an MPC v2 wallet.
382392

383393
### Master Express (Port 3081)
384394

385-
- `POST /ping` - Health check.
386-
- `GET /version` - Version information.
395+
- `POST /advancedwallet/ping` - Health check.
396+
- `GET /advancedwallet/version` - Version information.
387397
- `POST /ping/advancedWalletManager` - Test connection to Advanced Wallet Manager.
388398
- `POST /api/v1/:coin/advancedwallet/generate` - Generate wallet (with Advanced Wallet Manager integration).
389399
- `POST /api/v1/:coin/advancedwallet/:walletId/sendMany` - Send transaction with multiple recipients.
@@ -477,7 +487,7 @@ curl --cert /path/to/client-cert.crt --key /path/to/client-key.key \
477487
# Test Master Express (replace localhost with your server IP/hostname)
478488
curl --cert /path/to/client-cert.crt --key /path/to/client-key.key \
479489
--cacert /secure/certs/mbe-ca.crt \
480-
https://localhost:3081/ping
490+
https://localhost:3081/advancedwallet/ping
481491

482492
# Test connection between services
483493
curl --cert /path/to/client-cert.crt --key /path/to/client-key.key \

0 commit comments

Comments
 (0)