@cobo/cobo-waas2 1.23.0 → 1.24.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 (171) hide show
  1. package/README.md +45 -6
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/AddressBooksApi.js +6 -6
  4. package/dist/api/FeeStationApi.js +47 -4
  5. package/dist/api/PaymentApi.js +194 -47
  6. package/dist/api/SwapsApi.js +374 -0
  7. package/dist/api/TransactionsApi.js +4 -4
  8. package/dist/index.js +224 -14
  9. package/dist/model/AddressInfo.js +13 -0
  10. package/dist/model/AddressesEventDataAllOfAddresses.js +18 -0
  11. package/dist/model/BridgingFee.js +136 -0
  12. package/dist/model/CommissionFee.js +110 -0
  13. package/dist/model/ContractCallDestination.js +48 -8
  14. package/dist/model/ContractCallDestinationType.js +5 -0
  15. package/dist/model/CreateMerchantRequest.js +13 -6
  16. package/dist/model/CreatePaymentOrderRequest.js +14 -1
  17. package/dist/model/CreateSettlement.js +2 -2
  18. package/dist/model/CreateSettlementRequestRequest.js +39 -0
  19. package/dist/model/CreateSwapActivityRequest.js +193 -0
  20. package/dist/model/CustodialTransferDestination.js +1 -1
  21. package/dist/model/EstimateContractCallFeeParams.js +1 -1
  22. package/dist/model/EstimateFeeParams.js +1 -1
  23. package/dist/model/EstimateTransferFeeParams.js +1 -1
  24. package/dist/model/EstimatedEvmEip1559Fee.js +1 -1
  25. package/dist/model/EstimatedEvmLegacyFee.js +1 -1
  26. package/dist/model/EstimatedFILFee.js +1 -1
  27. package/dist/model/EstimatedFixedFee.js +1 -1
  28. package/dist/model/EstimatedSOLFee.js +1 -1
  29. package/dist/model/EstimatedUtxoFee.js +1 -1
  30. package/dist/model/FeeStationCheckFeeStationUsage.js +186 -0
  31. package/dist/model/FeeStationCheckFeeStationUsageResponse.js +200 -0
  32. package/dist/model/FeeStationGasStationType.js +61 -0
  33. package/dist/model/ListSwapActivities200Response.js +123 -0
  34. package/dist/model/ListSwapEnabledTokens200Response.js +123 -0
  35. package/dist/model/ListTopUpPayerAccounts200Response.js +123 -0
  36. package/dist/model/Merchant.js +9 -0
  37. package/dist/model/MerchantBalance.js +3 -3
  38. package/dist/model/MessageSignDestination.js +8 -70
  39. package/dist/model/OtcFee.js +123 -0
  40. package/dist/model/PaymentEstimateFee.js +125 -0
  41. package/dist/model/PaymentEstimateFee201Response.js +107 -0
  42. package/dist/model/{RawMessageSignDestination.js → PaymentEstimateFeeRequest.js} +51 -37
  43. package/dist/model/PaymentEstimatedFee.js +173 -0
  44. package/dist/model/PaymentFeeType.js +71 -0
  45. package/dist/model/PaymentRefundEventData.js +22 -2
  46. package/dist/model/PaymentSettlementEvent.js +62 -6
  47. package/dist/model/PspBalance.js +3 -3
  48. package/dist/model/Refund.js +17 -1
  49. package/dist/model/SettleRequestStatus.js +5 -0
  50. package/dist/model/Settlement.js +45 -3
  51. package/dist/model/SettlementDetail.js +33 -1
  52. package/dist/model/SettlementInfo.js +7 -7
  53. package/dist/model/SolContractCallAddressLookupTableAccount.js +126 -0
  54. package/dist/model/SolContractCallDestination.js +30 -0
  55. package/dist/model/StellarContractCallContractParam.js +164 -0
  56. package/dist/model/StellarContractCallContractType.js +56 -0
  57. package/dist/model/StellarContractCallDestination.js +125 -0
  58. package/dist/model/StellarContractCallTrustLineOperationType.js +56 -0
  59. package/dist/model/StellarContractCallTrustLineParam.js +133 -0
  60. package/dist/model/SupportedToken.js +9 -0
  61. package/dist/model/SwapActivity.js +9 -9
  62. package/dist/model/SwapActivityApprovers.js +1 -1
  63. package/dist/model/SwapActivityDetail.js +34 -18
  64. package/dist/model/SwapActivitySigners.js +2 -2
  65. package/dist/model/SwapActivityTimeline.js +5 -5
  66. package/dist/model/SwapEstimateFee.js +147 -0
  67. package/dist/model/SwapQuote.js +18 -31
  68. package/dist/model/SwapReceivingTransaction.js +133 -0
  69. package/dist/model/SwapToken.js +9 -9
  70. package/dist/model/TransactionCoboCategory.js +5 -0
  71. package/dist/model/TransactionDestination.js +48 -8
  72. package/dist/model/TransactionDestinationType.js +5 -0
  73. package/dist/model/TransactionEvmEip1559Fee.js +1 -1
  74. package/dist/model/TransactionEvmLegacyFee.js +1 -1
  75. package/dist/model/TransactionFILFee.js +1 -1
  76. package/dist/model/TransactionFixedFee.js +1 -1
  77. package/dist/model/TransactionFuelingInfo.js +13 -0
  78. package/dist/model/TransactionRequestEvmEip1559Fee.js +1 -1
  79. package/dist/model/TransactionRequestEvmLegacyFee.js +1 -1
  80. package/dist/model/TransactionRequestFILFee.js +1 -1
  81. package/dist/model/TransactionRequestSOLFee.js +1 -1
  82. package/dist/model/TransactionRequestUtxoFee.js +1 -1
  83. package/dist/model/TransactionSOLFee.js +1 -1
  84. package/dist/model/TransactionSolContractAddressLookupTableAccount.js +126 -0
  85. package/dist/model/TransactionSolContractDestination.js +30 -0
  86. package/dist/model/TransactionStellarContractParam.js +164 -0
  87. package/dist/model/TransactionStellarContractType.js +56 -0
  88. package/dist/model/{BTCEIP191MessageSignDestination.js → TransactionStellarDestination.js} +38 -35
  89. package/dist/model/TransactionStellarTrustLineOperationType.js +56 -0
  90. package/dist/model/TransactionStellarTrustLineParam.js +133 -0
  91. package/dist/model/TransactionUtxoFee.js +1 -1
  92. package/dist/model/UpdateBankAccountByIdRequest.js +108 -0
  93. package/dist/model/UpdateTopUpAddress.js +4 -6
  94. package/dist/model/WalletSetup.js +66 -0
  95. package/dist/model/WebhookEventData.js +19 -1
  96. package/docs/AddressBooksApi.md +3 -3
  97. package/docs/AddressInfo.md +1 -0
  98. package/docs/AddressesEventDataAllOfAddresses.md +1 -0
  99. package/docs/BridgingFee.md +11 -0
  100. package/docs/CommissionFee.md +9 -0
  101. package/docs/ContractCallDestination.md +2 -0
  102. package/docs/ContractCallDestinationType.md +2 -0
  103. package/docs/CreateMerchantRequest.md +2 -1
  104. package/docs/CreatePaymentOrderRequest.md +2 -1
  105. package/docs/CreateSettlement.md +2 -2
  106. package/docs/CreateSettlementRequestRequest.md +3 -0
  107. package/docs/CreateSwapActivityRequest.md +15 -0
  108. package/docs/EstimateContractCallFeeParams.md +1 -1
  109. package/docs/EstimateFeeParams.md +1 -1
  110. package/docs/EstimateTransferFeeParams.md +1 -1
  111. package/docs/FeeStationApi.md +53 -0
  112. package/docs/FeeStationCheckFeeStationUsage.md +14 -0
  113. package/docs/FeeStationCheckFeeStationUsageResponse.md +16 -0
  114. package/docs/FeeStationGasStationType.md +12 -0
  115. package/docs/ListSwapActivities200Response.md +10 -0
  116. package/docs/ListSwapEnabledTokens200Response.md +10 -0
  117. package/docs/ListTopUpPayerAccounts200Response.md +10 -0
  118. package/docs/Merchant.md +1 -0
  119. package/docs/MerchantBalance.md +3 -3
  120. package/docs/MessageSignDestination.md +0 -1
  121. package/docs/OtcFee.md +10 -0
  122. package/docs/PaymentApi.md +196 -21
  123. package/docs/PaymentEstimateFee.md +10 -0
  124. package/docs/PaymentEstimateFee201Response.md +9 -0
  125. package/docs/PaymentEstimateFeeRequest.md +10 -0
  126. package/docs/PaymentEstimatedFee.md +13 -0
  127. package/docs/PaymentFeeType.md +16 -0
  128. package/docs/PaymentRefundEventData.md +2 -1
  129. package/docs/PaymentSettlementEvent.md +6 -3
  130. package/docs/PspBalance.md +3 -3
  131. package/docs/Refund.md +2 -1
  132. package/docs/SettleRequestStatus.md +2 -0
  133. package/docs/Settlement.md +6 -3
  134. package/docs/SettlementDetail.md +3 -1
  135. package/docs/SettlementInfo.md +6 -6
  136. package/docs/SolContractCallAddressLookupTableAccount.md +10 -0
  137. package/docs/SolContractCallDestination.md +1 -0
  138. package/docs/StellarContractCallContractParam.md +11 -0
  139. package/docs/StellarContractCallContractType.md +10 -0
  140. package/docs/StellarContractCallDestination.md +10 -0
  141. package/docs/StellarContractCallTrustLineOperationType.md +10 -0
  142. package/docs/StellarContractCallTrustLineParam.md +11 -0
  143. package/docs/SupportedToken.md +1 -0
  144. package/docs/SwapActivity.md +9 -9
  145. package/docs/SwapActivityDetail.md +10 -9
  146. package/docs/SwapActivitySigners.md +1 -1
  147. package/docs/SwapActivityTimeline.md +3 -3
  148. package/docs/SwapEstimateFee.md +12 -0
  149. package/docs/SwapQuote.md +10 -11
  150. package/docs/SwapReceivingTransaction.md +11 -0
  151. package/docs/SwapToken.md +6 -6
  152. package/docs/SwapsApi.md +356 -0
  153. package/docs/TransactionCoboCategory.md +2 -0
  154. package/docs/TransactionDestination.md +2 -0
  155. package/docs/TransactionDestinationType.md +2 -0
  156. package/docs/TransactionFuelingInfo.md +1 -0
  157. package/docs/TransactionSolContractAddressLookupTableAccount.md +10 -0
  158. package/docs/TransactionSolContractDestination.md +1 -0
  159. package/docs/TransactionStellarContractParam.md +11 -0
  160. package/docs/TransactionStellarContractType.md +10 -0
  161. package/docs/TransactionStellarDestination.md +10 -0
  162. package/docs/TransactionStellarTrustLineOperationType.md +10 -0
  163. package/docs/TransactionStellarTrustLineParam.md +11 -0
  164. package/docs/TransactionsApi.md +2 -2
  165. package/docs/UpdateBankAccountByIdRequest.md +9 -0
  166. package/docs/UpdateTopUpAddress.md +1 -1
  167. package/docs/WalletSetup.md +14 -0
  168. package/docs/WebhookEventData.md +4 -1
  169. package/package.json +1 -1
  170. package/docs/BTCEIP191MessageSignDestination.md +0 -10
  171. package/docs/RawMessageSignDestination.md +0 -10
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.StellarContractCallTrustLineOperationType
2
+
3
+ ## Enum
4
+
5
+
6
+ * `ChangeTrust` (value: `"ChangeTrust"`)
7
+
8
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
9
+
10
+
@@ -0,0 +1,11 @@
1
+ # CoboWaas2.StellarContractCallTrustLineParam
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **contract_type** | [**StellarContractCallContractType**](StellarContractCallContractType.md) | |
8
+ **token_id** | **String** | The token ID, which is the unique identifier of a token. |
9
+ **operation_type** | [**StellarContractCallTrustLineOperationType**](StellarContractCallTrustLineOperationType.md) | |
10
+
11
+
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
13
13
  **chain_symbol** | **String** | Symbol of the underlying blockchain |
14
14
  **chain_icon_url** | **String** | URL to the blockchain's icon image | [optional]
15
15
  **token_icon_url** | **String** | URL to the token's icon image | [optional]
16
+ **can_off_ramp** | **Boolean** | Whether the token can by off ramp settlement | [optional]
16
17
 
17
18
 
@@ -7,20 +7,20 @@ Name | Type | Description | Notes
7
7
  **activity_id** | **String** | The unique identifier of the swap activity. | [optional]
8
8
  **swap_type** | [**SwapType**](SwapType.md) | | [optional]
9
9
  **status** | [**SwapActivityStatus**](SwapActivityStatus.md) | | [optional]
10
- **request_id** | **String** | The request id of the swap activity. | [optional]
11
- **wallet_id** | **String** | The unique identifier of the wallet. | [optional]
12
- **pay_token_id** | **String** | The token ID to pay. | [optional]
13
- **receive_token_id** | **String** | The token ID to receive. | [optional]
14
- **pay_amount** | **String** | The amount of tokens to bridge. | [optional]
15
- **receive_amount** | **String** | The amount of tokens to receive. | [optional]
16
- **fee_token_id** | **String** | The fee token ID. | [optional]
17
- **fee_amount** | **String** | The amount of fee. | [optional]
10
+ **request_id** | **String** | The request ID of the swap transaction. | [optional]
11
+ **wallet_id** | **String** | The ID of the wallet used to pay. | [optional]
12
+ **pay_token_id** | **String** | The ID of the token to pay. | [optional]
13
+ **receive_token_id** | **String** | The ID of the token to receive. | [optional]
14
+ **pay_amount** | **String** | The amount of the token to pay. | [optional]
15
+ **receive_amount** | **String** | The amount of the token to receive. | [optional]
16
+ **fee_token_id** | **String** | The ID of the token used for paying the service fee. | [optional]
17
+ **fee_amount** | **String** | The amount of the service fee. | [optional]
18
18
  **initiator** | **String** | The initiator of the swap activity. | [optional]
19
19
  **initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) | | [optional]
20
20
  **description** | **String** | The description of the swap activity. | [optional]
21
21
  **created_timestamp** | **Number** | The time when the swap activity was created, in Unix timestamp format, measured in milliseconds. | [optional]
22
22
  **updated_timestamp** | **Number** | The time when the swap activity was last updated, in Unix timestamp format, measured in milliseconds. | [optional]
23
23
  **network_fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
24
- **destination_address** | **String** | the destination address of web3/mpc wallets. | [optional]
24
+ **destination_address** | **String** | The address of an MPC Wallet or Web3 Wallet that receives the swapped or bridged assets. | [optional]
25
25
 
26
26
 
@@ -7,23 +7,24 @@ Name | Type | Description | Notes
7
7
  **activity_id** | **String** | The unique identifier of the swap activity. | [optional]
8
8
  **swap_type** | [**SwapType**](SwapType.md) | | [optional]
9
9
  **status** | [**SwapActivityStatus**](SwapActivityStatus.md) | | [optional]
10
- **request_id** | **String** | The request id of the swap activity. | [optional]
11
- **wallet_id** | **String** | The unique identifier of the wallet. | [optional]
12
- **pay_token_id** | **String** | The token ID to pay. | [optional]
13
- **receive_token_id** | **String** | The token ID to receive. | [optional]
14
- **pay_amount** | **String** | The amount of tokens to bridge. | [optional]
15
- **receive_amount** | **String** | The amount of tokens to receive. | [optional]
16
- **fee_token_id** | **String** | The fee token ID. | [optional]
17
- **fee_amount** | **String** | The amount of fee. | [optional]
10
+ **request_id** | **String** | The request ID of the swap transaction. | [optional]
11
+ **wallet_id** | **String** | The ID of the wallet used to pay. | [optional]
12
+ **pay_token_id** | **String** | The ID of the token to pay. | [optional]
13
+ **receive_token_id** | **String** | The ID of the token to receive. | [optional]
14
+ **pay_amount** | **String** | The amount of the token to pay. | [optional]
15
+ **receive_amount** | **String** | The amount of the token to receive. | [optional]
16
+ **fee_token_id** | **String** | The ID of the token used for paying the service fee. | [optional]
17
+ **fee_amount** | **String** | The amount of the service fee. | [optional]
18
18
  **initiator** | **String** | The initiator of the swap activity. | [optional]
19
19
  **initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) | | [optional]
20
20
  **description** | **String** | The description of the swap activity. | [optional]
21
21
  **created_timestamp** | **Number** | The time when the swap activity was created, in Unix timestamp format, measured in milliseconds. | [optional]
22
22
  **updated_timestamp** | **Number** | The time when the swap activity was last updated, in Unix timestamp format, measured in milliseconds. | [optional]
23
23
  **network_fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
24
- **destination_address** | **String** | the destination address of web3/mpc wallets. | [optional]
24
+ **destination_address** | **String** | The address of an MPC Wallet or Web3 Wallet that receives the swapped or bridged assets. | [optional]
25
25
  **timeline** | [**[SwapActivityTimeline]**](SwapActivityTimeline.md) | | [optional]
26
26
  **approvers** | [**[SwapActivityApprovers]**](SwapActivityApprovers.md) | | [optional]
27
27
  **signers** | [**[SwapActivitySigners]**](SwapActivitySigners.md) | | [optional]
28
+ **receiving_transaction** | [**SwapReceivingTransaction**](SwapReceivingTransaction.md) | | [optional]
28
29
 
29
30
 
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **signer** | **String** | The signer name. | [optional]
8
8
  **status** | [**SwapSingingStatus**](SwapSingingStatus.md) | | [optional]
9
- **failed_reason** | **String** | Failed reason of signing process. | [optional]
9
+ **failed_reason** | **String** | The reason for the signing failure. | [optional]
10
10
 
11
11
 
@@ -4,8 +4,8 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **action** | **String** | The action of the swap activity. Possible values include: - `Submitted`: The swap request is submitted. - `Pending Authorization`: The swap request is pending authorization. - `Bridge {Token}`: The token is being bridged to the target chain. - `Swap {Token}`: The token is being swapped on the target chain. - `Cobo Confirmation`: The swap result is waiting for Cobo confirmation. |
8
- **status** | **String** | The status of the action. Possible values include: - `Success`: The action is successfully completed. - `Processing`: The action is being processed. - `Failed`: The action has failed. |
9
- **timestamp** | **Number** | The time when the action took place, in Unix timestamp format, measured in milliseconds. | [optional]
7
+ **action** | **String** | The action in the swap activity. Possible values include: - `Submitted`: The swap request has been submitted. - `Pending Authorization`: The swap request is pending authorization. - `Bridge {Token}`: The token is being bridged to the destination chain. - `Swap {Token}`: The token is being exchanged to the destination token. - `Cobo Confirmation`: The swap result is pending Cobo's final confirmation. |
8
+ **status** | **String** | The status of the action. Possible values include: - `Success`: The action completed successfully. - `Processing`: The action is being processed. - `Failed`: The action failed. |
9
+ **timestamp** | **Number** | The time when the action occurred, in Unix timestamp format, measured in milliseconds. | [optional]
10
10
 
11
11
 
@@ -0,0 +1,12 @@
1
+ # CoboWaas2.SwapEstimateFee
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **wallet_id** | **String** | The ID of the wallet to pay. |
8
+ **address** | **String** | The wallet address. This property is required when the wallet to pay is not a Custodial Wallet (Asset Wallet). | [optional]
9
+ **quote_id** | **String** | The ID of the swap quote. |
10
+ **fee_type** | [**FeeType**](FeeType.md) | | [optional]
11
+
12
+
package/docs/SwapQuote.md CHANGED
@@ -4,16 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **quote_id** | **String** | The unique id of quote. |
8
- **pay_token_id** | **String** | The token ID to pay. |
9
- **pay_amount** | **String** | The amount of tokens to pay. |
10
- **receive_token_id** | **String** | The token ID to receive. |
11
- **receive_amount** | **String** | The amount of tokens to receive. |
12
- **fee_token_id** | **String** | The token ID for the service fee. |
13
- **fee_amount** | **String** | The amount of tokens for the service fee. |
14
- **estimated_network_fee_amount** | **String** | The estimated amount of tokens for the network fee. | [optional]
15
- **min_receive_amount** | **String** | The minimum amount of tokens to receive if the pay amount is specified. | [optional]
16
- **max_pay_amount** | **String** | The maximum amount of tokens to pay if the receive amount is specified. | [optional]
17
- **quote_expired_timestamp** | **Number** | The time when the quote will expire, in Unix timestamp format, measured in milliseconds. |
7
+ **quote_id** | **String** | The unique identifier of the swap quote. |
8
+ **pay_token_id** | **String** | The ID of the token to pay. |
9
+ **pay_amount** | **String** | The amount of the token to pay. |
10
+ **receive_token_id** | **String** | The ID of the token to receive. |
11
+ **receive_amount** | **String** | The amount of the token to receive. |
12
+ **fee_token_id** | **String** | The ID of the token for the service fee. |
13
+ **fee_amount** | **String** | The amount of the token for the service fee. |
14
+ **min_receive_amount** | **String** | The minimum amount of the token to receive if `pay_amount` is specified. | [optional]
15
+ **max_pay_amount** | **String** | The maximum amount of the token to pay if `receive_amount` is specified. | [optional]
16
+ **quote_expired_timestamp** | **Number** | The time when the swap quote expires, in Unix timestamp format, measured in milliseconds. |
18
17
 
19
18
 
@@ -0,0 +1,11 @@
1
+ # CoboWaas2.SwapReceivingTransaction
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). |
8
+ **transaction_hash** | **String** | The transaction hash. | [optional]
9
+ **is_loop** | **Boolean** | Whether the transaction was executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - `true`: The transaction was executed as a Cobo Loop transfer. - `false`: The transaction was not executed as a Cobo Loop transfer. | [optional]
10
+
11
+
package/docs/SwapToken.md CHANGED
@@ -4,11 +4,11 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **token_id** | **String** | The token id. |
8
- **chain_id** | **String** | The chain id. |
9
- **asset_id** | **String** | The asset id. |
10
- **token_address** | **String** | The token address. | [optional]
11
- **min_amount** | **String** | The minimum amount. | [optional]
12
- **max_amount** | **String** | The maximum amount. | [optional]
7
+ **token_id** | **String** | The token ID. |
8
+ **chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. |
9
+ **asset_id** | **String** | The asset ID. |
10
+ **token_address** | **String** | The on-chain contract address of the token. | [optional]
11
+ **min_amount** | **String** | The minimum amount allowed for a swap. | [optional]
12
+ **max_amount** | **String** | The maximum amount allowed for a swap. | [optional]
13
13
 
14
14
 
@@ -0,0 +1,356 @@
1
+ # CoboWaas2.SwapsApi
2
+
3
+ All URIs are relative to *https://api.dev.cobo.com/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**createSwapActivity**](SwapsApi.md#createSwapActivity) | **POST** /swaps/swap | Create swap activity
8
+ [**estimateSwapFee**](SwapsApi.md#estimateSwapFee) | **POST** /swaps/estimate_fee | Estimate swap fee
9
+ [**getSwapActivity**](SwapsApi.md#getSwapActivity) | **GET** /swaps/activities/{activity_id} | Get swap activity
10
+ [**getSwapQuote**](SwapsApi.md#getSwapQuote) | **GET** /swaps/quote | Get swap quote
11
+ [**listSwapActivities**](SwapsApi.md#listSwapActivities) | **GET** /swaps/activities | List swap activities
12
+ [**listSwapEnabledTokens**](SwapsApi.md#listSwapEnabledTokens) | **GET** /swaps/enabled_tokens | List enabled tokens for swap
13
+
14
+
15
+
16
+ ## createSwapActivity
17
+
18
+ > SwapActivityDetail createSwapActivity(CreateSwapActivityRequest)
19
+
20
+ Create swap activity
21
+
22
+ This operation creates a swap activity. A swap activity can be either a bridge (cross-chain transfer) or an exchange (token-to-token swap on the same chain).
23
+
24
+ ### Example
25
+
26
+ ```javascript
27
+ const CoboWaas2 = require('@cobo/cobo-waas2');
28
+ // Initialize the API client
29
+ const apiClient = CoboWaas2.ApiClient.instance
30
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
31
+ apiClient.setEnv(CoboWaas2.Env.DEV);
32
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
33
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
34
+ // Call the API
35
+ const apiInstance = new CoboWaas2.SwapsApi();
36
+ const CreateSwapActivityRequest = new CoboWaas2.CreateSwapActivityRequest();
37
+ apiInstance.createSwapActivity(CreateSwapActivityRequest).then((data) => {
38
+ console.log('API called successfully. Returned data: ' + data);
39
+ }, (error) => {
40
+ console.error(error);
41
+ });
42
+
43
+ ```
44
+
45
+ ### Parameters
46
+
47
+
48
+ Name | Type | Description | Notes
49
+ ------------- | ------------- | ------------- | -------------
50
+ **CreateSwapActivityRequest** | [**CreateSwapActivityRequest**](CreateSwapActivityRequest.md)| The request body for creating a swap activity. |
51
+
52
+ ### Return type
53
+
54
+ [**SwapActivityDetail**](SwapActivityDetail.md)
55
+
56
+ ### Authorization
57
+
58
+ [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
59
+
60
+ ### HTTP request headers
61
+
62
+ - **Content-Type**: application/json
63
+ - **Accept**: application/json
64
+
65
+
66
+ ## estimateSwapFee
67
+
68
+ > EstimatedFee estimateSwapFee(SwapEstimateFee)
69
+
70
+ Estimate swap fee
71
+
72
+ This operation estimates the network fee of a swap activity. You can use this operation to estimate the network fee before initiating swap activities from MPC Wallets or Web3 Wallets. It requires a valid &#x60;wallet_id&#x60; and &#x60;quote_id&#x60;, so you need to [get a swap quote](https://www.cobo.com/developers/v2/api-references/swaps/get-swap-quote) first.
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.SwapsApi();
86
+ const SwapEstimateFee = new CoboWaas2.SwapEstimateFee();
87
+ apiInstance.estimateSwapFee(SwapEstimateFee).then((data) => {
88
+ console.log('API called successfully. Returned data: ' + data);
89
+ }, (error) => {
90
+ console.error(error);
91
+ });
92
+
93
+ ```
94
+
95
+ ### Parameters
96
+
97
+
98
+ Name | Type | Description | Notes
99
+ ------------- | ------------- | ------------- | -------------
100
+ **SwapEstimateFee** | [**SwapEstimateFee**](SwapEstimateFee.md)| The request body for estimating the network fee of a swap activity. |
101
+
102
+ ### Return type
103
+
104
+ [**EstimatedFee**](EstimatedFee.md)
105
+
106
+ ### Authorization
107
+
108
+ [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
109
+
110
+ ### HTTP request headers
111
+
112
+ - **Content-Type**: application/json
113
+ - **Accept**: application/json
114
+
115
+
116
+ ## getSwapActivity
117
+
118
+ > SwapActivityDetail getSwapActivity(activity_id)
119
+
120
+ Get swap activity
121
+
122
+ This operation retrieves detailed information about a specified swap activity.
123
+
124
+ ### Example
125
+
126
+ ```javascript
127
+ const CoboWaas2 = require('@cobo/cobo-waas2');
128
+ // Initialize the API client
129
+ const apiClient = CoboWaas2.ApiClient.instance
130
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
131
+ apiClient.setEnv(CoboWaas2.Env.DEV);
132
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
133
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
134
+ // Call the API
135
+ const apiInstance = new CoboWaas2.SwapsApi();
136
+ const activity_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
137
+ apiInstance.getSwapActivity(activity_id).then((data) => {
138
+ console.log('API called successfully. Returned data: ' + data);
139
+ }, (error) => {
140
+ console.error(error);
141
+ });
142
+
143
+ ```
144
+
145
+ ### Parameters
146
+
147
+
148
+ Name | Type | Description | Notes
149
+ ------------- | ------------- | ------------- | -------------
150
+ **activity_id** | **String**| The unique identifier of the swap activity. |
151
+
152
+ ### Return type
153
+
154
+ [**SwapActivityDetail**](SwapActivityDetail.md)
155
+
156
+ ### Authorization
157
+
158
+ [CoboAuth](../README.md#CoboAuth)
159
+
160
+ ### HTTP request headers
161
+
162
+ - **Content-Type**: Not defined
163
+ - **Accept**: application/json
164
+
165
+
166
+ ## getSwapQuote
167
+
168
+ > SwapQuote getSwapQuote(wallet_id, pay_token_id, receive_token_id, opts)
169
+
170
+ Get swap quote
171
+
172
+ This operation retrieves the current market exchange rate and estimated service fee. You need to provide &#x60;wallet_id&#x60;, &#x60;pay_token_id&#x60;, and &#x60;receive_token_id&#x60;, along with either &#x60;pay_amount&#x60; or &#x60;receive_amount&#x60;.
173
+
174
+ ### Example
175
+
176
+ ```javascript
177
+ const CoboWaas2 = require('@cobo/cobo-waas2');
178
+ // Initialize the API client
179
+ const apiClient = CoboWaas2.ApiClient.instance
180
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
181
+ apiClient.setEnv(CoboWaas2.Env.DEV);
182
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
183
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
184
+ // Call the API
185
+ const apiInstance = new CoboWaas2.SwapsApi();
186
+ const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
187
+ const pay_token_id = "ETH";
188
+ const receive_token_id = "USDT";
189
+ const opts = {
190
+ 'pay_amount': "1.5",
191
+ 'receive_amount': "2000"
192
+ };
193
+ apiInstance.getSwapQuote(wallet_id, pay_token_id, receive_token_id, opts).then((data) => {
194
+ console.log('API called successfully. Returned data: ' + data);
195
+ }, (error) => {
196
+ console.error(error);
197
+ });
198
+
199
+ ```
200
+
201
+ ### Parameters
202
+
203
+
204
+ Name | Type | Description | Notes
205
+ ------------- | ------------- | ------------- | -------------
206
+ **wallet_id** | **String**| The wallet ID. |
207
+ **pay_token_id** | **String**| The ID of the token to pay. |
208
+ **receive_token_id** | **String**| The ID of the token to receive. |
209
+ **pay_amount** | **String**| The amount of the token to pay. | [optional]
210
+ **receive_amount** | **String**| The amount of the token to receive. | [optional]
211
+
212
+ ### Return type
213
+
214
+ [**SwapQuote**](SwapQuote.md)
215
+
216
+ ### Authorization
217
+
218
+ [CoboAuth](../README.md#CoboAuth)
219
+
220
+ ### HTTP request headers
221
+
222
+ - **Content-Type**: Not defined
223
+ - **Accept**: application/json
224
+
225
+
226
+ ## listSwapActivities
227
+
228
+ > ListSwapActivities200Response listSwapActivities(opts)
229
+
230
+ List swap activities
231
+
232
+ This operation retrieves a list of swap activities. You can filter the results by swap type, status, initiator, and time range.
233
+
234
+ ### Example
235
+
236
+ ```javascript
237
+ const CoboWaas2 = require('@cobo/cobo-waas2');
238
+ // Initialize the API client
239
+ const apiClient = CoboWaas2.ApiClient.instance
240
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
241
+ apiClient.setEnv(CoboWaas2.Env.DEV);
242
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
243
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
244
+ // Call the API
245
+ const apiInstance = new CoboWaas2.SwapsApi();
246
+ const opts = {
247
+ 'type': new CoboWaas2.SwapType(),
248
+ 'status': new CoboWaas2.SwapActivityStatus(),
249
+ 'min_updated_timestamp': 1635744000000,
250
+ 'max_updated_timestamp': 1635744000000,
251
+ 'initiator': "steve@example.com",
252
+ 'limit': 10,
253
+ 'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
254
+ 'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
255
+ 'sort_by': "created_timestamp",
256
+ 'direction': "ASC"
257
+ };
258
+ apiInstance.listSwapActivities(opts).then((data) => {
259
+ console.log('API called successfully. Returned data: ' + data);
260
+ }, (error) => {
261
+ console.error(error);
262
+ });
263
+
264
+ ```
265
+
266
+ ### Parameters
267
+
268
+
269
+ Name | Type | Description | Notes
270
+ ------------- | ------------- | ------------- | -------------
271
+ **type** | [**SwapType**](.md)| | [optional]
272
+ **status** | [**SwapActivityStatus**](.md)| | [optional]
273
+ **min_updated_timestamp** | **Number**| The start time of the query. All swap activities updated after the specified time will be retrieved. The time is in Unix timestamp format, measured in milliseconds. | [optional]
274
+ **max_updated_timestamp** | **Number**| The end time of the query. All swap activities updated before the specified time will be retrieved. The time is in Unix timestamp format, measured in milliseconds. | [optional]
275
+ **initiator** | **String**| The initiator of the swap activity. It is optional when creating the activity and defaults to your API key if not specified. | [optional]
276
+ **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
277
+ **before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
278
+ **after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
279
+ **sort_by** | **String**| The field to sort the results by. Possible values include: - &#x60;created_timestamp&#x60;: Sort by the time when the data was created. - &#x60;updated_timestamp&#x60;: Sort by the time when the data was last updated. | [optional]
280
+ **direction** | **String**| The sort direction. Possible values include: - &#x60;ASC&#x60;: Sort the results in ascending order. - &#x60;DESC&#x60;: Sort the results in descending order. | [optional] [default to &#39;ASC&#39;]
281
+
282
+ ### Return type
283
+
284
+ [**ListSwapActivities200Response**](ListSwapActivities200Response.md)
285
+
286
+ ### Authorization
287
+
288
+ [CoboAuth](../README.md#CoboAuth)
289
+
290
+ ### HTTP request headers
291
+
292
+ - **Content-Type**: Not defined
293
+ - **Accept**: application/json
294
+
295
+
296
+ ## listSwapEnabledTokens
297
+
298
+ > ListSwapEnabledTokens200Response listSwapEnabledTokens(opts)
299
+
300
+ List enabled tokens for swap
301
+
302
+ This operation retrieves a list of tokens that are enabled for the swap feature. You can filter the results by swap type, asset ID, and chain ID.
303
+
304
+ ### Example
305
+
306
+ ```javascript
307
+ const CoboWaas2 = require('@cobo/cobo-waas2');
308
+ // Initialize the API client
309
+ const apiClient = CoboWaas2.ApiClient.instance
310
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
311
+ apiClient.setEnv(CoboWaas2.Env.DEV);
312
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
313
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
314
+ // Call the API
315
+ const apiInstance = new CoboWaas2.SwapsApi();
316
+ const opts = {
317
+ 'type': new CoboWaas2.SwapType(),
318
+ 'asset_id': "USDT",
319
+ 'chain_id': "ETH",
320
+ 'limit': 10,
321
+ 'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
322
+ 'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
323
+ };
324
+ apiInstance.listSwapEnabledTokens(opts).then((data) => {
325
+ console.log('API called successfully. Returned data: ' + data);
326
+ }, (error) => {
327
+ console.error(error);
328
+ });
329
+
330
+ ```
331
+
332
+ ### Parameters
333
+
334
+
335
+ Name | Type | Description | Notes
336
+ ------------- | ------------- | ------------- | -------------
337
+ **type** | [**SwapType**](.md)| | [optional]
338
+ **asset_id** | **String**| (This concept applies to Exchange Wallets only) The asset ID. An asset ID is the unique identifier of the asset held within your linked exchange account. | [optional]
339
+ **chain_id** | **String**| The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional]
340
+ **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
341
+ **before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
342
+ **after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
343
+
344
+ ### Return type
345
+
346
+ [**ListSwapEnabledTokens200Response**](ListSwapEnabledTokens200Response.md)
347
+
348
+ ### Authorization
349
+
350
+ [CoboAuth](../README.md#CoboAuth)
351
+
352
+ ### HTTP request headers
353
+
354
+ - **Content-Type**: Not defined
355
+ - **Accept**: application/json
356
+
@@ -65,6 +65,8 @@
65
65
 
66
66
  * `ComplianceIsolate` (value: `"ComplianceIsolate"`)
67
67
 
68
+ * `StellarChangeTrust` (value: `"StellarChangeTrust"`)
69
+
68
70
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
69
71
 
70
72
 
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
19
19
  **calldata** | **String** | The data used to invoke a specific function or method within the specified contract at the destination address, with a maximum length of 65,000 characters. |
20
20
  **calldata_info** | [**TransactionEvmCalldataInfo**](TransactionEvmCalldataInfo.md) | | [optional]
21
21
  **instructions** | [**[TransactionSolContractInstruction]**](TransactionSolContractInstruction.md) | | [optional]
22
+ **address_lookup_table_accounts** | [**[TransactionSolContractAddressLookupTableAccount]**](TransactionSolContractAddressLookupTableAccount.md) | | [optional]
22
23
  **cosmos_messages** | [**[TransactionCosmosMessage]**](TransactionCosmosMessage.md) | |
23
24
  **message** | **String** | The raw data of the message to be signed, encoded in Base64 format. |
24
25
  **raw_structured_data** | **String** | The raw structured data to be signed, formatted as a JSON string. | [optional]
@@ -32,5 +33,6 @@ Name | Type | Description | Notes
32
33
  **message_bip137** | **String** | Message to be signed, in hexadecimal format. |
33
34
  **message_bip322** | **String** | Message to be signed, in hexadecimal format. |
34
35
  **message_cosmos_adr36** | **String** | Message to be signed, in hexadecimal format. |
36
+ **contract_param** | [**TransactionStellarContractParam**](TransactionStellarContractParam.md) | |
35
37
 
36
38
 
@@ -13,6 +13,8 @@
13
13
 
14
14
  * `SOL_Contract` (value: `"SOL_Contract"`)
15
15
 
16
+ * `STELLAR_Contract` (value: `"STELLAR_Contract"`)
17
+
16
18
  * `COSMOS_Contract` (value: `"COSMOS_Contract"`)
17
19
 
18
20
  * `EVM_EIP_191_Signature` (value: `"EVM_EIP_191_Signature"`)
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **request_id** | **String** | The request ID of the transaction. | [optional]
8
8
  **transaction_id** | **String** | The transaction ID. | [optional]
9
+ **main_transaction_id** | **String** | The UUID of the parent (main) transaction that this record is associated with. Set only when the current record is a gas/fee transaction initiated by Fee Station; omit for main transactions. | [optional]
9
10
 
10
11
 
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.TransactionSolContractAddressLookupTableAccount
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **alt_account_key** | **String** | The on-chain public key of the Address Lookup Table (ALT) account, identifying the specific lookup table. |
8
+ **addresses** | **[String]** | An array of stored account addresses within the lookup table, which can be referenced in transactions by index. |
9
+
10
+
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **destination_type** | [**TransactionDestinationType**](TransactionDestinationType.md) | |
8
8
  **instructions** | [**[TransactionSolContractInstruction]**](TransactionSolContractInstruction.md) | | [optional]
9
+ **address_lookup_table_accounts** | [**[TransactionSolContractAddressLookupTableAccount]**](TransactionSolContractAddressLookupTableAccount.md) | | [optional]
9
10
 
10
11
 
@@ -0,0 +1,11 @@
1
+ # CoboWaas2.TransactionStellarContractParam
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **contract_type** | [**TransactionStellarContractType**](TransactionStellarContractType.md) | |
8
+ **token_id** | **String** | The token ID, which is the unique identifier of a token. |
9
+ **operation_type** | [**TransactionStellarTrustLineOperationType**](TransactionStellarTrustLineOperationType.md) | |
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.TransactionStellarContractType
2
+
3
+ ## Enum
4
+
5
+
6
+ * `TrustLine` (value: `"TrustLine"`)
7
+
8
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.TransactionStellarDestination
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **destination_type** | [**TransactionDestinationType**](TransactionDestinationType.md) | |
8
+ **contract_param** | [**TransactionStellarContractParam**](TransactionStellarContractParam.md) | |
9
+
10
+