Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions modules/express/src/typedRoutes/api/v1/acceptShare.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export const AcceptShareRequestBody = {
* When a wallet is shared with a user, they need to accept the share to gain access
* to the wallet according to the permissions granted by the sharing user.
*
* @tag express
* @operationId express.v1.wallet.acceptShare
*/
export const PostAcceptShare = httpRoute({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ export const ConsolidateUnspentsResponse = t.array(
* multiple inputs to a single output. This is useful for reducing the number of UTXOs in a wallet,
* which can improve performance and reduce transaction fees.
*
* @tag express
* @operationId express.v1.wallet.consolidateunspents
*/
export const PutConsolidateUnspents = httpRoute({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ export const ConstructPendingApprovalTxResponse = t.type({
* For transaction request type approvals, either a wallet passphrase or xprv must be provided to sign the transaction.
* You can optionally specify fee-related parameters to customize the transaction fee.
*
* @tag express
* @operationId express.v1.pendingapproval.constructTx
*/
export const PutConstructPendingApprovalTx = httpRoute({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ export const CreateLocalKeyChainResponse = t.type({
* For security reasons, it is highly recommended that you encrypt and destroy
* the original xprv immediately to prevent theft.
*
* @tag express
* @operationId express.v1.keychain.local
*/
export const PostCreateLocalKeyChain = httpRoute({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export const DeriveLocalKeyChainResponse = t.type({
* both the derived xprv and xpub are returned. If xpub is provided, only the
* derived xpub is returned.
*
* @tag express
* @operationId express.v1.keychain.derive
*/
export const PostDeriveLocalKeyChain = httpRoute({
Expand Down
1 change: 1 addition & 0 deletions modules/express/src/typedRoutes/api/v1/fanoutUnspents.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ export const FanoutUnspentsResponse = t.type({
* multiple inputs to multiple outputs. This is useful for increasing the number of UTXOs
* in a wallet, which can improve transaction parallelization.
*
* @tag express
* @operationId express.v1.wallet.fanoutunspents
*/
export const PutFanoutUnspents = httpRoute({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ export const pendingApprovalRequestBody = {
* Handles various approval scenarios including transaction approvals, policy rule changes,
* and user change requests.
*
* @tag express
* @operationId express.v1.pendingapprovals
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export const signTransactionRequestBody = {
* signTransaction
* Sign a previously created transaction with a keychain
*
* @tag express
* @operationId express.v1.wallet.signTransaction
*/
export const PostSignTransaction = httpRoute({
Expand Down
1 change: 1 addition & 0 deletions modules/express/src/typedRoutes/api/v1/simpleCreate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export const SimpleCreateRequestBody = {
* 4. Creates the BitGo key on the service
* 5. Creates the wallet on BitGo with the 3 public keys above
*
* @tag express
* @operationId express.v1.wallet.simplecreate
*/
export const PostSimpleCreate = httpRoute({
Expand Down
1 change: 1 addition & 0 deletions modules/express/src/typedRoutes/api/v2/coinSignTx.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ export const CoinSignTxResponse = {
* - pubKeys: Public keys for multi-signature transactions
* - isEvmBasedCrossChainRecovery: For EVM cross-chain recovery
*
* @tag express
* @operationId express.v2.coin.signtx
*/
export const PostCoinSignTx = httpRoute({
Expand Down
1 change: 1 addition & 0 deletions modules/express/src/typedRoutes/api/v2/keychainLocal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ export const KeychainLocalResponse = {
*
* For security reasons, it is highly recommended that you encrypt and destroy the original xprv immediately to prevent theft.
*
* @tag express
* @operationId express.keychain.local
*/
export const PostKeychainLocal = httpRoute({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ export const LightningInitWalletResponse = {
* Lightning - This is only used for self-custody lightning. Initialize a newly created Lightning Network Daemon (LND) for the first time.
* Returns the updated wallet with the encrypted admin macaroon in the `coinSpecific` response field.
*
* @tag express
* @operationId express.lightning.initWallet
*/
export const PostLightningInitWallet = httpRoute({
Expand Down
1 change: 1 addition & 0 deletions modules/express/src/typedRoutes/api/v2/lightningState.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ export const LightningStateResponse = {
*
* This is only used for self-custody lightning. Get the current state of the lightning node.
*
* @tag express
* @operationId express.lightning.getState
*/
export const GetLightningState = httpRoute({
Expand Down
1 change: 1 addition & 0 deletions modules/express/src/typedRoutes/api/v2/unlockWallet.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ export const UnlockLightningWalletResponse = {
*
* This is only used for self-custody lightning. Unlock the Lightning Network Daemon (LND) node with the given wallet password.
*
* @tag express
* @operationId express.lightning.unlockWallet
*/
export const PostUnlockLightningWallet = httpRoute({
Expand Down
1 change: 1 addition & 0 deletions modules/express/src/typedRoutes/api/v2/verifyAddress.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export const VerifyAddressV2Body = {
* Returns whether the address is valid for the specified coin.
* For UTXO coins, an optional legacy script hash flag can be provided to allow previous script hash versions.
*
* @tag express
* @operationId express.verifycoinaddress
*/
export const PostVerifyCoinAddress = httpRoute({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ export const RecoverTokenResponse = t.type({
*
* Note: This endpoint is only supported for ETH family wallets.
*
* @tag express
* @operationId express.v2.wallet.recovertoken
*/
export const PostWalletRecoverToken = httpRoute({
Expand Down
1 change: 1 addition & 0 deletions modules/express/src/typedRoutes/api/v2/walletSignTx.ts
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ export const WalletSignTxResponse = {
* - sequenceId: Sequence ID for transactions
* - isEvmBasedCrossChainRecovery: For EVM cross-chain recovery
*
* @tag express
* @operationId express.v2.wallet.signtx
*/
export const PostWalletSignTx = httpRoute({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ export const WalletTxSignTSSResponse = {
* - sequenceId: Sequence ID for transactions
* - isEvmBasedCrossChainRecovery: For EVM cross-chain recovery
*
* @tag express
* @operationId express.v2.wallet.signtxtss
*/
export const PostWalletTxSignTSS = httpRoute({
Expand Down