@cobo/cobo-waas2 1.7.0 → 1.8.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 +48 -3
- package/dist/ApiClient.js +1 -1
- package/dist/api/AddressBooksApi.js +6 -6
- package/dist/api/DevelopersApi.js +110 -0
- package/dist/api/DevelopersWebhooksApi.js +30 -30
- package/dist/api/OAuthApi.js +2 -2
- package/dist/api/StakingsApi.js +33 -30
- package/dist/api/TransactionsApi.js +73 -28
- package/dist/api/TravelRuleApi.js +216 -0
- package/dist/api/WalletsApi.js +68 -68
- package/dist/api/WalletsExchangeWalletApi.js +12 -12
- package/dist/api/WalletsMPCWalletsApi.js +60 -60
- package/dist/index.js +273 -0
- package/dist/model/Activity.js +29 -0
- package/dist/model/ActivityAction.js +30 -0
- package/dist/model/ActivityExtra.js +274 -0
- package/dist/model/AddressInfo.js +15 -2
- package/dist/model/AddressTransferDestination.js +1 -1
- package/dist/model/AddressesEventData.js +190 -0
- package/dist/model/ApiLogDetails.js +2 -2
- package/dist/model/BabylonStakeExtra.js +1 -1
- package/dist/model/BabylonStakingActivityDetailExtra.js +165 -0
- 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/ContractCallParams.js +2 -2
- package/dist/model/CoreStakingActivityDetailExtra.js +164 -0
- package/dist/model/CreateAddressRequest.js +2 -2
- 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/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/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/ListCallbackMessages200Response.js +145 -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/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/RawMessageSignDestination.js +1 -1
- package/dist/model/RetryCallbackMessage201Response.js +83 -0
- 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/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/TSSRequestWebhookEventData.js +18 -3
- package/dist/model/TokenBalance.js +2 -2
- package/dist/model/TokenBalanceBalance.js +6 -6
- 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 +1 -1
- package/dist/model/TransactionDepositToWalletDestination.js +1 -1
- 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 +4 -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/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/TransferParams.js +2 -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/AddressBooksApi.md +3 -3
- package/docs/AddressInfo.md +2 -1
- package/docs/AddressesEventData.md +29 -0
- package/docs/ApiLogDetails.md +1 -1
- package/docs/BabylonStakeExtra.md +1 -1
- package/docs/BabylonStakingActivityDetailExtra.md +14 -0
- package/docs/BroadcastSignedTransactionsRequest.md +1 -1
- package/docs/CallbackMessage.md +46 -0
- package/docs/ChainInfo.md +1 -1
- package/docs/ContractCallParams.md +1 -1
- package/docs/CoreStakingActivityDetailExtra.md +13 -0
- package/docs/CreateAddressRequest.md +1 -1
- 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/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/DestinationWalletType.md +12 -0
- package/docs/DevelopersApi.md +118 -0
- package/docs/DevelopersWebhooksApi.md +15 -15
- 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/ListCallbackMessages200Response.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/MessageSignParams.md +1 -1
- package/docs/OAuthApi.md +1 -1
- package/docs/OrgInfo.md +11 -0
- package/docs/Pagination.md +2 -2
- package/docs/RetryCallbackMessage201Response.md +9 -0
- 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 +18 -16
- 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/TSSRequestWebhookEventData.md +7 -1
- package/docs/TokenBalance.md +1 -1
- package/docs/TokenBalanceBalance.md +4 -4
- 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/TransactionDetail.md +2 -2
- package/docs/TransactionDetails.md +2 -2
- package/docs/TransactionRawTxInfo.md +1 -1
- package/docs/TransactionRoleApprovalDetail.md +13 -0
- package/docs/TransactionSelectedUtxo.md +12 -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 +65 -14
- package/docs/TransferParams.md +1 -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 +34 -34
- package/docs/WalletsExchangeWalletApi.md +6 -6
- package/docs/WalletsMPCWalletsApi.md +30 -30
- package/docs/WebhookEventData.md +17 -5
- package/docs/WebhookEventDataType.md +7 -1
- package/docs/WebhookEventType.md +14 -8
- package/package.json +2 -2
|
@@ -103,7 +103,7 @@ apiInstance.getWebhookEndpointById(endpoint_id).then((data) => {
|
|
|
103
103
|
|
|
104
104
|
Name | Type | Description | Notes
|
|
105
105
|
------------- | ------------- | ------------- | -------------
|
|
106
|
-
**endpoint_id** | **String**| The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling [List webhook endpoints](/v2/api-references/developers--webhooks/list-webhook-endpoints). |
|
|
106
|
+
**endpoint_id** | **String**| The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling [List webhook endpoints](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-webhook-endpoints). |
|
|
107
107
|
|
|
108
108
|
### Return type
|
|
109
109
|
|
|
@@ -154,8 +154,8 @@ apiInstance.getWebhookEventById(event_id, endpoint_id).then((data) => {
|
|
|
154
154
|
|
|
155
155
|
Name | Type | Description | Notes
|
|
156
156
|
------------- | ------------- | ------------- | -------------
|
|
157
|
-
**event_id** | **String**| The event ID. You can obtain a list of event IDs by calling [List all events](/v2/api-references/developers--webhooks/list-all-events). |
|
|
158
|
-
**endpoint_id** | **String**| The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling [List webhook endpoints](/v2/api-references/developers--webhooks/list-webhook-endpoints). |
|
|
157
|
+
**event_id** | **String**| The event ID. You can obtain a list of event IDs by calling [List all events](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-all-events). |
|
|
158
|
+
**endpoint_id** | **String**| The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling [List webhook endpoints](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-webhook-endpoints). |
|
|
159
159
|
|
|
160
160
|
### Return type
|
|
161
161
|
|
|
@@ -214,8 +214,8 @@ Name | Type | Description | Notes
|
|
|
214
214
|
**status** | [**WebhookEndpointStatus**](.md)| | [optional]
|
|
215
215
|
**event_type** | [**WebhookEventType**](.md)| | [optional]
|
|
216
216
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
217
|
-
**before** | **String**|
|
|
218
|
-
**after** | **String**|
|
|
217
|
+
**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]
|
|
218
|
+
**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]
|
|
219
219
|
|
|
220
220
|
### Return type
|
|
221
221
|
|
|
@@ -317,11 +317,11 @@ apiInstance.listWebhookEventLogs(event_id, endpoint_id, opts).then((data) => {
|
|
|
317
317
|
|
|
318
318
|
Name | Type | Description | Notes
|
|
319
319
|
------------- | ------------- | ------------- | -------------
|
|
320
|
-
**event_id** | **String**| The event ID. You can obtain a list of event IDs by calling [List all events](/v2/api-references/developers--webhooks/list-all-events). |
|
|
321
|
-
**endpoint_id** | **String**| The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling [List webhook endpoints](/v2/api-references/developers--webhooks/list-webhook-endpoints). |
|
|
320
|
+
**event_id** | **String**| The event ID. You can obtain a list of event IDs by calling [List all events](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-all-events). |
|
|
321
|
+
**endpoint_id** | **String**| The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling [List webhook endpoints](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-webhook-endpoints). |
|
|
322
322
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
323
|
-
**before** | **String**|
|
|
324
|
-
**after** | **String**|
|
|
323
|
+
**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]
|
|
324
|
+
**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]
|
|
325
325
|
|
|
326
326
|
### Return type
|
|
327
327
|
|
|
@@ -378,12 +378,12 @@ apiInstance.listWebhookEvents(endpoint_id, opts).then((data) => {
|
|
|
378
378
|
|
|
379
379
|
Name | Type | Description | Notes
|
|
380
380
|
------------- | ------------- | ------------- | -------------
|
|
381
|
-
**endpoint_id** | **String**| The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling [List webhook endpoints](/v2/api-references/developers--webhooks/list-webhook-endpoints). |
|
|
381
|
+
**endpoint_id** | **String**| The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling [List webhook endpoints](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-webhook-endpoints). |
|
|
382
382
|
**status** | [**WebhookEventStatus**](.md)| | [optional]
|
|
383
383
|
**type** | [**WebhookEventType**](.md)| | [optional]
|
|
384
384
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
385
|
-
**before** | **String**|
|
|
386
|
-
**after** | **String**|
|
|
385
|
+
**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]
|
|
386
|
+
**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]
|
|
387
387
|
|
|
388
388
|
### Return type
|
|
389
389
|
|
|
@@ -434,8 +434,8 @@ apiInstance.retryWebhookEventById(event_id, endpoint_id).then((data) => {
|
|
|
434
434
|
|
|
435
435
|
Name | Type | Description | Notes
|
|
436
436
|
------------- | ------------- | ------------- | -------------
|
|
437
|
-
**event_id** | **String**| The event ID. You can obtain a list of event IDs by calling [List all events](/v2/api-references/developers--webhooks/list-all-events). |
|
|
438
|
-
**endpoint_id** | **String**| The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling [List webhook endpoints](/v2/api-references/developers--webhooks/list-webhook-endpoints). |
|
|
437
|
+
**event_id** | **String**| The event ID. You can obtain a list of event IDs by calling [List all events](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-all-events). |
|
|
438
|
+
**endpoint_id** | **String**| The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling [List webhook endpoints](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-webhook-endpoints). |
|
|
439
439
|
|
|
440
440
|
### Return type
|
|
441
441
|
|
|
@@ -540,7 +540,7 @@ apiInstance.updateWebhookEndpointById(endpoint_id, opts).then((data) => {
|
|
|
540
540
|
|
|
541
541
|
Name | Type | Description | Notes
|
|
542
542
|
------------- | ------------- | ------------- | -------------
|
|
543
|
-
**endpoint_id** | **String**| The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling [List webhook endpoints](/v2/api-references/developers--webhooks/list-webhook-endpoints). |
|
|
543
|
+
**endpoint_id** | **String**| The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling [List webhook endpoints](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-webhook-endpoints). |
|
|
544
544
|
**UpdateWebhookEndpointByIdRequest** | [**UpdateWebhookEndpointByIdRequest**](UpdateWebhookEndpointByIdRequest.md)| The request body to update a webhook endpoint. | [optional]
|
|
545
545
|
|
|
546
546
|
### Return type
|
package/docs/ErrorResponse.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**error_code** | **Number** | The error code. Refer to [Error codes and status codes](/v2/api-references/error-codes) for more details. |
|
|
7
|
+
**error_code** | **Number** | The error code. Refer to [Error codes and status codes](https://www.cobo.com/developers/v2/api-references/error-codes) for more details. |
|
|
8
8
|
**error_message** | **String** | The error description. |
|
|
9
9
|
**error_id** | **String** | The error log ID. You can provide the error ID when submitting a ticket to help Cobo to locate the issue. |
|
|
10
10
|
|
package/docs/EstimateClaimFee.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**activity_type** | [**ActivityType**](ActivityType.md) | |
|
|
8
|
-
**staking_id** | **String** | The ID of the staking position. You can retrieve a list of staking positions by calling [List staking positions](/v2/api-references/stakings/list-staking-positions). | [optional]
|
|
8
|
+
**staking_id** | **String** | The ID of the staking position. You can retrieve a list of staking positions by calling [List staking positions](https://www.cobo.com/developers/v2/api-references/stakings/list-staking-positions). | [optional]
|
|
9
9
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
|
|
10
10
|
|
|
11
11
|
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**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. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. | [optional]
|
|
8
8
|
**request_type** | [**EstimateFeeRequestType**](EstimateFeeRequestType.md) | |
|
|
9
|
-
**chain_id** | **String** | The chain ID of the chain on which the smart contract is deployed. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). |
|
|
9
|
+
**chain_id** | **String** | The chain ID of the chain on which the smart contract is deployed. 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). |
|
|
10
10
|
**source** | [**ContractCallSource**](ContractCallSource.md) | |
|
|
11
11
|
**destination** | [**ContractCallDestination**](ContractCallDestination.md) | |
|
|
12
12
|
**fee_type** | [**FeeType**](FeeType.md) | | [optional]
|
|
@@ -7,9 +7,9 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**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. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. | [optional]
|
|
8
8
|
**request_type** | [**EstimateFeeRequestType**](EstimateFeeRequestType.md) | |
|
|
9
9
|
**source** | [**ContractCallSource**](ContractCallSource.md) | |
|
|
10
|
-
**token_id** | **String** | The token ID of the transferred 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). |
|
|
10
|
+
**token_id** | **String** | The token ID of the transferred 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). |
|
|
11
11
|
**destination** | [**ContractCallDestination**](ContractCallDestination.md) | |
|
|
12
12
|
**fee_type** | [**FeeType**](FeeType.md) | | [optional]
|
|
13
|
-
**chain_id** | **String** | The chain ID of the chain on which the smart contract is deployed. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). |
|
|
13
|
+
**chain_id** | **String** | The chain ID of the chain on which the smart contract is deployed. 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). |
|
|
14
14
|
|
|
15
15
|
|
package/docs/EstimateStakeFee.md
CHANGED
|
@@ -10,6 +10,6 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**pool_id** | [**StakingPoolId**](StakingPoolId.md) | |
|
|
11
11
|
**amount** | **String** | The amount to stake. |
|
|
12
12
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
|
|
13
|
-
**extra** | [**CreateStakeActivityExtra**](CreateStakeActivityExtra.md) | |
|
|
13
|
+
**extra** | [**CreateStakeActivityExtra**](CreateStakeActivityExtra.md) | | [optional]
|
|
14
14
|
|
|
15
15
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**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. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. | [optional]
|
|
8
8
|
**request_type** | [**EstimateFeeRequestType**](EstimateFeeRequestType.md) | |
|
|
9
9
|
**source** | [**TransferSource**](TransferSource.md) | |
|
|
10
|
-
**token_id** | **String** | The token ID of the transferred 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). |
|
|
10
|
+
**token_id** | **String** | The token ID of the transferred 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). |
|
|
11
11
|
**destination** | [**TransferDestination**](TransferDestination.md) | | [optional]
|
|
12
12
|
**fee_type** | [**FeeType**](FeeType.md) | | [optional]
|
|
13
13
|
|
|
@@ -7,5 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**pool_type** | [**StakingPoolType**](StakingPoolType.md) | | [optional]
|
|
8
8
|
**fee** | [**EstimatedFee**](EstimatedFee.md) | | [optional]
|
|
9
9
|
**validator_pubkeys** | **[String]** | A list of public keys associated with the Ethereum validators for this staking operation. | [optional]
|
|
10
|
+
**core_btc_staking_address** | **String** | P2WSH address generated for this staking operation(If the estimated fee is for core BTC staking). | [optional]
|
|
10
11
|
|
|
11
12
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.EthStakingActivityDetailExtra
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**pool_type** | [**StakingPoolType**](StakingPoolType.md) | |
|
|
8
|
+
**provider_name** | **String** | The name of the provider. | [optional]
|
|
9
|
+
**validator_pubkeys** | **[String]** | A list of public keys identifying the validators to unstake from the Ethereum Beacon Chain. | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**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). |
|
|
7
|
+
**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). |
|
|
8
8
|
**chain_id** | **String** | The ID of the chain on which the token operates. |
|
|
9
9
|
**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]
|
|
10
10
|
**symbol** | **String** | The token symbol, which is the abbreviated name of a token. | [optional]
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**pool_type** | [**StakingPoolType**](StakingPoolType.md) | | [optional]
|
|
8
8
|
**fee** | [**EstimatedFee**](EstimatedFee.md) | | [optional]
|
|
9
9
|
**validator_pubkeys** | **[String]** | A list of public keys associated with the Ethereum validators for this staking operation. | [optional]
|
|
10
|
+
**core_btc_staking_address** | **String** | P2WSH address generated for this staking operation(If the estimated fee is for core BTC staking). | [optional]
|
|
10
11
|
**fee_type** | [**FeeType**](FeeType.md) | | [optional]
|
|
11
12
|
**fee_amount** | **String** | The amount of the estimated fee. | [optional]
|
|
12
13
|
**token_id** | **String** | The token ID of the staking fee. | [optional]
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**pool_id** | [**StakingPoolId**](StakingPoolId.md) | |
|
|
11
11
|
**amount** | **String** | The amount to withdraw. |
|
|
12
12
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
|
|
13
|
-
**extra** | [**CreateUnstakeActivityExtra**](CreateUnstakeActivityExtra.md) | |
|
|
14
|
-
**staking_id** | **String** | The ID of the staking position. You can retrieve a list of staking positions by calling [List staking positions](/v2/api-references/stakings/list-staking-positions). |
|
|
13
|
+
**extra** | [**CreateUnstakeActivityExtra**](CreateUnstakeActivityExtra.md) | | [optional]
|
|
14
|
+
**staking_id** | **String** | The ID of the staking position. You can retrieve a list of staking positions by calling [List staking positions](https://www.cobo.com/developers/v2/api-references/stakings/list-staking-positions). |
|
|
15
15
|
|
|
16
16
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.GetTransactionLimitation200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**vasp_list** | [**[Vasp]**](Vasp.md) | A list of VASPs (Virtual Asset Service Providers) associated with the token. | [optional]
|
|
8
|
+
**is_threshold_reached** | **Boolean** | Indicates whether the transaction amount exceeds a predefined threshold. - **If `true`**: Additional information is required when filling Travel Rule details: - For deposits: `date_of_incorporation` and `place_of_incorporation`. - **If `false`**: No extra fields are required. | [optional]
|
|
9
|
+
**self_custody_wallet_challenge** | **String** | A human-readable, time-sensitive message to be signed by the wallet owner. The message contains key details including the wallet address, a unique nonce, and a timestamp. Signing this message confirms ownership of the wallet and allows the operation to proceed. | [optional]
|
|
10
|
+
**connect_wallet_list** | **[String]** | A list of wallets connected to the system for transactions. | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.ListCallbackMessages200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**data** | [**[CallbackMessage]**](CallbackMessage.md) | |
|
|
8
|
+
**pagination** | [**Pagination**](Pagination.md) | |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.ListSupportedCountries200ResponseInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**en** | **String** | The English name of the country. |
|
|
8
|
+
**zh_hans** | **String** | The simplified Chinese name of the country. |
|
|
9
|
+
**code2** | **String** | The 2-letter country code (ISO 3166-1 alpha-2). |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**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). |
|
|
7
|
+
**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). |
|
|
8
8
|
**tx_hash** | **String** | The transaction hash. |
|
|
9
9
|
**vout_n** | **Number** | The output index of the UTXO. |
|
|
10
10
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# CoboWaas2.MPCVaultEventData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
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
|
+
**vault_id** | **String** | The vault ID. | [optional]
|
|
9
|
+
**project_id** | **String** | The project ID. | [optional]
|
|
10
|
+
**name** | **String** | The vault name. | [optional]
|
|
11
|
+
**type** | [**MPCVaultType**](MPCVaultType.md) | | [optional]
|
|
12
|
+
**root_pubkeys** | [**[RootPubkey]**](RootPubkey.md) | | [optional]
|
|
13
|
+
**created_timestamp** | **Number** | The vault's creation time in Unix timestamp format, measured in milliseconds. | [optional]
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## Enum: DataTypeEnum
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
* `Transaction` (value: `"Transaction"`)
|
|
21
|
+
|
|
22
|
+
* `TSSRequest` (value: `"TSSRequest"`)
|
|
23
|
+
|
|
24
|
+
* `Addresses` (value: `"Addresses"`)
|
|
25
|
+
|
|
26
|
+
* `WalletInfo` (value: `"WalletInfo"`)
|
|
27
|
+
|
|
28
|
+
* `MPCVault` (value: `"MPCVault"`)
|
|
29
|
+
|
|
30
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**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]
|
|
7
|
+
**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]
|
|
8
8
|
**max_transferable_value** | **String** | The maximum amount you can transfer from the wallet or the specified wallet address. | [optional]
|
|
9
9
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
|
|
10
10
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**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. |
|
|
8
|
-
**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). |
|
|
8
|
+
**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). |
|
|
9
9
|
**source** | [**MessageSignSource**](MessageSignSource.md) | |
|
|
10
10
|
**destination** | [**MessageSignDestination**](MessageSignDestination.md) | |
|
|
11
11
|
**description** | **String** | The description of the message signing transaction. | [optional]
|
package/docs/OAuthApi.md
CHANGED
|
@@ -15,7 +15,7 @@ Method | HTTP request | Description
|
|
|
15
15
|
|
|
16
16
|
Get Org Access Token
|
|
17
17
|
|
|
18
|
-
<Note>This operation is only applicable to Cobo Portal App developers. To call this operation, you need to use the Cobo OAuth authentication method that requires an app key.</Note> This operation allows Cobo Portal Apps to get an Org Access Token and a Refresh Token with a specified client ID, organization ID, and grant type. Access tokens allow the app to signal to the WaaS service that it has received permission to access specific resources of the app user's [organization](https://manuals.cobo.com/en/portal/organization/introduction). Once the app has been granted permission by the organization's admin, it can use this operation to obtain both an Org Access Token and a Refresh Token. For security purposes, Org Access Tokens expire after a certain period. Once they expire, the app needs to call [Refresh token](/v2/api-references/oauth/refresh-org-access-token) to get a new Org Access Token and a new Refresh Token.
|
|
18
|
+
<Note>This operation is only applicable to Cobo Portal App developers. To call this operation, you need to use the Cobo OAuth authentication method that requires an app key.</Note> This operation allows Cobo Portal Apps to get an Org Access Token and a Refresh Token with a specified client ID, organization ID, and grant type. Access tokens allow the app to signal to the WaaS service that it has received permission to access specific resources of the app user's [organization](https://manuals.cobo.com/en/portal/organization/introduction). Once the app has been granted permission by the organization's admin, it can use this operation to obtain both an Org Access Token and a Refresh Token. For security purposes, Org Access Tokens expire after a certain period. Once they expire, the app needs to call [Refresh token](https://www.cobo.com/developers/v2/api-references/oauth/refresh-org-access-token) to get a new Org Access Token and a new Refresh Token.
|
|
19
19
|
|
|
20
20
|
### Example
|
|
21
21
|
|
package/docs/OrgInfo.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.OrgInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**org_id** | **String** | The ID of the owning organization. |
|
|
8
|
+
**name** | **String** | The organization name. | [optional]
|
|
9
|
+
**created_timestamp** | **Number** | The organization's creation time in Unix timestamp format, measured in milliseconds. | [optional]
|
|
10
|
+
|
|
11
|
+
|
package/docs/Pagination.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**before** | **String** | An object ID
|
|
8
|
-
**after** | **String** | An object ID
|
|
7
|
+
**before** | **String** | An object ID used to retrieve records before the specified object, indicating earlier or smaller records relative to the current dataset. You can use it to paginate backwards. If empty, it means you have reached the start of the data. Most API endpoints sort by object ID, but some use other fields depending on the endpoint. |
|
|
8
|
+
**after** | **String** | An object ID used to retrieve records after the specified object, indicating newer or larger records relative to the current dataset. You can use it to paginate forwards. If empty, it means you have reached the end of the data. Most API endpoints sort by object ID, but some use other fields depending on the endpoint. |
|
|
9
9
|
**total_count** | **Number** | The total number of records that match the query criteria, unaffected by the pagination parameters (`before` , `after`, and `limit`). |
|
|
10
10
|
|
|
11
11
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CoboWaas2.RetryCallbackMessage201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**retried** | **Boolean** | Whether the callback message has been successfully resent: - `true`: The callback message has been successfully resent. - `false`: The callback message has not been successfully resent. | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.SelfCustodyWallet
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) | |
|
|
8
|
+
**self_custody_wallet_challenge** | **String** | The challenge obtained from a previous operation. |
|
|
9
|
+
**self_custody_wallet_address** | **String** | The address of the self-custodial wallet. |
|
|
10
|
+
**self_custody_wallet_sign** | **String** | The signed message from the self-custodial wallet. |
|
|
11
|
+
|
|
12
|
+
|
package/docs/SourceGroup.md
CHANGED
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**key_share_holder_group_id** | **String** | The source key share holder group ID. |
|
|
8
|
-
**tss_node_ids** | **[String]** | The TSS Node IDs participating in creating a new key share holder group when `type` is set to either `KeyGenFromKeyGroup` or `Recovery`. **Note:** In any [Threshold Signature Schemes (TSS)](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#threshold-signature-scheme-tss) such as the 2-2, 2-3, and 3-3 schemes (in the \"threshold - participants\" format), for `tss_node_ids`, you only need to fill in 1 Cobo TSS Node ID and enough non-Cobo TSS Node IDs to satisfy the number of approvers specified in `threshold`. To obtain the Cobo TSS Node ID, run [List all Cobo key share holders](/v2/api-references/wallets--mpc-wallets/list-all-cobo-key-share-holders). | [optional]
|
|
8
|
+
**tss_node_ids** | **[String]** | The TSS Node IDs participating in creating a new key share holder group when `type` is set to either `KeyGenFromKeyGroup` or `Recovery`. **Note:** In any [Threshold Signature Schemes (TSS)](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#threshold-signature-scheme-tss) such as the 2-2, 2-3, and 3-3 schemes (in the \"threshold - participants\" format), for `tss_node_ids`, you only need to fill in 1 Cobo TSS Node ID and enough non-Cobo TSS Node IDs to satisfy the number of approvers specified in `threshold`. To obtain the Cobo TSS Node ID, run [List all Cobo key share holders](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-cobo-key-share-holders). | [optional]
|
|
9
9
|
|
|
10
10
|
|
package/docs/StakingPoolId.md
CHANGED
package/docs/StakingPoolType.md
CHANGED
package/docs/StakingsApi.md
CHANGED
|
@@ -11,7 +11,7 @@ Method | HTTP request | Description
|
|
|
11
11
|
[**getStakingActivityById**](StakingsApi.md#getStakingActivityById) | **GET** /stakings/activities/{activity_id} | Get staking activity details
|
|
12
12
|
[**getStakingById**](StakingsApi.md#getStakingById) | **GET** /stakings/{staking_id} | Get staking position details
|
|
13
13
|
[**getStakingEstimationFee**](StakingsApi.md#getStakingEstimationFee) | **POST** /stakings/estimate_fee | Estimate staking fees
|
|
14
|
-
[**getStakingEstimationFeeV2**](StakingsApi.md#getStakingEstimationFeeV2) | **POST** /stakings/estimate_fee_v2 | Estimate staking fees
|
|
14
|
+
[**getStakingEstimationFeeV2**](StakingsApi.md#getStakingEstimationFeeV2) | **POST** /stakings/estimate_fee_v2 | Estimate staking fees v2
|
|
15
15
|
[**getStakingPoolById**](StakingsApi.md#getStakingPoolById) | **GET** /stakings/pools/{pool_id} | Get staking pool details
|
|
16
16
|
[**listStakingActivities**](StakingsApi.md#listStakingActivities) | **GET** /stakings/activities | List staking activities
|
|
17
17
|
[**listStakingPools**](StakingsApi.md#listStakingPools) | **GET** /stakings/pools | List staking pools
|
|
@@ -311,7 +311,7 @@ apiInstance.getStakingById(staking_id).then((data) => {
|
|
|
311
311
|
|
|
312
312
|
Name | Type | Description | Notes
|
|
313
313
|
------------- | ------------- | ------------- | -------------
|
|
314
|
-
**staking_id** | **String**| The ID of the staking position. You can retrieve a list of staking positions by calling [List staking positions](/v2/api-references/stakings/list-staking-positions). |
|
|
314
|
+
**staking_id** | **String**| The ID of the staking position. You can retrieve a list of staking positions by calling [List staking positions](https://www.cobo.com/developers/v2/api-references/stakings/list-staking-positions). |
|
|
315
315
|
|
|
316
316
|
### Return type
|
|
317
317
|
|
|
@@ -333,7 +333,7 @@ Name | Type | Description | Notes
|
|
|
333
333
|
|
|
334
334
|
Estimate staking fees
|
|
335
335
|
|
|
336
|
-
<Note>This operation is deprecated. Please use the [updated version](/v2/api-references/stakings/estimate-staking-fees-
|
|
336
|
+
<Note>This operation is deprecated. Please use the [updated version](https://www.cobo.com/developers/v2/api-references/stakings/estimate-staking-fees-v2) instead.</Note> This operation calculates the fee required for a staking activity based on factors such as network congestion and transaction complexity. For some protocols, you can use the `fee.fee_rate` property in the request body to specify the fee rate you are willing to pay. The `fee.max_fee_amount` property in the request body will be ignored. <Note>For the Babylon protocol, you can only select UTXO as the fee model.</Note>
|
|
337
337
|
|
|
338
338
|
### Example
|
|
339
339
|
|
|
@@ -383,7 +383,7 @@ Name | Type | Description | Notes
|
|
|
383
383
|
|
|
384
384
|
> EthStakeEstimatedFee getStakingEstimationFeeV2(opts)
|
|
385
385
|
|
|
386
|
-
Estimate staking fees
|
|
386
|
+
Estimate staking fees v2
|
|
387
387
|
|
|
388
388
|
This operation calculates the fee required for a staking activity based on factors such as network congestion and transaction complexity. <Note>For the Babylon protocol, you can only select UTXO as the fee model.</Note>
|
|
389
389
|
|
|
@@ -465,7 +465,7 @@ apiInstance.getStakingPoolById(pool_id).then((data) => {
|
|
|
465
465
|
|
|
466
466
|
Name | Type | Description | Notes
|
|
467
467
|
------------- | ------------- | ------------- | -------------
|
|
468
|
-
**pool_id** | **String**| The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. You can call [List staking pools](/v2/api-references/stakings/list-staking-pools) to retrieve a list of staking pools. |
|
|
468
|
+
**pool_id** | **String**| The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. You can call [List staking pools](https://www.cobo.com/developers/v2/api-references/stakings/list-staking-pools) to retrieve a list of staking pools. |
|
|
469
469
|
|
|
470
470
|
### Return type
|
|
471
471
|
|
|
@@ -509,6 +509,7 @@ const opts = {
|
|
|
509
509
|
'min_modified_timestamp': 1635744000000,
|
|
510
510
|
'max_modified_timestamp': 1635744000000,
|
|
511
511
|
'initiator': "steve@example.com",
|
|
512
|
+
'request_id': "web_send_by_user_327_1610444045047",
|
|
512
513
|
'limit': 10,
|
|
513
514
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
514
515
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
|
|
@@ -526,16 +527,17 @@ apiInstance.listStakingActivities(opts).then((data) => {
|
|
|
526
527
|
|
|
527
528
|
Name | Type | Description | Notes
|
|
528
529
|
------------- | ------------- | ------------- | -------------
|
|
529
|
-
**pool_id** | **String**| The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. You can call [List staking pools](/v2/api-references/stakings/list-staking-pools) to retrieve a list of staking pools. | [optional]
|
|
530
|
+
**pool_id** | **String**| The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. You can call [List staking pools](https://www.cobo.com/developers/v2/api-references/stakings/list-staking-pools) to retrieve a list of staking pools. | [optional]
|
|
530
531
|
**staking_id** | **String**| The position ID. | [optional]
|
|
531
532
|
**activity_type** | [**ActivityType**](.md)| | [optional]
|
|
532
533
|
**activity_status** | [**ActivityStatus**](.md)| | [optional]
|
|
533
534
|
**min_modified_timestamp** | **Number**| The start time of the query. All staking activities updated after the specified time will be retrieved. The time is in Unix timestamp format, measured in milliseconds. | [optional]
|
|
534
535
|
**max_modified_timestamp** | **Number**| The end time of the query. All staking activities updated before the specified time will be retrieved. The time is in Unix timestamp format, measured in milliseconds. | [optional]
|
|
535
536
|
**initiator** | **String**| The activity initiator, which is your API key by default. You can also specify the initiator when creating the activity. | [optional]
|
|
537
|
+
**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]
|
|
536
538
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
537
|
-
**before** | **String**|
|
|
538
|
-
**after** | **String**|
|
|
539
|
+
**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]
|
|
540
|
+
**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]
|
|
539
541
|
|
|
540
542
|
### Return type
|
|
541
543
|
|
|
@@ -591,11 +593,11 @@ apiInstance.listStakingPools(opts).then((data) => {
|
|
|
591
593
|
|
|
592
594
|
Name | Type | Description | Notes
|
|
593
595
|
------------- | ------------- | ------------- | -------------
|
|
594
|
-
**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]
|
|
595
|
-
**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]
|
|
596
|
+
**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]
|
|
597
|
+
**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]
|
|
596
598
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
597
|
-
**before** | **String**|
|
|
598
|
-
**after** | **String**|
|
|
599
|
+
**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]
|
|
600
|
+
**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]
|
|
599
601
|
|
|
600
602
|
### Return type
|
|
601
603
|
|
|
@@ -653,13 +655,13 @@ apiInstance.listStakings(opts).then((data) => {
|
|
|
653
655
|
|
|
654
656
|
Name | Type | Description | Notes
|
|
655
657
|
------------- | ------------- | ------------- | -------------
|
|
656
|
-
**pool_id** | **String**| The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. You can call [List staking pools](/v2/api-references/stakings/list-staking-pools) to retrieve a list of staking pools. | [optional]
|
|
658
|
+
**pool_id** | **String**| The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. You can call [List staking pools](https://www.cobo.com/developers/v2/api-references/stakings/list-staking-pools) to retrieve a list of staking pools. | [optional]
|
|
657
659
|
**statuses** | **String**| The statuses of the staking amounts, separated by comma. Possible values include: - `StakeInProgress`: The staking request is submitted and is waiting to be confirmed by the staking protocol. - `Active`: The amount has been staked. - `Rejected`: The staking request has been rejected because the signer refuses to sign the transaction. - `LimitExceeded`: The total staking cap of the staking protocol has been reached. - `Invalid`: The staking request is invalid. This is often due to the failure to broadcast the transaction. - `UnstakeInProgress`: The unstaking request is submitted and is waiting to be confirmed by the staking protocol. - `Withdrawable`: The tokens have been unstaked and are ready to be withdrawn. - `WithdrawInProgress`: The withdrawal request is submitted and is waiting to be confirmed on the chain network. - `Closed`: The staking position is closed. | [optional]
|
|
658
660
|
**wallet_id** | **String**| The wallet ID. | [optional]
|
|
659
|
-
**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]
|
|
661
|
+
**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]
|
|
660
662
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
661
|
-
**before** | **String**|
|
|
662
|
-
**after** | **String**|
|
|
663
|
+
**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]
|
|
664
|
+
**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]
|
|
663
665
|
|
|
664
666
|
### Return type
|
|
665
667
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CoboWaas2.SubmitDepositTravelRuleInfo201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**submitted** | **Boolean** | Whether the submitted Travel Rule info has been successfully executed. - `true`: The operation has been successfully executed. - `false`: The operation has not been executed. | [optional]
|
|
8
|
+
|
|
9
|
+
|