@cobo/cobo-waas2 1.7.0 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +122 -29
- package/dist/ApiClient.js +11 -1
- package/dist/api/AddressBooksApi.js +7 -7
- package/dist/api/DevelopersApi.js +111 -1
- package/dist/api/DevelopersWebhooksApi.js +38 -38
- package/dist/api/OAuthApi.js +2 -2
- package/dist/api/PrimeBrokerApi.js +317 -0
- package/dist/api/StakingsApi.js +45 -42
- package/dist/api/TransactionsApi.js +131 -42
- package/dist/api/TravelRuleApi.js +216 -0
- package/dist/api/WalletsApi.js +152 -81
- package/dist/api/WalletsExchangeWalletApi.js +13 -13
- package/dist/api/WalletsMPCWalletsApi.js +189 -77
- package/dist/api/WalletsSmartContractWalletsApi.js +1 -1
- package/dist/index.js +385 -7
- package/dist/model/Activity.js +29 -0
- package/dist/model/ActivityAction.js +30 -0
- package/dist/model/ActivityExtra.js +274 -0
- package/dist/model/AddressBalance.js +129 -0
- package/dist/model/AddressInfo.js +15 -2
- package/dist/model/AddressTransferDestination.js +37 -1
- package/dist/model/AddressesEventData.js +190 -0
- package/dist/model/ApiLogDetails.js +2 -2
- package/dist/model/ApprovalStatementStatus.js +81 -0
- package/dist/model/AssetBalance.js +6 -6
- package/dist/model/BTCEIP191MessageSignDestination.js +122 -0
- package/dist/model/BabylonStakeExtra.js +1 -1
- package/dist/model/BabylonStakingActivityDetailExtra.js +165 -0
- package/dist/model/{TokenBalanceBalance.js → Balance.js} +28 -28
- package/dist/model/BaseContractCallSource.js +1 -1
- package/dist/model/BroadcastSignedTransactionsRequest.js +1 -1
- package/dist/model/CallbackMessage.js +288 -0
- package/dist/model/ChainInfo.js +2 -2
- package/dist/model/ChangeGuardPubkey200Response.js +110 -0
- package/dist/model/ContractCallParams.js +38 -2
- package/dist/model/CoreStakingActivityDetailExtra.js +164 -0
- package/dist/model/CreateAddressRequest.js +30 -4
- package/dist/model/CreateClaimActivity.js +2 -2
- package/dist/model/CreateClaimActivityRequest.js +3 -3
- package/dist/model/CreateKeyShareHolder.js +1 -1
- package/dist/model/CreateMpcVaultRequest.js +1 -1
- package/dist/model/CreateMpcWalletParams.js +2 -2
- package/dist/model/CreatePrimeBrokerAddress201Response.js +140 -0
- package/dist/model/CreatePrimeBrokerAddressRequest.js +107 -0
- package/dist/model/CreateStakeActivity.js +4 -6
- package/dist/model/CreateStakeActivityExtra.js +1 -1
- package/dist/model/CreateStakeActivityRequest.js +5 -7
- package/dist/model/CreateWalletParams.js +1 -1
- package/dist/model/CreateWebhookEndpointRequest.js +2 -2
- package/dist/model/CustodialTransferSource.js +1 -1
- package/dist/model/DeleteGuardPubkey201Response.js +110 -0
- package/dist/model/DestinationWalletType.js +61 -0
- package/dist/model/ErrorResponse.js +2 -2
- package/dist/model/EstimateClaimFee.js +1 -1
- package/dist/model/EstimateContractCallFeeParams.js +2 -2
- package/dist/model/EstimateFeeParams.js +2 -2
- package/dist/model/EstimateStakeFee.js +5 -7
- package/dist/model/EstimateTransferFeeParams.js +2 -2
- package/dist/model/EthStakeEstimatedFee.js +13 -0
- package/dist/model/EthStakingActivityDetailExtra.js +142 -0
- package/dist/model/EvmContractCallDestination.js +1 -1
- package/dist/model/EvmEIP191MessageSignDestination.js +1 -1
- package/dist/model/EvmEIP712MessageSignDestination.js +1 -1
- package/dist/model/ExchangeTransferDestination.js +1 -1
- package/dist/model/ExchangeTransferSource.js +1 -1
- package/dist/model/ExtendedTokenInfo.js +3 -3
- package/dist/model/GetStakingEstimationFee201Response.js +6 -0
- package/dist/model/GetStakingEstimationFeeRequest.js +1 -1
- package/dist/model/GetTransactionLimitation200Response.js +143 -0
- package/dist/model/GuardPubkeyStatus.js +91 -0
- package/dist/model/ListAddressBalancesByToken200Response.js +123 -0
- package/dist/model/ListCallbackMessages200Response.js +145 -0
- package/dist/model/ListKeyShareHolders200Response.js +123 -0
- package/dist/model/ListSupportedCountries200ResponseInner.js +140 -0
- package/dist/model/LockUtxosRequestUtxosInner.js +2 -2
- package/dist/model/MPCDelegate.js +1 -1
- package/dist/model/MPCVaultEventData.js +279 -0
- package/dist/model/MaxTransferableValue.js +1 -1
- package/dist/model/MessageSignDestination.js +70 -8
- package/dist/model/MessageSignDestinationType.js +12 -2
- package/dist/model/MessageSignParams.js +2 -2
- package/dist/model/MpcTransferSource.js +1 -1
- package/dist/model/OrgInfo.js +133 -0
- package/dist/model/Pagination.js +4 -4
- package/dist/model/QueryApprovalStatement200Response.js +122 -0
- package/dist/model/QueryGuardPubkey200Response.js +129 -0
- package/dist/model/QueryGuardPubkey200ResponseAddressesInner.js +125 -0
- package/dist/model/RawMessageSignDestination.js +1 -1
- package/dist/model/RetryCallbackMessage201Response.js +83 -0
- package/dist/model/RootPubkey.js +1 -1
- package/dist/model/SafeContractCallSource.js +1 -1
- package/dist/model/SafeTransferSource.js +1 -1
- package/dist/model/SelectedEntityType.js +61 -0
- package/dist/model/SelfCustodyWallet.js +152 -0
- package/dist/model/SourceGroup.js +1 -1
- package/dist/model/StakingPoolId.js +5 -0
- package/dist/model/StakingPoolType.js +5 -0
- package/dist/model/SubWalletAssetBalance.js +6 -6
- package/dist/model/SubmitDepositTravelRuleInfo201Response.js +83 -0
- package/dist/model/SwapActivity.js +218 -0
- package/dist/model/SwapSummary.js +121 -0
- package/dist/model/SwapTokenPair.js +100 -0
- package/dist/model/TSSGroups.js +1 -1
- package/dist/model/TSSRequestWebhookEventData.js +18 -3
- package/dist/model/TokenBalance.js +8 -8
- package/dist/model/TokenInfo.js +2 -2
- package/dist/model/Transaction.js +2 -2
- package/dist/model/TransactionApprovalDetail.js +121 -0
- package/dist/model/TransactionApprovalResult.js +66 -0
- package/dist/model/TransactionCustodialAssetWalletSource.js +1 -1
- package/dist/model/TransactionDepositFromAddressSource.js +1 -1
- package/dist/model/TransactionDepositFromLoopSource.js +1 -1
- package/dist/model/TransactionDepositFromWalletSource.js +1 -1
- package/dist/model/TransactionDepositToAddressDestination.js +17 -1
- package/dist/model/TransactionDepositToAddressDestinationTxInfo.js +83 -0
- package/dist/model/TransactionDepositToWalletDestination.js +1 -1
- package/dist/model/TransactionDestination.js +6 -0
- package/dist/model/TransactionDetail.js +4 -4
- package/dist/model/TransactionDetails.js +4 -4
- package/dist/model/TransactionEvmContractDestination.js +1 -1
- package/dist/model/TransactionExchangeWalletSource.js +1 -1
- package/dist/model/TransactionMPCWalletSource.js +1 -1
- package/dist/model/TransactionMessageSignEIP191Destination.js +1 -1
- package/dist/model/TransactionMessageSignEIP712Destination.js +1 -1
- package/dist/model/TransactionRawMessageSignDestination.js +1 -1
- package/dist/model/TransactionRawTxInfo.js +17 -4
- package/dist/model/TransactionRequestEvmEip1559Fee.js +1 -1
- package/dist/model/TransactionRequestEvmLegacyFee.js +1 -1
- package/dist/model/TransactionRequestFixedFee.js +1 -1
- package/dist/model/TransactionRequestUtxoFee.js +1 -1
- package/dist/model/TransactionRoleApprovalDetail.js +152 -0
- package/dist/model/TransactionSelectedUtxo.js +123 -0
- package/dist/model/TransactionSmartContractSafeWalletSource.js +1 -1
- package/dist/model/TransactionSubStatus.js +5 -0
- package/dist/model/TransactionTokeApproval.js +3 -3
- package/dist/model/TransactionTokenAmount.js +1 -1
- package/dist/model/TransactionTransferToAddressDestination.js +1 -1
- package/dist/model/TransactionTransferToWalletDestination.js +1 -1
- package/dist/model/TransactionUserApprovalDetail.js +162 -0
- package/dist/model/TransactionWebhookEventData.js +22 -7
- package/dist/model/TransferDestination.js +6 -0
- package/dist/model/TransferParams.js +38 -2
- package/dist/model/TravelRuleDepositExchangesOrVASP.js +168 -0
- package/dist/model/TravelRuleDepositExchangesOrVASPEntityInfo.js +222 -0
- package/dist/model/TravelRuleDepositLegalEntity.js +171 -0
- package/dist/model/TravelRuleDepositNaturalEntity.js +186 -0
- package/dist/model/TravelRuleDepositRequest.js +128 -0
- package/dist/model/TravelRuleDepositRequestTravelRuleInfo.js +222 -0
- package/dist/model/TravelRuleWithdrawExchangesOrVASP.js +155 -0
- package/dist/model/TravelRuleWithdrawExchangesOrVASPEntityInfo.js +222 -0
- package/dist/model/TravelRuleWithdrawLegalEntity.js +144 -0
- package/dist/model/TravelRuleWithdrawNaturalEntity.js +159 -0
- package/dist/model/TravelRuleWithdrawRequest.js +128 -0
- package/dist/model/TravelRuleWithdrawRequestTravelRuleInfo.js +216 -0
- package/dist/model/TriggerTestWebhookEventRequest.js +1 -1
- package/dist/model/UpdateWebhookEndpointByIdRequest.js +1 -1
- package/dist/model/Vasp.js +141 -0
- package/dist/model/WalletInfoEventData.js +175 -0
- package/dist/model/WebhookEventData.js +135 -14
- package/dist/model/WebhookEventDataType.js +17 -2
- package/dist/model/WebhookEventType.js +23 -8
- package/docs/Activity.md +2 -0
- package/docs/ActivityAction.md +12 -0
- package/docs/ActivityExtra.md +20 -0
- package/docs/AddressBalance.md +10 -0
- package/docs/AddressBooksApi.md +4 -4
- package/docs/AddressInfo.md +2 -1
- package/docs/AddressTransferDestination.md +14 -0
- package/docs/AddressesEventData.md +29 -0
- package/docs/ApiLogDetails.md +1 -1
- package/docs/ApprovalStatementStatus.md +20 -0
- package/docs/AssetBalance.md +1 -1
- package/docs/BTCEIP191MessageSignDestination.md +10 -0
- package/docs/BabylonStakeExtra.md +1 -1
- package/docs/BabylonStakingActivityDetailExtra.md +14 -0
- package/docs/{TokenBalanceBalance.md → Balance.md} +5 -5
- package/docs/BroadcastSignedTransactionsRequest.md +1 -1
- package/docs/CallbackMessage.md +46 -0
- package/docs/ChainInfo.md +1 -1
- package/docs/ChangeGuardPubkey200Response.md +9 -0
- package/docs/ContractCallParams.md +15 -1
- package/docs/CoreStakingActivityDetailExtra.md +13 -0
- package/docs/CreateAddressRequest.md +4 -2
- package/docs/CreateClaimActivity.md +1 -1
- package/docs/CreateClaimActivityRequest.md +1 -1
- package/docs/CreateKeyShareHolder.md +1 -1
- package/docs/CreateMpcVaultRequest.md +1 -1
- package/docs/CreateMpcWalletParams.md +1 -1
- package/docs/CreatePrimeBrokerAddress201Response.md +10 -0
- package/docs/CreatePrimeBrokerAddressRequest.md +9 -0
- package/docs/CreateStakeActivity.md +1 -1
- package/docs/CreateStakeActivityExtra.md +1 -1
- package/docs/CreateStakeActivityRequest.md +1 -1
- package/docs/CreateWalletParams.md +1 -1
- package/docs/CreateWebhookEndpointRequest.md +1 -1
- package/docs/DeleteGuardPubkey201Response.md +9 -0
- package/docs/DestinationWalletType.md +12 -0
- package/docs/DevelopersApi.md +119 -1
- package/docs/DevelopersWebhooksApi.md +23 -23
- package/docs/ErrorResponse.md +1 -1
- package/docs/EstimateClaimFee.md +1 -1
- package/docs/EstimateContractCallFeeParams.md +1 -1
- package/docs/EstimateFeeParams.md +2 -2
- package/docs/EstimateStakeFee.md +1 -1
- package/docs/EstimateTransferFeeParams.md +1 -1
- package/docs/EthStakeEstimatedFee.md +1 -0
- package/docs/EthStakingActivityDetailExtra.md +11 -0
- package/docs/ExtendedTokenInfo.md +1 -1
- package/docs/GetStakingEstimationFee201Response.md +1 -0
- package/docs/GetStakingEstimationFeeRequest.md +2 -2
- package/docs/GetTransactionLimitation200Response.md +12 -0
- package/docs/GuardPubkeyStatus.md +24 -0
- package/docs/ListAddressBalancesByToken200Response.md +10 -0
- package/docs/ListCallbackMessages200Response.md +10 -0
- package/docs/ListKeyShareHolders200Response.md +10 -0
- package/docs/ListSupportedCountries200ResponseInner.md +11 -0
- package/docs/LockUtxosRequestUtxosInner.md +1 -1
- package/docs/MPCVaultEventData.md +34 -0
- package/docs/MaxTransferableValue.md +1 -1
- package/docs/MessageSignDestination.md +1 -0
- package/docs/MessageSignDestinationType.md +6 -2
- package/docs/MessageSignParams.md +1 -1
- package/docs/OAuthApi.md +1 -1
- package/docs/OrgInfo.md +11 -0
- package/docs/Pagination.md +2 -2
- package/docs/PrimeBrokerApi.md +318 -0
- package/docs/QueryApprovalStatement200Response.md +12 -0
- package/docs/QueryGuardPubkey200Response.md +11 -0
- package/docs/QueryGuardPubkey200ResponseAddressesInner.md +10 -0
- package/docs/RetryCallbackMessage201Response.md +9 -0
- package/docs/RootPubkey.md +1 -1
- package/docs/SelectedEntityType.md +12 -0
- package/docs/SelfCustodyWallet.md +12 -0
- package/docs/SourceGroup.md +1 -1
- package/docs/StakingPoolId.md +2 -0
- package/docs/StakingPoolType.md +2 -0
- package/docs/StakingsApi.md +30 -28
- package/docs/SubWalletAssetBalance.md +1 -1
- package/docs/SubmitDepositTravelRuleInfo201Response.md +9 -0
- package/docs/SwapActivity.md +20 -0
- package/docs/SwapSummary.md +10 -0
- package/docs/SwapTokenPair.md +10 -0
- package/docs/TSSGroups.md +1 -1
- package/docs/TSSRequestWebhookEventData.md +7 -1
- package/docs/TokenBalance.md +2 -2
- package/docs/TokenInfo.md +1 -1
- package/docs/Transaction.md +2 -2
- package/docs/TransactionApprovalDetail.md +11 -0
- package/docs/TransactionApprovalResult.md +14 -0
- package/docs/TransactionDepositToAddressDestination.md +1 -0
- package/docs/TransactionDepositToAddressDestinationTxInfo.md +9 -0
- package/docs/TransactionDestination.md +1 -0
- package/docs/TransactionDetail.md +2 -2
- package/docs/TransactionDetails.md +2 -2
- package/docs/TransactionRawTxInfo.md +2 -1
- package/docs/TransactionRoleApprovalDetail.md +13 -0
- package/docs/TransactionSelectedUtxo.md +12 -0
- package/docs/TransactionSubStatus.md +2 -0
- package/docs/TransactionTokeApproval.md +1 -1
- package/docs/TransactionTokenAmount.md +1 -1
- package/docs/TransactionUserApprovalDetail.md +15 -0
- package/docs/TransactionWebhookEventData.md +9 -3
- package/docs/TransactionsApi.md +129 -27
- package/docs/TransferDestination.md +14 -0
- package/docs/TransferParams.md +15 -1
- package/docs/TravelRuleApi.md +214 -0
- package/docs/TravelRuleDepositExchangesOrVASP.md +13 -0
- package/docs/TravelRuleDepositExchangesOrVASPEntityInfo.md +29 -0
- package/docs/TravelRuleDepositLegalEntity.md +25 -0
- package/docs/TravelRuleDepositNaturalEntity.md +26 -0
- package/docs/TravelRuleDepositRequest.md +10 -0
- package/docs/TravelRuleDepositRequestTravelRuleInfo.md +16 -0
- package/docs/TravelRuleWithdrawExchangesOrVASP.md +12 -0
- package/docs/TravelRuleWithdrawExchangesOrVASPEntityInfo.md +16 -0
- package/docs/TravelRuleWithdrawLegalEntity.md +12 -0
- package/docs/TravelRuleWithdrawNaturalEntity.md +13 -0
- package/docs/TravelRuleWithdrawRequest.md +10 -0
- package/docs/TravelRuleWithdrawRequestTravelRuleInfo.md +15 -0
- package/docs/TriggerTestWebhookEventRequest.md +1 -1
- package/docs/UpdateWebhookEndpointByIdRequest.md +1 -1
- package/docs/Vasp.md +11 -0
- package/docs/WalletInfoEventData.md +29 -0
- package/docs/WalletsApi.md +112 -47
- package/docs/WalletsExchangeWalletApi.md +7 -7
- package/docs/WalletsMPCWalletsApi.md +160 -46
- package/docs/WalletsSmartContractWalletsApi.md +1 -1
- package/docs/WebhookEventData.md +17 -5
- package/docs/WebhookEventDataType.md +7 -1
- package/docs/WebhookEventType.md +14 -8
- package/package.json +2 -2
|
@@ -10,12 +10,14 @@ Method | HTTP request | Description
|
|
|
10
10
|
[**createMpcVault**](WalletsMPCWalletsApi.md#createMpcVault) | **POST** /wallets/mpc/vaults | Create vault
|
|
11
11
|
[**createTssRequest**](WalletsMPCWalletsApi.md#createTssRequest) | **POST** /wallets/mpc/vaults/{vault_id}/tss_requests | Create TSS request
|
|
12
12
|
[**deleteKeyShareHolderGroupById**](WalletsMPCWalletsApi.md#deleteKeyShareHolderGroupById) | **POST** /wallets/mpc/vaults/{vault_id}/key_share_holder_groups/{key_share_holder_group_id}/delete | Delete key share holder group
|
|
13
|
+
[**getKeyShareHolderByTssNodeId**](WalletsMPCWalletsApi.md#getKeyShareHolderByTssNodeId) | **GET** /wallets/mpc/vaults/{vault_id}/key_share_holders/{tss_node_id} | Get key share holder information
|
|
13
14
|
[**getKeyShareHolderGroupById**](WalletsMPCWalletsApi.md#getKeyShareHolderGroupById) | **GET** /wallets/mpc/vaults/{vault_id}/key_share_holder_groups/{key_share_holder_group_id} | Get key share holder group information
|
|
14
15
|
[**getMpcProjectById**](WalletsMPCWalletsApi.md#getMpcProjectById) | **GET** /wallets/mpc/projects/{project_id} | Get project information
|
|
15
16
|
[**getMpcVaultById**](WalletsMPCWalletsApi.md#getMpcVaultById) | **GET** /wallets/mpc/vaults/{vault_id} | Get vault information
|
|
16
17
|
[**getTssRequestById**](WalletsMPCWalletsApi.md#getTssRequestById) | **GET** /wallets/mpc/vaults/{vault_id}/tss_requests/{tss_request_id} | Get TSS request
|
|
17
18
|
[**listCoboKeyHolders**](WalletsMPCWalletsApi.md#listCoboKeyHolders) | **GET** /wallets/mpc/cobo_key_share_holders | List all Cobo key share holders
|
|
18
19
|
[**listKeyShareHolderGroups**](WalletsMPCWalletsApi.md#listKeyShareHolderGroups) | **GET** /wallets/mpc/vaults/{vault_id}/key_share_holder_groups | List all key share holder groups
|
|
20
|
+
[**listKeyShareHolders**](WalletsMPCWalletsApi.md#listKeyShareHolders) | **GET** /wallets/mpc/vaults/{vault_id}/key_share_holders | List all key share holders
|
|
19
21
|
[**listMpcProjects**](WalletsMPCWalletsApi.md#listMpcProjects) | **GET** /wallets/mpc/projects | List all projects
|
|
20
22
|
[**listMpcVaults**](WalletsMPCWalletsApi.md#listMpcVaults) | **GET** /wallets/mpc/vaults | List all vaults
|
|
21
23
|
[**listTssRequests**](WalletsMPCWalletsApi.md#listTssRequests) | **GET** /wallets/mpc/vaults/{vault_id}/tss_requests | List TSS requests
|
|
@@ -60,8 +62,8 @@ apiInstance.cancelTssRequestById(vault_id, tss_request_id).then((data) => {
|
|
|
60
62
|
|
|
61
63
|
Name | Type | Description | Notes
|
|
62
64
|
------------- | ------------- | ------------- | -------------
|
|
63
|
-
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-
|
|
64
|
-
**tss_request_id** | **String**| The TSS request ID, which you can retrieve by calling [List TSS requests](/v2/api-references/wallets--mpc-wallets/list-tss-requests). |
|
|
65
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). |
|
|
66
|
+
**tss_request_id** | **String**| The TSS request ID, which you can retrieve by calling [List TSS requests](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-tss-requests). |
|
|
65
67
|
|
|
66
68
|
### Return type
|
|
67
69
|
|
|
@@ -69,7 +71,7 @@ Name | Type | Description | Notes
|
|
|
69
71
|
|
|
70
72
|
### Authorization
|
|
71
73
|
|
|
72
|
-
[OAuth2](../README.md#OAuth2)
|
|
74
|
+
[OAuth2](../README.md#OAuth2)
|
|
73
75
|
|
|
74
76
|
### HTTP request headers
|
|
75
77
|
|
|
@@ -83,7 +85,7 @@ Name | Type | Description | Notes
|
|
|
83
85
|
|
|
84
86
|
Create key share holder group
|
|
85
87
|
|
|
86
|
-
This operation creates a key share holder group for a specified vault. <Note>This operation will not return the `tss_key_share_groups` property until key shares have been created using the [Create TSS request](/v2/api-references/wallets--mpc-wallets/create-tss-request) operation. Creating a wallet with the [Create wallet](/v2/api-references/wallets/create-wallet) operation is only possible after you've completed the previous actions.</Note>
|
|
88
|
+
This operation creates a key share holder group for a specified vault. <Note>This operation will not return the `tss_key_share_groups` property until key shares have been created using the [Create TSS request](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/create-tss-request) operation. Creating a wallet with the [Create wallet](https://www.cobo.com/developers/v2/api-references/wallets/create-wallet) operation is only possible after you've completed the previous actions.</Note>
|
|
87
89
|
|
|
88
90
|
### Example
|
|
89
91
|
|
|
@@ -114,7 +116,7 @@ apiInstance.createKeyShareHolderGroup(vault_id, opts).then((data) => {
|
|
|
114
116
|
|
|
115
117
|
Name | Type | Description | Notes
|
|
116
118
|
------------- | ------------- | ------------- | -------------
|
|
117
|
-
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-
|
|
119
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). |
|
|
118
120
|
**CreateKeyShareHolderGroupRequest** | [**CreateKeyShareHolderGroupRequest**](CreateKeyShareHolderGroupRequest.md)| The request body to create a key share holder group. | [optional]
|
|
119
121
|
|
|
120
122
|
### Return type
|
|
@@ -123,7 +125,7 @@ Name | Type | Description | Notes
|
|
|
123
125
|
|
|
124
126
|
### Authorization
|
|
125
127
|
|
|
126
|
-
[OAuth2](../README.md#OAuth2)
|
|
128
|
+
[OAuth2](../README.md#OAuth2)
|
|
127
129
|
|
|
128
130
|
### HTTP request headers
|
|
129
131
|
|
|
@@ -175,7 +177,7 @@ Name | Type | Description | Notes
|
|
|
175
177
|
|
|
176
178
|
### Authorization
|
|
177
179
|
|
|
178
|
-
[OAuth2](../README.md#OAuth2)
|
|
180
|
+
[OAuth2](../README.md#OAuth2)
|
|
179
181
|
|
|
180
182
|
### HTTP request headers
|
|
181
183
|
|
|
@@ -189,7 +191,7 @@ Name | Type | Description | Notes
|
|
|
189
191
|
|
|
190
192
|
Create vault
|
|
191
193
|
|
|
192
|
-
This operation creates a vault. <Info>To learn what a vault is and how it relates to MPC Wallets, see [Get started with MPC Wallets](/v2/guides/mpc-wallets/get-started-ocw#technical-architecture).</Info>
|
|
194
|
+
This operation creates a vault. <Info>To learn what a vault is and how it relates to MPC Wallets, see [Get started with MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/get-started-ocw#technical-architecture).</Info>
|
|
193
195
|
|
|
194
196
|
### Example
|
|
195
197
|
|
|
@@ -227,7 +229,7 @@ Name | Type | Description | Notes
|
|
|
227
229
|
|
|
228
230
|
### Authorization
|
|
229
231
|
|
|
230
|
-
[OAuth2](../README.md#OAuth2)
|
|
232
|
+
[OAuth2](../README.md#OAuth2)
|
|
231
233
|
|
|
232
234
|
### HTTP request headers
|
|
233
235
|
|
|
@@ -272,7 +274,7 @@ apiInstance.createTssRequest(vault_id, opts).then((data) => {
|
|
|
272
274
|
|
|
273
275
|
Name | Type | Description | Notes
|
|
274
276
|
------------- | ------------- | ------------- | -------------
|
|
275
|
-
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-
|
|
277
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). |
|
|
276
278
|
**CreateTssRequestRequest** | [**CreateTssRequestRequest**](CreateTssRequestRequest.md)| The request body to create a TSS request. | [optional]
|
|
277
279
|
|
|
278
280
|
### Return type
|
|
@@ -281,7 +283,7 @@ Name | Type | Description | Notes
|
|
|
281
283
|
|
|
282
284
|
### Authorization
|
|
283
285
|
|
|
284
|
-
[OAuth2](../README.md#OAuth2)
|
|
286
|
+
[OAuth2](../README.md#OAuth2)
|
|
285
287
|
|
|
286
288
|
### HTTP request headers
|
|
287
289
|
|
|
@@ -324,7 +326,7 @@ apiInstance.deleteKeyShareHolderGroupById(vault_id, key_share_holder_group_id).t
|
|
|
324
326
|
|
|
325
327
|
Name | Type | Description | Notes
|
|
326
328
|
------------- | ------------- | ------------- | -------------
|
|
327
|
-
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-
|
|
329
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). |
|
|
328
330
|
**key_share_holder_group_id** | **String**| The key share holder group ID. |
|
|
329
331
|
|
|
330
332
|
### Return type
|
|
@@ -333,7 +335,59 @@ Name | Type | Description | Notes
|
|
|
333
335
|
|
|
334
336
|
### Authorization
|
|
335
337
|
|
|
336
|
-
[OAuth2](../README.md#OAuth2)
|
|
338
|
+
[OAuth2](../README.md#OAuth2)
|
|
339
|
+
|
|
340
|
+
### HTTP request headers
|
|
341
|
+
|
|
342
|
+
- **Content-Type**: Not defined
|
|
343
|
+
- **Accept**: application/json
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
## getKeyShareHolderByTssNodeId
|
|
347
|
+
|
|
348
|
+
> KeyShareHolder getKeyShareHolderByTssNodeId(vault_id, tss_node_id)
|
|
349
|
+
|
|
350
|
+
Get key share holder information
|
|
351
|
+
|
|
352
|
+
This operation retrieves detailed information about a specified key share holder.
|
|
353
|
+
|
|
354
|
+
### Example
|
|
355
|
+
|
|
356
|
+
```javascript
|
|
357
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
358
|
+
// Initialize the API client
|
|
359
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
360
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
361
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
362
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
363
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
364
|
+
// Call the API
|
|
365
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
366
|
+
const vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
367
|
+
const tss_node_id = "coboBTGDvjJG99pABegvPYmavrcTU3SkjTLHVdsko8dWBga4w";
|
|
368
|
+
apiInstance.getKeyShareHolderByTssNodeId(vault_id, tss_node_id).then((data) => {
|
|
369
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
370
|
+
}, (error) => {
|
|
371
|
+
console.error(error);
|
|
372
|
+
});
|
|
373
|
+
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
### Parameters
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
Name | Type | Description | Notes
|
|
380
|
+
------------- | ------------- | ------------- | -------------
|
|
381
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). |
|
|
382
|
+
**tss_node_id** | **String**| The TSS Node ID. |
|
|
383
|
+
|
|
384
|
+
### Return type
|
|
385
|
+
|
|
386
|
+
[**KeyShareHolder**](KeyShareHolder.md)
|
|
387
|
+
|
|
388
|
+
### Authorization
|
|
389
|
+
|
|
390
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
337
391
|
|
|
338
392
|
### HTTP request headers
|
|
339
393
|
|
|
@@ -376,7 +430,7 @@ apiInstance.getKeyShareHolderGroupById(vault_id, key_share_holder_group_id).then
|
|
|
376
430
|
|
|
377
431
|
Name | Type | Description | Notes
|
|
378
432
|
------------- | ------------- | ------------- | -------------
|
|
379
|
-
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-
|
|
433
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). |
|
|
380
434
|
**key_share_holder_group_id** | **String**| The key share holder group ID. |
|
|
381
435
|
|
|
382
436
|
### Return type
|
|
@@ -385,7 +439,7 @@ Name | Type | Description | Notes
|
|
|
385
439
|
|
|
386
440
|
### Authorization
|
|
387
441
|
|
|
388
|
-
[
|
|
442
|
+
[OAuth2](../README.md#OAuth2)
|
|
389
443
|
|
|
390
444
|
### HTTP request headers
|
|
391
445
|
|
|
@@ -427,7 +481,7 @@ apiInstance.getMpcProjectById(project_id).then((data) => {
|
|
|
427
481
|
|
|
428
482
|
Name | Type | Description | Notes
|
|
429
483
|
------------- | ------------- | ------------- | -------------
|
|
430
|
-
**project_id** | **String**| The project ID, which you can retrieve by calling [List all projects](/v2/api-references/wallets--mpc-wallets/list-all-projects). |
|
|
484
|
+
**project_id** | **String**| The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects). |
|
|
431
485
|
|
|
432
486
|
### Return type
|
|
433
487
|
|
|
@@ -435,7 +489,7 @@ Name | Type | Description | Notes
|
|
|
435
489
|
|
|
436
490
|
### Authorization
|
|
437
491
|
|
|
438
|
-
[
|
|
492
|
+
[OAuth2](../README.md#OAuth2)
|
|
439
493
|
|
|
440
494
|
### HTTP request headers
|
|
441
495
|
|
|
@@ -449,7 +503,7 @@ Name | Type | Description | Notes
|
|
|
449
503
|
|
|
450
504
|
Get vault information
|
|
451
505
|
|
|
452
|
-
This operation retrieves detailed information about a vault. <Info>To learn what a vault is and how it relates to MPC Wallets, see [Get started with MPC Wallets](/v2/guides/mpc-wallets/get-started-ocw#technical-architecture).</Info>
|
|
506
|
+
This operation retrieves detailed information about a vault. <Info>To learn what a vault is and how it relates to MPC Wallets, see [Get started with MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/get-started-ocw#technical-architecture).</Info>
|
|
453
507
|
|
|
454
508
|
### Example
|
|
455
509
|
|
|
@@ -477,7 +531,7 @@ apiInstance.getMpcVaultById(vault_id).then((data) => {
|
|
|
477
531
|
|
|
478
532
|
Name | Type | Description | Notes
|
|
479
533
|
------------- | ------------- | ------------- | -------------
|
|
480
|
-
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-
|
|
534
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). |
|
|
481
535
|
|
|
482
536
|
### Return type
|
|
483
537
|
|
|
@@ -485,7 +539,7 @@ Name | Type | Description | Notes
|
|
|
485
539
|
|
|
486
540
|
### Authorization
|
|
487
541
|
|
|
488
|
-
[
|
|
542
|
+
[OAuth2](../README.md#OAuth2)
|
|
489
543
|
|
|
490
544
|
### HTTP request headers
|
|
491
545
|
|
|
@@ -528,8 +582,8 @@ apiInstance.getTssRequestById(vault_id, tss_request_id).then((data) => {
|
|
|
528
582
|
|
|
529
583
|
Name | Type | Description | Notes
|
|
530
584
|
------------- | ------------- | ------------- | -------------
|
|
531
|
-
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-
|
|
532
|
-
**tss_request_id** | **String**| The TSS request ID, which you can retrieve by calling [List TSS requests](/v2/api-references/wallets--mpc-wallets/list-tss-requests). |
|
|
585
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). |
|
|
586
|
+
**tss_request_id** | **String**| The TSS request ID, which you can retrieve by calling [List TSS requests](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-tss-requests). |
|
|
533
587
|
|
|
534
588
|
### Return type
|
|
535
589
|
|
|
@@ -537,7 +591,7 @@ Name | Type | Description | Notes
|
|
|
537
591
|
|
|
538
592
|
### Authorization
|
|
539
593
|
|
|
540
|
-
[OAuth2](../README.md#OAuth2)
|
|
594
|
+
[OAuth2](../README.md#OAuth2)
|
|
541
595
|
|
|
542
596
|
### HTTP request headers
|
|
543
597
|
|
|
@@ -631,11 +685,11 @@ apiInstance.listKeyShareHolderGroups(vault_id, opts).then((data) => {
|
|
|
631
685
|
|
|
632
686
|
Name | Type | Description | Notes
|
|
633
687
|
------------- | ------------- | ------------- | -------------
|
|
634
|
-
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-
|
|
688
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). |
|
|
635
689
|
**key_share_holder_group_type** | [**KeyShareHolderGroupType**](.md)| The key share holder group type. Possible values include: - `MainGroup`: The [Main Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#main-group). - `SigningGroup`: The [Signing Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#signing-group). - `RecoveryGroup`: The [Recovery Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#recovery-group). **Note**: If this parameter is left empty, all key share holder group types will be retrieved. | [optional]
|
|
636
690
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
637
|
-
**before** | **String**|
|
|
638
|
-
**after** | **String**|
|
|
691
|
+
**before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned. | [optional]
|
|
692
|
+
**after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
|
|
639
693
|
|
|
640
694
|
### Return type
|
|
641
695
|
|
|
@@ -643,6 +697,66 @@ Name | Type | Description | Notes
|
|
|
643
697
|
|
|
644
698
|
### Authorization
|
|
645
699
|
|
|
700
|
+
[OAuth2](../README.md#OAuth2)
|
|
701
|
+
|
|
702
|
+
### HTTP request headers
|
|
703
|
+
|
|
704
|
+
- **Content-Type**: Not defined
|
|
705
|
+
- **Accept**: application/json
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
## listKeyShareHolders
|
|
709
|
+
|
|
710
|
+
> ListKeyShareHolders200Response listKeyShareHolders(vault_id, opts)
|
|
711
|
+
|
|
712
|
+
List all key share holders
|
|
713
|
+
|
|
714
|
+
This operation retrieves a list of all key share holders under a specified vault. You can filter the result by key share holder group ID.
|
|
715
|
+
|
|
716
|
+
### Example
|
|
717
|
+
|
|
718
|
+
```javascript
|
|
719
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
720
|
+
// Initialize the API client
|
|
721
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
722
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
723
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
724
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
725
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
726
|
+
// Call the API
|
|
727
|
+
const apiInstance = new CoboWaas2.WalletsMPCWalletsApi();
|
|
728
|
+
const vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
729
|
+
const opts = {
|
|
730
|
+
'key_share_holder_group_ids': "dc0cac48-9add-4243-9c7a-b8badac8a198,5558bd1b-d221-4e2b-8c29-f6c97d9e6aca",
|
|
731
|
+
'limit': 10,
|
|
732
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
733
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
|
|
734
|
+
};
|
|
735
|
+
apiInstance.listKeyShareHolders(vault_id, opts).then((data) => {
|
|
736
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
737
|
+
}, (error) => {
|
|
738
|
+
console.error(error);
|
|
739
|
+
});
|
|
740
|
+
|
|
741
|
+
```
|
|
742
|
+
|
|
743
|
+
### Parameters
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
Name | Type | Description | Notes
|
|
747
|
+
------------- | ------------- | ------------- | -------------
|
|
748
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). |
|
|
749
|
+
**key_share_holder_group_ids** | **String**| A list of key share holder group IDs, separated by comma. You can retrieve the IDs of all the key share holder groups by calling [List all key share holder groups](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-key-share-holder-groups). | [optional]
|
|
750
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
751
|
+
**before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned. | [optional]
|
|
752
|
+
**after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
|
|
753
|
+
|
|
754
|
+
### Return type
|
|
755
|
+
|
|
756
|
+
[**ListKeyShareHolders200Response**](ListKeyShareHolders200Response.md)
|
|
757
|
+
|
|
758
|
+
### Authorization
|
|
759
|
+
|
|
646
760
|
[CoboAuth](../README.md#CoboAuth)
|
|
647
761
|
|
|
648
762
|
### HTTP request headers
|
|
@@ -690,8 +804,8 @@ apiInstance.listMpcProjects(opts).then((data) => {
|
|
|
690
804
|
Name | Type | Description | Notes
|
|
691
805
|
------------- | ------------- | ------------- | -------------
|
|
692
806
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
693
|
-
**before** | **String**|
|
|
694
|
-
**after** | **String**|
|
|
807
|
+
**before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned. | [optional]
|
|
808
|
+
**after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
|
|
695
809
|
|
|
696
810
|
### Return type
|
|
697
811
|
|
|
@@ -699,7 +813,7 @@ Name | Type | Description | Notes
|
|
|
699
813
|
|
|
700
814
|
### Authorization
|
|
701
815
|
|
|
702
|
-
[
|
|
816
|
+
[OAuth2](../README.md#OAuth2)
|
|
703
817
|
|
|
704
818
|
### HTTP request headers
|
|
705
819
|
|
|
@@ -713,7 +827,7 @@ Name | Type | Description | Notes
|
|
|
713
827
|
|
|
714
828
|
List all vaults
|
|
715
829
|
|
|
716
|
-
This operation retrieves a list of all vaults. You can filter the result by project ID. **Notes for query parameters**: 1. `project_id` is required when `vault_type` is set to `User-Controlled`. 2. `project_id` must be left blank when `vault_type` is set to `Org-Controlled`. <Info>To learn what a vault is and how it relates to MPC Wallets, see [Get started with MPC Wallets](/v2/guides/mpc-wallets/get-started-ocw#technical-architecture).</Info>
|
|
830
|
+
This operation retrieves a list of all vaults. You can filter the result by project ID. **Notes for query parameters**: 1. `project_id` is required when `vault_type` is set to `User-Controlled`. 2. `project_id` must be left blank when `vault_type` is set to `Org-Controlled`. <Info>To learn what a vault is and how it relates to MPC Wallets, see [Get started with MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/get-started-ocw#technical-architecture).</Info>
|
|
717
831
|
|
|
718
832
|
### Example
|
|
719
833
|
|
|
@@ -748,10 +862,10 @@ apiInstance.listMpcVaults(vault_type, opts).then((data) => {
|
|
|
748
862
|
Name | Type | Description | Notes
|
|
749
863
|
------------- | ------------- | ------------- | -------------
|
|
750
864
|
**vault_type** | [**MPCVaultType**](.md)| The vault type. Possible values include: - `Org-Controlled`: This vault is a collection of [Organization-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#organization-controlled-wallets). - `User-Controlled`: This vault is a collection of [User-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#user-controlled-wallets). |
|
|
751
|
-
**project_id** | **String**| The project ID, which you can retrieve by calling [List all projects](/v2/api-references/wallets--mpc-wallets/list-all-projects). | [optional]
|
|
865
|
+
**project_id** | **String**| The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects). | [optional]
|
|
752
866
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
753
|
-
**before** | **String**|
|
|
754
|
-
**after** | **String**|
|
|
867
|
+
**before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned. | [optional]
|
|
868
|
+
**after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
|
|
755
869
|
|
|
756
870
|
### Return type
|
|
757
871
|
|
|
@@ -759,7 +873,7 @@ Name | Type | Description | Notes
|
|
|
759
873
|
|
|
760
874
|
### Authorization
|
|
761
875
|
|
|
762
|
-
[
|
|
876
|
+
[OAuth2](../README.md#OAuth2)
|
|
763
877
|
|
|
764
878
|
### HTTP request headers
|
|
765
879
|
|
|
@@ -807,11 +921,11 @@ apiInstance.listTssRequests(vault_id, key_share_holder_group_id, opts).then((dat
|
|
|
807
921
|
|
|
808
922
|
Name | Type | Description | Notes
|
|
809
923
|
------------- | ------------- | ------------- | -------------
|
|
810
|
-
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-
|
|
811
|
-
**key_share_holder_group_id** | **String**| The key share holder group ID of the TSS request, which you can retrieve by calling [List all key share holder groups](/v2/api-references/wallets--mpc-wallets/list-all-key-share-holder-groups). |
|
|
924
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). |
|
|
925
|
+
**key_share_holder_group_id** | **String**| The key share holder group ID of the TSS request, which you can retrieve by calling [List all key share holder groups](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-key-share-holder-groups). |
|
|
812
926
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
813
|
-
**before** | **String**|
|
|
814
|
-
**after** | **String**|
|
|
927
|
+
**before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned. | [optional]
|
|
928
|
+
**after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
|
|
815
929
|
|
|
816
930
|
### Return type
|
|
817
931
|
|
|
@@ -819,7 +933,7 @@ Name | Type | Description | Notes
|
|
|
819
933
|
|
|
820
934
|
### Authorization
|
|
821
935
|
|
|
822
|
-
[
|
|
936
|
+
[OAuth2](../README.md#OAuth2)
|
|
823
937
|
|
|
824
938
|
### HTTP request headers
|
|
825
939
|
|
|
@@ -865,7 +979,7 @@ apiInstance.updateKeyShareHolderGroupById(vault_id, key_share_holder_group_id, o
|
|
|
865
979
|
|
|
866
980
|
Name | Type | Description | Notes
|
|
867
981
|
------------- | ------------- | ------------- | -------------
|
|
868
|
-
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-
|
|
982
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). |
|
|
869
983
|
**key_share_holder_group_id** | **String**| The key share holder group ID. |
|
|
870
984
|
**UpdateKeyShareHolderGroupByIdRequest** | [**UpdateKeyShareHolderGroupByIdRequest**](UpdateKeyShareHolderGroupByIdRequest.md)| | [optional]
|
|
871
985
|
|
|
@@ -875,7 +989,7 @@ Name | Type | Description | Notes
|
|
|
875
989
|
|
|
876
990
|
### Authorization
|
|
877
991
|
|
|
878
|
-
[OAuth2](../README.md#OAuth2)
|
|
992
|
+
[OAuth2](../README.md#OAuth2)
|
|
879
993
|
|
|
880
994
|
### HTTP request headers
|
|
881
995
|
|
|
@@ -920,7 +1034,7 @@ apiInstance.updateMpcProjectById(project_id, opts).then((data) => {
|
|
|
920
1034
|
|
|
921
1035
|
Name | Type | Description | Notes
|
|
922
1036
|
------------- | ------------- | ------------- | -------------
|
|
923
|
-
**project_id** | **String**| The project ID, which you can retrieve by calling [List all projects](/v2/api-references/wallets--mpc-wallets/list-all-projects). |
|
|
1037
|
+
**project_id** | **String**| The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects). |
|
|
924
1038
|
**UpdateMpcProjectByIdRequest** | [**UpdateMpcProjectByIdRequest**](UpdateMpcProjectByIdRequest.md)| The request body to update a project's name. | [optional]
|
|
925
1039
|
|
|
926
1040
|
### Return type
|
|
@@ -929,7 +1043,7 @@ Name | Type | Description | Notes
|
|
|
929
1043
|
|
|
930
1044
|
### Authorization
|
|
931
1045
|
|
|
932
|
-
[OAuth2](../README.md#OAuth2)
|
|
1046
|
+
[OAuth2](../README.md#OAuth2)
|
|
933
1047
|
|
|
934
1048
|
### HTTP request headers
|
|
935
1049
|
|
|
@@ -943,7 +1057,7 @@ Name | Type | Description | Notes
|
|
|
943
1057
|
|
|
944
1058
|
Update vault name
|
|
945
1059
|
|
|
946
|
-
This operation updates a vault's name. <Info>To learn what a vault is and how it relates to MPC Wallets, see [Get started with MPC Wallets](/v2/guides/mpc-wallets/get-started-ocw#technical-architecture).</Info>
|
|
1060
|
+
This operation updates a vault's name. <Info>To learn what a vault is and how it relates to MPC Wallets, see [Get started with MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/get-started-ocw#technical-architecture).</Info>
|
|
947
1061
|
|
|
948
1062
|
### Example
|
|
949
1063
|
|
|
@@ -974,7 +1088,7 @@ apiInstance.updateMpcVaultById(vault_id, opts).then((data) => {
|
|
|
974
1088
|
|
|
975
1089
|
Name | Type | Description | Notes
|
|
976
1090
|
------------- | ------------- | ------------- | -------------
|
|
977
|
-
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-
|
|
1091
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). |
|
|
978
1092
|
**UpdateMpcVaultByIdRequest** | [**UpdateMpcVaultByIdRequest**](UpdateMpcVaultByIdRequest.md)| The request body to update a vault's name. | [optional]
|
|
979
1093
|
|
|
980
1094
|
### Return type
|
|
@@ -983,7 +1097,7 @@ Name | Type | Description | Notes
|
|
|
983
1097
|
|
|
984
1098
|
### Authorization
|
|
985
1099
|
|
|
986
|
-
[OAuth2](../README.md#OAuth2)
|
|
1100
|
+
[OAuth2](../README.md#OAuth2)
|
|
987
1101
|
|
|
988
1102
|
### HTTP request headers
|
|
989
1103
|
|
package/docs/WebhookEventData.md
CHANGED
|
@@ -4,17 +4,17 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. |
|
|
8
8
|
**transaction_id** | **String** | The transaction ID. |
|
|
9
9
|
**cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
|
|
10
10
|
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
11
11
|
**wallet_id** | **String** | For deposit transactions, this property represents the wallet ID of the transaction destination. For transactions of other types, this property represents the wallet ID of the transaction source. |
|
|
12
|
-
**type** | [**
|
|
12
|
+
**type** | [**MPCVaultType**](MPCVaultType.md) | | [optional]
|
|
13
13
|
**status** | [**TSSRequestStatus**](TSSRequestStatus.md) | |
|
|
14
14
|
**sub_status** | [**TransactionSubStatus**](TransactionSubStatus.md) | | [optional]
|
|
15
15
|
**failed_reason** | **String** | (This property is applicable to approval failures and signature failures only) The reason why the transaction failed. | [optional]
|
|
16
|
-
**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
17
|
-
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
16
|
+
**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
17
|
+
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
18
18
|
**asset_id** | **String** | (This concept applies to Exchange Wallets only) The asset ID. An asset ID is the unique identifier of the asset held within your linked exchange account. | [optional]
|
|
19
19
|
**source** | [**TransactionSource**](TransactionSource.md) | |
|
|
20
20
|
**destination** | [**TransactionDestination**](TransactionDestination.md) | |
|
|
@@ -31,11 +31,17 @@ Name | Type | Description | Notes
|
|
|
31
31
|
**category** | **[String]** | A custom transaction category for you to identify your transfers more easily. | [optional]
|
|
32
32
|
**description** | **String** | The description of the TSS request. | [optional]
|
|
33
33
|
**is_loop** | **Boolean** | Whether the transaction was executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - `true`: The transaction was executed as a Cobo Loop transfer. - `false`: The transaction was not executed as a Cobo Loop transfer. | [optional]
|
|
34
|
-
**created_timestamp** | **Number** | The
|
|
34
|
+
**created_timestamp** | **Number** | The vault's creation time in Unix timestamp format, measured in milliseconds. | [optional]
|
|
35
35
|
**updated_timestamp** | **Number** | The time when the transaction was updated, in Unix timestamp format, measured in milliseconds. | [optional]
|
|
36
36
|
**tss_request_id** | **String** | The TSS request ID. | [optional]
|
|
37
37
|
**source_key_share_holder_group** | [**SourceGroup**](SourceGroup.md) | | [optional]
|
|
38
38
|
**target_key_share_holder_group_id** | **String** | The target key share holder group ID. | [optional]
|
|
39
|
+
**addresses** | [**[AddressInfo]**](AddressInfo.md) | A list of addresses. | [optional]
|
|
40
|
+
**wallet** | [**WalletInfo**](WalletInfo.md) | | [optional]
|
|
41
|
+
**vault_id** | **String** | The vault ID. | [optional]
|
|
42
|
+
**project_id** | **String** | The project ID. | [optional]
|
|
43
|
+
**name** | **String** | The vault name. | [optional]
|
|
44
|
+
**root_pubkeys** | [**[RootPubkey]**](RootPubkey.md) | | [optional]
|
|
39
45
|
|
|
40
46
|
|
|
41
47
|
|
|
@@ -46,6 +52,12 @@ Name | Type | Description | Notes
|
|
|
46
52
|
|
|
47
53
|
* `TSSRequest` (value: `"TSSRequest"`)
|
|
48
54
|
|
|
55
|
+
* `Addresses` (value: `"Addresses"`)
|
|
56
|
+
|
|
57
|
+
* `WalletInfo` (value: `"WalletInfo"`)
|
|
58
|
+
|
|
59
|
+
* `MPCVault` (value: `"MPCVault"`)
|
|
60
|
+
|
|
49
61
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
50
62
|
|
|
51
63
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. |
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
|
|
@@ -15,6 +15,12 @@ Name | Type | Description | Notes
|
|
|
15
15
|
|
|
16
16
|
* `TSSRequest` (value: `"TSSRequest"`)
|
|
17
17
|
|
|
18
|
+
* `Addresses` (value: `"Addresses"`)
|
|
19
|
+
|
|
20
|
+
* `WalletInfo` (value: `"WalletInfo"`)
|
|
21
|
+
|
|
22
|
+
* `MPCVault` (value: `"MPCVault"`)
|
|
23
|
+
|
|
18
24
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
19
25
|
|
|
20
26
|
|
package/docs/WebhookEventType.md
CHANGED
|
@@ -3,21 +3,27 @@
|
|
|
3
3
|
## Enum
|
|
4
4
|
|
|
5
5
|
|
|
6
|
-
* `transaction.created` (value: `"wallets.transaction.created"`)
|
|
6
|
+
* `wallets.transaction.created` (value: `"wallets.transaction.created"`)
|
|
7
7
|
|
|
8
|
-
* `transaction.updated` (value: `"wallets.transaction.updated"`)
|
|
8
|
+
* `wallets.transaction.updated` (value: `"wallets.transaction.updated"`)
|
|
9
9
|
|
|
10
|
-
* `transaction.failed` (value: `"wallets.transaction.failed"`)
|
|
10
|
+
* `wallets.transaction.failed` (value: `"wallets.transaction.failed"`)
|
|
11
11
|
|
|
12
|
-
* `transaction.succeeded` (value: `"wallets.transaction.succeeded"`)
|
|
12
|
+
* `wallets.transaction.succeeded` (value: `"wallets.transaction.succeeded"`)
|
|
13
13
|
|
|
14
|
-
* `mpc.tss_request.created` (value: `"wallets.mpc.tss_request.created"`)
|
|
14
|
+
* `wallets.mpc.tss_request.created` (value: `"wallets.mpc.tss_request.created"`)
|
|
15
15
|
|
|
16
|
-
* `mpc.tss_request.updated` (value: `"wallets.mpc.tss_request.updated"`)
|
|
16
|
+
* `wallets.mpc.tss_request.updated` (value: `"wallets.mpc.tss_request.updated"`)
|
|
17
17
|
|
|
18
|
-
* `mpc.tss_request.failed` (value: `"wallets.mpc.tss_request.failed"`)
|
|
18
|
+
* `wallets.mpc.tss_request.failed` (value: `"wallets.mpc.tss_request.failed"`)
|
|
19
19
|
|
|
20
|
-
* `mpc.tss_request.succeeded` (value: `"wallets.mpc.tss_request.succeeded"`)
|
|
20
|
+
* `wallets.mpc.tss_request.succeeded` (value: `"wallets.mpc.tss_request.succeeded"`)
|
|
21
|
+
|
|
22
|
+
* `wallets.addresses.created` (value: `"wallets.addresses.created"`)
|
|
23
|
+
|
|
24
|
+
* `wallets.created` (value: `"wallets.created"`)
|
|
25
|
+
|
|
26
|
+
* `mpc_vaults.created` (value: `"mpc_vaults.created"`)
|
|
21
27
|
|
|
22
28
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
23
29
|
|