@cobo/cobo-waas2 1.7.0 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +122 -29
- package/dist/ApiClient.js +11 -1
- package/dist/api/AddressBooksApi.js +7 -7
- package/dist/api/DevelopersApi.js +111 -1
- package/dist/api/DevelopersWebhooksApi.js +38 -38
- package/dist/api/OAuthApi.js +2 -2
- package/dist/api/PrimeBrokerApi.js +317 -0
- package/dist/api/StakingsApi.js +45 -42
- package/dist/api/TransactionsApi.js +131 -42
- package/dist/api/TravelRuleApi.js +216 -0
- package/dist/api/WalletsApi.js +152 -81
- package/dist/api/WalletsExchangeWalletApi.js +13 -13
- package/dist/api/WalletsMPCWalletsApi.js +189 -77
- package/dist/api/WalletsSmartContractWalletsApi.js +1 -1
- package/dist/index.js +385 -7
- package/dist/model/Activity.js +29 -0
- package/dist/model/ActivityAction.js +30 -0
- package/dist/model/ActivityExtra.js +274 -0
- package/dist/model/AddressBalance.js +129 -0
- package/dist/model/AddressInfo.js +15 -2
- package/dist/model/AddressTransferDestination.js +37 -1
- package/dist/model/AddressesEventData.js +190 -0
- package/dist/model/ApiLogDetails.js +2 -2
- package/dist/model/ApprovalStatementStatus.js +81 -0
- package/dist/model/AssetBalance.js +6 -6
- package/dist/model/BTCEIP191MessageSignDestination.js +122 -0
- package/dist/model/BabylonStakeExtra.js +1 -1
- package/dist/model/BabylonStakingActivityDetailExtra.js +165 -0
- package/dist/model/{TokenBalanceBalance.js → Balance.js} +28 -28
- package/dist/model/BaseContractCallSource.js +1 -1
- package/dist/model/BroadcastSignedTransactionsRequest.js +1 -1
- package/dist/model/CallbackMessage.js +288 -0
- package/dist/model/ChainInfo.js +2 -2
- package/dist/model/ChangeGuardPubkey200Response.js +110 -0
- package/dist/model/ContractCallParams.js +38 -2
- package/dist/model/CoreStakingActivityDetailExtra.js +164 -0
- package/dist/model/CreateAddressRequest.js +30 -4
- package/dist/model/CreateClaimActivity.js +2 -2
- package/dist/model/CreateClaimActivityRequest.js +3 -3
- package/dist/model/CreateKeyShareHolder.js +1 -1
- package/dist/model/CreateMpcVaultRequest.js +1 -1
- package/dist/model/CreateMpcWalletParams.js +2 -2
- package/dist/model/CreatePrimeBrokerAddress201Response.js +140 -0
- package/dist/model/CreatePrimeBrokerAddressRequest.js +107 -0
- package/dist/model/CreateStakeActivity.js +4 -6
- package/dist/model/CreateStakeActivityExtra.js +1 -1
- package/dist/model/CreateStakeActivityRequest.js +5 -7
- package/dist/model/CreateWalletParams.js +1 -1
- package/dist/model/CreateWebhookEndpointRequest.js +2 -2
- package/dist/model/CustodialTransferSource.js +1 -1
- package/dist/model/DeleteGuardPubkey201Response.js +110 -0
- package/dist/model/DestinationWalletType.js +61 -0
- package/dist/model/ErrorResponse.js +2 -2
- package/dist/model/EstimateClaimFee.js +1 -1
- package/dist/model/EstimateContractCallFeeParams.js +2 -2
- package/dist/model/EstimateFeeParams.js +2 -2
- package/dist/model/EstimateStakeFee.js +5 -7
- package/dist/model/EstimateTransferFeeParams.js +2 -2
- package/dist/model/EthStakeEstimatedFee.js +13 -0
- package/dist/model/EthStakingActivityDetailExtra.js +142 -0
- package/dist/model/EvmContractCallDestination.js +1 -1
- package/dist/model/EvmEIP191MessageSignDestination.js +1 -1
- package/dist/model/EvmEIP712MessageSignDestination.js +1 -1
- package/dist/model/ExchangeTransferDestination.js +1 -1
- package/dist/model/ExchangeTransferSource.js +1 -1
- package/dist/model/ExtendedTokenInfo.js +3 -3
- package/dist/model/GetStakingEstimationFee201Response.js +6 -0
- package/dist/model/GetStakingEstimationFeeRequest.js +1 -1
- package/dist/model/GetTransactionLimitation200Response.js +143 -0
- package/dist/model/GuardPubkeyStatus.js +91 -0
- package/dist/model/ListAddressBalancesByToken200Response.js +123 -0
- package/dist/model/ListCallbackMessages200Response.js +145 -0
- package/dist/model/ListKeyShareHolders200Response.js +123 -0
- package/dist/model/ListSupportedCountries200ResponseInner.js +140 -0
- package/dist/model/LockUtxosRequestUtxosInner.js +2 -2
- package/dist/model/MPCDelegate.js +1 -1
- package/dist/model/MPCVaultEventData.js +279 -0
- package/dist/model/MaxTransferableValue.js +1 -1
- package/dist/model/MessageSignDestination.js +70 -8
- package/dist/model/MessageSignDestinationType.js +12 -2
- package/dist/model/MessageSignParams.js +2 -2
- package/dist/model/MpcTransferSource.js +1 -1
- package/dist/model/OrgInfo.js +133 -0
- package/dist/model/Pagination.js +4 -4
- package/dist/model/QueryApprovalStatement200Response.js +122 -0
- package/dist/model/QueryGuardPubkey200Response.js +129 -0
- package/dist/model/QueryGuardPubkey200ResponseAddressesInner.js +125 -0
- package/dist/model/RawMessageSignDestination.js +1 -1
- package/dist/model/RetryCallbackMessage201Response.js +83 -0
- package/dist/model/RootPubkey.js +1 -1
- package/dist/model/SafeContractCallSource.js +1 -1
- package/dist/model/SafeTransferSource.js +1 -1
- package/dist/model/SelectedEntityType.js +61 -0
- package/dist/model/SelfCustodyWallet.js +152 -0
- package/dist/model/SourceGroup.js +1 -1
- package/dist/model/StakingPoolId.js +5 -0
- package/dist/model/StakingPoolType.js +5 -0
- package/dist/model/SubWalletAssetBalance.js +6 -6
- package/dist/model/SubmitDepositTravelRuleInfo201Response.js +83 -0
- package/dist/model/SwapActivity.js +218 -0
- package/dist/model/SwapSummary.js +121 -0
- package/dist/model/SwapTokenPair.js +100 -0
- package/dist/model/TSSGroups.js +1 -1
- package/dist/model/TSSRequestWebhookEventData.js +18 -3
- package/dist/model/TokenBalance.js +8 -8
- package/dist/model/TokenInfo.js +2 -2
- package/dist/model/Transaction.js +2 -2
- package/dist/model/TransactionApprovalDetail.js +121 -0
- package/dist/model/TransactionApprovalResult.js +66 -0
- package/dist/model/TransactionCustodialAssetWalletSource.js +1 -1
- package/dist/model/TransactionDepositFromAddressSource.js +1 -1
- package/dist/model/TransactionDepositFromLoopSource.js +1 -1
- package/dist/model/TransactionDepositFromWalletSource.js +1 -1
- package/dist/model/TransactionDepositToAddressDestination.js +17 -1
- package/dist/model/TransactionDepositToAddressDestinationTxInfo.js +83 -0
- package/dist/model/TransactionDepositToWalletDestination.js +1 -1
- package/dist/model/TransactionDestination.js +6 -0
- package/dist/model/TransactionDetail.js +4 -4
- package/dist/model/TransactionDetails.js +4 -4
- package/dist/model/TransactionEvmContractDestination.js +1 -1
- package/dist/model/TransactionExchangeWalletSource.js +1 -1
- package/dist/model/TransactionMPCWalletSource.js +1 -1
- package/dist/model/TransactionMessageSignEIP191Destination.js +1 -1
- package/dist/model/TransactionMessageSignEIP712Destination.js +1 -1
- package/dist/model/TransactionRawMessageSignDestination.js +1 -1
- package/dist/model/TransactionRawTxInfo.js +17 -4
- package/dist/model/TransactionRequestEvmEip1559Fee.js +1 -1
- package/dist/model/TransactionRequestEvmLegacyFee.js +1 -1
- package/dist/model/TransactionRequestFixedFee.js +1 -1
- package/dist/model/TransactionRequestUtxoFee.js +1 -1
- package/dist/model/TransactionRoleApprovalDetail.js +152 -0
- package/dist/model/TransactionSelectedUtxo.js +123 -0
- package/dist/model/TransactionSmartContractSafeWalletSource.js +1 -1
- package/dist/model/TransactionSubStatus.js +5 -0
- package/dist/model/TransactionTokeApproval.js +3 -3
- package/dist/model/TransactionTokenAmount.js +1 -1
- package/dist/model/TransactionTransferToAddressDestination.js +1 -1
- package/dist/model/TransactionTransferToWalletDestination.js +1 -1
- package/dist/model/TransactionUserApprovalDetail.js +162 -0
- package/dist/model/TransactionWebhookEventData.js +22 -7
- package/dist/model/TransferDestination.js +6 -0
- package/dist/model/TransferParams.js +38 -2
- package/dist/model/TravelRuleDepositExchangesOrVASP.js +168 -0
- package/dist/model/TravelRuleDepositExchangesOrVASPEntityInfo.js +222 -0
- package/dist/model/TravelRuleDepositLegalEntity.js +171 -0
- package/dist/model/TravelRuleDepositNaturalEntity.js +186 -0
- package/dist/model/TravelRuleDepositRequest.js +128 -0
- package/dist/model/TravelRuleDepositRequestTravelRuleInfo.js +222 -0
- package/dist/model/TravelRuleWithdrawExchangesOrVASP.js +155 -0
- package/dist/model/TravelRuleWithdrawExchangesOrVASPEntityInfo.js +222 -0
- package/dist/model/TravelRuleWithdrawLegalEntity.js +144 -0
- package/dist/model/TravelRuleWithdrawNaturalEntity.js +159 -0
- package/dist/model/TravelRuleWithdrawRequest.js +128 -0
- package/dist/model/TravelRuleWithdrawRequestTravelRuleInfo.js +216 -0
- package/dist/model/TriggerTestWebhookEventRequest.js +1 -1
- package/dist/model/UpdateWebhookEndpointByIdRequest.js +1 -1
- package/dist/model/Vasp.js +141 -0
- package/dist/model/WalletInfoEventData.js +175 -0
- package/dist/model/WebhookEventData.js +135 -14
- package/dist/model/WebhookEventDataType.js +17 -2
- package/dist/model/WebhookEventType.js +23 -8
- package/docs/Activity.md +2 -0
- package/docs/ActivityAction.md +12 -0
- package/docs/ActivityExtra.md +20 -0
- package/docs/AddressBalance.md +10 -0
- package/docs/AddressBooksApi.md +4 -4
- package/docs/AddressInfo.md +2 -1
- package/docs/AddressTransferDestination.md +14 -0
- package/docs/AddressesEventData.md +29 -0
- package/docs/ApiLogDetails.md +1 -1
- package/docs/ApprovalStatementStatus.md +20 -0
- package/docs/AssetBalance.md +1 -1
- package/docs/BTCEIP191MessageSignDestination.md +10 -0
- package/docs/BabylonStakeExtra.md +1 -1
- package/docs/BabylonStakingActivityDetailExtra.md +14 -0
- package/docs/{TokenBalanceBalance.md → Balance.md} +5 -5
- package/docs/BroadcastSignedTransactionsRequest.md +1 -1
- package/docs/CallbackMessage.md +46 -0
- package/docs/ChainInfo.md +1 -1
- package/docs/ChangeGuardPubkey200Response.md +9 -0
- package/docs/ContractCallParams.md +15 -1
- package/docs/CoreStakingActivityDetailExtra.md +13 -0
- package/docs/CreateAddressRequest.md +4 -2
- package/docs/CreateClaimActivity.md +1 -1
- package/docs/CreateClaimActivityRequest.md +1 -1
- package/docs/CreateKeyShareHolder.md +1 -1
- package/docs/CreateMpcVaultRequest.md +1 -1
- package/docs/CreateMpcWalletParams.md +1 -1
- package/docs/CreatePrimeBrokerAddress201Response.md +10 -0
- package/docs/CreatePrimeBrokerAddressRequest.md +9 -0
- package/docs/CreateStakeActivity.md +1 -1
- package/docs/CreateStakeActivityExtra.md +1 -1
- package/docs/CreateStakeActivityRequest.md +1 -1
- package/docs/CreateWalletParams.md +1 -1
- package/docs/CreateWebhookEndpointRequest.md +1 -1
- package/docs/DeleteGuardPubkey201Response.md +9 -0
- package/docs/DestinationWalletType.md +12 -0
- package/docs/DevelopersApi.md +119 -1
- package/docs/DevelopersWebhooksApi.md +23 -23
- package/docs/ErrorResponse.md +1 -1
- package/docs/EstimateClaimFee.md +1 -1
- package/docs/EstimateContractCallFeeParams.md +1 -1
- package/docs/EstimateFeeParams.md +2 -2
- package/docs/EstimateStakeFee.md +1 -1
- package/docs/EstimateTransferFeeParams.md +1 -1
- package/docs/EthStakeEstimatedFee.md +1 -0
- package/docs/EthStakingActivityDetailExtra.md +11 -0
- package/docs/ExtendedTokenInfo.md +1 -1
- package/docs/GetStakingEstimationFee201Response.md +1 -0
- package/docs/GetStakingEstimationFeeRequest.md +2 -2
- package/docs/GetTransactionLimitation200Response.md +12 -0
- package/docs/GuardPubkeyStatus.md +24 -0
- package/docs/ListAddressBalancesByToken200Response.md +10 -0
- package/docs/ListCallbackMessages200Response.md +10 -0
- package/docs/ListKeyShareHolders200Response.md +10 -0
- package/docs/ListSupportedCountries200ResponseInner.md +11 -0
- package/docs/LockUtxosRequestUtxosInner.md +1 -1
- package/docs/MPCVaultEventData.md +34 -0
- package/docs/MaxTransferableValue.md +1 -1
- package/docs/MessageSignDestination.md +1 -0
- package/docs/MessageSignDestinationType.md +6 -2
- package/docs/MessageSignParams.md +1 -1
- package/docs/OAuthApi.md +1 -1
- package/docs/OrgInfo.md +11 -0
- package/docs/Pagination.md +2 -2
- package/docs/PrimeBrokerApi.md +318 -0
- package/docs/QueryApprovalStatement200Response.md +12 -0
- package/docs/QueryGuardPubkey200Response.md +11 -0
- package/docs/QueryGuardPubkey200ResponseAddressesInner.md +10 -0
- package/docs/RetryCallbackMessage201Response.md +9 -0
- package/docs/RootPubkey.md +1 -1
- package/docs/SelectedEntityType.md +12 -0
- package/docs/SelfCustodyWallet.md +12 -0
- package/docs/SourceGroup.md +1 -1
- package/docs/StakingPoolId.md +2 -0
- package/docs/StakingPoolType.md +2 -0
- package/docs/StakingsApi.md +30 -28
- package/docs/SubWalletAssetBalance.md +1 -1
- package/docs/SubmitDepositTravelRuleInfo201Response.md +9 -0
- package/docs/SwapActivity.md +20 -0
- package/docs/SwapSummary.md +10 -0
- package/docs/SwapTokenPair.md +10 -0
- package/docs/TSSGroups.md +1 -1
- package/docs/TSSRequestWebhookEventData.md +7 -1
- package/docs/TokenBalance.md +2 -2
- package/docs/TokenInfo.md +1 -1
- package/docs/Transaction.md +2 -2
- package/docs/TransactionApprovalDetail.md +11 -0
- package/docs/TransactionApprovalResult.md +14 -0
- package/docs/TransactionDepositToAddressDestination.md +1 -0
- package/docs/TransactionDepositToAddressDestinationTxInfo.md +9 -0
- package/docs/TransactionDestination.md +1 -0
- package/docs/TransactionDetail.md +2 -2
- package/docs/TransactionDetails.md +2 -2
- package/docs/TransactionRawTxInfo.md +2 -1
- package/docs/TransactionRoleApprovalDetail.md +13 -0
- package/docs/TransactionSelectedUtxo.md +12 -0
- package/docs/TransactionSubStatus.md +2 -0
- package/docs/TransactionTokeApproval.md +1 -1
- package/docs/TransactionTokenAmount.md +1 -1
- package/docs/TransactionUserApprovalDetail.md +15 -0
- package/docs/TransactionWebhookEventData.md +9 -3
- package/docs/TransactionsApi.md +129 -27
- package/docs/TransferDestination.md +14 -0
- package/docs/TransferParams.md +15 -1
- package/docs/TravelRuleApi.md +214 -0
- package/docs/TravelRuleDepositExchangesOrVASP.md +13 -0
- package/docs/TravelRuleDepositExchangesOrVASPEntityInfo.md +29 -0
- package/docs/TravelRuleDepositLegalEntity.md +25 -0
- package/docs/TravelRuleDepositNaturalEntity.md +26 -0
- package/docs/TravelRuleDepositRequest.md +10 -0
- package/docs/TravelRuleDepositRequestTravelRuleInfo.md +16 -0
- package/docs/TravelRuleWithdrawExchangesOrVASP.md +12 -0
- package/docs/TravelRuleWithdrawExchangesOrVASPEntityInfo.md +16 -0
- package/docs/TravelRuleWithdrawLegalEntity.md +12 -0
- package/docs/TravelRuleWithdrawNaturalEntity.md +13 -0
- package/docs/TravelRuleWithdrawRequest.md +10 -0
- package/docs/TravelRuleWithdrawRequestTravelRuleInfo.md +15 -0
- package/docs/TriggerTestWebhookEventRequest.md +1 -1
- package/docs/UpdateWebhookEndpointByIdRequest.md +1 -1
- package/docs/Vasp.md +11 -0
- package/docs/WalletInfoEventData.md +29 -0
- package/docs/WalletsApi.md +112 -47
- package/docs/WalletsExchangeWalletApi.md +7 -7
- package/docs/WalletsMPCWalletsApi.md +160 -46
- package/docs/WalletsSmartContractWalletsApi.md +1 -1
- package/docs/WebhookEventData.md +17 -5
- package/docs/WebhookEventDataType.md +7 -1
- package/docs/WebhookEventType.md +14 -8
- package/package.json +2 -2
package/docs/TransactionsApi.md
CHANGED
|
@@ -12,9 +12,11 @@ Method | HTTP request | Description
|
|
|
12
12
|
[**createTransferTransaction**](TransactionsApi.md#createTransferTransaction) | **POST** /transactions/transfer | Transfer token
|
|
13
13
|
[**dropTransactionById**](TransactionsApi.md#dropTransactionById) | **POST** /transactions/{transaction_id}/drop | Drop transaction
|
|
14
14
|
[**estimateFee**](TransactionsApi.md#estimateFee) | **POST** /transactions/estimate_fee | Estimate transaction fee
|
|
15
|
+
[**getTransactionApprovalDetail**](TransactionsApi.md#getTransactionApprovalDetail) | **GET** /transactions/{transaction_id}/approval_detail | Get transaction approval details
|
|
15
16
|
[**getTransactionById**](TransactionsApi.md#getTransactionById) | **GET** /transactions/{transaction_id} | Get transaction information
|
|
16
17
|
[**listTransactions**](TransactionsApi.md#listTransactions) | **GET** /transactions | List all transactions
|
|
17
18
|
[**resendTransactionById**](TransactionsApi.md#resendTransactionById) | **POST** /transactions/{transaction_id}/resend | Resend transaction
|
|
19
|
+
[**signAndBroadcastTransactionById**](TransactionsApi.md#signAndBroadcastTransactionById) | **POST** /transactions/{transaction_id}/sign_and_broadcast | Sign and broadcast transaction
|
|
18
20
|
[**speedupTransactionById**](TransactionsApi.md#speedupTransactionById) | **POST** /transactions/{transaction_id}/speedup | Speed up transaction
|
|
19
21
|
|
|
20
22
|
|
|
@@ -25,7 +27,7 @@ Method | HTTP request | Description
|
|
|
25
27
|
|
|
26
28
|
Broadcast signed transactions
|
|
27
29
|
|
|
28
|
-
<Note>This operation is only applicable to the staking scenarios.</Note> This operation broadcasts a list of signed transactions. If you set `auto_broadcast` to `false` when [creating a staking activity](/v2/api-references/staking/create-stake-activity), the transaction will not be submitted to the blockchain automatically after being signed. In such cases, you can call this operation to broadcast the transaction to the blockchain. A transaction can only be broadcast if its status is `Broadcasting`.
|
|
30
|
+
<Note>This operation is only applicable to the staking scenarios.</Note> This operation broadcasts a list of signed transactions. If you set `auto_broadcast` to `false` when [creating a staking activity](https://www.cobo.com/developers/v2/api-references/staking/create-stake-activity), the transaction will not be submitted to the blockchain automatically after being signed. In such cases, you can call this operation to broadcast the transaction to the blockchain. A transaction can only be broadcast if its status is `Broadcasting`.
|
|
29
31
|
|
|
30
32
|
### Example
|
|
31
33
|
|
|
@@ -63,7 +65,7 @@ Name | Type | Description | Notes
|
|
|
63
65
|
|
|
64
66
|
### Authorization
|
|
65
67
|
|
|
66
|
-
[
|
|
68
|
+
[OAuth2](../README.md#OAuth2)
|
|
67
69
|
|
|
68
70
|
### HTTP request headers
|
|
69
71
|
|
|
@@ -77,7 +79,7 @@ Name | Type | Description | Notes
|
|
|
77
79
|
|
|
78
80
|
Cancel transaction
|
|
79
81
|
|
|
80
|
-
This operation cancels a specified transaction. A transaction can be cancelled if its status is either of the following: - `Submitted` - `PendingScreening` - `PendingAuthorization` - `PendingSignature`
|
|
82
|
+
This operation cancels a specified transaction. Canceling a transaction stops it while it is still pending. For more information, see [Cancel a transaction](https://www.cobo.com/developers/v2/guides/transactions/manage-transactions#cancel-a-transaction). <Note>This operation only applies to transactions from MPC Wallets and Smart Contract Wallets.</Note> A transaction can be cancelled if its status is either of the following: - `Submitted` - `PendingScreening` - `PendingAuthorization` - `PendingSignature`
|
|
81
83
|
|
|
82
84
|
### Example
|
|
83
85
|
|
|
@@ -113,7 +115,7 @@ Name | Type | Description | Notes
|
|
|
113
115
|
|
|
114
116
|
### Authorization
|
|
115
117
|
|
|
116
|
-
[
|
|
118
|
+
[OAuth2](../README.md#OAuth2)
|
|
117
119
|
|
|
118
120
|
### HTTP request headers
|
|
119
121
|
|
|
@@ -157,7 +159,7 @@ apiInstance.checkLoopTransfers(token_id, source_wallet_id, destination_addresses
|
|
|
157
159
|
|
|
158
160
|
Name | Type | Description | Notes
|
|
159
161
|
------------- | ------------- | ------------- | -------------
|
|
160
|
-
**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). |
|
|
162
|
+
**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). |
|
|
161
163
|
**source_wallet_id** | **String**| The wallet ID of the transaction source. |
|
|
162
164
|
**destination_addresses** | **String**| A list of destination addresses, separated by comma. |
|
|
163
165
|
|
|
@@ -167,7 +169,7 @@ Name | Type | Description | Notes
|
|
|
167
169
|
|
|
168
170
|
### Authorization
|
|
169
171
|
|
|
170
|
-
[
|
|
172
|
+
[OAuth2](../README.md#OAuth2)
|
|
171
173
|
|
|
172
174
|
### HTTP request headers
|
|
173
175
|
|
|
@@ -219,7 +221,7 @@ Name | Type | Description | Notes
|
|
|
219
221
|
|
|
220
222
|
### Authorization
|
|
221
223
|
|
|
222
|
-
[OAuth2](../README.md#OAuth2)
|
|
224
|
+
[OAuth2](../README.md#OAuth2)
|
|
223
225
|
|
|
224
226
|
### HTTP request headers
|
|
225
227
|
|
|
@@ -233,7 +235,7 @@ Name | Type | Description | Notes
|
|
|
233
235
|
|
|
234
236
|
Sign message
|
|
235
237
|
|
|
236
|
-
This operation creates a transaction to sign the provided message using cryptographic techniques. In some scenarios, you want to sign a message for identity authentication or transaction approval. You need to provide details such as the source address, destination address, and the message to be signed. A transaction request for tracking is returned upon successful operation. You can get the signature result by calling [Get transaction information](/v2/api-references/transactions/get-transaction-information). <Note>This operation only applies to transactions from MPC Wallets.</Note>
|
|
238
|
+
This operation creates a transaction to sign the provided message using cryptographic techniques. In some scenarios, you want to sign a message for identity authentication or transaction approval. You need to provide details such as the source address, destination address, and the message to be signed. A transaction request for tracking is returned upon successful operation. You can get the signature result by calling [Get transaction information](https://www.cobo.com/developers/v2/api-references/transactions/get-transaction-information). <Note>This operation only applies to transactions from MPC Wallets.</Note>
|
|
237
239
|
|
|
238
240
|
### Example
|
|
239
241
|
|
|
@@ -271,7 +273,7 @@ Name | Type | Description | Notes
|
|
|
271
273
|
|
|
272
274
|
### Authorization
|
|
273
275
|
|
|
274
|
-
[OAuth2](../README.md#OAuth2)
|
|
276
|
+
[OAuth2](../README.md#OAuth2)
|
|
275
277
|
|
|
276
278
|
### HTTP request headers
|
|
277
279
|
|
|
@@ -285,7 +287,7 @@ Name | Type | Description | Notes
|
|
|
285
287
|
|
|
286
288
|
Transfer token
|
|
287
289
|
|
|
288
|
-
The operation transfers your assets from a wallet created on Cobo Portal to another address. You need to specify details such as the sender address and recipient address, token ID, and the amount to transfer. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation. <Note>If you make transfers from Custodial Wallets, do not set the fee-related properties
|
|
290
|
+
The operation transfers your assets from a wallet created on Cobo Portal to another address. You need to specify details such as the sender address and recipient address, token ID, and the amount to transfer. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation. <Note>If you make transfers from Custodial Wallets (Asset Wallets) and Exchange Wallets, do not set the fee-related properties, as they will not take effects.</Note> <Note>You can transfer tokens to multiple addresses only if you use MPC Wallets as the transaction source. You should use the <code>utxo_outputs</code> property to specify the destination addresses.</Note> <Info>If you initiate a transaction from a Smart Contract Wallet, a relevant transaction will be triggered from the Delegate to the Cobo Safe's address of the Smart Contract Wallet, with a transfer amount of <code>0</code>.</Info>
|
|
289
291
|
|
|
290
292
|
### Example
|
|
291
293
|
|
|
@@ -323,7 +325,7 @@ Name | Type | Description | Notes
|
|
|
323
325
|
|
|
324
326
|
### Authorization
|
|
325
327
|
|
|
326
|
-
[OAuth2](../README.md#OAuth2)
|
|
328
|
+
[OAuth2](../README.md#OAuth2)
|
|
327
329
|
|
|
328
330
|
### HTTP request headers
|
|
329
331
|
|
|
@@ -337,7 +339,7 @@ Name | Type | Description | Notes
|
|
|
337
339
|
|
|
338
340
|
Drop transaction
|
|
339
341
|
|
|
340
|
-
This operation drops a specified transaction.
|
|
342
|
+
This operation drops a specified transaction. Dropping a transaction leverages RBF to replace the original transaction with a version that effectively cancels it. For more details about dropping a transaction, refer to [Drop a transaction](https://www.cobo.com/developers/v2/guides/transactions/manage-transactions#drop-a-transaction). A transaction can be sped up only if its status is `Broadcasting`. <Note>This operation only applies to transactions from MPC Wallets and Smart Contract Wallets. It does not apply to transactions on the following chains: VET, TRON, TVET, SOL, and TON.</Note> You can use the `address` or `included_utxos` properties in the request body to specify the address or UTXOs that will cover the transaction fee. Generally, the transaction fee is paid by the original transaction's source. If that source's balance is insufficient, the specified address or UTXOs can be used to cover the fee.
|
|
341
343
|
|
|
342
344
|
### Example
|
|
343
345
|
|
|
@@ -377,7 +379,7 @@ Name | Type | Description | Notes
|
|
|
377
379
|
|
|
378
380
|
### Authorization
|
|
379
381
|
|
|
380
|
-
[
|
|
382
|
+
[OAuth2](../README.md#OAuth2)
|
|
381
383
|
|
|
382
384
|
### HTTP request headers
|
|
383
385
|
|
|
@@ -391,7 +393,7 @@ Name | Type | Description | Notes
|
|
|
391
393
|
|
|
392
394
|
Estimate transaction fee
|
|
393
395
|
|
|
394
|
-
This operation estimates the transaction fee of a token transfer or a contract call based on the fee model that the chain uses, considering factors such as network congestion and transaction complexity. You need to specify the transaction information, including the request ID, request type, source address, destination address, token ID (only applicable to token transfers), and chain ID (only applicable to contract calls). The response can contain different properties based on the transaction fee model used by the chain. For the legacy, EIP-1559, and UTXO fee models, Cobo also supports three different transaction speed levels: slow, recommended, and fast. For more information about estimating transaction fees, refer to [Estimate transaction fee](/v2/guides/transactions/estimate-fees).
|
|
396
|
+
This operation estimates the transaction fee of a token transfer or a contract call based on the fee model that the chain uses, considering factors such as network congestion and transaction complexity. You need to specify the transaction information, including the request ID, request type, source address, destination address, token ID (only applicable to token transfers), and chain ID (only applicable to contract calls). The response can contain different properties based on the transaction fee model used by the chain. For the legacy, EIP-1559, and UTXO fee models, Cobo also supports three different transaction speed levels: slow, recommended, and fast. For more information about estimating transaction fees, refer to [Estimate transaction fee](https://www.cobo.com/developers/v2/guides/transactions/estimate-fees).
|
|
395
397
|
|
|
396
398
|
### Example
|
|
397
399
|
|
|
@@ -429,7 +431,7 @@ Name | Type | Description | Notes
|
|
|
429
431
|
|
|
430
432
|
### Authorization
|
|
431
433
|
|
|
432
|
-
[
|
|
434
|
+
[OAuth2](../README.md#OAuth2)
|
|
433
435
|
|
|
434
436
|
### HTTP request headers
|
|
435
437
|
|
|
@@ -437,6 +439,56 @@ Name | Type | Description | Notes
|
|
|
437
439
|
- **Accept**: application/json
|
|
438
440
|
|
|
439
441
|
|
|
442
|
+
## getTransactionApprovalDetail
|
|
443
|
+
|
|
444
|
+
> TransactionApprovalDetail getTransactionApprovalDetail(transaction_id)
|
|
445
|
+
|
|
446
|
+
Get transaction approval details
|
|
447
|
+
|
|
448
|
+
This operation retrieves approval detailed information about a specified transaction.
|
|
449
|
+
|
|
450
|
+
### Example
|
|
451
|
+
|
|
452
|
+
```javascript
|
|
453
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
454
|
+
// Initialize the API client
|
|
455
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
456
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
457
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
458
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
459
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
460
|
+
// Call the API
|
|
461
|
+
const apiInstance = new CoboWaas2.TransactionsApi();
|
|
462
|
+
const transaction_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
463
|
+
apiInstance.getTransactionApprovalDetail(transaction_id).then((data) => {
|
|
464
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
465
|
+
}, (error) => {
|
|
466
|
+
console.error(error);
|
|
467
|
+
});
|
|
468
|
+
|
|
469
|
+
```
|
|
470
|
+
|
|
471
|
+
### Parameters
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
Name | Type | Description | Notes
|
|
475
|
+
------------- | ------------- | ------------- | -------------
|
|
476
|
+
**transaction_id** | **String**| The transaction ID. |
|
|
477
|
+
|
|
478
|
+
### Return type
|
|
479
|
+
|
|
480
|
+
[**TransactionApprovalDetail**](TransactionApprovalDetail.md)
|
|
481
|
+
|
|
482
|
+
### Authorization
|
|
483
|
+
|
|
484
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
485
|
+
|
|
486
|
+
### HTTP request headers
|
|
487
|
+
|
|
488
|
+
- **Content-Type**: Not defined
|
|
489
|
+
- **Accept**: application/json
|
|
490
|
+
|
|
491
|
+
|
|
440
492
|
## getTransactionById
|
|
441
493
|
|
|
442
494
|
> TransactionDetail getTransactionById(transaction_id)
|
|
@@ -479,7 +531,7 @@ Name | Type | Description | Notes
|
|
|
479
531
|
|
|
480
532
|
### Authorization
|
|
481
533
|
|
|
482
|
-
[
|
|
534
|
+
[OAuth2](../README.md#OAuth2)
|
|
483
535
|
|
|
484
536
|
### HTTP request headers
|
|
485
537
|
|
|
@@ -546,16 +598,16 @@ Name | Type | Description | Notes
|
|
|
546
598
|
**types** | **String**| A list of transaction types, separated by comma. Possible values include: - `Deposit`: A deposit transaction. - `Withdrawal`: A withdrawal transaction. - `ContractCall`: A transaction that interacts with a smart contract. - `MessageSign`: A transaction that signs a message. - `ExternalSafeTx`: A transaction to a Smart Contract Wallet (Safe{Wallet}) that requires one or multiple signatures to be executed. - `Stake`: A transaction that creates a staking request. - `Unstake`: A transaction that creates a unstaking request. | [optional]
|
|
547
599
|
**statuses** | **String**| A list of transaction statuses, separated by comma. Possible values include: - `Submitted`: The transaction is submitted. - `PendingScreening`: The transaction is pending screening by Risk Control. - `PendingAuthorization`: The transaction is pending approvals. - `PendingSignature`: The transaction is pending signature. - `Broadcasting`: The transaction is being broadcast. - `Confirming`: The transaction is waiting for the required number of confirmations. - `Completed`: The transaction is completed. - `Failed`: The transaction failed. - `Rejected`: The transaction is rejected. - `Pending`: The transaction is waiting to be included in the next block of the blockchain. | [optional]
|
|
548
600
|
**wallet_ids** | **String**| A list of wallet IDs, separated by comma. | [optional]
|
|
549
|
-
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID 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]
|
|
550
|
-
**token_ids** | **String**| A list of token IDs, separated by comma. The token ID 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]
|
|
601
|
+
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID 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]
|
|
602
|
+
**token_ids** | **String**| A list of token IDs, separated by comma. The token ID 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]
|
|
551
603
|
**asset_ids** | **String**| (This concept applies to Exchange Wallets only) A list of asset IDs, separated by comma. An asset ID is the unique identifier of the asset held within your linked exchange account. | [optional]
|
|
552
|
-
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallets/list-all-vaults). | [optional]
|
|
553
|
-
**project_id** | **String**| The project ID, which you can retrieve by calling [List all projects](/v2/api-references/wallets--mpc-wallets/list-all-projects). | [optional]
|
|
604
|
+
**vault_id** | **String**| The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). | [optional]
|
|
605
|
+
**project_id** | **String**| The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects). | [optional]
|
|
554
606
|
**min_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time. | [optional]
|
|
555
607
|
**max_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time. | [optional]
|
|
556
608
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
557
|
-
**before** | **String**|
|
|
558
|
-
**after** | **String**|
|
|
609
|
+
**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]
|
|
610
|
+
**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]
|
|
559
611
|
|
|
560
612
|
### Return type
|
|
561
613
|
|
|
@@ -563,7 +615,7 @@ Name | Type | Description | Notes
|
|
|
563
615
|
|
|
564
616
|
### Authorization
|
|
565
617
|
|
|
566
|
-
[
|
|
618
|
+
[OAuth2](../README.md#OAuth2)
|
|
567
619
|
|
|
568
620
|
### HTTP request headers
|
|
569
621
|
|
|
@@ -577,7 +629,7 @@ Name | Type | Description | Notes
|
|
|
577
629
|
|
|
578
630
|
Resend transaction
|
|
579
631
|
|
|
580
|
-
This operation resends a specified transaction. Resending a transaction
|
|
632
|
+
This operation resends a specified transaction. Resending a transaction means retrying a previously failed transaction. For more details about resending a transaction, see [Resend a transaction](/v2/guides/transactions/manage-transactions#resend-a-transaction). A transaction can be resent if its status is `failed`. <Note>This operation only applies to transactions from MPC Wallets in the SOL token.</Note>
|
|
581
633
|
|
|
582
634
|
### Example
|
|
583
635
|
|
|
@@ -617,7 +669,7 @@ Name | Type | Description | Notes
|
|
|
617
669
|
|
|
618
670
|
### Authorization
|
|
619
671
|
|
|
620
|
-
[
|
|
672
|
+
[OAuth2](../README.md#OAuth2)
|
|
621
673
|
|
|
622
674
|
### HTTP request headers
|
|
623
675
|
|
|
@@ -625,13 +677,63 @@ Name | Type | Description | Notes
|
|
|
625
677
|
- **Accept**: application/json
|
|
626
678
|
|
|
627
679
|
|
|
680
|
+
## signAndBroadcastTransactionById
|
|
681
|
+
|
|
682
|
+
> CreateTransferTransaction201Response signAndBroadcastTransactionById(transaction_id)
|
|
683
|
+
|
|
684
|
+
Sign and broadcast transaction
|
|
685
|
+
|
|
686
|
+
This operation signs and broadcasts a specified transaction. To call this operation, the following conditions must be met: - The `transaction_process_type` of the transaction must be set to `BuildOnly` when you call the [Transfer token](https://www.cobo.com/developers/v2/api-references/transactions/transfer-token) or [Call smart contract](https://www.cobo.com/developers/v2/api-references/transactions/call-smart-contract) operation. - The transaction status must be `Built`.
|
|
687
|
+
|
|
688
|
+
### Example
|
|
689
|
+
|
|
690
|
+
```javascript
|
|
691
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
692
|
+
// Initialize the API client
|
|
693
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
694
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
695
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
696
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
697
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
698
|
+
// Call the API
|
|
699
|
+
const apiInstance = new CoboWaas2.TransactionsApi();
|
|
700
|
+
const transaction_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
701
|
+
apiInstance.signAndBroadcastTransactionById(transaction_id).then((data) => {
|
|
702
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
703
|
+
}, (error) => {
|
|
704
|
+
console.error(error);
|
|
705
|
+
});
|
|
706
|
+
|
|
707
|
+
```
|
|
708
|
+
|
|
709
|
+
### Parameters
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
Name | Type | Description | Notes
|
|
713
|
+
------------- | ------------- | ------------- | -------------
|
|
714
|
+
**transaction_id** | **String**| The transaction ID. |
|
|
715
|
+
|
|
716
|
+
### Return type
|
|
717
|
+
|
|
718
|
+
[**CreateTransferTransaction201Response**](CreateTransferTransaction201Response.md)
|
|
719
|
+
|
|
720
|
+
### Authorization
|
|
721
|
+
|
|
722
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
723
|
+
|
|
724
|
+
### HTTP request headers
|
|
725
|
+
|
|
726
|
+
- **Content-Type**: Not defined
|
|
727
|
+
- **Accept**: application/json
|
|
728
|
+
|
|
729
|
+
|
|
628
730
|
## speedupTransactionById
|
|
629
731
|
|
|
630
732
|
> CreateTransferTransaction201Response speedupTransactionById(transaction_id, opts)
|
|
631
733
|
|
|
632
734
|
Speed up transaction
|
|
633
735
|
|
|
634
|
-
This operation accelerates a specified transaction.
|
|
736
|
+
This operation accelerates a specified transaction. Speeding up a transaction will trigger a Replace-By-Fee (RBF) transaction which is a new version of the original transaction. For more details about speeding up a transaction, refer to [Speed up a transaction](/v2/guides/transactions/manage-transactions#speed-up-a-transaction). You can use the `address` or `included_utxos` properties in the request body to specify the address or UTXOs that will cover the transaction fee. Generally, the transaction fee is paid by the original transaction's source. If that source's balance is insufficient, the specified address or UTXOs can be used to cover the fee. A transaction can be sped up only if its status is `Broadcasting`. <Note>This operation only applies to transactions from MPC Wallets and Smart Contract Wallets. It does not apply to transactions on the following chains: VET, TRON, TVET, SOL, and TON.</Note> <Info>If you speed up a transaction from a Smart Contract Wallet, two RBF transactions will be triggered, one for the transaction from the Smart Contract Wallet, and the other for the transaction from the Delegate.</Info>
|
|
635
737
|
|
|
636
738
|
### Example
|
|
637
739
|
|
|
@@ -671,7 +773,7 @@ Name | Type | Description | Notes
|
|
|
671
773
|
|
|
672
774
|
### Authorization
|
|
673
775
|
|
|
674
|
-
[
|
|
776
|
+
[OAuth2](../README.md#OAuth2)
|
|
675
777
|
|
|
676
778
|
### HTTP request headers
|
|
677
779
|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**account_output** | [**AddressTransferDestinationAccountOutput**](AddressTransferDestinationAccountOutput.md) | | [optional]
|
|
9
9
|
**utxo_outputs** | [**[AddressTransferDestinationUtxoOutputsInner]**](AddressTransferDestinationUtxoOutputsInner.md) | | [optional]
|
|
10
10
|
**change_address** | **String** | The address used to receive the remaining funds or change from the transaction. | [optional]
|
|
11
|
+
**change_output_type** | **String** | The position of the change output in the transaction's outputs. Possible values are: - `Last`: The change output is placed at the end of the transaction's outputs. - `First`: The change output is placed at the beginning of the transaction's outputs. | [optional]
|
|
11
12
|
**force_internal** | **Boolean** | Whether the transaction request must be executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - `true`: The transaction request must be executed as a Cobo Loop transfer. - `false`: The transaction request may not be executed as a Cobo Loop transfer. Please do not set both `force_internal` and `force_external` as `true`. | [optional]
|
|
12
13
|
**force_external** | **Boolean** | Whether the transaction request must not be executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - `true`: The transaction request must not be executed as a Cobo Loop transfer. - `false`: The transaction request can be executed as a Cobo Loop transfer. Please do not set both `force_internal` and `force_external` as `true`. | [optional]
|
|
13
14
|
**wallet_id** | **String** | The wallet ID. |
|
|
@@ -15,3 +16,16 @@ Name | Type | Description | Notes
|
|
|
15
16
|
**amount** | **String** | The transfer amount. For example, if you trade 1.5 BTC, then the value is `1.5`. |
|
|
16
17
|
|
|
17
18
|
|
|
19
|
+
|
|
20
|
+
## Enum: ChangeOutputTypeEnum
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
* `Last` (value: `"Last"`)
|
|
24
|
+
|
|
25
|
+
* `First` (value: `"First"`)
|
|
26
|
+
|
|
27
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
package/docs/TransferParams.md
CHANGED
|
@@ -6,11 +6,25 @@ 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
8
|
**source** | [**TransferSource**](TransferSource.md) | |
|
|
9
|
-
**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). For transfers from Exchange Wallets, this property value represents the asset ID. |
|
|
9
|
+
**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). For transfers from Exchange Wallets, this property value represents the asset ID. |
|
|
10
10
|
**destination** | [**TransferDestination**](TransferDestination.md) | |
|
|
11
11
|
**category_names** | **[String]** | The custom category for you to identify your transactions. | [optional]
|
|
12
12
|
**description** | **String** | The description of the transfer. | [optional]
|
|
13
13
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
|
|
14
|
+
**transaction_process_type** | **String** | Transaction processing type. Possible values are: - `AutoProcess` (default): After the transaction is constructed, it will be automatically signed and broadcast. - `BuildOnly`: Set to this value if you want to build the transaction first without automatically signing and broadcasting it. You can manually call the [Sign and broadcast transaction](https://www.cobo.com/developers/v2/api-references/transactions/sign-and-broadcast-transaction) operation to complete the signing and broadcasting process. | [optional]
|
|
14
15
|
**auto_fuel** | [**AutoFuelType**](AutoFuelType.md) | | [optional]
|
|
15
16
|
|
|
16
17
|
|
|
18
|
+
|
|
19
|
+
## Enum: TransactionProcessTypeEnum
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
* `AutoProcess` (value: `"AutoProcess"`)
|
|
23
|
+
|
|
24
|
+
* `BuildOnly` (value: `"BuildOnly"`)
|
|
25
|
+
|
|
26
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**getTransactionLimitation**](TravelRuleApi.md#getTransactionLimitation) | **GET** /travel_rule/transaction/limitation | Retrieve transaction limitations
|
|
8
|
+
[**listSupportedCountries**](TravelRuleApi.md#listSupportedCountries) | **GET** /travel_rule/transaction/countries | List supported countries
|
|
9
|
+
[**submitDepositTravelRuleInfo**](TravelRuleApi.md#submitDepositTravelRuleInfo) | **POST** /travel_rule/transaction/deposit/travel_rule_info | Submit Travel Rule information for deposits
|
|
10
|
+
[**submitWithdrawTravelRuleInfo**](TravelRuleApi.md#submitWithdrawTravelRuleInfo) | **POST** /travel_rule/transaction/withdraw/travel_rule_info | Submit Travel Rule information for withdrawals
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## getTransactionLimitation
|
|
15
|
+
|
|
16
|
+
> GetTransactionLimitation200Response getTransactionLimitation(transaction_type, transaction_id)
|
|
17
|
+
|
|
18
|
+
Retrieve transaction limitations
|
|
19
|
+
|
|
20
|
+
This operation retrieves Travel Rule requirements and available options for a transaction based on its transaction type and ID. Use this endpoint before submitting Travel Rule information to understand the requirements and available options for your transaction.
|
|
21
|
+
|
|
22
|
+
### Example
|
|
23
|
+
|
|
24
|
+
```javascript
|
|
25
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
26
|
+
// Initialize the API client
|
|
27
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
28
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
29
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
30
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
31
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
32
|
+
// Call the API
|
|
33
|
+
const apiInstance = new CoboWaas2.TravelRuleApi();
|
|
34
|
+
const transaction_type = "DEPOSIT";
|
|
35
|
+
const transaction_id = "123e4567-e89b-12d3-a456-426614174000";
|
|
36
|
+
apiInstance.getTransactionLimitation(transaction_type, transaction_id).then((data) => {
|
|
37
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
38
|
+
}, (error) => {
|
|
39
|
+
console.error(error);
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Parameters
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
Name | Type | Description | Notes
|
|
48
|
+
------------- | ------------- | ------------- | -------------
|
|
49
|
+
**transaction_type** | **String**| The transaction type. Possible values include: - `DEPOSIT`: A deposit transaction. - `WITHDRAW`: A withdrawal transaction. |
|
|
50
|
+
**transaction_id** | **String**| The transaction ID. |
|
|
51
|
+
|
|
52
|
+
### Return type
|
|
53
|
+
|
|
54
|
+
[**GetTransactionLimitation200Response**](GetTransactionLimitation200Response.md)
|
|
55
|
+
|
|
56
|
+
### Authorization
|
|
57
|
+
|
|
58
|
+
[OAuth2](../README.md#OAuth2)
|
|
59
|
+
|
|
60
|
+
### HTTP request headers
|
|
61
|
+
|
|
62
|
+
- **Content-Type**: Not defined
|
|
63
|
+
- **Accept**: application/json
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
## listSupportedCountries
|
|
67
|
+
|
|
68
|
+
> [ListSupportedCountries200ResponseInner] listSupportedCountries()
|
|
69
|
+
|
|
70
|
+
List supported countries
|
|
71
|
+
|
|
72
|
+
This operation retrieves a list of supported countries that can be used when submitting Travel Rule information. Use this endpoint to obtain valid country values for: - Place of incorporation of a legal entity - Place of birth of a natural person
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```javascript
|
|
77
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
78
|
+
// Initialize the API client
|
|
79
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
80
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
81
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
82
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
83
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
84
|
+
// Call the API
|
|
85
|
+
const apiInstance = new CoboWaas2.TravelRuleApi();
|
|
86
|
+
apiInstance.listSupportedCountries().then((data) => {
|
|
87
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
88
|
+
}, (error) => {
|
|
89
|
+
console.error(error);
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
This endpoint does not need any parameter.
|
|
97
|
+
|
|
98
|
+
### Return type
|
|
99
|
+
|
|
100
|
+
[**[ListSupportedCountries200ResponseInner]**](ListSupportedCountries200ResponseInner.md)
|
|
101
|
+
|
|
102
|
+
### Authorization
|
|
103
|
+
|
|
104
|
+
[OAuth2](../README.md#OAuth2)
|
|
105
|
+
|
|
106
|
+
### HTTP request headers
|
|
107
|
+
|
|
108
|
+
- **Content-Type**: Not defined
|
|
109
|
+
- **Accept**: application/json
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
## submitDepositTravelRuleInfo
|
|
113
|
+
|
|
114
|
+
> SubmitDepositTravelRuleInfo201Response submitDepositTravelRuleInfo(opts)
|
|
115
|
+
|
|
116
|
+
Submit Travel Rule information for deposits
|
|
117
|
+
|
|
118
|
+
This operation submits Travel Rule information for a deposit transaction.
|
|
119
|
+
|
|
120
|
+
### Example
|
|
121
|
+
|
|
122
|
+
```javascript
|
|
123
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
124
|
+
// Initialize the API client
|
|
125
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
126
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
127
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
128
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
129
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
130
|
+
// Call the API
|
|
131
|
+
const apiInstance = new CoboWaas2.TravelRuleApi();
|
|
132
|
+
const opts = {
|
|
133
|
+
'TravelRuleDepositRequest': new CoboWaas2.TravelRuleDepositRequest()
|
|
134
|
+
};
|
|
135
|
+
apiInstance.submitDepositTravelRuleInfo(opts).then((data) => {
|
|
136
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
137
|
+
}, (error) => {
|
|
138
|
+
console.error(error);
|
|
139
|
+
});
|
|
140
|
+
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Parameters
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
Name | Type | Description | Notes
|
|
147
|
+
------------- | ------------- | ------------- | -------------
|
|
148
|
+
**TravelRuleDepositRequest** | [**TravelRuleDepositRequest**](TravelRuleDepositRequest.md)| | [optional]
|
|
149
|
+
|
|
150
|
+
### Return type
|
|
151
|
+
|
|
152
|
+
[**SubmitDepositTravelRuleInfo201Response**](SubmitDepositTravelRuleInfo201Response.md)
|
|
153
|
+
|
|
154
|
+
### Authorization
|
|
155
|
+
|
|
156
|
+
[OAuth2](../README.md#OAuth2)
|
|
157
|
+
|
|
158
|
+
### HTTP request headers
|
|
159
|
+
|
|
160
|
+
- **Content-Type**: application/json
|
|
161
|
+
- **Accept**: application/json
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
## submitWithdrawTravelRuleInfo
|
|
165
|
+
|
|
166
|
+
> SubmitDepositTravelRuleInfo201Response submitWithdrawTravelRuleInfo(opts)
|
|
167
|
+
|
|
168
|
+
Submit Travel Rule information for withdrawals
|
|
169
|
+
|
|
170
|
+
This operation submits Travel Rule information for a withdrawal transaction.
|
|
171
|
+
|
|
172
|
+
### Example
|
|
173
|
+
|
|
174
|
+
```javascript
|
|
175
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
176
|
+
// Initialize the API client
|
|
177
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
178
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
179
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
180
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
181
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
182
|
+
// Call the API
|
|
183
|
+
const apiInstance = new CoboWaas2.TravelRuleApi();
|
|
184
|
+
const opts = {
|
|
185
|
+
'TravelRuleWithdrawRequest': new CoboWaas2.TravelRuleWithdrawRequest()
|
|
186
|
+
};
|
|
187
|
+
apiInstance.submitWithdrawTravelRuleInfo(opts).then((data) => {
|
|
188
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
189
|
+
}, (error) => {
|
|
190
|
+
console.error(error);
|
|
191
|
+
});
|
|
192
|
+
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### Parameters
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
Name | Type | Description | Notes
|
|
199
|
+
------------- | ------------- | ------------- | -------------
|
|
200
|
+
**TravelRuleWithdrawRequest** | [**TravelRuleWithdrawRequest**](TravelRuleWithdrawRequest.md)| | [optional]
|
|
201
|
+
|
|
202
|
+
### Return type
|
|
203
|
+
|
|
204
|
+
[**SubmitDepositTravelRuleInfo201Response**](SubmitDepositTravelRuleInfo201Response.md)
|
|
205
|
+
|
|
206
|
+
### Authorization
|
|
207
|
+
|
|
208
|
+
[OAuth2](../README.md#OAuth2)
|
|
209
|
+
|
|
210
|
+
### HTTP request headers
|
|
211
|
+
|
|
212
|
+
- **Content-Type**: application/json
|
|
213
|
+
- **Accept**: application/json
|
|
214
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CoboWaas2.TravelRuleDepositExchangesOrVASP
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) | |
|
|
8
|
+
**vendor_code** | **String** | The vendor code of the VASP. |
|
|
9
|
+
**vendor_vasp_id** | **String** | The unique identifier of the VASP. |
|
|
10
|
+
**vendor_vasp_name** | **String** | The vendor name. Use this field to specify the name of a vendor not listed. | [optional]
|
|
11
|
+
**entity_info** | [**TravelRuleDepositExchangesOrVASPEntityInfo**](TravelRuleDepositExchangesOrVASPEntityInfo.md) | |
|
|
12
|
+
|
|
13
|
+
|