@cobo/cobo-waas2 1.17.0 → 1.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -4
- package/dist/ApiClient.js +1 -1
- package/dist/api/FeeStationApi.js +2 -2
- package/dist/api/OAuthApi.js +12 -12
- package/dist/api/OrganizationsApi.js +79 -0
- package/dist/api/PaymentApi.js +233 -16
- package/dist/api/TransactionsApi.js +2 -2
- package/dist/api/WalletsApi.js +5 -2
- package/dist/index.js +203 -7
- package/dist/model/Account.js +174 -0
- package/dist/model/AcquiringType.js +61 -0
- package/dist/model/AddressTransferDestination.js +2 -2
- package/dist/model/AddressesEventData.js +8 -3
- package/dist/model/BalanceUpdateInfo.js +170 -0
- package/dist/model/BalanceUpdateInfoEventData.js +297 -0
- package/dist/model/BankAccount.js +2 -2
- package/dist/model/ChainsEventData.js +8 -3
- package/dist/model/CreateMerchantRequest.js +13 -0
- package/dist/model/CreatePaymentOrderRequest.js +10 -1
- package/dist/model/CreateRefundRequest.js +9 -11
- package/dist/model/CreateSettlement.js +8 -27
- package/dist/model/CreateSettlementRequestRequest.js +27 -0
- package/dist/model/CryptoAddress.js +7 -7
- package/dist/model/CustodialTransferDestination.js +1 -1
- package/dist/model/EstimateContractCallFeeParams.js +2 -2
- package/dist/model/EstimateFeeParams.js +1 -1
- package/dist/model/EstimatedFILFee.js +170 -0
- package/dist/model/EstimatedFILFeeSlow.js +186 -0
- package/dist/model/EstimatedFee.js +68 -12
- package/dist/model/EstimatedSOLFee.js +170 -0
- package/dist/model/EstimatedSOLFeeSlow.js +184 -0
- package/dist/model/ExchangePermissionToken201Response.js +4 -4
- package/dist/model/ExchangePermissionTokenRequest.js +2 -2
- package/dist/model/FILBase.js +88 -0
- package/dist/model/FILPrice.js +114 -0
- package/dist/model/FeeType.js +10 -0
- package/dist/model/GetExchangeRate200Response.js +2 -2
- package/dist/model/GraphQLError.js +135 -0
- package/dist/model/GraphQLErrorLocationsInner.js +92 -0
- package/dist/model/{TransactionMessageSignBTCEIP191Destination.js → GraphQLRequest.js} +49 -36
- package/dist/model/GraphQLResponse.js +119 -0
- package/dist/model/ListTopUpPayers200Response.js +123 -0
- package/dist/model/ListTopUpPayers200ResponseDataInner.js +189 -0
- package/dist/model/MPCVaultEventData.js +8 -3
- package/dist/model/Merchant.js +15 -2
- package/dist/model/Order.js +12 -3
- package/dist/model/PayerAccount.js +189 -0
- package/dist/model/PaymentOrderEventData.js +27 -9
- package/dist/model/PaymentRefundEventData.js +66 -11
- package/dist/model/PaymentSettlementEvent.js +14 -9
- package/dist/model/RefreshPermissionTokenRequest.js +2 -2
- package/dist/model/Refund.js +39 -4
- package/dist/model/RefundStatus.js +5 -0
- package/dist/model/SOLBase.js +101 -0
- package/dist/model/SOLComputeUnit.js +101 -0
- package/dist/model/Settlement.js +3 -3
- package/dist/model/SettlementDetail.js +15 -6
- package/dist/model/SettlementInfo.js +11 -2
- package/dist/model/SwapActivityDetail.js +30 -0
- package/dist/model/SwapActivitySigners.js +110 -0
- package/dist/model/SwapQuote.js +17 -4
- package/dist/model/SwapSingingStatus.js +71 -0
- package/dist/model/TSSRequestWebhookEventData.js +8 -3
- package/dist/model/TokenListingEventData.js +8 -3
- package/dist/model/TokensEventData.js +8 -3
- package/dist/model/TopUpAddress.js +230 -0
- package/dist/model/TransactionCoboCategory.js +20 -0
- package/dist/model/TransactionDestination.js +10 -38
- package/dist/model/TransactionEvmCalldataInfo.js +1 -1
- package/dist/model/TransactionFILFee.js +229 -0
- package/dist/model/TransactionFee.js +107 -9
- package/dist/model/TransactionRequestFILFee.js +186 -0
- package/dist/model/TransactionRequestFee.js +89 -9
- package/dist/model/TransactionRequestSOLFee.js +168 -0
- package/dist/model/TransactionSOLFee.js +229 -0
- package/dist/model/TransactionTransferToAddressDestination.js +2 -2
- package/dist/model/TransactionTransferToWalletDestination.js +1 -1
- package/dist/model/TransactionWebhookEventData.js +8 -3
- package/dist/model/TransferDestination.js +2 -2
- package/dist/model/UpdateMerchantByIdRequest.js +13 -0
- package/dist/model/UpdateRefundByIdRequest.js +110 -0
- package/dist/model/UpdateTopUpAddress.js +141 -0
- package/dist/model/WalletInfoEventData.js +8 -3
- package/dist/model/WebhookEvent.js +2 -2
- package/dist/model/WebhookEventData.js +83 -13
- package/dist/model/WebhookEventDataType.js +7 -2
- package/dist/model/WebhookEventLog.js +2 -2
- package/dist/model/WebhookEventType.js +15 -0
- package/docs/Account.md +14 -0
- package/docs/AcquiringType.md +12 -0
- package/docs/AddressTransferDestination.md +2 -2
- package/docs/AddressesEventData.md +3 -1
- package/docs/BalanceUpdateInfo.md +13 -0
- package/docs/BalanceUpdateInfoEventData.md +47 -0
- package/docs/BankAccount.md +2 -2
- package/docs/ChainsEventData.md +3 -1
- package/docs/CreateMerchantRequest.md +1 -0
- package/docs/CreatePaymentOrderRequest.md +2 -1
- package/docs/CreateRefundRequest.md +5 -5
- package/docs/CreateSettlement.md +7 -9
- package/docs/CreateSettlementRequestRequest.md +3 -0
- package/docs/CryptoAddress.md +5 -5
- package/docs/EstimateContractCallFeeParams.md +1 -1
- package/docs/EstimateFeeParams.md +1 -1
- package/docs/EstimatedFILFee.md +13 -0
- package/docs/EstimatedFILFeeSlow.md +12 -0
- package/docs/EstimatedFee.md +3 -3
- package/docs/EstimatedSOLFee.md +13 -0
- package/docs/EstimatedSOLFeeSlow.md +12 -0
- package/docs/ExchangePermissionToken201Response.md +4 -4
- package/docs/ExchangePermissionTokenRequest.md +1 -1
- package/docs/FILBase.md +9 -0
- package/docs/FILPrice.md +11 -0
- package/docs/FeeStationApi.md +1 -1
- package/docs/FeeType.md +4 -0
- package/docs/GetExchangeRate200Response.md +1 -1
- package/docs/GraphQLError.md +11 -0
- package/docs/GraphQLErrorLocationsInner.md +10 -0
- package/docs/GraphQLRequest.md +11 -0
- package/docs/GraphQLResponse.md +10 -0
- package/docs/ListTopUpPayers200Response.md +10 -0
- package/docs/ListTopUpPayers200ResponseDataInner.md +14 -0
- package/docs/MPCVaultEventData.md +3 -1
- package/docs/Merchant.md +3 -2
- package/docs/OAuthApi.md +8 -8
- package/docs/Order.md +4 -3
- package/docs/OrganizationsApi.md +55 -0
- package/docs/PayerAccount.md +14 -0
- package/docs/PaymentApi.md +230 -6
- package/docs/PaymentOrderEventData.md +7 -4
- package/docs/PaymentRefundEventData.md +10 -5
- package/docs/PaymentSettlementEvent.md +6 -4
- package/docs/RefreshPermissionTokenRequest.md +1 -1
- package/docs/Refund.md +7 -4
- package/docs/RefundStatus.md +2 -0
- package/docs/SOLBase.md +10 -0
- package/docs/SOLComputeUnit.md +10 -0
- package/docs/Settlement.md +3 -3
- package/docs/SettlementDetail.md +7 -6
- package/docs/SettlementInfo.md +3 -2
- package/docs/SwapActivityDetail.md +1 -0
- package/docs/SwapActivitySigners.md +11 -0
- package/docs/SwapQuote.md +3 -2
- package/docs/SwapSingingStatus.md +16 -0
- package/docs/TSSRequestWebhookEventData.md +3 -1
- package/docs/TokenListingEventData.md +3 -1
- package/docs/TokensEventData.md +3 -1
- package/docs/TopUpAddress.md +18 -0
- package/docs/TransactionCoboCategory.md +8 -0
- package/docs/TransactionDestination.md +2 -2
- package/docs/TransactionEvmCalldataInfo.md +1 -1
- package/docs/TransactionFILFee.md +16 -0
- package/docs/TransactionFee.md +8 -1
- package/docs/TransactionRequestFILFee.md +13 -0
- package/docs/TransactionRequestFee.md +5 -1
- package/docs/TransactionRequestSOLFee.md +12 -0
- package/docs/TransactionSOLFee.md +16 -0
- package/docs/TransactionTransferToAddressDestination.md +2 -2
- package/docs/TransactionTransferToWalletDestination.md +1 -1
- package/docs/TransactionWebhookEventData.md +3 -1
- package/docs/TransactionsApi.md +1 -1
- package/docs/TransferDestination.md +2 -2
- package/docs/UpdateMerchantByIdRequest.md +1 -0
- package/docs/UpdateRefundByIdRequest.md +9 -0
- package/docs/UpdateTopUpAddress.md +11 -0
- package/docs/WalletInfoEventData.md +3 -1
- package/docs/WalletsApi.md +3 -1
- package/docs/WebhookEvent.md +1 -1
- package/docs/WebhookEventData.md +14 -5
- package/docs/WebhookEventDataType.md +3 -1
- package/docs/WebhookEventLog.md +1 -1
- package/docs/WebhookEventType.md +6 -0
- package/package.json +1 -1
- package/docs/TransactionMessageSignBTCEIP191Destination.md +0 -10
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
8
8
|
**request_id** | **String** | The unique identifier of the token listing request. |
|
|
9
9
|
**chain_id** | **String** | The ID of the blockchain where the token is deployed. |
|
|
10
10
|
**contract_address** | **String** | The token's contract address on the specified blockchain. |
|
|
@@ -38,6 +38,8 @@ Name | Type | Description | Notes
|
|
|
38
38
|
|
|
39
39
|
* `TokenListing` (value: `"TokenListing"`)
|
|
40
40
|
|
|
41
|
+
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
42
|
+
|
|
41
43
|
* `PaymentOrder` (value: `"PaymentOrder"`)
|
|
42
44
|
|
|
43
45
|
* `PaymentRefund` (value: `"PaymentRefund"`)
|
package/docs/TokensEventData.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
8
8
|
**tokens** | [**[TokenInfo]**](TokenInfo.md) | The enabled tokens. |
|
|
9
9
|
**wallet_type** | [**WalletType**](WalletType.md) | | [optional]
|
|
10
10
|
**wallet_subtypes** | [**[WalletSubtype]**](WalletSubtype.md) | | [optional]
|
|
@@ -30,6 +30,8 @@ Name | Type | Description | Notes
|
|
|
30
30
|
|
|
31
31
|
* `TokenListing` (value: `"TokenListing"`)
|
|
32
32
|
|
|
33
|
+
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
34
|
+
|
|
33
35
|
* `PaymentOrder` (value: `"PaymentOrder"`)
|
|
34
36
|
|
|
35
37
|
* `PaymentRefund` (value: `"PaymentRefund"`)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# CoboWaas2.TopUpAddress
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**address** | **String** | The dedicated top-up address assigned to a specific payer under a merchant on a specified chain. |
|
|
8
|
+
**payer_id** | **String** | A unique identifier assigned by Cobo to track and identify individual payers. |
|
|
9
|
+
**custom_payer_id** | **String** | A unique identifier assigned by the developer to track and identify individual payers in their system. |
|
|
10
|
+
**merchant_id** | **String** | The merchant ID. |
|
|
11
|
+
**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}`. |
|
|
12
|
+
**chain** | **String** | The chain ID. | [optional]
|
|
13
|
+
**developer_fee_rate** | **String** | The developer fee rate applied to top-up transactions made to this address. Expressed as a decimal string where \"0.1\" represents 10%. | [optional]
|
|
14
|
+
**min_amount** | **String** | The minimum top-up amount allowed for this address. Top-ups below this threshold will not be credited to merchant funds, but to developer funds instead. |
|
|
15
|
+
**created_timestamp** | **Number** | The creation time of the top-up address, represented as a UNIX timestamp in seconds. | [optional]
|
|
16
|
+
**updated_timestamp** | **Number** | The last update time of the top-up address, represented as a UNIX timestamp in seconds. | [optional]
|
|
17
|
+
|
|
18
|
+
|
|
@@ -57,6 +57,14 @@
|
|
|
57
57
|
|
|
58
58
|
* `StakingSkyfarmUnstake` (value: `"StakingSkyfarmUnstake"`)
|
|
59
59
|
|
|
60
|
+
* `ScreenAppRefund` (value: `"ScreenAppRefund"`)
|
|
61
|
+
|
|
62
|
+
* `ScreenAppIsolate` (value: `"ScreenAppIsolate"`)
|
|
63
|
+
|
|
64
|
+
* `ComplianceRefund` (value: `"ComplianceRefund"`)
|
|
65
|
+
|
|
66
|
+
* `ComplianceIsolate` (value: `"ComplianceIsolate"`)
|
|
67
|
+
|
|
60
68
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
61
69
|
|
|
62
70
|
|
|
@@ -8,8 +8,8 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**account_output** | [**TransactionTransferToAddressDestinationAccountOutput**](TransactionTransferToAddressDestinationAccountOutput.md) | | [optional]
|
|
9
9
|
**utxo_outputs** | [**[TransactionTransferToAddressDestinationUtxoOutputsInner]**](TransactionTransferToAddressDestinationUtxoOutputsInner.md) | | [optional]
|
|
10
10
|
**change_address** | **String** | The address used to receive the remaining funds or change from the transaction. | [optional]
|
|
11
|
-
**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. - `true`: The transaction request must be executed as a Cobo Loop transfer. - `false`: The transaction request may not be executed as a Cobo Loop transfer. | [optional]
|
|
12
|
-
**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. - `true`: The transaction request must not be executed as a Cobo Loop transfer. - `false`: The transaction request can be executed as a Cobo Loop transfer. | [optional]
|
|
11
|
+
**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. - `true`: The transaction request must be executed as a Cobo Loop transfer. - `false`: The transaction request may not be executed as a Cobo Loop transfer. If both `force_internal` and `force_external` are set to `false`, the system uses Cobo Loop by default if possible; otherwise, it proceeds with an on-chain transfer. | [optional]
|
|
12
|
+
**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. - `true`: The transaction request must not be executed as a Cobo Loop transfer. - `false`: The transaction request can be executed as a Cobo Loop transfer. If both `force_internal` and `force_external` are set to `false`, the system uses Cobo Loop by default if possible; otherwise, it proceeds with an on-chain transfer. | [optional]
|
|
13
13
|
**wallet_id** | **String** | The wallet ID. |
|
|
14
14
|
**trading_account_type** | **String** | The trading account type. | [optional]
|
|
15
15
|
**exchange_id** | [**ExchangeId**](ExchangeId.md) | | [optional]
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**chain_id** | **String** | The ID of the chain on which the smart contract is
|
|
7
|
+
**chain_id** | **String** | The ID of the chain on which the smart contract is issued. | [optional]
|
|
8
8
|
**address** | **String** | The address of the smart contract. | [optional]
|
|
9
9
|
**name** | **String** | The name of the smart contract. | [optional]
|
|
10
10
|
**impl_address** | **String** | The address of the implementation smart contract. This property is applicable only when the specified smart contract is a proxy contract. | [optional]
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CoboWaas2.TransactionFILFee
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**gas_base** | **String** | This is the minimum fee required to include a transaction in a block. It is determined by the network's congestion level, which adjusts to maintain a target block utilization rate. The base fee is burned, reducing the total supply of Filecoin over time. | [optional]
|
|
8
|
+
**gas_premium** | **String** | An optional additional fee that users can include to prioritize their transactions over others. It acts like a tip to incentivize miners to select and include your transaction over transactions with only the base fee. | [optional]
|
|
9
|
+
**gas_fee_cap** | **String** | The gas_fee_cap is a user-defined limit on how much they are willing to pay per unit of gas. | [optional]
|
|
10
|
+
**gas_limit** | **String** | This defines the maximum amount of computational effort that a transaction is allowed to consume. It's a way to cap the resources that a transaction can use, ensuring it doesn't consume excessive network resources. | [optional]
|
|
11
|
+
**fee_type** | [**FeeType**](FeeType.md) | |
|
|
12
|
+
**token_id** | **String** | The token ID of the transaction fee. | [optional]
|
|
13
|
+
**fee_used** | **String** | The transaction fee. | [optional]
|
|
14
|
+
**estimated_fee_used** | **String** | The estimated transaction fee. | [optional]
|
|
15
|
+
|
|
16
|
+
|
package/docs/TransactionFee.md
CHANGED
|
@@ -12,9 +12,16 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**gas_used** | **String** | The gas units used in the transaction. | [optional]
|
|
13
13
|
**max_fee_per_gas** | **String** | The maximum gas fee per gas unit used on the chain, in wei. | [optional]
|
|
14
14
|
**max_priority_fee_per_gas** | **String** | The maximum priority fee per gas unit used, in wei. The maximum priority fee represents the highest amount of miner tips that you are willing to pay for your transaction. | [optional]
|
|
15
|
-
**gas_limit** | **String** |
|
|
15
|
+
**gas_limit** | **String** | This defines the maximum amount of computational effort that a transaction is allowed to consume. It's a way to cap the resources that a transaction can use, ensuring it doesn't consume excessive network resources. | [optional]
|
|
16
16
|
**gas_price** | **String** | The gas price, in wei. The gas price represents the amount of ETH that must be paid to validators for processing transactions per gas unit used. | [optional]
|
|
17
17
|
**max_fee_amount** | **String** | The maximum fee that you are willing to pay for the transaction. Provide the value without applying precision. The transaction will fail if the transaction fee exceeds the maximum fee. | [optional]
|
|
18
18
|
**fee_rate** | **String** | The fee rate in sat/vByte. The fee rate represents the satoshis you are willing to pay for each byte of data that your transaction will consume on the blockchain. | [optional]
|
|
19
|
+
**base_fee** | **String** | The fundamental fee required for each transaction. It is charged to prevent spam transactions and network congestion, ensuring that only meaningful transactions consume network resources. | [optional]
|
|
20
|
+
**rent_amount** | **String** | The fee charged as rent for maintaining the state of accounts on the blockchain. This rent ensures accounts are stored on-chain over the long term and that there's sufficient balance to sustain the account state. | [optional]
|
|
21
|
+
**compute_unit_price** | **String** | The cost per compute unit. Transactions consume computational resources measured in compute units, and this price helps determine the cost of executing transactions, especially complex ones involving smart contracts. | [optional]
|
|
22
|
+
**compute_unit_limit** | **String** | The maximum number of compute units allowed for a transaction. This limits the resources any single transaction can consume, preventing excessive resource usage that could impact network performance negatively. | [optional]
|
|
23
|
+
**gas_base** | **String** | This is the minimum fee required to include a transaction in a block. It is determined by the network's congestion level, which adjusts to maintain a target block utilization rate. The base fee is burned, reducing the total supply of Filecoin over time. | [optional]
|
|
24
|
+
**gas_premium** | **String** | An optional additional fee that users can include to prioritize their transactions over others. It acts like a tip to incentivize miners to select and include your transaction over transactions with only the base fee. | [optional]
|
|
25
|
+
**gas_fee_cap** | **String** | The gas_fee_cap is a user-defined limit on how much they are willing to pay per unit of gas. | [optional]
|
|
19
26
|
|
|
20
27
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CoboWaas2.TransactionRequestFILFee
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**gas_premium** | **String** | An optional additional fee that users can include to prioritize their transactions over others. It acts like a tip to incentivize miners to select and include your transaction over transactions with only the base fee. |
|
|
8
|
+
**gas_fee_cap** | **String** | The gas_fee_cap is a user-defined limit on how much they are willing to pay per unit of gas. |
|
|
9
|
+
**gas_limit** | **String** | This defines the maximum amount of computational effort that a transaction is allowed to consume. It's a way to cap the resources that a transaction can use, ensuring it doesn't consume excessive network resources. | [optional]
|
|
10
|
+
**fee_type** | [**FeeType**](FeeType.md) | |
|
|
11
|
+
**token_id** | **String** | The token ID of the transaction fee. |
|
|
12
|
+
|
|
13
|
+
|
|
@@ -7,10 +7,14 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**fee_type** | [**FeeType**](FeeType.md) | |
|
|
8
8
|
**token_id** | **String** | The token ID of the transaction fee. |
|
|
9
9
|
**max_fee_amount** | **String** | The maximum fee that you are willing to pay for the transaction. Provide the value without applying precision. The transaction will fail if the transaction fee exceeds the maximum fee. | [optional]
|
|
10
|
-
**gas_limit** | **String** |
|
|
10
|
+
**gas_limit** | **String** | This defines the maximum amount of computational effort that a transaction is allowed to consume. It's a way to cap the resources that a transaction can use, ensuring it doesn't consume excessive network resources. | [optional]
|
|
11
11
|
**max_fee_per_gas** | **String** | The maximum gas fee per gas unit used on the chain, in wei. |
|
|
12
12
|
**max_priority_fee_per_gas** | **String** | The maximum priority fee per gas unit used, in wei. The maximum priority fee represents the highest amount of miner tips that you are willing to pay for your transaction. |
|
|
13
13
|
**gas_price** | **String** | The gas price, in wei. The gas price represents the amount of ETH that must be paid to validators for processing transactions per gas unit used. |
|
|
14
14
|
**fee_rate** | **String** | The fee rate in sat/vByte. The fee rate represents the satoshis you are willing to pay for each byte of data that your transaction will consume on the blockchain. | [optional]
|
|
15
|
+
**compute_unit_price** | **String** | The cost per compute unit. Transactions consume computational resources measured in compute units, and this price helps determine the cost of executing transactions, especially complex ones involving smart contracts. |
|
|
16
|
+
**compute_unit_limit** | **String** | The maximum number of compute units allowed for a transaction. This limits the resources any single transaction can consume, preventing excessive resource usage that could impact network performance negatively. |
|
|
17
|
+
**gas_premium** | **String** | An optional additional fee that users can include to prioritize their transactions over others. It acts like a tip to incentivize miners to select and include your transaction over transactions with only the base fee. |
|
|
18
|
+
**gas_fee_cap** | **String** | The gas_fee_cap is a user-defined limit on how much they are willing to pay per unit of gas. |
|
|
15
19
|
|
|
16
20
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.TransactionRequestSOLFee
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**compute_unit_price** | **String** | The cost per compute unit. Transactions consume computational resources measured in compute units, and this price helps determine the cost of executing transactions, especially complex ones involving smart contracts. |
|
|
8
|
+
**compute_unit_limit** | **String** | The maximum number of compute units allowed for a transaction. This limits the resources any single transaction can consume, preventing excessive resource usage that could impact network performance negatively. |
|
|
9
|
+
**fee_type** | [**FeeType**](FeeType.md) | |
|
|
10
|
+
**token_id** | **String** | The token ID of the transaction fee. |
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CoboWaas2.TransactionSOLFee
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**base_fee** | **String** | The fundamental fee required for each transaction. It is charged to prevent spam transactions and network congestion, ensuring that only meaningful transactions consume network resources. | [optional]
|
|
8
|
+
**rent_amount** | **String** | The fee charged as rent for maintaining the state of accounts on the blockchain. This rent ensures accounts are stored on-chain over the long term and that there's sufficient balance to sustain the account state. | [optional]
|
|
9
|
+
**compute_unit_price** | **String** | The cost per compute unit. Transactions consume computational resources measured in compute units, and this price helps determine the cost of executing transactions, especially complex ones involving smart contracts. | [optional]
|
|
10
|
+
**compute_unit_limit** | **String** | The maximum number of compute units allowed for a transaction. This limits the resources any single transaction can consume, preventing excessive resource usage that could impact network performance negatively. | [optional]
|
|
11
|
+
**fee_type** | [**FeeType**](FeeType.md) | |
|
|
12
|
+
**token_id** | **String** | The token ID of the transaction fee. | [optional]
|
|
13
|
+
**fee_used** | **String** | The transaction fee. | [optional]
|
|
14
|
+
**estimated_fee_used** | **String** | The estimated transaction fee. | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**account_output** | [**TransactionTransferToAddressDestinationAccountOutput**](TransactionTransferToAddressDestinationAccountOutput.md) | | [optional]
|
|
9
9
|
**utxo_outputs** | [**[TransactionTransferToAddressDestinationUtxoOutputsInner]**](TransactionTransferToAddressDestinationUtxoOutputsInner.md) | | [optional]
|
|
10
10
|
**change_address** | **String** | The address used to receive the remaining funds or change from the transaction. | [optional]
|
|
11
|
-
**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. - `true`: The transaction request must be executed as a Cobo Loop transfer. - `false`: The transaction request may not be executed as a Cobo Loop transfer. | [optional]
|
|
12
|
-
**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. - `true`: The transaction request must not be executed as a Cobo Loop transfer. - `false`: The transaction request can be executed as a Cobo Loop transfer. | [optional]
|
|
11
|
+
**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. - `true`: The transaction request must be executed as a Cobo Loop transfer. - `false`: The transaction request may not be executed as a Cobo Loop transfer. If both `force_internal` and `force_external` are set to `false`, the system uses Cobo Loop by default if possible; otherwise, it proceeds with an on-chain transfer. | [optional]
|
|
12
|
+
**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. - `true`: The transaction request must not be executed as a Cobo Loop transfer. - `false`: The transaction request can be executed as a Cobo Loop transfer. If both `force_internal` and `force_external` are set to `false`, the system uses Cobo Loop by default if possible; otherwise, it proceeds with an on-chain transfer. | [optional]
|
|
13
13
|
|
|
14
14
|
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**destination_type** | [**TransactionDestinationType**](TransactionDestinationType.md) | |
|
|
8
8
|
**wallet_id** | **String** | The wallet ID. |
|
|
9
|
-
**trading_account_type** | **String** | The trading account type.
|
|
9
|
+
**trading_account_type** | **String** | The trading account type. This field is only applicable when `destination_type` is `ExchangeWallet`. | [optional]
|
|
10
10
|
**exchange_id** | [**ExchangeId**](ExchangeId.md) | | [optional]
|
|
11
11
|
**amount** | **String** | The transfer amount. For example, if you trade 1.5 BTC, then the value is `1.5`. |
|
|
12
12
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
8
8
|
**transaction_id** | **String** | The transaction ID. |
|
|
9
9
|
**cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
|
|
10
10
|
**request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional]
|
|
@@ -58,6 +58,8 @@ Name | Type | Description | Notes
|
|
|
58
58
|
|
|
59
59
|
* `TokenListing` (value: `"TokenListing"`)
|
|
60
60
|
|
|
61
|
+
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
62
|
+
|
|
61
63
|
* `PaymentOrder` (value: `"PaymentOrder"`)
|
|
62
64
|
|
|
63
65
|
* `PaymentRefund` (value: `"PaymentRefund"`)
|
package/docs/TransactionsApi.md
CHANGED
|
@@ -668,7 +668,7 @@ Name | Type | Description | Notes
|
|
|
668
668
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
669
669
|
**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]
|
|
670
670
|
**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]
|
|
671
|
-
**direction** | **String**| The sort direction. Possible values include: - `ASC`: Sort the results in ascending order. - `DESC`: Sort the results in descending order. | [optional] [default to '
|
|
671
|
+
**direction** | **String**| The sort direction. Possible values include: - `ASC`: Sort the results in ascending order. - `DESC`: Sort the results in descending order. | [optional] [default to 'ASC']
|
|
672
672
|
|
|
673
673
|
### Return type
|
|
674
674
|
|
|
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
|
|
|
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
11
|
**change_output_type** | **String** | The position of the change output in the transaction's outputs. Possible values are: - `Last`: The change output is placed at the end of the transaction's outputs. - `First`: The change output is placed at the beginning of the transaction's outputs. | [optional]
|
|
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. - `true`: The transaction request must be executed as a Cobo Loop transfer. - `false`: The transaction request may not be executed as a Cobo Loop transfer. Please do not set both `force_internal` and `force_external` as `true`. | [optional]
|
|
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. - `true`: The transaction request must not be executed as a Cobo Loop transfer. - `false`: The transaction request can be executed as a Cobo Loop transfer. Please do not set both `force_internal` and `force_external` as `true`. | [optional]
|
|
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. - `true`: The transaction request must be executed as a Cobo Loop transfer. - `false`: The transaction request may not be executed as a Cobo Loop transfer. Please do not set both `force_internal` and `force_external` as `true`. If both are set to `false`, the system uses Cobo Loop by default if possible; otherwise, it proceeds with an on-chain transfer. | [optional]
|
|
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. - `true`: The transaction request must not be executed as a Cobo Loop transfer. - `false`: The transaction request can be executed as a Cobo Loop transfer. Please do not set both `force_internal` and `force_external` as `true`. If both are set to `false`, the system uses Cobo Loop by default if possible; otherwise, it proceeds with an on-chain transfer. | [optional]
|
|
14
14
|
**wallet_id** | **String** | The wallet ID. |
|
|
15
15
|
**amount** | **String** | The transfer amount. For example, if you trade 1.5 BTC, then the value is `1.5`. |
|
|
16
16
|
**trading_account_type** | **String** | The trading account type. |
|
|
@@ -5,5 +5,6 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | The merchant name. | [optional]
|
|
8
|
+
**developer_fee_rate** | **String** | The developer fee rate applied to this merchant. Expressed as a string in decimal format where \"0.1\" represents 10%. This fee is deducted from the payment amount and only applies to top-up transactions. | [optional]
|
|
8
9
|
|
|
9
10
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.UpdateTopUpAddress
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**merchant_id** | **String** | The merchant ID. |
|
|
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_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` |
|
|
9
|
+
**custom_payer_id** | **String** | Unique customer identifier on the merchant side, used to allocate a dedicated top-up address |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
8
8
|
**wallet** | [**WalletInfo**](WalletInfo.md) | | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -28,6 +28,8 @@ Name | Type | Description | Notes
|
|
|
28
28
|
|
|
29
29
|
* `TokenListing` (value: `"TokenListing"`)
|
|
30
30
|
|
|
31
|
+
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
32
|
+
|
|
31
33
|
* `PaymentOrder` (value: `"PaymentOrder"`)
|
|
32
34
|
|
|
33
35
|
* `PaymentRefund` (value: `"PaymentRefund"`)
|
package/docs/WalletsApi.md
CHANGED
|
@@ -901,7 +901,7 @@ Name | Type | Description | Notes
|
|
|
901
901
|
|
|
902
902
|
List enabled tokens
|
|
903
903
|
|
|
904
|
-
This operation retrieves all the tokens that can be used by your organization. You can filter the result by wallet type, subtype, and
|
|
904
|
+
This operation retrieves all the tokens that can be used by your organization. You can filter the result by wallet type, subtype, chain IDs, and token IDs. If you do not specify a wallet type, this operation returns a combination of tokens that can be used by your organization for each wallet type.
|
|
905
905
|
|
|
906
906
|
### Example
|
|
907
907
|
|
|
@@ -919,6 +919,7 @@ const opts = {
|
|
|
919
919
|
'wallet_type': new CoboWaas2.WalletType(),
|
|
920
920
|
'wallet_subtype': new CoboWaas2.WalletSubtype(),
|
|
921
921
|
'chain_ids': "BTC,ETH",
|
|
922
|
+
'token_ids': "ETH_USDT,ETH_USDC",
|
|
922
923
|
'limit': 10,
|
|
923
924
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
924
925
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
|
|
@@ -939,6 +940,7 @@ Name | Type | Description | Notes
|
|
|
939
940
|
**wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional]
|
|
940
941
|
**wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional]
|
|
941
942
|
**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]
|
|
943
|
+
**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]
|
|
942
944
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
943
945
|
**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]
|
|
944
946
|
**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]
|
package/docs/WebhookEvent.md
CHANGED
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**event_id** | **String** | The event ID. | [optional]
|
|
8
8
|
**url** | **String** | The webhook endpoint URL. |
|
|
9
|
-
**created_timestamp** | **Number** | The time when the event
|
|
9
|
+
**created_timestamp** | **Number** | The time when the event type was triggered, in Unix timestamp format (milliseconds). - The value remains unchanged across retries. - The default webhook timeout is 2 seconds. |
|
|
10
10
|
**type** | [**WebhookEventType**](WebhookEventType.md) | |
|
|
11
11
|
**data** | [**WebhookEventData**](WebhookEventData.md) | |
|
|
12
12
|
**status** | [**WebhookEventStatus**](WebhookEventStatus.md) | | [optional]
|
package/docs/WebhookEventData.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
8
8
|
**transaction_id** | **String** | The transaction ID. |
|
|
9
9
|
**cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional]
|
|
10
10
|
**request_id** | **String** | The request ID provided by you when creating the settlement request. |
|
|
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**destination** | [**TransactionDestination**](TransactionDestination.md) | |
|
|
21
21
|
**result** | [**TransactionResult**](TransactionResult.md) | | [optional]
|
|
22
22
|
**fee** | [**TransactionFee**](TransactionFee.md) | | [optional]
|
|
23
|
-
**initiator** | **String** |
|
|
23
|
+
**initiator** | **String** | The initiator of this settlement request. Can return either an API key or the Payment Management App's ID. - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payment API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payment Management App using the App ID. | [optional]
|
|
24
24
|
**initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) | |
|
|
25
25
|
**confirmed_num** | **Number** | The number of confirmations this transaction has received. | [optional]
|
|
26
26
|
**confirming_threshold** | **Number** | The minimum number of confirmations required to deem a transaction secure. The common threshold is 6 for a Bitcoin transaction. | [optional]
|
|
@@ -34,8 +34,8 @@ Name | Type | Description | Notes
|
|
|
34
34
|
**cobo_category** | **[String]** | The transaction category defined by Cobo. Possible values include: - `AutoSweep`: An auto-sweep transaction. - `AutoFueling`: A transaction where Fee Station pays transaction fees to an address within your wallet. - `AutoFuelingRefund`: A refund for an auto-fueling transaction. - `SafeTxMessage`: A message signing transaction to authorize a Smart Contract Wallet (Safe\\{Wallet\\}) transaction. - `BillPayment`: A transaction to pay Cobo bills through Fee Station. - `BillRefund`: A refund for a previously made bill payment. - `CommissionFeeCharge`: A transaction to charge commission fees via Fee Station. - `CommissionFeeRefund`: A refund of previously charged commission fees. | [optional]
|
|
35
35
|
**extra** | **[String]** | A list of JSON-encoded strings containing structured, business-specific extra information for the transaction. Each item corresponds to a specific data type, indicated by the `extra_type` field in the JSON object (for example, \"BabylonBusinessInfo\", \"BtcAddressInfo\"). | [optional]
|
|
36
36
|
**fueling_info** | [**TransactionFuelingInfo**](TransactionFuelingInfo.md) | | [optional]
|
|
37
|
-
**created_timestamp** | **Number** | The
|
|
38
|
-
**updated_timestamp** | **Number** | The
|
|
37
|
+
**created_timestamp** | **Number** | The creation time of the settlement request, represented as a UNIX timestamp in seconds. |
|
|
38
|
+
**updated_timestamp** | **Number** | The last update time of the settlement request, represented as a UNIX timestamp in seconds. |
|
|
39
39
|
**tss_request_id** | **String** | The TSS request ID. | [optional]
|
|
40
40
|
**source_key_share_holder_group** | [**SourceGroup**](SourceGroup.md) | | [optional]
|
|
41
41
|
**target_key_share_holder_group_id** | **String** | The target key share holder group ID. | [optional]
|
|
@@ -53,7 +53,10 @@ Name | Type | Description | Notes
|
|
|
53
53
|
**wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) | |
|
|
54
54
|
**token** | [**TokenInfo**](TokenInfo.md) | | [optional]
|
|
55
55
|
**feedback** | **String** | The feedback provided by Cobo when a token listing request is rejected. | [optional]
|
|
56
|
-
**
|
|
56
|
+
**address** | **String** | The wallet address. |
|
|
57
|
+
**wallet_uuid** | **String** | The wallet ID. |
|
|
58
|
+
**balance** | [**Balance**](Balance.md) | |
|
|
59
|
+
**order_id** | **String** | The ID of the pay-in order corresponding to this refund. |
|
|
57
60
|
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
58
61
|
**payable_amount** | **String** | The cryptocurrency amount to be paid for this order. |
|
|
59
62
|
**receive_address** | **String** | The recipient wallet address to be used for the payment transaction. |
|
|
@@ -66,10 +69,14 @@ Name | Type | Description | Notes
|
|
|
66
69
|
**psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. |
|
|
67
70
|
**received_token_amount** | **String** | The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT). |
|
|
68
71
|
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this refund order. Each transaction represents a separate blockchain operation related to the refund process. | [optional]
|
|
72
|
+
**settlement_status** | [**SettleStatus**](SettleStatus.md) | | [optional]
|
|
69
73
|
**refund_id** | **String** | The refund order ID. |
|
|
70
74
|
**amount** | **String** | The amount in cryptocurrency to be returned for this refund order. |
|
|
71
75
|
**to_address** | **String** | The recipient's wallet address where the refund will be sent. |
|
|
72
76
|
**refund_type** | [**RefundType**](RefundType.md) | | [optional]
|
|
77
|
+
**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]
|
|
78
|
+
**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]
|
|
79
|
+
**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]
|
|
73
80
|
**settlement_request_id** | **String** | The settlement request ID generated by Cobo. |
|
|
74
81
|
**settlements** | [**[SettlementDetail]**](SettlementDetail.md) | |
|
|
75
82
|
|
|
@@ -94,6 +101,8 @@ Name | Type | Description | Notes
|
|
|
94
101
|
|
|
95
102
|
* `TokenListing` (value: `"TokenListing"`)
|
|
96
103
|
|
|
104
|
+
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
105
|
+
|
|
97
106
|
* `PaymentOrder` (value: `"PaymentOrder"`)
|
|
98
107
|
|
|
99
108
|
* `PaymentRefund` (value: `"PaymentRefund"`)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
|
|
@@ -27,6 +27,8 @@ Name | Type | Description | Notes
|
|
|
27
27
|
|
|
28
28
|
* `TokenListing` (value: `"TokenListing"`)
|
|
29
29
|
|
|
30
|
+
* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
|
|
31
|
+
|
|
30
32
|
* `PaymentOrder` (value: `"PaymentOrder"`)
|
|
31
33
|
|
|
32
34
|
* `PaymentRefund` (value: `"PaymentRefund"`)
|
package/docs/WebhookEventLog.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**id** | **String** | The event log ID. |
|
|
8
|
-
**created_timestamp** | **Number** | The time when the
|
|
8
|
+
**created_timestamp** | **Number** | The time when the event type was triggered, in Unix timestamp format (milliseconds). - The value remains unchanged across retries. - The default webhook timeout is 2 seconds. |
|
|
9
9
|
**request_headers** | **Object** | The request headers of the webhook event. |
|
|
10
10
|
**request_body** | [**WebhookEvent**](WebhookEvent.md) | |
|
|
11
11
|
**response_body** | **String** | The response body of the webhook event. | [optional]
|
package/docs/WebhookEventType.md
CHANGED
|
@@ -41,10 +41,16 @@
|
|
|
41
41
|
|
|
42
42
|
* `wallet.chain.enabled` (value: `"wallet.chain.enabled"`)
|
|
43
43
|
|
|
44
|
+
* `wallet.mpc.balance.updated` (value: `"wallet.mpc.balance.updated"`)
|
|
45
|
+
|
|
46
|
+
* `wallet.web3.balance.updated` (value: `"wallet.web3.balance.updated"`)
|
|
47
|
+
|
|
44
48
|
* `payment.transaction.created` (value: `"payment.transaction.created"`)
|
|
45
49
|
|
|
46
50
|
* `payment.transaction.late` (value: `"payment.transaction.late"`)
|
|
47
51
|
|
|
52
|
+
* `payment.transaction.completed` (value: `"payment.transaction.completed"`)
|
|
53
|
+
|
|
48
54
|
* `payment.transaction.held` (value: `"payment.transaction.held"`)
|
|
49
55
|
|
|
50
56
|
* `payment.status.updated` (value: `"payment.status.updated"`)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cobo/cobo-waas2",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.18.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.TransactionMessageSignBTCEIP191Destination
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**destination_type** | [**TransactionDestinationType**](TransactionDestinationType.md) | |
|
|
8
|
-
**message** | **String** | The raw data of the message to be signed, encoded in Base64 format. |
|
|
9
|
-
|
|
10
|
-
|