@cobo/cobo-waas2 1.6.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 +63 -3
- package/dist/ApiClient.js +56 -6
- package/dist/api/AddressBooksApi.js +6 -6
- package/dist/api/DevelopersApi.js +110 -0
- package/dist/api/DevelopersWebhooksApi.js +32 -32
- package/dist/api/OAuthApi.js +2 -2
- package/dist/api/StakingsApi.js +118 -31
- package/dist/api/TransactionsApi.js +75 -30
- 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/crypto/Ed25519Signer.js +36 -0
- package/dist/crypto/Secp256k1Signer.js +36 -0
- package/dist/index.js +341 -5
- package/dist/model/Activity.js +33 -8
- package/dist/model/ActivityAction.js +50 -0
- package/dist/model/ActivityExtra.js +274 -0
- package/dist/model/ActivityType.js +5 -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/AutoFuelType.js +61 -0
- package/dist/model/BabylonStakeExtra.js +1 -1
- package/dist/model/BabylonStakingActivityDetailExtra.js +165 -0
- package/dist/model/BabylonValidator.js +4 -12
- 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 +11 -2
- package/dist/model/CoreStakeExtra.js +170 -0
- package/dist/model/CoreStakingActivityDetailExtra.js +164 -0
- package/dist/model/CoreStakingExtra.js +187 -0
- package/dist/model/CreateAddressRequest.js +2 -2
- package/dist/model/CreateClaimActivity.js +139 -0
- package/dist/model/CreateClaimActivityRequest.js +182 -0
- 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 +8 -14
- package/dist/model/CreateStakeActivityExtra.js +61 -9
- package/dist/model/CreateStakeActivityRequest.js +10 -17
- package/dist/model/CreateWalletParams.js +1 -1
- package/dist/model/CreateWebhookEndpointRequest.js +2 -2
- package/dist/model/CreateWithdrawActivity.js +0 -13
- package/dist/model/CreateWithdrawActivityRequest.js +0 -18
- 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 +145 -0
- package/dist/model/EstimateContractCallFeeParams.js +2 -2
- package/dist/model/EstimateFeeParams.js +2 -2
- package/dist/model/EstimateStakeFee.js +10 -17
- package/dist/model/EstimateTransferFeeParams.js +2 -2
- package/dist/model/EstimateWithdrawFee.js +0 -18
- package/dist/model/EstimatedFee.js +1 -1
- package/dist/model/EstimatedFixedFee.js +4 -4
- package/dist/model/EstimatedUtxoFeeSlow.js +3 -3
- package/dist/model/EthStakeEstimatedFee.js +13 -0
- package/dist/model/EthStakingActivityDetailExtra.js +142 -0
- package/dist/model/EthStakingExtra.js +31 -0
- package/dist/model/EthStakingExtraAllOfBeaconValidators.js +140 -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/FeeAmount.js +1 -1
- package/dist/model/FeeRate.js +1 -1
- package/dist/model/FixedFeeRate.js +2 -2
- package/dist/model/GetStakingEstimationFee201Response.js +6 -0
- package/dist/model/GetStakingEstimationFeeRequest.js +39 -17
- 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/MPCProject.js +4 -4
- 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 +2 -2
- package/dist/model/OrgInfo.js +133 -0
- package/dist/model/Pagination.js +6 -6
- 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 +86 -0
- package/dist/model/StakingPoolType.js +10 -0
- package/dist/model/Stakings.js +10 -14
- package/dist/model/StakingsExtra.js +67 -8
- 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/TransactionRbf.js +9 -0
- package/dist/model/TransactionRbfSource.js +1 -1
- 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/{StakingsValidatorInfo.js → TransactionSelectedUtxo.js} +38 -55
- 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 +11 -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 +3 -1
- package/docs/ActivityAction.md +20 -0
- package/docs/ActivityExtra.md +20 -0
- package/docs/ActivityType.md +2 -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/AutoFuelType.md +12 -0
- package/docs/BabylonStakeExtra.md +1 -1
- package/docs/BabylonStakingActivityDetailExtra.md +14 -0
- package/docs/BabylonValidator.md +4 -4
- package/docs/BroadcastSignedTransactionsRequest.md +1 -1
- package/docs/CallbackMessage.md +46 -0
- package/docs/ChainInfo.md +1 -1
- package/docs/ContractCallParams.md +2 -1
- package/docs/CoreStakeExtra.md +13 -0
- package/docs/CoreStakingActivityDetailExtra.md +13 -0
- package/docs/CoreStakingExtra.md +14 -0
- package/docs/CreateAddressRequest.md +1 -1
- package/docs/CreateClaimActivity.md +11 -0
- package/docs/CreateClaimActivityRequest.md +12 -0
- package/docs/CreateKeyShareHolder.md +1 -1
- package/docs/CreateMpcVaultRequest.md +1 -1
- package/docs/CreateMpcWalletParams.md +1 -1
- package/docs/CreateStakeActivity.md +2 -2
- package/docs/CreateStakeActivityExtra.md +5 -1
- package/docs/CreateStakeActivityRequest.md +2 -2
- package/docs/CreateWalletParams.md +1 -1
- package/docs/CreateWebhookEndpointRequest.md +1 -1
- package/docs/CreateWithdrawActivity.md +0 -1
- package/docs/CreateWithdrawActivityRequest.md +0 -1
- package/docs/DestinationWalletType.md +12 -0
- package/docs/DevelopersApi.md +118 -0
- package/docs/DevelopersWebhooksApi.md +16 -16
- package/docs/ErrorResponse.md +1 -1
- package/docs/EstimateClaimFee.md +11 -0
- package/docs/EstimateContractCallFeeParams.md +1 -1
- package/docs/EstimateFeeParams.md +2 -2
- package/docs/EstimateStakeFee.md +2 -2
- package/docs/EstimateTransferFeeParams.md +1 -1
- package/docs/EstimateWithdrawFee.md +0 -1
- package/docs/EstimatedFee.md +1 -1
- package/docs/EstimatedFixedFee.md +1 -1
- package/docs/EstimatedUtxoFeeSlow.md +1 -1
- package/docs/EthStakeEstimatedFee.md +1 -0
- package/docs/EthStakingActivityDetailExtra.md +11 -0
- package/docs/EthStakingExtra.md +1 -0
- package/docs/EthStakingExtraAllOfBeaconValidators.md +14 -0
- package/docs/ExtendedTokenInfo.md +1 -1
- package/docs/FeeAmount.md +1 -1
- package/docs/FeeRate.md +1 -1
- package/docs/FixedFeeRate.md +1 -1
- package/docs/GetStakingEstimationFee201Response.md +1 -0
- package/docs/GetStakingEstimationFeeRequest.md +3 -4
- 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/MPCProject.md +1 -1
- package/docs/MPCVaultEventData.md +34 -0
- package/docs/MaxTransferableValue.md +1 -1
- package/docs/MessageSignParams.md +1 -1
- package/docs/MpcTransferSource.md +1 -1
- package/docs/OAuthApi.md +1 -1
- package/docs/OrgInfo.md +11 -0
- package/docs/Pagination.md +3 -3
- package/docs/PoolDetailsAllOfValidatorsInfo.md +4 -4
- 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 +22 -0
- package/docs/StakingPoolType.md +4 -0
- package/docs/Stakings.md +2 -2
- package/docs/StakingsApi.md +122 -14
- package/docs/StakingsExtra.md +5 -0
- 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/TransactionRbf.md +1 -0
- package/docs/TransactionRbfSource.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 +66 -15
- package/docs/TransferParams.md +2 -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 +4 -3
- package/docs/StakingsValidatorInfo.md +0 -13
package/docs/DevelopersApi.md
CHANGED
|
@@ -5,6 +5,8 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**getApiKeyInfo**](DevelopersApi.md#getApiKeyInfo) | **GET** /developers/api_key_info | Get API key information
|
|
8
|
+
[**listCallbackMessages**](DevelopersApi.md#listCallbackMessages) | **GET** /developers/callback_messages | List all callback messages
|
|
9
|
+
[**retryCallbackMessage**](DevelopersApi.md#retryCallbackMessage) | **POST** /developers/callback_messages/{message_id}/retry | Retry callback message
|
|
8
10
|
|
|
9
11
|
|
|
10
12
|
|
|
@@ -53,3 +55,119 @@ This endpoint does not need any parameter.
|
|
|
53
55
|
- **Content-Type**: Not defined
|
|
54
56
|
- **Accept**: application/json
|
|
55
57
|
|
|
58
|
+
|
|
59
|
+
## listCallbackMessages
|
|
60
|
+
|
|
61
|
+
> ListCallbackMessages200Response listCallbackMessages(opts)
|
|
62
|
+
|
|
63
|
+
List all callback messages
|
|
64
|
+
|
|
65
|
+
This operation retrieves all the callback messages in your organization. For more details about how to respond to callback messages, refer to [Callback messages](/v2/guides/webhooks-callbacks/set-up-endpoint#callback-messages).
|
|
66
|
+
|
|
67
|
+
### Example
|
|
68
|
+
|
|
69
|
+
```javascript
|
|
70
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
71
|
+
// Initialize the API client
|
|
72
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
73
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
74
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
75
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
76
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
77
|
+
// Call the API
|
|
78
|
+
const apiInstance = new CoboWaas2.DevelopersApi();
|
|
79
|
+
const opts = {
|
|
80
|
+
'callback_message_ids': "f47ac10b-58cc-4372-a567-0e02b2c3d479,f47ac10b-58cc-4372-a567-0e02b2c3d479",
|
|
81
|
+
'request_ids': "f47ac10b-58cc-4372-a567-0e02b2c3d479,f47ac10b-58cc-4372-a567-0e02b2c3d479",
|
|
82
|
+
'transaction_ids': "f47ac10b-58cc-4372-a567-0e02b2c3d479,f47ac10b-58cc-4372-a567-0e02b2c3d479",
|
|
83
|
+
'wallet_ids': "f47ac10b-58cc-4372-a567-0e02b2c3d479,f47ac10b-58cc-4372-a567-0e02b2c3d479",
|
|
84
|
+
'status': "Approved",
|
|
85
|
+
'limit': 10,
|
|
86
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
87
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
|
|
88
|
+
};
|
|
89
|
+
apiInstance.listCallbackMessages(opts).then((data) => {
|
|
90
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
91
|
+
}, (error) => {
|
|
92
|
+
console.error(error);
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Parameters
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
Name | Type | Description | Notes
|
|
101
|
+
------------- | ------------- | ------------- | -------------
|
|
102
|
+
**callback_message_ids** | **String**| A list of callback message IDs, separated by commas. | [optional]
|
|
103
|
+
**request_ids** | **String**| A list of request IDs, separated by commas. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
104
|
+
**transaction_ids** | **String**| A list of transaction IDs, separated by commas. | [optional]
|
|
105
|
+
**wallet_ids** | **String**| A list of wallet IDs, separated by commas. | [optional]
|
|
106
|
+
**status** | **String**| The callback message status. Possible values include `Approved`, `Denied`, and `Failed`. | [optional]
|
|
107
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
108
|
+
**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]
|
|
109
|
+
**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]
|
|
110
|
+
|
|
111
|
+
### Return type
|
|
112
|
+
|
|
113
|
+
[**ListCallbackMessages200Response**](ListCallbackMessages200Response.md)
|
|
114
|
+
|
|
115
|
+
### Authorization
|
|
116
|
+
|
|
117
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
118
|
+
|
|
119
|
+
### HTTP request headers
|
|
120
|
+
|
|
121
|
+
- **Content-Type**: Not defined
|
|
122
|
+
- **Accept**: application/json
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
## retryCallbackMessage
|
|
126
|
+
|
|
127
|
+
> RetryCallbackMessage201Response retryCallbackMessage(message_id)
|
|
128
|
+
|
|
129
|
+
Retry callback message
|
|
130
|
+
|
|
131
|
+
This operation resends a callback message that failed previously. If your callback endpoint doesn't respond as expected, the WaaS service will retry sending the callback message up to 30 times. After that, the callback message status will be `Failed`. Use this operation to resend the message. For more details, refer to [Webhooks and Callbacks](/v2/guides/webhooks-callbacks/set-up-endpoint#callback-messages).
|
|
132
|
+
|
|
133
|
+
### Example
|
|
134
|
+
|
|
135
|
+
```javascript
|
|
136
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
137
|
+
// Initialize the API client
|
|
138
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
139
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
140
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
141
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
142
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
143
|
+
// Call the API
|
|
144
|
+
const apiInstance = new CoboWaas2.DevelopersApi();
|
|
145
|
+
const message_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
146
|
+
apiInstance.retryCallbackMessage(message_id).then((data) => {
|
|
147
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
148
|
+
}, (error) => {
|
|
149
|
+
console.error(error);
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### Parameters
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
Name | Type | Description | Notes
|
|
158
|
+
------------- | ------------- | ------------- | -------------
|
|
159
|
+
**message_id** | **String**| The callback message ID. |
|
|
160
|
+
|
|
161
|
+
### Return type
|
|
162
|
+
|
|
163
|
+
[**RetryCallbackMessage201Response**](RetryCallbackMessage201Response.md)
|
|
164
|
+
|
|
165
|
+
### Authorization
|
|
166
|
+
|
|
167
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
168
|
+
|
|
169
|
+
### HTTP request headers
|
|
170
|
+
|
|
171
|
+
- **Content-Type**: Not defined
|
|
172
|
+
- **Accept**: application/json
|
|
173
|
+
|
|
@@ -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
|
|
|
@@ -457,7 +457,7 @@ Name | Type | Description | Notes
|
|
|
457
457
|
|
|
458
458
|
Trigger test event
|
|
459
459
|
|
|
460
|
-
This operation tests the functionality of your webhook endpoint by triggering a test webhook event.
|
|
460
|
+
This operation tests the functionality of your webhook endpoint by triggering a test webhook event. The test event will be sent to all the endpoints you have registered on Cobo Portal. You only need to provide the event type. By default, the payload contains dummy data with no impact on your real business transactions or activities. You can optionally provide the `override_data` property to customize the payload.
|
|
461
461
|
|
|
462
462
|
### Example
|
|
463
463
|
|
|
@@ -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
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.EstimateClaimFee
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
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](https://www.cobo.com/developers/v2/api-references/stakings/list-staking-positions). | [optional]
|
|
9
|
+
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
|
|
10
|
+
|
|
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
|
|
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
|
|
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
|
@@ -7,9 +7,9 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**activity_type** | [**ActivityType**](ActivityType.md) | |
|
|
8
8
|
**request_id** | **String** | The request ID that is used to track a request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
9
9
|
**source** | [**StakingSource**](StakingSource.md) | | [optional]
|
|
10
|
-
**pool_id** | **
|
|
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
|
|
|
@@ -8,7 +8,6 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**request_id** | **String** | The request ID that is used to track a request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
9
9
|
**staking_id** | **String** | The ID of the corresponding staking position. |
|
|
10
10
|
**amount** | **String** | The amount to withdraw. | [optional]
|
|
11
|
-
**address** | **String** | The withdrawal address. | [optional]
|
|
12
11
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
|
|
13
12
|
|
|
14
13
|
|
package/docs/EstimatedFee.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**fee_type** | [**FeeType**](FeeType.md) | |
|
|
8
8
|
**token_id** | **String** | The token ID of the transaction fee. |
|
|
9
9
|
**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]
|
|
10
|
-
**fee_amount** | **String** | The fee that you need to pay for the transaction. |
|
|
10
|
+
**fee_amount** | **String** | The transaction fee that you need to pay for the transaction. |
|
|
11
11
|
**slow** | [**EstimatedUtxoFeeSlow**](EstimatedUtxoFeeSlow.md) | | [optional]
|
|
12
12
|
**recommended** | [**EstimatedUtxoFeeSlow**](EstimatedUtxoFeeSlow.md) | |
|
|
13
13
|
**fast** | [**EstimatedUtxoFeeSlow**](EstimatedUtxoFeeSlow.md) | | [optional]
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**fee_amount** | **String** | The fee that you need to pay for the transaction. |
|
|
7
|
+
**fee_amount** | **String** | The transaction fee that you need to pay for the transaction. |
|
|
8
8
|
**fee_type** | [**FeeType**](FeeType.md) | |
|
|
9
9
|
**token_id** | **String** | The token ID of the transaction fee. |
|
|
10
10
|
**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]
|
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**fee_rate** | **String** | The fee rate in sat/vByte. The fee rate represents the satoshis you are willing to pay for each byte of data that your transaction will consume on the blockchain. |
|
|
8
|
-
**fee_amount** | **String** | The fee that you need to pay for the transaction. |
|
|
8
|
+
**fee_amount** | **String** | The transaction fee that you need to pay for the transaction. |
|
|
9
9
|
|
|
10
10
|
|
|
@@ -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
|
+
|
package/docs/EthStakingExtra.md
CHANGED
|
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**pool_type** | [**StakingPoolType**](StakingPoolType.md) | |
|
|
8
8
|
**pos_chain** | **String** | The Proof-of-Stake (PoS) chain. |
|
|
9
|
+
**beacon_validators** | [**[EthStakingExtraAllOfBeaconValidators]**](EthStakingExtraAllOfBeaconValidators.md) | The list of validator information. | [optional]
|
|
9
10
|
|
|
10
11
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# CoboWaas2.EthStakingExtraAllOfBeaconValidators
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**pubkey** | **String** | The public key of the validator. | [optional]
|
|
8
|
+
**status** | [**AmountStatus**](AmountStatus.md) | | [optional]
|
|
9
|
+
**apy** | **Number** | The annual percentage yield (APY) of the validator. | [optional]
|
|
10
|
+
**staked_amount** | **String** | The staked amount. | [optional]
|
|
11
|
+
**rewards_received** | **String** | The rewards received. | [optional]
|
|
12
|
+
**updated_timestamp** | **Number** | The time when the validator's status was last updated, in Unix timestamp format and measured in milliseconds. | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -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]
|
package/docs/FeeAmount.md
CHANGED
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**fee_amount** | **String** | The fee that you need to pay for the transaction. | [optional]
|
|
7
|
+
**fee_amount** | **String** | The transaction fee that you need to pay for the transaction. | [optional]
|
|
8
8
|
|
|
9
9
|
|
package/docs/FeeRate.md
CHANGED
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**fee_type** | [**FeeType**](FeeType.md) | |
|
|
8
8
|
**token_id** | **String** | The token ID of the transaction fee. |
|
|
9
|
-
**fee_amount** | **String** | The fee that you need to pay for the transaction. | [optional]
|
|
9
|
+
**fee_amount** | **String** | The transaction fee that you need to pay for the transaction. | [optional]
|
|
10
10
|
**slow** | [**UtxoFeeBasePrice**](UtxoFeeBasePrice.md) | | [optional]
|
|
11
11
|
**recommended** | [**UtxoFeeBasePrice**](UtxoFeeBasePrice.md) | |
|
|
12
12
|
**fast** | [**UtxoFeeBasePrice**](UtxoFeeBasePrice.md) | | [optional]
|
package/docs/FixedFeeRate.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**fee_amount** | **String** | The fee that you need to pay for the transaction. | [optional]
|
|
7
|
+
**fee_amount** | **String** | The transaction fee that you need to pay for the transaction. | [optional]
|
|
8
8
|
**fee_type** | [**FeeType**](FeeType.md) | |
|
|
9
9
|
**token_id** | **String** | The token ID of the transaction fee. |
|
|
10
10
|
|
|
@@ -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]
|
|
@@ -7,11 +7,10 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**activity_type** | [**ActivityType**](ActivityType.md) | |
|
|
8
8
|
**request_id** | **String** | The request ID that is used to track a request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
9
9
|
**source** | [**StakingSource**](StakingSource.md) | | [optional]
|
|
10
|
-
**pool_id** | **
|
|
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
|
|
15
|
-
**address** | **String** | The withdrawal address. |
|
|
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). |
|
|
16
15
|
|
|
17
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
|
|
package/docs/MPCProject.md
CHANGED
|
@@ -9,6 +9,6 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**name** | **String** | The project name. | [optional]
|
|
10
10
|
**participants** | **Number** | The number of key share holders in the project. | [optional]
|
|
11
11
|
**threshold** | **Number** | The number of key share holders required to sign an operation in the project. | [optional]
|
|
12
|
-
**
|
|
12
|
+
**created_timestamp** | **Number** | The project's creation time in Unix timestamp format, measured in milliseconds. | [optional]
|
|
13
13
|
|
|
14
14
|
|
|
@@ -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]
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**source_type** | [**WalletSubtype**](WalletSubtype.md) | |
|
|
8
8
|
**wallet_id** | **String** | The wallet ID. |
|
|
9
|
-
**address** | **String** | The wallet address. If you want to specify the UTXOs to be used, please provide the `included_utxos` property. If you specify both the `address` and `included_utxos` properties, the specified included UTXOs must belong to the address. You need to provide either the `address` or `included_utxos` property. If neither property is provided, the transfer will fail. | [optional]
|
|
9
|
+
**address** | **String** | The wallet address. If you want to specify the UTXOs to be used, please provide the `included_utxos` property. If you specify both the `address` and `included_utxos` properties, the specified included UTXOs must belong to the address. It is recommended to specify no more than 100 included UTXOs to ensure optimal transaction processing. You need to provide either the `address` or `included_utxos` property. If neither property is provided, the transfer will fail. | [optional]
|
|
10
10
|
**included_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) | | [optional]
|
|
11
11
|
**excluded_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) | | [optional]
|
|
12
12
|
|
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
|
|