@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.TransactionStellarTrustLineOperationType
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.TransactionStellarTrustLineParam
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
+
@@ -186,7 +186,7 @@ Name | Type | Description | Notes
186
186
 
187
187
  Call smart contract
188
188
 
189
- This operation creates a transaction to interact with a smart contract on the blockchain. You need to provide details such as the source address, destination address, and the calldata. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation. <Note>Currently, this operation only applies to the transactions from Custodial Wallets (Web3 Wallets), MPC Wallets, or Smart Contract Wallets on the blockchains that have a similar architecture to Ethereum.</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>
189
+ This operation creates a transaction to interact with a smart contract on the blockchain. You need to provide details such as the source address, destination address, and the calldata. You can specify the fee-related properties to limit the transaction fee. A transaction request for tracking is returned upon successful operation. <Note>Currently, this operation only applies to transactions from Custodial Wallets (Web3 Wallets), MPC Wallets, or Smart Contract Wallets on EVM-compatible chains and Solana. Solana v0 transactions are not supported.</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>
190
190
 
191
191
  ### Example
192
192
 
@@ -238,7 +238,7 @@ Name | Type | Description | Notes
238
238
 
239
239
  Sign message
240
240
 
241
- This operation creates a transaction to sign the provided message using cryptographic techniques. In some scenarios, you want to sign a message for identity authentication or transaction approval. You need to provide details such as the source address, destination address, and the message to be signed. A transaction request for tracking is returned upon successful operation. You can get the signature result by calling [Get transaction information](https://www.cobo.com/developers/v2/api-references/transactions/get-transaction-information). <Note> This operation only supports message signing transactions from the following wallets and chains: - MPC Wallets: BTC, EVM-compatible chains, Cosmos, and Solana. - Web3 Wallets: EVM-compatible chains. </Note>
241
+ This operation creates a transaction to sign the provided message using cryptographic techniques. In some scenarios, you want to sign a message for identity authentication or transaction approval. You need to provide details such as the source address, destination address, and the message to be signed. A transaction request for tracking is returned upon successful operation. You can get the signature result by calling [Get transaction information](https://www.cobo.com/developers/v2/api-references/transactions/get-transaction-information). <Note> This operation only supports message signing transactions from the following wallets and chains: - MPC Wallets: BTC, EVM-compatible chains, and Cosmos. - Web3 Wallets: EVM-compatible chains. </Note>
242
242
 
243
243
  ### Example
244
244
 
@@ -0,0 +1,9 @@
1
+ # CoboWaas2.UpdateBankAccountByIdRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **info** | **{String: Object}** | JSON-formatted bank account details. The object should include the following fields: - beneficiary_name: Name of the account holder - beneficiary_address: Address of the account holder - account_number: Bank account number - bank_name: Name of the bank - bank_address: Address of the bank - iban: (Optional) International Bank Account Number - swift_or_bic: SWIFT or BIC code of the bank |
8
+
9
+
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **merchant_id** | **String** | The merchant ID. |
7
+ **merchant_id** | **String** | The merchant ID. | [optional]
8
8
  **token_id** | **String** | The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
9
9
  **custom_payer_id** | **String** | A unique identifier assigned by the developer to track and identify individual payers in their system. |
10
10
 
@@ -0,0 +1,14 @@
1
+ # CoboWaas2.WalletSetup
2
+
3
+ ## Enum
4
+
5
+
6
+ * `Default` (value: `"Default"`)
7
+
8
+ * `Shared` (value: `"Shared"`)
9
+
10
+ * `Separate` (value: `"Separate"`)
11
+
12
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
13
+
14
+
@@ -62,7 +62,7 @@ Name | Type | Description | Notes
62
62
  **merchant_id** | **String** | The merchant ID. | [optional]
63
63
  **payable_amount** | **String** | The cryptocurrency amount to be paid for this order. |
64
64
  **receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
65
- **currency** | **String** | The fiat currency of the order. |
65
+ **currency** | **String** | The fiat currency for the settlement request. |
66
66
  **order_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). |
67
67
  **fee_amount** | **String** | The developer fee for the order in fiat currency. It is added to the base amount (`order_amount`) to determine the final charge. |
68
68
  **exchange_rate** | **String** | The exchange rate between a currency pair. Expressed as the amount of fiat currency per one unit of cryptocurrency. For example, if the cryptocurrency is USDT and the fiat currency is USD, a rate of \"0.99\" means 1 USDT = 0.99 USD. |
@@ -79,11 +79,14 @@ Name | Type | Description | Notes
79
79
  **charge_merchant_fee** | **Boolean** | Whether to charge developer fee to the merchant for the refund. - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance - `false`: The merchant is not charged any developer fee. | [optional]
80
80
  **merchant_fee_amount** | **String** | The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This is only applicable if `charge_merchant_fee` is set to `true`. | [optional]
81
81
  **merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the developer fee. This is only applicable if `charge_merchant_fee` is set to true. | [optional]
82
+ **commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional]
82
83
  **settlement_request_id** | **String** | The settlement request ID generated by Cobo. |
83
84
  **settlements** | [**[SettlementDetail]**](SettlementDetail.md) | |
84
85
  **acquiring_type** | [**AcquiringType**](AcquiringType.md) | |
85
86
  **payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional]
86
87
  **settlement_type** | [**SettlementType**](SettlementType.md) | | [optional]
88
+ **received_amount_fiat** | **String** | The received fiat amount of this settlement request. | [optional]
89
+ **bank_account** | [**BankAccount**](BankAccount.md) | | [optional]
87
90
  **payer_id** | **String** | A unique identifier assigned by Cobo to track and identify individual payers. |
88
91
  **custom_payer_id** | **String** | A unique identifier assigned by the developer to track and identify individual payers in their system. |
89
92
  **chain** | **String** | The chain ID. |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cobo/cobo-waas2",
3
- "version": "1.23.0",
3
+ "version": "1.24.0",
4
4
  "description": "The Cobo Wallet-as-a-Service (WaaS) 2.0 API is the latest version of Cobo's WaaS API offering. It enables you to access Cobo's full suite of crypto wallet technologies with powerful and flexible access controls. By encapsulating complex security protocols and streamlining blockchain interactions, this API allows you to concentrate on your core business activities without worrying about the safety of your assets. The WaaS 2.0 API presents the following key features: - A unified API for Cobo's [all four wallet types](https://manuals.cobo.com/en/portal/introduction#an-all-in-one-wallet-platform) - Support for 80+ chains and 3000+ tokens - A comprehensive selection of webhook events - Flexible usage models for MPC Wallets, including [Organization-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/introduction) and [User-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ucw/introduction) - Programmatic control of smart contract wallets such as Safe{Wallet} with fine-grained access controls - Seamlessly transfer funds across multiple exchanges, including Binance, OKX, Bybit, Deribit, and more For more information about the WaaS 2.0 API, see [Introduction to WaaS 2.0](https://www.cobo.com/developers/v2/guides/overview/introduction). ",
5
5
  "license": "GPL 2.0",
6
6
  "main": "dist/index.js",
@@ -1,10 +0,0 @@
1
- # CoboWaas2.BTCEIP191MessageSignDestination
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **destination_type** | [**MessageSignDestinationType**](MessageSignDestinationType.md) | |
8
- **message** | **String** | The raw data of the message to be signed, encoded in Base64 format. |
9
-
10
-
@@ -1,10 +0,0 @@
1
- # CoboWaas2.RawMessageSignDestination
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **destination_type** | [**MessageSignDestinationType**](MessageSignDestinationType.md) | |
8
- **msg_hash** | **String** | Message hash to be signed, in hexadecimal format. |
9
-
10
-