@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
|
@@ -15,6 +15,7 @@ var _EstimateFeeParams = _interopRequireDefault(require("../model/EstimateFeePar
|
|
|
15
15
|
var _EstimatedFee = _interopRequireDefault(require("../model/EstimatedFee"));
|
|
16
16
|
var _ListTransactions200Response = _interopRequireDefault(require("../model/ListTransactions200Response"));
|
|
17
17
|
var _MessageSignParams = _interopRequireDefault(require("../model/MessageSignParams"));
|
|
18
|
+
var _TransactionApprovalDetail = _interopRequireDefault(require("../model/TransactionApprovalDetail"));
|
|
18
19
|
var _TransactionDetail = _interopRequireDefault(require("../model/TransactionDetail"));
|
|
19
20
|
var _TransactionRbf = _interopRequireDefault(require("../model/TransactionRbf"));
|
|
20
21
|
var _TransactionResend = _interopRequireDefault(require("../model/TransactionResend"));
|
|
@@ -54,7 +55,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
54
55
|
|
|
55
56
|
/**
|
|
56
57
|
* Broadcast signed transactions
|
|
57
|
-
* <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`.
|
|
58
|
+
* <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`.
|
|
58
59
|
* @param {Object} opts Optional parameters
|
|
59
60
|
* @param {module:model/BroadcastSignedTransactionsRequest} [BroadcastSignedTransactionsRequest] The request body to broadcast a list of signed transactions.
|
|
60
61
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/BroadcastSignedTransactions201ResponseInner>} and HTTP response
|
|
@@ -80,7 +81,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
80
81
|
|
|
81
82
|
/**
|
|
82
83
|
* Broadcast signed transactions
|
|
83
|
-
* <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`.
|
|
84
|
+
* <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`.
|
|
84
85
|
* @param {Object} opts Optional parameters
|
|
85
86
|
* @param {module:model/BroadcastSignedTransactionsRequest} opts.BroadcastSignedTransactionsRequest The request body to broadcast a list of signed transactions.
|
|
86
87
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/BroadcastSignedTransactions201ResponseInner>}
|
|
@@ -95,7 +96,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
95
96
|
|
|
96
97
|
/**
|
|
97
98
|
* Cancel transaction
|
|
98
|
-
* This operation cancels a specified transaction.
|
|
99
|
+
* 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`
|
|
99
100
|
* @param {String} transaction_id The transaction ID.
|
|
100
101
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateTransferTransaction201Response} and HTTP response
|
|
101
102
|
*/
|
|
@@ -125,7 +126,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
125
126
|
|
|
126
127
|
/**
|
|
127
128
|
* Cancel transaction
|
|
128
|
-
* This operation cancels a specified transaction.
|
|
129
|
+
* 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`
|
|
129
130
|
* @param {String} transaction_id The transaction ID.
|
|
130
131
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateTransferTransaction201Response}
|
|
131
132
|
*/
|
|
@@ -140,7 +141,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
140
141
|
/**
|
|
141
142
|
* Check Cobo Loop transfers
|
|
142
143
|
* This operation verifies if the transactions from a given source wallet to a list of given destinations can be executed as Cobo Loop transfers. For more information about Cobo Loop, see [Cobo Loop's product manuals](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop).
|
|
143
|
-
* @param {String} token_id 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).
|
|
144
|
+
* @param {String} token_id 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).
|
|
144
145
|
* @param {String} source_wallet_id The wallet ID of the transaction source.
|
|
145
146
|
* @param {String} destination_addresses A list of destination addresses, separated by comma.
|
|
146
147
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/CheckLoopTransfers200ResponseInner>} and HTTP response
|
|
@@ -182,7 +183,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
182
183
|
/**
|
|
183
184
|
* Check Cobo Loop transfers
|
|
184
185
|
* This operation verifies if the transactions from a given source wallet to a list of given destinations can be executed as Cobo Loop transfers. For more information about Cobo Loop, see [Cobo Loop's product manuals](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop).
|
|
185
|
-
* @param {String} token_id 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).
|
|
186
|
+
* @param {String} token_id 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).
|
|
186
187
|
* @param {String} source_wallet_id The wallet ID of the transaction source.
|
|
187
188
|
* @param {String} destination_addresses A list of destination addresses, separated by comma.
|
|
188
189
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/CheckLoopTransfers200ResponseInner>}
|
|
@@ -238,7 +239,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
238
239
|
|
|
239
240
|
/**
|
|
240
241
|
* Sign message
|
|
241
|
-
* 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>
|
|
242
|
+
* 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>
|
|
242
243
|
* @param {Object} opts Optional parameters
|
|
243
244
|
* @param {module:model/MessageSignParams} [MessageSignParams] The request body to create a message signing transaction
|
|
244
245
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateTransferTransaction201Response} and HTTP response
|
|
@@ -264,7 +265,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
264
265
|
|
|
265
266
|
/**
|
|
266
267
|
* Sign message
|
|
267
|
-
* 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>
|
|
268
|
+
* 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>
|
|
268
269
|
* @param {Object} opts Optional parameters
|
|
269
270
|
* @param {module:model/MessageSignParams} opts.MessageSignParams The request body to create a message signing transaction
|
|
270
271
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateTransferTransaction201Response}
|
|
@@ -320,7 +321,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
320
321
|
|
|
321
322
|
/**
|
|
322
323
|
* Drop transaction
|
|
323
|
-
* This operation drops a specified transaction.
|
|
324
|
+
* 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.
|
|
324
325
|
* @param {String} transaction_id The transaction ID.
|
|
325
326
|
* @param {Object} opts Optional parameters
|
|
326
327
|
* @param {module:model/TransactionRbf} [TransactionRbf] The request body to drop or to speed up transactions
|
|
@@ -353,7 +354,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
353
354
|
|
|
354
355
|
/**
|
|
355
356
|
* Drop transaction
|
|
356
|
-
* This operation drops a specified transaction.
|
|
357
|
+
* 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.
|
|
357
358
|
* @param {String} transaction_id The transaction ID.
|
|
358
359
|
* @param {Object} opts Optional parameters
|
|
359
360
|
* @param {module:model/TransactionRbf} opts.TransactionRbf The request body to drop or to speed up transactions
|
|
@@ -369,7 +370,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
369
370
|
|
|
370
371
|
/**
|
|
371
372
|
* Estimate transaction fee
|
|
372
|
-
* 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).
|
|
373
|
+
* 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).
|
|
373
374
|
* @param {Object} opts Optional parameters
|
|
374
375
|
* @param {module:model/EstimateFeeParams} [EstimateFeeParams] The request body to estimate the transaction fee of a token transfer or a contract call.
|
|
375
376
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EstimatedFee} and HTTP response
|
|
@@ -395,7 +396,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
395
396
|
|
|
396
397
|
/**
|
|
397
398
|
* Estimate transaction fee
|
|
398
|
-
* 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).
|
|
399
|
+
* 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).
|
|
399
400
|
* @param {Object} opts Optional parameters
|
|
400
401
|
* @param {module:model/EstimateFeeParams} opts.EstimateFeeParams The request body to estimate the transaction fee of a token transfer or a contract call.
|
|
401
402
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EstimatedFee}
|
|
@@ -408,6 +409,50 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
408
409
|
});
|
|
409
410
|
}
|
|
410
411
|
|
|
412
|
+
/**
|
|
413
|
+
* Get transaction approval information
|
|
414
|
+
* This operation retrieves approval detailed information about a specified transaction.
|
|
415
|
+
* @param {String} transaction_id The transaction ID.
|
|
416
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TransactionApprovalDetail} and HTTP response
|
|
417
|
+
*/
|
|
418
|
+
}, {
|
|
419
|
+
key: "getTransactionApprovalDetailWithHttpInfo",
|
|
420
|
+
value: function getTransactionApprovalDetailWithHttpInfo(transaction_id) {
|
|
421
|
+
var postBody = null;
|
|
422
|
+
if (postBody && postBody.toJSON) {
|
|
423
|
+
postBody = postBody.toJSON();
|
|
424
|
+
}
|
|
425
|
+
// verify the required parameter 'transaction_id' is set
|
|
426
|
+
if (transaction_id === undefined || transaction_id === null) {
|
|
427
|
+
throw new Error("Missing the required parameter 'transaction_id' when calling getTransactionApprovalDetail");
|
|
428
|
+
}
|
|
429
|
+
var pathParams = {
|
|
430
|
+
'transaction_id': transaction_id
|
|
431
|
+
};
|
|
432
|
+
var queryParams = {};
|
|
433
|
+
var headerParams = {};
|
|
434
|
+
var formParams = {};
|
|
435
|
+
var authNames = ['CoboAuth'];
|
|
436
|
+
var contentTypes = [];
|
|
437
|
+
var accepts = ['application/json'];
|
|
438
|
+
var returnType = _TransactionApprovalDetail["default"];
|
|
439
|
+
return this.apiClient.callApi('/transactions/{transaction_id}/approval_detail', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
440
|
+
}
|
|
441
|
+
|
|
442
|
+
/**
|
|
443
|
+
* Get transaction approval information
|
|
444
|
+
* This operation retrieves approval detailed information about a specified transaction.
|
|
445
|
+
* @param {String} transaction_id The transaction ID.
|
|
446
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TransactionApprovalDetail}
|
|
447
|
+
*/
|
|
448
|
+
}, {
|
|
449
|
+
key: "getTransactionApprovalDetail",
|
|
450
|
+
value: function getTransactionApprovalDetail(transaction_id) {
|
|
451
|
+
return this.getTransactionApprovalDetailWithHttpInfo(transaction_id).then(function (response_and_data) {
|
|
452
|
+
return response_and_data.data;
|
|
453
|
+
});
|
|
454
|
+
}
|
|
455
|
+
|
|
411
456
|
/**
|
|
412
457
|
* Get transaction information
|
|
413
458
|
* This operation retrieves detailed information about a specified transaction, such as the transaction status, source address, destination address, and timestamp.
|
|
@@ -463,16 +508,16 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
463
508
|
* @param {String} [types] 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.
|
|
464
509
|
* @param {String} [statuses] 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.
|
|
465
510
|
* @param {String} [wallet_ids] A list of wallet IDs, separated by comma.
|
|
466
|
-
* @param {String} [chain_ids] 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).
|
|
467
|
-
* @param {String} [token_ids] 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).
|
|
511
|
+
* @param {String} [chain_ids] 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).
|
|
512
|
+
* @param {String} [token_ids] 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).
|
|
468
513
|
* @param {String} [asset_ids] (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.
|
|
469
|
-
* @param {String} [vault_id] The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallets/list-all-vaults).
|
|
470
|
-
* @param {String} [project_id] The project ID, which you can retrieve by calling [List all projects](/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
514
|
+
* @param {String} [vault_id] 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).
|
|
515
|
+
* @param {String} [project_id] 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).
|
|
471
516
|
* @param {Number} [min_created_timestamp] 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.
|
|
472
517
|
* @param {Number} [max_created_timestamp] 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.
|
|
473
518
|
* @param {Number} [limit = 10)] The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
474
|
-
* @param {String} [before]
|
|
475
|
-
* @param {String} [after]
|
|
519
|
+
* @param {String} [before] 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.
|
|
520
|
+
* @param {String} [after] 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.
|
|
476
521
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListTransactions200Response} and HTTP response
|
|
477
522
|
*/
|
|
478
523
|
}, {
|
|
@@ -523,16 +568,16 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
523
568
|
* @param {String} opts.types 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.
|
|
524
569
|
* @param {String} opts.statuses 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.
|
|
525
570
|
* @param {String} opts.wallet_ids A list of wallet IDs, separated by comma.
|
|
526
|
-
* @param {String} opts.chain_ids 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).
|
|
527
|
-
* @param {String} opts.token_ids 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).
|
|
571
|
+
* @param {String} opts.chain_ids 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).
|
|
572
|
+
* @param {String} opts.token_ids 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).
|
|
528
573
|
* @param {String} opts.asset_ids (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.
|
|
529
|
-
* @param {String} opts.vault_id The vault ID, which you can retrieve by calling [List all vaults](/v2/api-references/wallets--mpc-wallets/list-all-vaults).
|
|
530
|
-
* @param {String} opts.project_id The project ID, which you can retrieve by calling [List all projects](/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
574
|
+
* @param {String} opts.vault_id 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).
|
|
575
|
+
* @param {String} opts.project_id 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).
|
|
531
576
|
* @param {Number} opts.min_created_timestamp 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.
|
|
532
577
|
* @param {Number} opts.max_created_timestamp 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.
|
|
533
578
|
* @param {Number} opts.limit The maximum number of objects to return. For most operations, the value range is [1, 50]. (default to 10)
|
|
534
|
-
* @param {String} opts.before
|
|
535
|
-
* @param {String} opts.after
|
|
579
|
+
* @param {String} opts.before 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.
|
|
580
|
+
* @param {String} opts.after 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.
|
|
536
581
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListTransactions200Response}
|
|
537
582
|
*/
|
|
538
583
|
}, {
|
|
@@ -545,7 +590,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
545
590
|
|
|
546
591
|
/**
|
|
547
592
|
* Resend transaction
|
|
548
|
-
* This operation resends a specified transaction. Resending a transaction
|
|
593
|
+
* 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>
|
|
549
594
|
* @param {String} transaction_id The transaction ID.
|
|
550
595
|
* @param {Object} opts Optional parameters
|
|
551
596
|
* @param {module:model/TransactionResend} [TransactionResend] The request body to resend transactions
|
|
@@ -578,7 +623,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
578
623
|
|
|
579
624
|
/**
|
|
580
625
|
* Resend transaction
|
|
581
|
-
* This operation resends a specified transaction. Resending a transaction
|
|
626
|
+
* 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>
|
|
582
627
|
* @param {String} transaction_id The transaction ID.
|
|
583
628
|
* @param {Object} opts Optional parameters
|
|
584
629
|
* @param {module:model/TransactionResend} opts.TransactionResend The request body to resend transactions
|
|
@@ -594,7 +639,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
594
639
|
|
|
595
640
|
/**
|
|
596
641
|
* Speed up transaction
|
|
597
|
-
* This operation accelerates a specified transaction.
|
|
642
|
+
* 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>
|
|
598
643
|
* @param {String} transaction_id The transaction ID.
|
|
599
644
|
* @param {Object} opts Optional parameters
|
|
600
645
|
* @param {module:model/TransactionRbf} [TransactionRbf] The request body to drop or to speed up transactions
|
|
@@ -627,7 +672,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
627
672
|
|
|
628
673
|
/**
|
|
629
674
|
* Speed up transaction
|
|
630
|
-
* This operation accelerates a specified transaction.
|
|
675
|
+
* 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>
|
|
631
676
|
* @param {String} transaction_id The transaction ID.
|
|
632
677
|
* @param {Object} opts Optional parameters
|
|
633
678
|
* @param {module:model/TransactionRbf} opts.TransactionRbf The request body to drop or to speed up transactions
|
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports["default"] = void 0;
|
|
7
|
+
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
+
var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
|
|
9
|
+
var _GetTransactionLimitation200Response = _interopRequireDefault(require("../model/GetTransactionLimitation200Response"));
|
|
10
|
+
var _ListSupportedCountries200ResponseInner = _interopRequireDefault(require("../model/ListSupportedCountries200ResponseInner"));
|
|
11
|
+
var _SubmitDepositTravelRuleInfo201Response = _interopRequireDefault(require("../model/SubmitDepositTravelRuleInfo201Response"));
|
|
12
|
+
var _TravelRuleDepositRequest = _interopRequireDefault(require("../model/TravelRuleDepositRequest"));
|
|
13
|
+
var _TravelRuleWithdrawRequest = _interopRequireDefault(require("../model/TravelRuleWithdrawRequest"));
|
|
14
|
+
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
15
|
+
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
|
|
16
|
+
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
17
|
+
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
|
|
18
|
+
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
|
|
19
|
+
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
20
|
+
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
|
|
21
|
+
* Cobo Wallet as a Service 2.0
|
|
22
|
+
*
|
|
23
|
+
* Contact: help@cobo.com
|
|
24
|
+
*
|
|
25
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
26
|
+
* https://openapi-generator.tech
|
|
27
|
+
* Do not edit the class manually.
|
|
28
|
+
*
|
|
29
|
+
*/
|
|
30
|
+
/**
|
|
31
|
+
* TravelRule service.
|
|
32
|
+
* @module api/TravelRuleApi
|
|
33
|
+
*/
|
|
34
|
+
var TravelRuleApi = exports["default"] = /*#__PURE__*/function () {
|
|
35
|
+
/**
|
|
36
|
+
* Constructs a new TravelRuleApi.
|
|
37
|
+
* @alias module:api/TravelRuleApi
|
|
38
|
+
* @class
|
|
39
|
+
* @param {module:ApiClient} [apiClient] Optional API client implementation to use,
|
|
40
|
+
* default to {@link module:ApiClient#instance} if unspecified.
|
|
41
|
+
*/
|
|
42
|
+
function TravelRuleApi(apiClient) {
|
|
43
|
+
_classCallCheck(this, TravelRuleApi);
|
|
44
|
+
this.apiClient = apiClient || _ApiClient["default"].instance;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Retrieve transaction limitations
|
|
49
|
+
* This endpoint retrieves transaction-related limitations based on the provided `transaction_type` and `transaction_id`. The response includes the following information: - **`vasp_list`**: A list of Virtual Asset Service Providers (VASPs) associated with the transaction token. - **`is_threshold_reached`**: Indicates whether the transaction amount has exceeded the predefined threshold. - If `true`: Additional Travel Rule information may be required for processing. - **`self_custody_wallet_challenge`**: A challenge string for verifying ownership of self-custody wallets. - **`connect_wallet_list`**: A list of supported wallet integrations for the transaction, such as MetaMask or WalletConnect. Use this endpoint to ensure compliance with Travel Rule requirements and to retrieve supported options for completing the transaction.
|
|
50
|
+
* @param {module:model/String} transaction_type The transaction type. Possible values include: - `DEPOSIT`: A deposit transaction. - `WITHDRAW`: A withdrawal transaction.
|
|
51
|
+
* @param {String} transaction_id The transaction ID
|
|
52
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetTransactionLimitation200Response} and HTTP response
|
|
53
|
+
*/
|
|
54
|
+
return _createClass(TravelRuleApi, [{
|
|
55
|
+
key: "getTransactionLimitationWithHttpInfo",
|
|
56
|
+
value: function getTransactionLimitationWithHttpInfo(transaction_type, transaction_id) {
|
|
57
|
+
var postBody = null;
|
|
58
|
+
if (postBody && postBody.toJSON) {
|
|
59
|
+
postBody = postBody.toJSON();
|
|
60
|
+
}
|
|
61
|
+
// verify the required parameter 'transaction_type' is set
|
|
62
|
+
if (transaction_type === undefined || transaction_type === null) {
|
|
63
|
+
throw new Error("Missing the required parameter 'transaction_type' when calling getTransactionLimitation");
|
|
64
|
+
}
|
|
65
|
+
// verify the required parameter 'transaction_id' is set
|
|
66
|
+
if (transaction_id === undefined || transaction_id === null) {
|
|
67
|
+
throw new Error("Missing the required parameter 'transaction_id' when calling getTransactionLimitation");
|
|
68
|
+
}
|
|
69
|
+
var pathParams = {};
|
|
70
|
+
var queryParams = {
|
|
71
|
+
'transaction_type': transaction_type,
|
|
72
|
+
'transaction_id': transaction_id
|
|
73
|
+
};
|
|
74
|
+
var headerParams = {};
|
|
75
|
+
var formParams = {};
|
|
76
|
+
var authNames = ['OAuth2', 'CoboAuth'];
|
|
77
|
+
var contentTypes = [];
|
|
78
|
+
var accepts = ['application/json'];
|
|
79
|
+
var returnType = _GetTransactionLimitation200Response["default"];
|
|
80
|
+
return this.apiClient.callApi('/travel_rule/transaction/limitation', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* Retrieve transaction limitations
|
|
85
|
+
* This endpoint retrieves transaction-related limitations based on the provided `transaction_type` and `transaction_id`. The response includes the following information: - **`vasp_list`**: A list of Virtual Asset Service Providers (VASPs) associated with the transaction token. - **`is_threshold_reached`**: Indicates whether the transaction amount has exceeded the predefined threshold. - If `true`: Additional Travel Rule information may be required for processing. - **`self_custody_wallet_challenge`**: A challenge string for verifying ownership of self-custody wallets. - **`connect_wallet_list`**: A list of supported wallet integrations for the transaction, such as MetaMask or WalletConnect. Use this endpoint to ensure compliance with Travel Rule requirements and to retrieve supported options for completing the transaction.
|
|
86
|
+
* @param {module:model/String} transaction_type The transaction type. Possible values include: - `DEPOSIT`: A deposit transaction. - `WITHDRAW`: A withdrawal transaction.
|
|
87
|
+
* @param {String} transaction_id The transaction ID
|
|
88
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetTransactionLimitation200Response}
|
|
89
|
+
*/
|
|
90
|
+
}, {
|
|
91
|
+
key: "getTransactionLimitation",
|
|
92
|
+
value: function getTransactionLimitation(transaction_type, transaction_id) {
|
|
93
|
+
return this.getTransactionLimitationWithHttpInfo(transaction_type, transaction_id).then(function (response_and_data) {
|
|
94
|
+
return response_and_data.data;
|
|
95
|
+
});
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
/**
|
|
99
|
+
* List supported countries
|
|
100
|
+
* This operation retrieves all countries supported.
|
|
101
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/ListSupportedCountries200ResponseInner>} and HTTP response
|
|
102
|
+
*/
|
|
103
|
+
}, {
|
|
104
|
+
key: "listSupportedCountriesWithHttpInfo",
|
|
105
|
+
value: function listSupportedCountriesWithHttpInfo() {
|
|
106
|
+
var postBody = null;
|
|
107
|
+
if (postBody && postBody.toJSON) {
|
|
108
|
+
postBody = postBody.toJSON();
|
|
109
|
+
}
|
|
110
|
+
var pathParams = {};
|
|
111
|
+
var queryParams = {};
|
|
112
|
+
var headerParams = {};
|
|
113
|
+
var formParams = {};
|
|
114
|
+
var authNames = ['OAuth2', 'CoboAuth'];
|
|
115
|
+
var contentTypes = [];
|
|
116
|
+
var accepts = ['application/json'];
|
|
117
|
+
var returnType = [_ListSupportedCountries200ResponseInner["default"]];
|
|
118
|
+
return this.apiClient.callApi('/travel_rule/transaction/countries', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* List supported countries
|
|
123
|
+
* This operation retrieves all countries supported.
|
|
124
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/ListSupportedCountries200ResponseInner>}
|
|
125
|
+
*/
|
|
126
|
+
}, {
|
|
127
|
+
key: "listSupportedCountries",
|
|
128
|
+
value: function listSupportedCountries() {
|
|
129
|
+
return this.listSupportedCountriesWithHttpInfo().then(function (response_and_data) {
|
|
130
|
+
return response_and_data.data;
|
|
131
|
+
});
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
/**
|
|
135
|
+
* Submit Deposit Transaction Travel Rule information
|
|
136
|
+
* This operation allows you to submit the required Travel Rule information based on the transaction details. It supports both self-custody wallets and exchanges/VASPs, ensuring compliance with Travel Rule requirements. - **Destination Wallet Type (`destination_wallet_type`)**: - `SELF_CUSTODY_WALLET`: A self-custodial wallet (e.g., plugin wallet). Requires `self_custody_wallet_sign`, `self_custody_wallet_address`, and `self_custody_wallet_challenge`. - `EXCHANGES_OR_VASP`: A wallet associated with an exchange or VASP. Requires `vendor_vasp_id` and information depending on `selected_entity_type`. - **Entity Types (`selected_entity_type`)**: - `LEGAL`: For legal entities, provide `legal_name`, `date_of_incorporation`, and `place_of_incorporation`. - `NATURAL`: For natural persons, provide `date_of_birth`, `place_of_birth`, `first_name`, and `last_name`.
|
|
137
|
+
* @param {Object} opts Optional parameters
|
|
138
|
+
* @param {module:model/TravelRuleDepositRequest} [TravelRuleDepositRequest]
|
|
139
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubmitDepositTravelRuleInfo201Response} and HTTP response
|
|
140
|
+
*/
|
|
141
|
+
}, {
|
|
142
|
+
key: "submitDepositTravelRuleInfoWithHttpInfo",
|
|
143
|
+
value: function submitDepositTravelRuleInfoWithHttpInfo(opts) {
|
|
144
|
+
opts = opts || {};
|
|
145
|
+
var postBody = opts['TravelRuleDepositRequest'];
|
|
146
|
+
if (postBody && postBody.toJSON) {
|
|
147
|
+
postBody = postBody.toJSON();
|
|
148
|
+
}
|
|
149
|
+
var pathParams = {};
|
|
150
|
+
var queryParams = {};
|
|
151
|
+
var headerParams = {};
|
|
152
|
+
var formParams = {};
|
|
153
|
+
var authNames = ['OAuth2', 'CoboAuth'];
|
|
154
|
+
var contentTypes = ['application/json'];
|
|
155
|
+
var accepts = ['application/json'];
|
|
156
|
+
var returnType = _SubmitDepositTravelRuleInfo201Response["default"];
|
|
157
|
+
return this.apiClient.callApi('/travel_rule/transaction/deposit/travel_rule_info', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* Submit Deposit Transaction Travel Rule information
|
|
162
|
+
* This operation allows you to submit the required Travel Rule information based on the transaction details. It supports both self-custody wallets and exchanges/VASPs, ensuring compliance with Travel Rule requirements. - **Destination Wallet Type (`destination_wallet_type`)**: - `SELF_CUSTODY_WALLET`: A self-custodial wallet (e.g., plugin wallet). Requires `self_custody_wallet_sign`, `self_custody_wallet_address`, and `self_custody_wallet_challenge`. - `EXCHANGES_OR_VASP`: A wallet associated with an exchange or VASP. Requires `vendor_vasp_id` and information depending on `selected_entity_type`. - **Entity Types (`selected_entity_type`)**: - `LEGAL`: For legal entities, provide `legal_name`, `date_of_incorporation`, and `place_of_incorporation`. - `NATURAL`: For natural persons, provide `date_of_birth`, `place_of_birth`, `first_name`, and `last_name`.
|
|
163
|
+
* @param {Object} opts Optional parameters
|
|
164
|
+
* @param {module:model/TravelRuleDepositRequest} opts.TravelRuleDepositRequest
|
|
165
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubmitDepositTravelRuleInfo201Response}
|
|
166
|
+
*/
|
|
167
|
+
}, {
|
|
168
|
+
key: "submitDepositTravelRuleInfo",
|
|
169
|
+
value: function submitDepositTravelRuleInfo(opts) {
|
|
170
|
+
return this.submitDepositTravelRuleInfoWithHttpInfo(opts).then(function (response_and_data) {
|
|
171
|
+
return response_and_data.data;
|
|
172
|
+
});
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
/**
|
|
176
|
+
* Submit Withdraw Transaction Travel Rule information
|
|
177
|
+
* This operation allows you to submit the required Travel Rule information based on the transaction details. It supports both self-custody wallets and exchanges/VASPs, ensuring compliance with Travel Rule requirements. - **Destination Wallet Type (`destination_wallet_type`)**: - `SELF_CUSTODY_WALLET`: A self-custodial wallet (e.g., plugin wallet). Requires `self_custody_wallet_sign`, `self_custody_wallet_address`, and `self_custody_wallet_challenge`. - `EXCHANGES_OR_VASP`: A wallet associated with an exchange or VASP. Requires `vendor_vasp_id` and information depending on `selected_entity_type`. - **Entity Types (`selected_entity_type`)**: - `LEGAL`: For legal entities, provide `legal_name`. - `NATURAL`: For natural persons, provide `date_of_birth`, `place_of_birth`, `first_name`, and `last_name`.
|
|
178
|
+
* @param {Object} opts Optional parameters
|
|
179
|
+
* @param {module:model/TravelRuleWithdrawRequest} [TravelRuleWithdrawRequest]
|
|
180
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubmitDepositTravelRuleInfo201Response} and HTTP response
|
|
181
|
+
*/
|
|
182
|
+
}, {
|
|
183
|
+
key: "submitWithdrawTravelRuleInfoWithHttpInfo",
|
|
184
|
+
value: function submitWithdrawTravelRuleInfoWithHttpInfo(opts) {
|
|
185
|
+
opts = opts || {};
|
|
186
|
+
var postBody = opts['TravelRuleWithdrawRequest'];
|
|
187
|
+
if (postBody && postBody.toJSON) {
|
|
188
|
+
postBody = postBody.toJSON();
|
|
189
|
+
}
|
|
190
|
+
var pathParams = {};
|
|
191
|
+
var queryParams = {};
|
|
192
|
+
var headerParams = {};
|
|
193
|
+
var formParams = {};
|
|
194
|
+
var authNames = ['OAuth2', 'CoboAuth'];
|
|
195
|
+
var contentTypes = ['application/json'];
|
|
196
|
+
var accepts = ['application/json'];
|
|
197
|
+
var returnType = _SubmitDepositTravelRuleInfo201Response["default"];
|
|
198
|
+
return this.apiClient.callApi('/travel_rule/transaction/withdraw/travel_rule_info', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
/**
|
|
202
|
+
* Submit Withdraw Transaction Travel Rule information
|
|
203
|
+
* This operation allows you to submit the required Travel Rule information based on the transaction details. It supports both self-custody wallets and exchanges/VASPs, ensuring compliance with Travel Rule requirements. - **Destination Wallet Type (`destination_wallet_type`)**: - `SELF_CUSTODY_WALLET`: A self-custodial wallet (e.g., plugin wallet). Requires `self_custody_wallet_sign`, `self_custody_wallet_address`, and `self_custody_wallet_challenge`. - `EXCHANGES_OR_VASP`: A wallet associated with an exchange or VASP. Requires `vendor_vasp_id` and information depending on `selected_entity_type`. - **Entity Types (`selected_entity_type`)**: - `LEGAL`: For legal entities, provide `legal_name`. - `NATURAL`: For natural persons, provide `date_of_birth`, `place_of_birth`, `first_name`, and `last_name`.
|
|
204
|
+
* @param {Object} opts Optional parameters
|
|
205
|
+
* @param {module:model/TravelRuleWithdrawRequest} opts.TravelRuleWithdrawRequest
|
|
206
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubmitDepositTravelRuleInfo201Response}
|
|
207
|
+
*/
|
|
208
|
+
}, {
|
|
209
|
+
key: "submitWithdrawTravelRuleInfo",
|
|
210
|
+
value: function submitWithdrawTravelRuleInfo(opts) {
|
|
211
|
+
return this.submitWithdrawTravelRuleInfoWithHttpInfo(opts).then(function (response_and_data) {
|
|
212
|
+
return response_and_data.data;
|
|
213
|
+
});
|
|
214
|
+
}
|
|
215
|
+
}]);
|
|
216
|
+
}();
|