@cobo/cobo-waas2 1.7.0 → 1.9.0

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