@cobo/cobo-waas2 1.7.0 → 1.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -3
- package/dist/ApiClient.js +1 -1
- package/dist/api/AddressBooksApi.js +6 -6
- package/dist/api/DevelopersApi.js +110 -0
- package/dist/api/DevelopersWebhooksApi.js +30 -30
- package/dist/api/OAuthApi.js +2 -2
- package/dist/api/StakingsApi.js +33 -30
- package/dist/api/TransactionsApi.js +73 -28
- package/dist/api/TravelRuleApi.js +216 -0
- package/dist/api/WalletsApi.js +68 -68
- package/dist/api/WalletsExchangeWalletApi.js +12 -12
- package/dist/api/WalletsMPCWalletsApi.js +60 -60
- package/dist/index.js +273 -0
- package/dist/model/Activity.js +29 -0
- package/dist/model/ActivityAction.js +30 -0
- package/dist/model/ActivityExtra.js +274 -0
- package/dist/model/AddressInfo.js +15 -2
- package/dist/model/AddressTransferDestination.js +1 -1
- package/dist/model/AddressesEventData.js +190 -0
- package/dist/model/ApiLogDetails.js +2 -2
- package/dist/model/BabylonStakeExtra.js +1 -1
- package/dist/model/BabylonStakingActivityDetailExtra.js +165 -0
- package/dist/model/BaseContractCallSource.js +1 -1
- package/dist/model/BroadcastSignedTransactionsRequest.js +1 -1
- package/dist/model/CallbackMessage.js +288 -0
- package/dist/model/ChainInfo.js +2 -2
- package/dist/model/ContractCallParams.js +2 -2
- package/dist/model/CoreStakingActivityDetailExtra.js +164 -0
- package/dist/model/CreateAddressRequest.js +2 -2
- package/dist/model/CreateClaimActivity.js +2 -2
- package/dist/model/CreateClaimActivityRequest.js +3 -3
- package/dist/model/CreateKeyShareHolder.js +1 -1
- package/dist/model/CreateMpcVaultRequest.js +1 -1
- package/dist/model/CreateMpcWalletParams.js +2 -2
- package/dist/model/CreateStakeActivity.js +4 -6
- package/dist/model/CreateStakeActivityExtra.js +1 -1
- package/dist/model/CreateStakeActivityRequest.js +5 -7
- package/dist/model/CreateWalletParams.js +1 -1
- package/dist/model/CreateWebhookEndpointRequest.js +2 -2
- package/dist/model/CustodialTransferSource.js +1 -1
- package/dist/model/DestinationWalletType.js +61 -0
- package/dist/model/ErrorResponse.js +2 -2
- package/dist/model/EstimateClaimFee.js +1 -1
- package/dist/model/EstimateContractCallFeeParams.js +2 -2
- package/dist/model/EstimateFeeParams.js +2 -2
- package/dist/model/EstimateStakeFee.js +5 -7
- package/dist/model/EstimateTransferFeeParams.js +2 -2
- package/dist/model/EthStakeEstimatedFee.js +13 -0
- package/dist/model/EthStakingActivityDetailExtra.js +142 -0
- package/dist/model/EvmContractCallDestination.js +1 -1
- package/dist/model/EvmEIP191MessageSignDestination.js +1 -1
- package/dist/model/EvmEIP712MessageSignDestination.js +1 -1
- package/dist/model/ExchangeTransferDestination.js +1 -1
- package/dist/model/ExchangeTransferSource.js +1 -1
- package/dist/model/ExtendedTokenInfo.js +3 -3
- package/dist/model/GetStakingEstimationFee201Response.js +6 -0
- package/dist/model/GetStakingEstimationFeeRequest.js +1 -1
- package/dist/model/GetTransactionLimitation200Response.js +143 -0
- package/dist/model/ListCallbackMessages200Response.js +145 -0
- package/dist/model/ListSupportedCountries200ResponseInner.js +140 -0
- package/dist/model/LockUtxosRequestUtxosInner.js +2 -2
- package/dist/model/MPCDelegate.js +1 -1
- package/dist/model/MPCVaultEventData.js +279 -0
- package/dist/model/MaxTransferableValue.js +1 -1
- package/dist/model/MessageSignParams.js +2 -2
- package/dist/model/MpcTransferSource.js +1 -1
- package/dist/model/OrgInfo.js +133 -0
- package/dist/model/Pagination.js +4 -4
- package/dist/model/RawMessageSignDestination.js +1 -1
- package/dist/model/RetryCallbackMessage201Response.js +83 -0
- package/dist/model/SafeContractCallSource.js +1 -1
- package/dist/model/SafeTransferSource.js +1 -1
- package/dist/model/SelectedEntityType.js +61 -0
- package/dist/model/SelfCustodyWallet.js +152 -0
- package/dist/model/SourceGroup.js +1 -1
- package/dist/model/StakingPoolId.js +5 -0
- package/dist/model/StakingPoolType.js +5 -0
- package/dist/model/SubmitDepositTravelRuleInfo201Response.js +83 -0
- package/dist/model/SwapActivity.js +218 -0
- package/dist/model/SwapSummary.js +121 -0
- package/dist/model/SwapTokenPair.js +100 -0
- package/dist/model/TSSRequestWebhookEventData.js +18 -3
- package/dist/model/TokenBalance.js +2 -2
- package/dist/model/TokenBalanceBalance.js +6 -6
- package/dist/model/TokenInfo.js +2 -2
- package/dist/model/Transaction.js +2 -2
- package/dist/model/TransactionApprovalDetail.js +121 -0
- package/dist/model/TransactionApprovalResult.js +66 -0
- package/dist/model/TransactionCustodialAssetWalletSource.js +1 -1
- package/dist/model/TransactionDepositFromAddressSource.js +1 -1
- package/dist/model/TransactionDepositFromLoopSource.js +1 -1
- package/dist/model/TransactionDepositFromWalletSource.js +1 -1
- package/dist/model/TransactionDepositToAddressDestination.js +1 -1
- package/dist/model/TransactionDepositToWalletDestination.js +1 -1
- package/dist/model/TransactionDetail.js +4 -4
- package/dist/model/TransactionDetails.js +4 -4
- package/dist/model/TransactionEvmContractDestination.js +1 -1
- package/dist/model/TransactionExchangeWalletSource.js +1 -1
- package/dist/model/TransactionMPCWalletSource.js +1 -1
- package/dist/model/TransactionMessageSignEIP191Destination.js +1 -1
- package/dist/model/TransactionMessageSignEIP712Destination.js +1 -1
- package/dist/model/TransactionRawMessageSignDestination.js +1 -1
- package/dist/model/TransactionRawTxInfo.js +4 -4
- package/dist/model/TransactionRequestEvmEip1559Fee.js +1 -1
- package/dist/model/TransactionRequestEvmLegacyFee.js +1 -1
- package/dist/model/TransactionRequestFixedFee.js +1 -1
- package/dist/model/TransactionRequestUtxoFee.js +1 -1
- package/dist/model/TransactionRoleApprovalDetail.js +152 -0
- package/dist/model/TransactionSelectedUtxo.js +123 -0
- package/dist/model/TransactionSmartContractSafeWalletSource.js +1 -1
- package/dist/model/TransactionTokeApproval.js +3 -3
- package/dist/model/TransactionTokenAmount.js +1 -1
- package/dist/model/TransactionTransferToAddressDestination.js +1 -1
- package/dist/model/TransactionTransferToWalletDestination.js +1 -1
- package/dist/model/TransactionUserApprovalDetail.js +162 -0
- package/dist/model/TransactionWebhookEventData.js +22 -7
- package/dist/model/TransferParams.js +2 -2
- package/dist/model/TravelRuleDepositExchangesOrVASP.js +168 -0
- package/dist/model/TravelRuleDepositExchangesOrVASPEntityInfo.js +222 -0
- package/dist/model/TravelRuleDepositLegalEntity.js +171 -0
- package/dist/model/TravelRuleDepositNaturalEntity.js +186 -0
- package/dist/model/TravelRuleDepositRequest.js +128 -0
- package/dist/model/TravelRuleDepositRequestTravelRuleInfo.js +222 -0
- package/dist/model/TravelRuleWithdrawExchangesOrVASP.js +155 -0
- package/dist/model/TravelRuleWithdrawExchangesOrVASPEntityInfo.js +222 -0
- package/dist/model/TravelRuleWithdrawLegalEntity.js +144 -0
- package/dist/model/TravelRuleWithdrawNaturalEntity.js +159 -0
- package/dist/model/TravelRuleWithdrawRequest.js +128 -0
- package/dist/model/TravelRuleWithdrawRequestTravelRuleInfo.js +216 -0
- package/dist/model/TriggerTestWebhookEventRequest.js +1 -1
- package/dist/model/UpdateWebhookEndpointByIdRequest.js +1 -1
- package/dist/model/Vasp.js +141 -0
- package/dist/model/WalletInfoEventData.js +175 -0
- package/dist/model/WebhookEventData.js +135 -14
- package/dist/model/WebhookEventDataType.js +17 -2
- package/dist/model/WebhookEventType.js +23 -8
- package/docs/Activity.md +2 -0
- package/docs/ActivityAction.md +12 -0
- package/docs/ActivityExtra.md +20 -0
- package/docs/AddressBooksApi.md +3 -3
- package/docs/AddressInfo.md +2 -1
- package/docs/AddressesEventData.md +29 -0
- package/docs/ApiLogDetails.md +1 -1
- package/docs/BabylonStakeExtra.md +1 -1
- package/docs/BabylonStakingActivityDetailExtra.md +14 -0
- package/docs/BroadcastSignedTransactionsRequest.md +1 -1
- package/docs/CallbackMessage.md +46 -0
- package/docs/ChainInfo.md +1 -1
- package/docs/ContractCallParams.md +1 -1
- package/docs/CoreStakingActivityDetailExtra.md +13 -0
- package/docs/CreateAddressRequest.md +1 -1
- package/docs/CreateClaimActivity.md +1 -1
- package/docs/CreateClaimActivityRequest.md +1 -1
- package/docs/CreateKeyShareHolder.md +1 -1
- package/docs/CreateMpcVaultRequest.md +1 -1
- package/docs/CreateMpcWalletParams.md +1 -1
- package/docs/CreateStakeActivity.md +1 -1
- package/docs/CreateStakeActivityExtra.md +1 -1
- package/docs/CreateStakeActivityRequest.md +1 -1
- package/docs/CreateWalletParams.md +1 -1
- package/docs/CreateWebhookEndpointRequest.md +1 -1
- package/docs/DestinationWalletType.md +12 -0
- package/docs/DevelopersApi.md +118 -0
- package/docs/DevelopersWebhooksApi.md +15 -15
- package/docs/ErrorResponse.md +1 -1
- package/docs/EstimateClaimFee.md +1 -1
- package/docs/EstimateContractCallFeeParams.md +1 -1
- package/docs/EstimateFeeParams.md +2 -2
- package/docs/EstimateStakeFee.md +1 -1
- package/docs/EstimateTransferFeeParams.md +1 -1
- package/docs/EthStakeEstimatedFee.md +1 -0
- package/docs/EthStakingActivityDetailExtra.md +11 -0
- package/docs/ExtendedTokenInfo.md +1 -1
- package/docs/GetStakingEstimationFee201Response.md +1 -0
- package/docs/GetStakingEstimationFeeRequest.md +2 -2
- package/docs/GetTransactionLimitation200Response.md +12 -0
- package/docs/ListCallbackMessages200Response.md +10 -0
- package/docs/ListSupportedCountries200ResponseInner.md +11 -0
- package/docs/LockUtxosRequestUtxosInner.md +1 -1
- package/docs/MPCVaultEventData.md +34 -0
- package/docs/MaxTransferableValue.md +1 -1
- package/docs/MessageSignParams.md +1 -1
- package/docs/OAuthApi.md +1 -1
- package/docs/OrgInfo.md +11 -0
- package/docs/Pagination.md +2 -2
- package/docs/RetryCallbackMessage201Response.md +9 -0
- package/docs/SelectedEntityType.md +12 -0
- package/docs/SelfCustodyWallet.md +12 -0
- package/docs/SourceGroup.md +1 -1
- package/docs/StakingPoolId.md +2 -0
- package/docs/StakingPoolType.md +2 -0
- package/docs/StakingsApi.md +18 -16
- package/docs/SubmitDepositTravelRuleInfo201Response.md +9 -0
- package/docs/SwapActivity.md +20 -0
- package/docs/SwapSummary.md +10 -0
- package/docs/SwapTokenPair.md +10 -0
- package/docs/TSSRequestWebhookEventData.md +7 -1
- package/docs/TokenBalance.md +1 -1
- package/docs/TokenBalanceBalance.md +4 -4
- package/docs/TokenInfo.md +1 -1
- package/docs/Transaction.md +2 -2
- package/docs/TransactionApprovalDetail.md +11 -0
- package/docs/TransactionApprovalResult.md +14 -0
- package/docs/TransactionDetail.md +2 -2
- package/docs/TransactionDetails.md +2 -2
- package/docs/TransactionRawTxInfo.md +1 -1
- package/docs/TransactionRoleApprovalDetail.md +13 -0
- package/docs/TransactionSelectedUtxo.md +12 -0
- package/docs/TransactionTokeApproval.md +1 -1
- package/docs/TransactionTokenAmount.md +1 -1
- package/docs/TransactionUserApprovalDetail.md +15 -0
- package/docs/TransactionWebhookEventData.md +9 -3
- package/docs/TransactionsApi.md +65 -14
- package/docs/TransferParams.md +1 -1
- package/docs/TravelRuleApi.md +214 -0
- package/docs/TravelRuleDepositExchangesOrVASP.md +13 -0
- package/docs/TravelRuleDepositExchangesOrVASPEntityInfo.md +29 -0
- package/docs/TravelRuleDepositLegalEntity.md +25 -0
- package/docs/TravelRuleDepositNaturalEntity.md +26 -0
- package/docs/TravelRuleDepositRequest.md +10 -0
- package/docs/TravelRuleDepositRequestTravelRuleInfo.md +16 -0
- package/docs/TravelRuleWithdrawExchangesOrVASP.md +12 -0
- package/docs/TravelRuleWithdrawExchangesOrVASPEntityInfo.md +16 -0
- package/docs/TravelRuleWithdrawLegalEntity.md +12 -0
- package/docs/TravelRuleWithdrawNaturalEntity.md +13 -0
- package/docs/TravelRuleWithdrawRequest.md +10 -0
- package/docs/TravelRuleWithdrawRequestTravelRuleInfo.md +15 -0
- package/docs/TriggerTestWebhookEventRequest.md +1 -1
- package/docs/UpdateWebhookEndpointByIdRequest.md +1 -1
- package/docs/Vasp.md +11 -0
- package/docs/WalletInfoEventData.md +29 -0
- package/docs/WalletsApi.md +34 -34
- package/docs/WalletsExchangeWalletApi.md +6 -6
- package/docs/WalletsMPCWalletsApi.md +30 -30
- package/docs/WebhookEventData.md +17 -5
- package/docs/WebhookEventDataType.md +7 -1
- package/docs/WebhookEventType.md +14 -8
- package/package.json +2 -2
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# CoboWaas2.SwapActivity
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**activity_id** | **String** | The unique identifier of the swap activity. | [optional]
|
|
8
|
+
**status** | **String** | The status of the swap activity. | [optional]
|
|
9
|
+
**wallet_id** | **String** | The unique identifier of the wallet. | [optional]
|
|
10
|
+
**pay_token_id** | **String** | The token symbol to swap from. | [optional]
|
|
11
|
+
**receive_token_id** | **String** | The token symbol to swap to. | [optional]
|
|
12
|
+
**pay_amount** | **String** | The amount of tokens to bridge. | [optional]
|
|
13
|
+
**receive_amount** | **String** | The amount of tokens to receive. | [optional]
|
|
14
|
+
**fee_amount** | **String** | The amount of fee. | [optional]
|
|
15
|
+
**initiator** | **String** | The initiator of the swap activity. | [optional]
|
|
16
|
+
**initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) | | [optional]
|
|
17
|
+
**created_timestamp** | **Number** | The time when the swap activity was created, in Unix timestamp format, measured in milliseconds. | [optional]
|
|
18
|
+
**updated_timestamp** | **Number** | The time when the swap activity was last updated, in Unix timestamp format, measured in milliseconds. | [optional]
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.SwapSummary
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total_usd_value** | **String** | The total USD value of the swap activities, represented as a string. |
|
|
8
|
+
**activity_count** | **Number** | The total number of swap activities. |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.SwapTokenPair
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**pay_token_id** | **String** | The source token symbol. | [optional]
|
|
8
|
+
**receive_token_id** | **String** | The target token symbol. | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. |
|
|
8
8
|
**tss_request_id** | **String** | The TSS request ID. | [optional]
|
|
9
9
|
**source_key_share_holder_group** | [**SourceGroup**](SourceGroup.md) | | [optional]
|
|
10
10
|
**target_key_share_holder_group_id** | **String** | The target key share holder group ID. | [optional]
|
|
@@ -22,6 +22,12 @@ Name | Type | Description | Notes
|
|
|
22
22
|
|
|
23
23
|
* `TSSRequest` (value: `"TSSRequest"`)
|
|
24
24
|
|
|
25
|
+
* `Addresses` (value: `"Addresses"`)
|
|
26
|
+
|
|
27
|
+
* `WalletInfo` (value: `"WalletInfo"`)
|
|
28
|
+
|
|
29
|
+
* `MPCVault` (value: `"MPCVault"`)
|
|
30
|
+
|
|
25
31
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
26
32
|
|
|
27
33
|
|
package/docs/TokenBalance.md
CHANGED
|
@@ -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
|
**balance** | [**TokenBalanceBalance**](TokenBalanceBalance.md) | |
|
|
9
9
|
|
|
10
10
|
|
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**total** | **String** | The current amount of tokens in an address, which is retrieved directly from the network. To learn more, see [Balances and transaction amounts for MPC Wallets](/v2/guides/mpc-wallets/balance-amounts) for more details. |
|
|
8
|
-
**available** | **String** | The amount of tokens ready to be spent. To learn more, see [Balances and transaction amounts for MPC Wallets](/v2/guides/mpc-wallets/balance-amounts) for more details. |
|
|
9
|
-
**pending** | **String** | The total amount being sent in a transaction, which is calculated as the withdrawal amount plus the transaction fee. To learn more, see [Balances and transaction amounts for MPC Wallets](/v2/guides/mpc-wallets/balance-amounts) for more details. | [optional] [default to '0']
|
|
10
|
-
**locked** | **String** | For UTXO chains, this is the combined value of the selected UTXOs for the transaction. For other chains, it is equal to the Pending amount. To learn more, see [Balances and transaction amounts for MPC Wallets](/v2/guides/mpc-wallets/balance-amounts) for more details. | [optional] [default to '0']
|
|
7
|
+
**total** | **String** | The current amount of tokens in an address, which is retrieved directly from the network. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. |
|
|
8
|
+
**available** | **String** | The amount of tokens ready to be spent. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. |
|
|
9
|
+
**pending** | **String** | The total amount being sent in a transaction, which is calculated as the withdrawal amount plus the transaction fee. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. | [optional] [default to '0']
|
|
10
|
+
**locked** | **String** | For UTXO chains, this is the combined value of the selected UTXOs for the transaction. For other chains, it is equal to the Pending amount. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. | [optional] [default to '0']
|
|
11
11
|
|
|
12
12
|
|
package/docs/TokenInfo.md
CHANGED
|
@@ -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/Transaction.md
CHANGED
|
@@ -12,8 +12,8 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**status** | [**TransactionStatus**](TransactionStatus.md) | |
|
|
13
13
|
**sub_status** | [**TransactionSubStatus**](TransactionSubStatus.md) | | [optional]
|
|
14
14
|
**failed_reason** | **String** | (This property is applicable to approval failures and signature failures only) The reason why the transaction failed. | [optional]
|
|
15
|
-
**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
16
|
-
**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]
|
|
15
|
+
**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
16
|
+
**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]
|
|
17
17
|
**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]
|
|
18
18
|
**source** | [**TransactionSource**](TransactionSource.md) | |
|
|
19
19
|
**destination** | [**TransactionDestination**](TransactionDestination.md) | |
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.TransactionApprovalDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**spender** | [**TransactionRoleApprovalDetail**](TransactionRoleApprovalDetail.md) | | [optional]
|
|
8
|
+
**approver** | [**TransactionRoleApprovalDetail**](TransactionRoleApprovalDetail.md) | | [optional]
|
|
9
|
+
**address_owner** | [**TransactionRoleApprovalDetail**](TransactionRoleApprovalDetail.md) | | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -12,8 +12,8 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**status** | [**TransactionStatus**](TransactionStatus.md) | |
|
|
13
13
|
**sub_status** | [**TransactionSubStatus**](TransactionSubStatus.md) | | [optional]
|
|
14
14
|
**failed_reason** | **String** | (This property is applicable to approval failures and signature failures only) The reason why the transaction failed. | [optional]
|
|
15
|
-
**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
16
|
-
**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]
|
|
15
|
+
**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
16
|
+
**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]
|
|
17
17
|
**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]
|
|
18
18
|
**source** | [**TransactionSource**](TransactionSource.md) | |
|
|
19
19
|
**destination** | [**TransactionDestination**](TransactionDestination.md) | |
|
|
@@ -12,8 +12,8 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**status** | [**TransactionStatus**](TransactionStatus.md) | |
|
|
13
13
|
**sub_status** | [**TransactionSubStatus**](TransactionSubStatus.md) | | [optional]
|
|
14
14
|
**failed_reason** | **String** | (This property is applicable to approval failures and signature failures only) The reason why the transaction failed. | [optional]
|
|
15
|
-
**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
16
|
-
**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]
|
|
15
|
+
**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
16
|
+
**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]
|
|
17
17
|
**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]
|
|
18
18
|
**source** | [**TransactionSource**](TransactionSource.md) | |
|
|
19
19
|
**destination** | [**TransactionDestination**](TransactionDestination.md) | |
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**used_nonce** | **Number** | The transaction nonce. | [optional]
|
|
8
|
-
**selected_utxos** | [**[
|
|
8
|
+
**selected_utxos** | [**[TransactionSelectedUtxo]**](TransactionSelectedUtxo.md) | The selected UTXOs to be consumed in the transaction. | [optional]
|
|
9
9
|
**raw_tx** | **String** | The raw transaction data. | [optional]
|
|
10
10
|
|
|
11
11
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CoboWaas2.TransactionRoleApprovalDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**result** | [**TransactionApprovalResult**](TransactionApprovalResult.md) | | [optional]
|
|
8
|
+
**review_threshold** | **Number** | The threshold for passing the review of this role. | [optional]
|
|
9
|
+
**initiator** | **String** | The initiator of the transaction. | [optional]
|
|
10
|
+
**complete_time** | **String** | Time to complete the review. | [optional]
|
|
11
|
+
**user_details** | [**[TransactionUserApprovalDetail]**](TransactionUserApprovalDetail.md) | | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.TransactionSelectedUtxo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**tx_hash** | **String** | The transaction hash of the UTXO. | [optional]
|
|
8
|
+
**vout_n** | **Number** | The output index of the UTXO. | [optional]
|
|
9
|
+
**address** | **String** | The address of the UTXO. | [optional]
|
|
10
|
+
**value** | **String** | The value of the UTXO. | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -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]
|
|
@@ -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
|
**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. |
|
|
9
9
|
**amount** | **Number** | Transaction value (Note that this is an absolute value. If you trade 1.5 BTC, then the value is 1.5) |
|
|
10
10
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# CoboWaas2.TransactionUserApprovalDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**pubkey** | **String** | The gaurd pubkey of the user who audited the message. | [optional]
|
|
8
|
+
**result** | [**TransactionApprovalResult**](TransactionApprovalResult.md) | | [optional]
|
|
9
|
+
**signature** | **String** | Signature of the audited message. | [optional]
|
|
10
|
+
**language** | **String** | The language of the audited message. | [optional]
|
|
11
|
+
**message_version** | **String** | Version of the audited message. | [optional]
|
|
12
|
+
**message** | **String** | The audited message. | [optional]
|
|
13
|
+
**extra_message** | **String** | The extra audited message. | [optional]
|
|
14
|
+
|
|
15
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. |
|
|
8
8
|
**transaction_id** | **String** | The transaction ID. |
|
|
9
9
|
**cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
|
|
10
10
|
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**status** | [**TransactionStatus**](TransactionStatus.md) | |
|
|
14
14
|
**sub_status** | [**TransactionSubStatus**](TransactionSubStatus.md) | | [optional]
|
|
15
15
|
**failed_reason** | **String** | (This property is applicable to approval failures and signature failures only) The reason why the transaction failed. | [optional]
|
|
16
|
-
**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
17
|
-
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
16
|
+
**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
17
|
+
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
18
18
|
**asset_id** | **String** | (This concept applies to Exchange Wallets only) The asset ID. An asset ID is the unique identifier of the asset held within your linked exchange account. | [optional]
|
|
19
19
|
**source** | [**TransactionSource**](TransactionSource.md) | |
|
|
20
20
|
**destination** | [**TransactionDestination**](TransactionDestination.md) | |
|
|
@@ -43,6 +43,12 @@ Name | Type | Description | Notes
|
|
|
43
43
|
|
|
44
44
|
* `TSSRequest` (value: `"TSSRequest"`)
|
|
45
45
|
|
|
46
|
+
* `Addresses` (value: `"Addresses"`)
|
|
47
|
+
|
|
48
|
+
* `WalletInfo` (value: `"WalletInfo"`)
|
|
49
|
+
|
|
50
|
+
* `MPCVault` (value: `"MPCVault"`)
|
|
51
|
+
|
|
46
52
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
47
53
|
|
|
48
54
|
|
package/docs/TransactionsApi.md
CHANGED
|
@@ -12,6 +12,7 @@ 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 information
|
|
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
|
|
@@ -25,7 +26,7 @@ Method | HTTP request | Description
|
|
|
25
26
|
|
|
26
27
|
Broadcast signed transactions
|
|
27
28
|
|
|
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`.
|
|
29
|
+
<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
30
|
|
|
30
31
|
### Example
|
|
31
32
|
|
|
@@ -77,7 +78,7 @@ Name | Type | Description | Notes
|
|
|
77
78
|
|
|
78
79
|
Cancel transaction
|
|
79
80
|
|
|
80
|
-
This operation cancels a specified transaction. A transaction can be cancelled if its status is either of the following: - `Submitted` - `PendingScreening` - `PendingAuthorization` - `PendingSignature`
|
|
81
|
+
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
82
|
|
|
82
83
|
### Example
|
|
83
84
|
|
|
@@ -157,7 +158,7 @@ apiInstance.checkLoopTransfers(token_id, source_wallet_id, destination_addresses
|
|
|
157
158
|
|
|
158
159
|
Name | Type | Description | Notes
|
|
159
160
|
------------- | ------------- | ------------- | -------------
|
|
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). |
|
|
161
|
+
**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
162
|
**source_wallet_id** | **String**| The wallet ID of the transaction source. |
|
|
162
163
|
**destination_addresses** | **String**| A list of destination addresses, separated by comma. |
|
|
163
164
|
|
|
@@ -233,7 +234,7 @@ Name | Type | Description | Notes
|
|
|
233
234
|
|
|
234
235
|
Sign message
|
|
235
236
|
|
|
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>
|
|
237
|
+
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
238
|
|
|
238
239
|
### Example
|
|
239
240
|
|
|
@@ -337,7 +338,7 @@ Name | Type | Description | Notes
|
|
|
337
338
|
|
|
338
339
|
Drop transaction
|
|
339
340
|
|
|
340
|
-
This operation drops a specified transaction.
|
|
341
|
+
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
342
|
|
|
342
343
|
### Example
|
|
343
344
|
|
|
@@ -391,7 +392,7 @@ Name | Type | Description | Notes
|
|
|
391
392
|
|
|
392
393
|
Estimate transaction fee
|
|
393
394
|
|
|
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).
|
|
395
|
+
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
396
|
|
|
396
397
|
### Example
|
|
397
398
|
|
|
@@ -437,6 +438,56 @@ Name | Type | Description | Notes
|
|
|
437
438
|
- **Accept**: application/json
|
|
438
439
|
|
|
439
440
|
|
|
441
|
+
## getTransactionApprovalDetail
|
|
442
|
+
|
|
443
|
+
> TransactionApprovalDetail getTransactionApprovalDetail(transaction_id)
|
|
444
|
+
|
|
445
|
+
Get transaction approval information
|
|
446
|
+
|
|
447
|
+
This operation retrieves approval detailed information about a specified transaction.
|
|
448
|
+
|
|
449
|
+
### Example
|
|
450
|
+
|
|
451
|
+
```javascript
|
|
452
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
453
|
+
// Initialize the API client
|
|
454
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
455
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
456
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
457
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
458
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
459
|
+
// Call the API
|
|
460
|
+
const apiInstance = new CoboWaas2.TransactionsApi();
|
|
461
|
+
const transaction_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
462
|
+
apiInstance.getTransactionApprovalDetail(transaction_id).then((data) => {
|
|
463
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
464
|
+
}, (error) => {
|
|
465
|
+
console.error(error);
|
|
466
|
+
});
|
|
467
|
+
|
|
468
|
+
```
|
|
469
|
+
|
|
470
|
+
### Parameters
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
Name | Type | Description | Notes
|
|
474
|
+
------------- | ------------- | ------------- | -------------
|
|
475
|
+
**transaction_id** | **String**| The transaction ID. |
|
|
476
|
+
|
|
477
|
+
### Return type
|
|
478
|
+
|
|
479
|
+
[**TransactionApprovalDetail**](TransactionApprovalDetail.md)
|
|
480
|
+
|
|
481
|
+
### Authorization
|
|
482
|
+
|
|
483
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
484
|
+
|
|
485
|
+
### HTTP request headers
|
|
486
|
+
|
|
487
|
+
- **Content-Type**: Not defined
|
|
488
|
+
- **Accept**: application/json
|
|
489
|
+
|
|
490
|
+
|
|
440
491
|
## getTransactionById
|
|
441
492
|
|
|
442
493
|
> TransactionDetail getTransactionById(transaction_id)
|
|
@@ -546,16 +597,16 @@ Name | Type | Description | Notes
|
|
|
546
597
|
**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
598
|
**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
599
|
**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]
|
|
600
|
+
**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]
|
|
601
|
+
**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
602
|
**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]
|
|
603
|
+
**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]
|
|
604
|
+
**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
605
|
**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
606
|
**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
607
|
**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**|
|
|
608
|
+
**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]
|
|
609
|
+
**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
610
|
|
|
560
611
|
### Return type
|
|
561
612
|
|
|
@@ -577,7 +628,7 @@ Name | Type | Description | Notes
|
|
|
577
628
|
|
|
578
629
|
Resend transaction
|
|
579
630
|
|
|
580
|
-
This operation resends a specified transaction. Resending a transaction
|
|
631
|
+
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
632
|
|
|
582
633
|
### Example
|
|
583
634
|
|
|
@@ -631,7 +682,7 @@ Name | Type | Description | Notes
|
|
|
631
682
|
|
|
632
683
|
Speed up transaction
|
|
633
684
|
|
|
634
|
-
This operation accelerates a specified transaction.
|
|
685
|
+
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
686
|
|
|
636
687
|
### Example
|
|
637
688
|
|
package/docs/TransferParams.md
CHANGED
|
@@ -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. |
|
|
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]
|