@cobo/cobo-waas2 1.6.0 → 1.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +63 -3
- package/dist/ApiClient.js +56 -6
- package/dist/api/AddressBooksApi.js +6 -6
- package/dist/api/DevelopersApi.js +110 -0
- package/dist/api/DevelopersWebhooksApi.js +32 -32
- package/dist/api/OAuthApi.js +2 -2
- package/dist/api/StakingsApi.js +118 -31
- package/dist/api/TransactionsApi.js +75 -30
- package/dist/api/TravelRuleApi.js +216 -0
- package/dist/api/WalletsApi.js +68 -68
- package/dist/api/WalletsExchangeWalletApi.js +12 -12
- package/dist/api/WalletsMPCWalletsApi.js +60 -60
- package/dist/crypto/Ed25519Signer.js +36 -0
- package/dist/crypto/Secp256k1Signer.js +36 -0
- package/dist/index.js +341 -5
- package/dist/model/Activity.js +33 -8
- package/dist/model/ActivityAction.js +50 -0
- package/dist/model/ActivityExtra.js +274 -0
- package/dist/model/ActivityType.js +5 -0
- package/dist/model/AddressInfo.js +15 -2
- package/dist/model/AddressTransferDestination.js +1 -1
- package/dist/model/AddressesEventData.js +190 -0
- package/dist/model/ApiLogDetails.js +2 -2
- package/dist/model/AutoFuelType.js +61 -0
- package/dist/model/BabylonStakeExtra.js +1 -1
- package/dist/model/BabylonStakingActivityDetailExtra.js +165 -0
- package/dist/model/BabylonValidator.js +4 -12
- package/dist/model/BaseContractCallSource.js +1 -1
- package/dist/model/BroadcastSignedTransactionsRequest.js +1 -1
- package/dist/model/CallbackMessage.js +288 -0
- package/dist/model/ChainInfo.js +2 -2
- package/dist/model/ContractCallParams.js +11 -2
- package/dist/model/CoreStakeExtra.js +170 -0
- package/dist/model/CoreStakingActivityDetailExtra.js +164 -0
- package/dist/model/CoreStakingExtra.js +187 -0
- package/dist/model/CreateAddressRequest.js +2 -2
- package/dist/model/CreateClaimActivity.js +139 -0
- package/dist/model/CreateClaimActivityRequest.js +182 -0
- package/dist/model/CreateKeyShareHolder.js +1 -1
- package/dist/model/CreateMpcVaultRequest.js +1 -1
- package/dist/model/CreateMpcWalletParams.js +2 -2
- package/dist/model/CreateStakeActivity.js +8 -14
- package/dist/model/CreateStakeActivityExtra.js +61 -9
- package/dist/model/CreateStakeActivityRequest.js +10 -17
- package/dist/model/CreateWalletParams.js +1 -1
- package/dist/model/CreateWebhookEndpointRequest.js +2 -2
- package/dist/model/CreateWithdrawActivity.js +0 -13
- package/dist/model/CreateWithdrawActivityRequest.js +0 -18
- package/dist/model/CustodialTransferSource.js +1 -1
- package/dist/model/DestinationWalletType.js +61 -0
- package/dist/model/ErrorResponse.js +2 -2
- package/dist/model/EstimateClaimFee.js +145 -0
- package/dist/model/EstimateContractCallFeeParams.js +2 -2
- package/dist/model/EstimateFeeParams.js +2 -2
- package/dist/model/EstimateStakeFee.js +10 -17
- package/dist/model/EstimateTransferFeeParams.js +2 -2
- package/dist/model/EstimateWithdrawFee.js +0 -18
- package/dist/model/EstimatedFee.js +1 -1
- package/dist/model/EstimatedFixedFee.js +4 -4
- package/dist/model/EstimatedUtxoFeeSlow.js +3 -3
- package/dist/model/EthStakeEstimatedFee.js +13 -0
- package/dist/model/EthStakingActivityDetailExtra.js +142 -0
- package/dist/model/EthStakingExtra.js +31 -0
- package/dist/model/EthStakingExtraAllOfBeaconValidators.js +140 -0
- package/dist/model/EvmContractCallDestination.js +1 -1
- package/dist/model/EvmEIP191MessageSignDestination.js +1 -1
- package/dist/model/EvmEIP712MessageSignDestination.js +1 -1
- package/dist/model/ExchangeTransferDestination.js +1 -1
- package/dist/model/ExchangeTransferSource.js +1 -1
- package/dist/model/ExtendedTokenInfo.js +3 -3
- package/dist/model/FeeAmount.js +1 -1
- package/dist/model/FeeRate.js +1 -1
- package/dist/model/FixedFeeRate.js +2 -2
- package/dist/model/GetStakingEstimationFee201Response.js +6 -0
- package/dist/model/GetStakingEstimationFeeRequest.js +39 -17
- package/dist/model/GetTransactionLimitation200Response.js +143 -0
- package/dist/model/ListCallbackMessages200Response.js +145 -0
- package/dist/model/ListSupportedCountries200ResponseInner.js +140 -0
- package/dist/model/LockUtxosRequestUtxosInner.js +2 -2
- package/dist/model/MPCDelegate.js +1 -1
- package/dist/model/MPCProject.js +4 -4
- package/dist/model/MPCVaultEventData.js +279 -0
- package/dist/model/MaxTransferableValue.js +1 -1
- package/dist/model/MessageSignParams.js +2 -2
- package/dist/model/MpcTransferSource.js +2 -2
- package/dist/model/OrgInfo.js +133 -0
- package/dist/model/Pagination.js +6 -6
- package/dist/model/RawMessageSignDestination.js +1 -1
- package/dist/model/RetryCallbackMessage201Response.js +83 -0
- package/dist/model/SafeContractCallSource.js +1 -1
- package/dist/model/SafeTransferSource.js +1 -1
- package/dist/model/SelectedEntityType.js +61 -0
- package/dist/model/SelfCustodyWallet.js +152 -0
- package/dist/model/SourceGroup.js +1 -1
- package/dist/model/StakingPoolId.js +86 -0
- package/dist/model/StakingPoolType.js +10 -0
- package/dist/model/Stakings.js +10 -14
- package/dist/model/StakingsExtra.js +67 -8
- package/dist/model/SubmitDepositTravelRuleInfo201Response.js +83 -0
- package/dist/model/SwapActivity.js +218 -0
- package/dist/model/SwapSummary.js +121 -0
- package/dist/model/SwapTokenPair.js +100 -0
- package/dist/model/TSSRequestWebhookEventData.js +18 -3
- package/dist/model/TokenBalance.js +2 -2
- package/dist/model/TokenBalanceBalance.js +6 -6
- package/dist/model/TokenInfo.js +2 -2
- package/dist/model/Transaction.js +2 -2
- package/dist/model/TransactionApprovalDetail.js +121 -0
- package/dist/model/TransactionApprovalResult.js +66 -0
- package/dist/model/TransactionCustodialAssetWalletSource.js +1 -1
- package/dist/model/TransactionDepositFromAddressSource.js +1 -1
- package/dist/model/TransactionDepositFromLoopSource.js +1 -1
- package/dist/model/TransactionDepositFromWalletSource.js +1 -1
- package/dist/model/TransactionDepositToAddressDestination.js +1 -1
- package/dist/model/TransactionDepositToWalletDestination.js +1 -1
- package/dist/model/TransactionDetail.js +4 -4
- package/dist/model/TransactionDetails.js +4 -4
- package/dist/model/TransactionEvmContractDestination.js +1 -1
- package/dist/model/TransactionExchangeWalletSource.js +1 -1
- package/dist/model/TransactionMPCWalletSource.js +1 -1
- package/dist/model/TransactionMessageSignEIP191Destination.js +1 -1
- package/dist/model/TransactionMessageSignEIP712Destination.js +1 -1
- package/dist/model/TransactionRawMessageSignDestination.js +1 -1
- package/dist/model/TransactionRawTxInfo.js +4 -4
- package/dist/model/TransactionRbf.js +9 -0
- package/dist/model/TransactionRbfSource.js +1 -1
- package/dist/model/TransactionRequestEvmEip1559Fee.js +1 -1
- package/dist/model/TransactionRequestEvmLegacyFee.js +1 -1
- package/dist/model/TransactionRequestFixedFee.js +1 -1
- package/dist/model/TransactionRequestUtxoFee.js +1 -1
- package/dist/model/TransactionRoleApprovalDetail.js +152 -0
- package/dist/model/{StakingsValidatorInfo.js → TransactionSelectedUtxo.js} +38 -55
- package/dist/model/TransactionSmartContractSafeWalletSource.js +1 -1
- package/dist/model/TransactionTokeApproval.js +3 -3
- package/dist/model/TransactionTokenAmount.js +1 -1
- package/dist/model/TransactionTransferToAddressDestination.js +1 -1
- package/dist/model/TransactionTransferToWalletDestination.js +1 -1
- package/dist/model/TransactionUserApprovalDetail.js +162 -0
- package/dist/model/TransactionWebhookEventData.js +22 -7
- package/dist/model/TransferParams.js +11 -2
- package/dist/model/TravelRuleDepositExchangesOrVASP.js +168 -0
- package/dist/model/TravelRuleDepositExchangesOrVASPEntityInfo.js +222 -0
- package/dist/model/TravelRuleDepositLegalEntity.js +171 -0
- package/dist/model/TravelRuleDepositNaturalEntity.js +186 -0
- package/dist/model/TravelRuleDepositRequest.js +128 -0
- package/dist/model/TravelRuleDepositRequestTravelRuleInfo.js +222 -0
- package/dist/model/TravelRuleWithdrawExchangesOrVASP.js +155 -0
- package/dist/model/TravelRuleWithdrawExchangesOrVASPEntityInfo.js +222 -0
- package/dist/model/TravelRuleWithdrawLegalEntity.js +144 -0
- package/dist/model/TravelRuleWithdrawNaturalEntity.js +159 -0
- package/dist/model/TravelRuleWithdrawRequest.js +128 -0
- package/dist/model/TravelRuleWithdrawRequestTravelRuleInfo.js +216 -0
- package/dist/model/TriggerTestWebhookEventRequest.js +1 -1
- package/dist/model/UpdateWebhookEndpointByIdRequest.js +1 -1
- package/dist/model/Vasp.js +141 -0
- package/dist/model/WalletInfoEventData.js +175 -0
- package/dist/model/WebhookEventData.js +135 -14
- package/dist/model/WebhookEventDataType.js +17 -2
- package/dist/model/WebhookEventType.js +23 -8
- package/docs/Activity.md +3 -1
- package/docs/ActivityAction.md +20 -0
- package/docs/ActivityExtra.md +20 -0
- package/docs/ActivityType.md +2 -0
- package/docs/AddressBooksApi.md +3 -3
- package/docs/AddressInfo.md +2 -1
- package/docs/AddressesEventData.md +29 -0
- package/docs/ApiLogDetails.md +1 -1
- package/docs/AutoFuelType.md +12 -0
- package/docs/BabylonStakeExtra.md +1 -1
- package/docs/BabylonStakingActivityDetailExtra.md +14 -0
- package/docs/BabylonValidator.md +4 -4
- package/docs/BroadcastSignedTransactionsRequest.md +1 -1
- package/docs/CallbackMessage.md +46 -0
- package/docs/ChainInfo.md +1 -1
- package/docs/ContractCallParams.md +2 -1
- package/docs/CoreStakeExtra.md +13 -0
- package/docs/CoreStakingActivityDetailExtra.md +13 -0
- package/docs/CoreStakingExtra.md +14 -0
- package/docs/CreateAddressRequest.md +1 -1
- package/docs/CreateClaimActivity.md +11 -0
- package/docs/CreateClaimActivityRequest.md +12 -0
- package/docs/CreateKeyShareHolder.md +1 -1
- package/docs/CreateMpcVaultRequest.md +1 -1
- package/docs/CreateMpcWalletParams.md +1 -1
- package/docs/CreateStakeActivity.md +2 -2
- package/docs/CreateStakeActivityExtra.md +5 -1
- package/docs/CreateStakeActivityRequest.md +2 -2
- package/docs/CreateWalletParams.md +1 -1
- package/docs/CreateWebhookEndpointRequest.md +1 -1
- package/docs/CreateWithdrawActivity.md +0 -1
- package/docs/CreateWithdrawActivityRequest.md +0 -1
- package/docs/DestinationWalletType.md +12 -0
- package/docs/DevelopersApi.md +118 -0
- package/docs/DevelopersWebhooksApi.md +16 -16
- package/docs/ErrorResponse.md +1 -1
- package/docs/EstimateClaimFee.md +11 -0
- package/docs/EstimateContractCallFeeParams.md +1 -1
- package/docs/EstimateFeeParams.md +2 -2
- package/docs/EstimateStakeFee.md +2 -2
- package/docs/EstimateTransferFeeParams.md +1 -1
- package/docs/EstimateWithdrawFee.md +0 -1
- package/docs/EstimatedFee.md +1 -1
- package/docs/EstimatedFixedFee.md +1 -1
- package/docs/EstimatedUtxoFeeSlow.md +1 -1
- package/docs/EthStakeEstimatedFee.md +1 -0
- package/docs/EthStakingActivityDetailExtra.md +11 -0
- package/docs/EthStakingExtra.md +1 -0
- package/docs/EthStakingExtraAllOfBeaconValidators.md +14 -0
- package/docs/ExtendedTokenInfo.md +1 -1
- package/docs/FeeAmount.md +1 -1
- package/docs/FeeRate.md +1 -1
- package/docs/FixedFeeRate.md +1 -1
- package/docs/GetStakingEstimationFee201Response.md +1 -0
- package/docs/GetStakingEstimationFeeRequest.md +3 -4
- package/docs/GetTransactionLimitation200Response.md +12 -0
- package/docs/ListCallbackMessages200Response.md +10 -0
- package/docs/ListSupportedCountries200ResponseInner.md +11 -0
- package/docs/LockUtxosRequestUtxosInner.md +1 -1
- package/docs/MPCProject.md +1 -1
- package/docs/MPCVaultEventData.md +34 -0
- package/docs/MaxTransferableValue.md +1 -1
- package/docs/MessageSignParams.md +1 -1
- package/docs/MpcTransferSource.md +1 -1
- package/docs/OAuthApi.md +1 -1
- package/docs/OrgInfo.md +11 -0
- package/docs/Pagination.md +3 -3
- package/docs/PoolDetailsAllOfValidatorsInfo.md +4 -4
- package/docs/RetryCallbackMessage201Response.md +9 -0
- package/docs/SelectedEntityType.md +12 -0
- package/docs/SelfCustodyWallet.md +12 -0
- package/docs/SourceGroup.md +1 -1
- package/docs/StakingPoolId.md +22 -0
- package/docs/StakingPoolType.md +4 -0
- package/docs/Stakings.md +2 -2
- package/docs/StakingsApi.md +122 -14
- package/docs/StakingsExtra.md +5 -0
- package/docs/SubmitDepositTravelRuleInfo201Response.md +9 -0
- package/docs/SwapActivity.md +20 -0
- package/docs/SwapSummary.md +10 -0
- package/docs/SwapTokenPair.md +10 -0
- package/docs/TSSRequestWebhookEventData.md +7 -1
- package/docs/TokenBalance.md +1 -1
- package/docs/TokenBalanceBalance.md +4 -4
- package/docs/TokenInfo.md +1 -1
- package/docs/Transaction.md +2 -2
- package/docs/TransactionApprovalDetail.md +11 -0
- package/docs/TransactionApprovalResult.md +14 -0
- package/docs/TransactionDetail.md +2 -2
- package/docs/TransactionDetails.md +2 -2
- package/docs/TransactionRawTxInfo.md +1 -1
- package/docs/TransactionRbf.md +1 -0
- package/docs/TransactionRbfSource.md +1 -1
- package/docs/TransactionRoleApprovalDetail.md +13 -0
- package/docs/TransactionSelectedUtxo.md +12 -0
- package/docs/TransactionTokeApproval.md +1 -1
- package/docs/TransactionTokenAmount.md +1 -1
- package/docs/TransactionUserApprovalDetail.md +15 -0
- package/docs/TransactionWebhookEventData.md +9 -3
- package/docs/TransactionsApi.md +66 -15
- package/docs/TransferParams.md +2 -1
- package/docs/TravelRuleApi.md +214 -0
- package/docs/TravelRuleDepositExchangesOrVASP.md +13 -0
- package/docs/TravelRuleDepositExchangesOrVASPEntityInfo.md +29 -0
- package/docs/TravelRuleDepositLegalEntity.md +25 -0
- package/docs/TravelRuleDepositNaturalEntity.md +26 -0
- package/docs/TravelRuleDepositRequest.md +10 -0
- package/docs/TravelRuleDepositRequestTravelRuleInfo.md +16 -0
- package/docs/TravelRuleWithdrawExchangesOrVASP.md +12 -0
- package/docs/TravelRuleWithdrawExchangesOrVASPEntityInfo.md +16 -0
- package/docs/TravelRuleWithdrawLegalEntity.md +12 -0
- package/docs/TravelRuleWithdrawNaturalEntity.md +13 -0
- package/docs/TravelRuleWithdrawRequest.md +10 -0
- package/docs/TravelRuleWithdrawRequestTravelRuleInfo.md +15 -0
- package/docs/TriggerTestWebhookEventRequest.md +1 -1
- package/docs/UpdateWebhookEndpointByIdRequest.md +1 -1
- package/docs/Vasp.md +11 -0
- package/docs/WalletInfoEventData.md +29 -0
- package/docs/WalletsApi.md +34 -34
- package/docs/WalletsExchangeWalletApi.md +6 -6
- package/docs/WalletsMPCWalletsApi.md +30 -30
- package/docs/WebhookEventData.md +17 -5
- package/docs/WebhookEventDataType.md +7 -1
- package/docs/WebhookEventType.md +14 -8
- package/package.json +4 -3
- package/docs/StakingsValidatorInfo.md +0 -13
package/docs/OrgInfo.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.OrgInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**org_id** | **String** | The ID of the owning organization. |
|
|
8
|
+
**name** | **String** | The organization name. | [optional]
|
|
9
|
+
**created_timestamp** | **Number** | The organization's creation time in Unix timestamp format, measured in milliseconds. | [optional]
|
|
10
|
+
|
|
11
|
+
|
package/docs/Pagination.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**before** | **String** | An object ID
|
|
8
|
-
**after** | **String** | An object ID
|
|
9
|
-
**total_count** | **Number** | The total number of records that match the query,
|
|
7
|
+
**before** | **String** | An object ID used to retrieve records before the specified object, indicating earlier or smaller records relative to the current dataset. You can use it to paginate backwards. If empty, it means you have reached the start of the data. Most API endpoints sort by object ID, but some use other fields depending on the endpoint. |
|
|
8
|
+
**after** | **String** | An object ID used to retrieve records after the specified object, indicating newer or larger records relative to the current dataset. You can use it to paginate forwards. If empty, it means you have reached the end of the data. Most API endpoints sort by object ID, but some use other fields depending on the endpoint. |
|
|
9
|
+
**total_count** | **Number** | The total number of records that match the query criteria, unaffected by the pagination parameters (`before` , `after`, and `limit`). |
|
|
10
10
|
|
|
11
11
|
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**pool_type** | [**StakingPoolType**](StakingPoolType.md) | |
|
|
8
|
-
**icon_url** | **String** | The URL of the validator's icon. |
|
|
8
|
+
**icon_url** | **String** | The URL of the validator's icon. | [optional]
|
|
9
9
|
**name** | **String** | The validator's name. |
|
|
10
10
|
**priority** | **Number** | This property can be ignored. | [optional]
|
|
11
|
-
**public_key** | **String** | The public key of the validator. |
|
|
12
|
-
**commission_rate** | **Number** | The commission rate of the validator. |
|
|
13
|
-
**supported_pos_chains** | **[String]** | A list of supported Proof-of-Stake (PoS) chains. |
|
|
11
|
+
**public_key** | **String** | The public key of the validator. | [optional]
|
|
12
|
+
**commission_rate** | **Number** | The commission rate of the validator. | [optional]
|
|
13
|
+
**supported_pos_chains** | **[String]** | A list of supported Proof-of-Stake (PoS) chains. | [optional]
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CoboWaas2.RetryCallbackMessage201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**retried** | **Boolean** | Whether the callback message has been successfully resent: - `true`: The callback message has been successfully resent. - `false`: The callback message has not been successfully resent. | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.SelfCustodyWallet
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) | |
|
|
8
|
+
**self_custody_wallet_challenge** | **String** | The challenge obtained from a previous operation. |
|
|
9
|
+
**self_custody_wallet_address** | **String** | The address of the self-custodial wallet. |
|
|
10
|
+
**self_custody_wallet_sign** | **String** | The signed message from the self-custodial wallet. |
|
|
11
|
+
|
|
12
|
+
|
package/docs/SourceGroup.md
CHANGED
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**key_share_holder_group_id** | **String** | The source key share holder group ID. |
|
|
8
|
-
**tss_node_ids** | **[String]** | The TSS Node IDs participating in creating a new key share holder group when `type` is set to either `KeyGenFromKeyGroup` or `Recovery`. **Note:** In any [Threshold Signature Schemes (TSS)](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#threshold-signature-scheme-tss) such as the 2-2, 2-3, and 3-3 schemes (in the \"threshold - participants\" format), for `tss_node_ids`, you only need to fill in 1 Cobo TSS Node ID and enough non-Cobo TSS Node IDs to satisfy the number of approvers specified in `threshold`. To obtain the Cobo TSS Node ID, run [List all Cobo key share holders](/v2/api-references/wallets--mpc-wallets/list-all-cobo-key-share-holders). | [optional]
|
|
8
|
+
**tss_node_ids** | **[String]** | The TSS Node IDs participating in creating a new key share holder group when `type` is set to either `KeyGenFromKeyGroup` or `Recovery`. **Note:** In any [Threshold Signature Schemes (TSS)](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#threshold-signature-scheme-tss) such as the 2-2, 2-3, and 3-3 schemes (in the \"threshold - participants\" format), for `tss_node_ids`, you only need to fill in 1 Cobo TSS Node ID and enough non-Cobo TSS Node IDs to satisfy the number of approvers specified in `threshold`. To obtain the Cobo TSS Node ID, run [List all Cobo key share holders](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-cobo-key-share-holders). | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# CoboWaas2.StakingPoolId
|
|
2
|
+
|
|
3
|
+
## Enum
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
* `babylon_btc_signet` (value: `"babylon_btc_signet"`)
|
|
7
|
+
|
|
8
|
+
* `babylon_btc` (value: `"babylon_btc"`)
|
|
9
|
+
|
|
10
|
+
* `beacon_eth` (value: `"beacon_eth"`)
|
|
11
|
+
|
|
12
|
+
* `beacon_eth_holesky` (value: `"beacon_eth_holesky"`)
|
|
13
|
+
|
|
14
|
+
* `core_btc` (value: `"core_btc"`)
|
|
15
|
+
|
|
16
|
+
* `core_xtn` (value: `"core_xtn"`)
|
|
17
|
+
|
|
18
|
+
* `sky_farm_eth_usdc` (value: `"sky_farm_eth_usdc"`)
|
|
19
|
+
|
|
20
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
21
|
+
|
|
22
|
+
|
package/docs/StakingPoolType.md
CHANGED
package/docs/Stakings.md
CHANGED
|
@@ -8,12 +8,12 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**wallet_id** | **String** | The staker's wallet ID. |
|
|
9
9
|
**address** | **String** | The staker's wallet address. |
|
|
10
10
|
**amounts** | [**[AmountDetailsInner]**](AmountDetailsInner.md) | The details about the staking amount. |
|
|
11
|
-
**pool_id** | **
|
|
11
|
+
**pool_id** | [**StakingPoolId**](StakingPoolId.md) | |
|
|
12
12
|
**token_id** | **String** | The token ID. |
|
|
13
13
|
**rewards_info** | **Object** | The information about the staking rewards. | [optional]
|
|
14
14
|
**created_timestamp** | **Number** | The time when the staking position was created. |
|
|
15
15
|
**updated_timestamp** | **Number** | The time when the staking position was last updated. |
|
|
16
|
-
**validator_info** | [**
|
|
16
|
+
**validator_info** | [**BabylonValidator**](BabylonValidator.md) | |
|
|
17
17
|
**extra** | [**StakingsExtra**](StakingsExtra.md) | | [optional]
|
|
18
18
|
|
|
19
19
|
|
package/docs/StakingsApi.md
CHANGED
|
@@ -4,12 +4,14 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
+
[**createClaimActivity**](StakingsApi.md#createClaimActivity) | **POST** /stakings/activities/claim | Create claim activity
|
|
7
8
|
[**createStakeActivity**](StakingsApi.md#createStakeActivity) | **POST** /stakings/activities/stake | Create stake activity
|
|
8
9
|
[**createUnstakeActivity**](StakingsApi.md#createUnstakeActivity) | **POST** /stakings/activities/unstake | Create unstake activity
|
|
9
10
|
[**createWithdrawActivity**](StakingsApi.md#createWithdrawActivity) | **POST** /stakings/activities/withdraw | Create withdraw activity
|
|
10
11
|
[**getStakingActivityById**](StakingsApi.md#getStakingActivityById) | **GET** /stakings/activities/{activity_id} | Get staking activity details
|
|
11
12
|
[**getStakingById**](StakingsApi.md#getStakingById) | **GET** /stakings/{staking_id} | Get staking position details
|
|
12
13
|
[**getStakingEstimationFee**](StakingsApi.md#getStakingEstimationFee) | **POST** /stakings/estimate_fee | Estimate staking fees
|
|
14
|
+
[**getStakingEstimationFeeV2**](StakingsApi.md#getStakingEstimationFeeV2) | **POST** /stakings/estimate_fee_v2 | Estimate staking fees v2
|
|
13
15
|
[**getStakingPoolById**](StakingsApi.md#getStakingPoolById) | **GET** /stakings/pools/{pool_id} | Get staking pool details
|
|
14
16
|
[**listStakingActivities**](StakingsApi.md#listStakingActivities) | **GET** /stakings/activities | List staking activities
|
|
15
17
|
[**listStakingPools**](StakingsApi.md#listStakingPools) | **GET** /stakings/pools | List staking pools
|
|
@@ -17,6 +19,58 @@ Method | HTTP request | Description
|
|
|
17
19
|
|
|
18
20
|
|
|
19
21
|
|
|
22
|
+
## createClaimActivity
|
|
23
|
+
|
|
24
|
+
> CreateStakeActivity201Response createClaimActivity(opts)
|
|
25
|
+
|
|
26
|
+
Create claim activity
|
|
27
|
+
|
|
28
|
+
This operation creates a claim request. <Note>Currently, only the Ethereum Beacon protocol supports this operation.</Note> For some protocols, you can use the `fee` property in the request body to specify the maximum fee you are willing to pay. The transaction will fail if the actual fee exceeds the specified maximum fee.
|
|
29
|
+
|
|
30
|
+
### Example
|
|
31
|
+
|
|
32
|
+
```javascript
|
|
33
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
34
|
+
// Initialize the API client
|
|
35
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
36
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
37
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
38
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
39
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
40
|
+
// Call the API
|
|
41
|
+
const apiInstance = new CoboWaas2.StakingsApi();
|
|
42
|
+
const opts = {
|
|
43
|
+
'CreateClaimActivityRequest': new CoboWaas2.CreateClaimActivityRequest()
|
|
44
|
+
};
|
|
45
|
+
apiInstance.createClaimActivity(opts).then((data) => {
|
|
46
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
47
|
+
}, (error) => {
|
|
48
|
+
console.error(error);
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Parameters
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
Name | Type | Description | Notes
|
|
57
|
+
------------- | ------------- | ------------- | -------------
|
|
58
|
+
**CreateClaimActivityRequest** | [**CreateClaimActivityRequest**](CreateClaimActivityRequest.md)| The request body to create a staking request. | [optional]
|
|
59
|
+
|
|
60
|
+
### Return type
|
|
61
|
+
|
|
62
|
+
[**CreateStakeActivity201Response**](CreateStakeActivity201Response.md)
|
|
63
|
+
|
|
64
|
+
### Authorization
|
|
65
|
+
|
|
66
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
67
|
+
|
|
68
|
+
### HTTP request headers
|
|
69
|
+
|
|
70
|
+
- **Content-Type**: application/json
|
|
71
|
+
- **Accept**: application/json
|
|
72
|
+
|
|
73
|
+
|
|
20
74
|
## createStakeActivity
|
|
21
75
|
|
|
22
76
|
> CreateStakeActivity201Response createStakeActivity(opts)
|
|
@@ -257,7 +311,7 @@ apiInstance.getStakingById(staking_id).then((data) => {
|
|
|
257
311
|
|
|
258
312
|
Name | Type | Description | Notes
|
|
259
313
|
------------- | ------------- | ------------- | -------------
|
|
260
|
-
**staking_id** | **String**| The ID of the staking position. You can retrieve a list of staking positions by calling [List staking positions](/v2/api-references/stakings/list-
|
|
314
|
+
**staking_id** | **String**| The ID of the staking position. You can retrieve a list of staking positions by calling [List staking positions](https://www.cobo.com/developers/v2/api-references/stakings/list-staking-positions). |
|
|
261
315
|
|
|
262
316
|
### Return type
|
|
263
317
|
|
|
@@ -279,7 +333,7 @@ Name | Type | Description | Notes
|
|
|
279
333
|
|
|
280
334
|
Estimate staking fees
|
|
281
335
|
|
|
282
|
-
This operation calculates the fee required for a staking activity based on factors such as network congestion and transaction complexity. For some protocols, you can use the `fee.fee_rate` property in the request body to specify the fee rate you are willing to pay. The `fee.max_fee_amount` property in the request body will be ignored. <Note>For the Babylon protocol, you can only select UTXO as the fee model.</Note>
|
|
336
|
+
<Note>This operation is deprecated. Please use the [updated version](https://www.cobo.com/developers/v2/api-references/stakings/estimate-staking-fees-v2) instead.</Note> This operation calculates the fee required for a staking activity based on factors such as network congestion and transaction complexity. For some protocols, you can use the `fee.fee_rate` property in the request body to specify the fee rate you are willing to pay. The `fee.max_fee_amount` property in the request body will be ignored. <Note>For the Babylon protocol, you can only select UTXO as the fee model.</Note>
|
|
283
337
|
|
|
284
338
|
### Example
|
|
285
339
|
|
|
@@ -325,6 +379,58 @@ Name | Type | Description | Notes
|
|
|
325
379
|
- **Accept**: application/json
|
|
326
380
|
|
|
327
381
|
|
|
382
|
+
## getStakingEstimationFeeV2
|
|
383
|
+
|
|
384
|
+
> EthStakeEstimatedFee getStakingEstimationFeeV2(opts)
|
|
385
|
+
|
|
386
|
+
Estimate staking fees v2
|
|
387
|
+
|
|
388
|
+
This operation calculates the fee required for a staking activity based on factors such as network congestion and transaction complexity. <Note>For the Babylon protocol, you can only select UTXO as the fee model.</Note>
|
|
389
|
+
|
|
390
|
+
### Example
|
|
391
|
+
|
|
392
|
+
```javascript
|
|
393
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
394
|
+
// Initialize the API client
|
|
395
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
396
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
397
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
398
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
399
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
400
|
+
// Call the API
|
|
401
|
+
const apiInstance = new CoboWaas2.StakingsApi();
|
|
402
|
+
const opts = {
|
|
403
|
+
'GetStakingEstimationFeeRequest': new CoboWaas2.GetStakingEstimationFeeRequest()
|
|
404
|
+
};
|
|
405
|
+
apiInstance.getStakingEstimationFeeV2(opts).then((data) => {
|
|
406
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
407
|
+
}, (error) => {
|
|
408
|
+
console.error(error);
|
|
409
|
+
});
|
|
410
|
+
|
|
411
|
+
```
|
|
412
|
+
|
|
413
|
+
### Parameters
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
Name | Type | Description | Notes
|
|
417
|
+
------------- | ------------- | ------------- | -------------
|
|
418
|
+
**GetStakingEstimationFeeRequest** | [**GetStakingEstimationFeeRequest**](GetStakingEstimationFeeRequest.md)| The request body to get the estimated fee of a staking activity. | [optional]
|
|
419
|
+
|
|
420
|
+
### Return type
|
|
421
|
+
|
|
422
|
+
[**EthStakeEstimatedFee**](EthStakeEstimatedFee.md)
|
|
423
|
+
|
|
424
|
+
### Authorization
|
|
425
|
+
|
|
426
|
+
[CoboAuth](../README.md#CoboAuth)
|
|
427
|
+
|
|
428
|
+
### HTTP request headers
|
|
429
|
+
|
|
430
|
+
- **Content-Type**: application/json
|
|
431
|
+
- **Accept**: application/json
|
|
432
|
+
|
|
433
|
+
|
|
328
434
|
## getStakingPoolById
|
|
329
435
|
|
|
330
436
|
> PoolDetails getStakingPoolById(pool_id)
|
|
@@ -359,7 +465,7 @@ apiInstance.getStakingPoolById(pool_id).then((data) => {
|
|
|
359
465
|
|
|
360
466
|
Name | Type | Description | Notes
|
|
361
467
|
------------- | ------------- | ------------- | -------------
|
|
362
|
-
**pool_id** | **String**| The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. You can call [List staking pools](/v2/api-references/stakings/list-staking-pools) to retrieve a list of staking pools. |
|
|
468
|
+
**pool_id** | **String**| The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. You can call [List staking pools](https://www.cobo.com/developers/v2/api-references/stakings/list-staking-pools) to retrieve a list of staking pools. |
|
|
363
469
|
|
|
364
470
|
### Return type
|
|
365
471
|
|
|
@@ -403,6 +509,7 @@ const opts = {
|
|
|
403
509
|
'min_modified_timestamp': 1635744000000,
|
|
404
510
|
'max_modified_timestamp': 1635744000000,
|
|
405
511
|
'initiator': "steve@example.com",
|
|
512
|
+
'request_id': "web_send_by_user_327_1610444045047",
|
|
406
513
|
'limit': 10,
|
|
407
514
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
408
515
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
|
|
@@ -420,16 +527,17 @@ apiInstance.listStakingActivities(opts).then((data) => {
|
|
|
420
527
|
|
|
421
528
|
Name | Type | Description | Notes
|
|
422
529
|
------------- | ------------- | ------------- | -------------
|
|
423
|
-
**pool_id** | **String**| The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. You can call [List staking pools](/v2/api-references/stakings/list-staking-pools) to retrieve a list of staking pools. | [optional]
|
|
530
|
+
**pool_id** | **String**| The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. You can call [List staking pools](https://www.cobo.com/developers/v2/api-references/stakings/list-staking-pools) to retrieve a list of staking pools. | [optional]
|
|
424
531
|
**staking_id** | **String**| The position ID. | [optional]
|
|
425
532
|
**activity_type** | [**ActivityType**](.md)| | [optional]
|
|
426
533
|
**activity_status** | [**ActivityStatus**](.md)| | [optional]
|
|
427
534
|
**min_modified_timestamp** | **Number**| The start time of the query. All staking activities updated after the specified time will be retrieved. The time is in Unix timestamp format, measured in milliseconds. | [optional]
|
|
428
535
|
**max_modified_timestamp** | **Number**| The end time of the query. All staking activities updated before the specified time will be retrieved. The time is in Unix timestamp format, measured in milliseconds. | [optional]
|
|
429
536
|
**initiator** | **String**| The activity initiator, which is your API key by default. You can also specify the initiator when creating the activity. | [optional]
|
|
537
|
+
**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]
|
|
430
538
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
431
|
-
**before** | **String**|
|
|
432
|
-
**after** | **String**|
|
|
539
|
+
**before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned. | [optional]
|
|
540
|
+
**after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
|
|
433
541
|
|
|
434
542
|
### Return type
|
|
435
543
|
|
|
@@ -485,11 +593,11 @@ apiInstance.listStakingPools(opts).then((data) => {
|
|
|
485
593
|
|
|
486
594
|
Name | Type | Description | Notes
|
|
487
595
|
------------- | ------------- | ------------- | -------------
|
|
488
|
-
**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](/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
489
|
-
**token_id** | **String**| The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
596
|
+
**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]
|
|
597
|
+
**token_id** | **String**| The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
490
598
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
491
|
-
**before** | **String**|
|
|
492
|
-
**after** | **String**|
|
|
599
|
+
**before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned. | [optional]
|
|
600
|
+
**after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
|
|
493
601
|
|
|
494
602
|
### Return type
|
|
495
603
|
|
|
@@ -547,13 +655,13 @@ apiInstance.listStakings(opts).then((data) => {
|
|
|
547
655
|
|
|
548
656
|
Name | Type | Description | Notes
|
|
549
657
|
------------- | ------------- | ------------- | -------------
|
|
550
|
-
**pool_id** | **String**| The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. You can call [List staking pools](/v2/api-references/stakings/list-staking-pools) to retrieve a list of staking pools. | [optional]
|
|
658
|
+
**pool_id** | **String**| The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. You can call [List staking pools](https://www.cobo.com/developers/v2/api-references/stakings/list-staking-pools) to retrieve a list of staking pools. | [optional]
|
|
551
659
|
**statuses** | **String**| The statuses of the staking amounts, separated by comma. Possible values include: - `StakeInProgress`: The staking request is submitted and is waiting to be confirmed by the staking protocol. - `Active`: The amount has been staked. - `Rejected`: The staking request has been rejected because the signer refuses to sign the transaction. - `LimitExceeded`: The total staking cap of the staking protocol has been reached. - `Invalid`: The staking request is invalid. This is often due to the failure to broadcast the transaction. - `UnstakeInProgress`: The unstaking request is submitted and is waiting to be confirmed by the staking protocol. - `Withdrawable`: The tokens have been unstaked and are ready to be withdrawn. - `WithdrawInProgress`: The withdrawal request is submitted and is waiting to be confirmed on the chain network. - `Closed`: The staking position is closed. | [optional]
|
|
552
660
|
**wallet_id** | **String**| The wallet ID. | [optional]
|
|
553
|
-
**token_id** | **String**| The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
661
|
+
**token_id** | **String**| The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
554
662
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
555
|
-
**before** | **String**|
|
|
556
|
-
**after** | **String**|
|
|
663
|
+
**before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned. | [optional]
|
|
664
|
+
**after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
|
|
557
665
|
|
|
558
666
|
### Return type
|
|
559
667
|
|
package/docs/StakingsExtra.md
CHANGED
|
@@ -10,5 +10,10 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**unlock_block_height** | **Number** | The block height at which the bitcoins will be unlocked. | [optional]
|
|
11
11
|
**stake_address** | **String** | The address receiving the staked bitcoins. | [optional]
|
|
12
12
|
**unbond_address** | **String** | The address receiving the unlocked bitcoins. | [optional]
|
|
13
|
+
**beacon_validators** | [**[EthStakingExtraAllOfBeaconValidators]**](EthStakingExtraAllOfBeaconValidators.md) | The list of validator information. | [optional]
|
|
14
|
+
**staker_address** | **String** | The staker's Bitcoin address. |
|
|
15
|
+
**validator_address** | **String** | The validator's EVM address. |
|
|
16
|
+
**reward_address** | **String** | The EVM address to receive staking rewards. |
|
|
17
|
+
**timelock** | **Number** | The Unix timestamp (in seconds) when the staking position will be unlocked and available for withdrawal. |
|
|
13
18
|
|
|
14
19
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CoboWaas2.SubmitDepositTravelRuleInfo201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**submitted** | **Boolean** | Whether the submitted Travel Rule info has been successfully executed. - `true`: The operation has been successfully executed. - `false`: The operation has not been executed. | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# CoboWaas2.SwapActivity
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**activity_id** | **String** | The unique identifier of the swap activity. | [optional]
|
|
8
|
+
**status** | **String** | The status of the swap activity. | [optional]
|
|
9
|
+
**wallet_id** | **String** | The unique identifier of the wallet. | [optional]
|
|
10
|
+
**pay_token_id** | **String** | The token symbol to swap from. | [optional]
|
|
11
|
+
**receive_token_id** | **String** | The token symbol to swap to. | [optional]
|
|
12
|
+
**pay_amount** | **String** | The amount of tokens to bridge. | [optional]
|
|
13
|
+
**receive_amount** | **String** | The amount of tokens to receive. | [optional]
|
|
14
|
+
**fee_amount** | **String** | The amount of fee. | [optional]
|
|
15
|
+
**initiator** | **String** | The initiator of the swap activity. | [optional]
|
|
16
|
+
**initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) | | [optional]
|
|
17
|
+
**created_timestamp** | **Number** | The time when the swap activity was created, in Unix timestamp format, measured in milliseconds. | [optional]
|
|
18
|
+
**updated_timestamp** | **Number** | The time when the swap activity was last updated, in Unix timestamp format, measured in milliseconds. | [optional]
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.SwapSummary
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total_usd_value** | **String** | The total USD value of the swap activities, represented as a string. |
|
|
8
|
+
**activity_count** | **Number** | The total number of swap activities. |
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.SwapTokenPair
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**pay_token_id** | **String** | The source token symbol. | [optional]
|
|
8
|
+
**receive_token_id** | **String** | The target token symbol. | [optional]
|
|
9
|
+
|
|
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. |
|
|
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. |
|
|
8
8
|
**tss_request_id** | **String** | The TSS request ID. | [optional]
|
|
9
9
|
**source_key_share_holder_group** | [**SourceGroup**](SourceGroup.md) | | [optional]
|
|
10
10
|
**target_key_share_holder_group_id** | **String** | The target key share holder group ID. | [optional]
|
|
@@ -22,6 +22,12 @@ Name | Type | Description | Notes
|
|
|
22
22
|
|
|
23
23
|
* `TSSRequest` (value: `"TSSRequest"`)
|
|
24
24
|
|
|
25
|
+
* `Addresses` (value: `"Addresses"`)
|
|
26
|
+
|
|
27
|
+
* `WalletInfo` (value: `"WalletInfo"`)
|
|
28
|
+
|
|
29
|
+
* `MPCVault` (value: `"MPCVault"`)
|
|
30
|
+
|
|
25
31
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
26
32
|
|
|
27
33
|
|
package/docs/TokenBalance.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). |
|
|
7
|
+
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). |
|
|
8
8
|
**balance** | [**TokenBalanceBalance**](TokenBalanceBalance.md) | |
|
|
9
9
|
|
|
10
10
|
|
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**total** | **String** | The current amount of tokens in an address, which is retrieved directly from the network. To learn more, see [Balances and transaction amounts for MPC Wallets](/v2/guides/mpc-wallets/balance-amounts) for more details. |
|
|
8
|
-
**available** | **String** | The amount of tokens ready to be spent. To learn more, see [Balances and transaction amounts for MPC Wallets](/v2/guides/mpc-wallets/balance-amounts) for more details. |
|
|
9
|
-
**pending** | **String** | The total amount being sent in a transaction, which is calculated as the withdrawal amount plus the transaction fee. To learn more, see [Balances and transaction amounts for MPC Wallets](/v2/guides/mpc-wallets/balance-amounts) for more details. | [optional] [default to '0']
|
|
10
|
-
**locked** | **String** | For UTXO chains, this is the combined value of the selected UTXOs for the transaction. For other chains, it is equal to the Pending amount. To learn more, see [Balances and transaction amounts for MPC Wallets](/v2/guides/mpc-wallets/balance-amounts) for more details. | [optional] [default to '0']
|
|
7
|
+
**total** | **String** | The current amount of tokens in an address, which is retrieved directly from the network. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. |
|
|
8
|
+
**available** | **String** | The amount of tokens ready to be spent. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. |
|
|
9
|
+
**pending** | **String** | The total amount being sent in a transaction, which is calculated as the withdrawal amount plus the transaction fee. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. | [optional] [default to '0']
|
|
10
|
+
**locked** | **String** | For UTXO chains, this is the combined value of the selected UTXOs for the transaction. For other chains, it is equal to the Pending amount. To learn more, see [Balances and transaction amounts for MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/balance-amounts) for more details. | [optional] [default to '0']
|
|
11
11
|
|
|
12
12
|
|
package/docs/TokenInfo.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). |
|
|
7
|
+
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). |
|
|
8
8
|
**chain_id** | **String** | The ID of the chain on which the token operates. |
|
|
9
9
|
**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]
|
|
10
10
|
**symbol** | **String** | The token symbol, which is the abbreviated name of a token. | [optional]
|
package/docs/Transaction.md
CHANGED
|
@@ -12,8 +12,8 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**status** | [**TransactionStatus**](TransactionStatus.md) | |
|
|
13
13
|
**sub_status** | [**TransactionSubStatus**](TransactionSubStatus.md) | | [optional]
|
|
14
14
|
**failed_reason** | **String** | (This property is applicable to approval failures and signature failures only) The reason why the transaction failed. | [optional]
|
|
15
|
-
**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](/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
16
|
-
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
15
|
+
**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]
|
|
16
|
+
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
17
17
|
**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]
|
|
18
18
|
**source** | [**TransactionSource**](TransactionSource.md) | |
|
|
19
19
|
**destination** | [**TransactionDestination**](TransactionDestination.md) | |
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CoboWaas2.TransactionApprovalDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**spender** | [**TransactionRoleApprovalDetail**](TransactionRoleApprovalDetail.md) | | [optional]
|
|
8
|
+
**approver** | [**TransactionRoleApprovalDetail**](TransactionRoleApprovalDetail.md) | | [optional]
|
|
9
|
+
**address_owner** | [**TransactionRoleApprovalDetail**](TransactionRoleApprovalDetail.md) | | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -12,8 +12,8 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**status** | [**TransactionStatus**](TransactionStatus.md) | |
|
|
13
13
|
**sub_status** | [**TransactionSubStatus**](TransactionSubStatus.md) | | [optional]
|
|
14
14
|
**failed_reason** | **String** | (This property is applicable to approval failures and signature failures only) The reason why the transaction failed. | [optional]
|
|
15
|
-
**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](/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
16
|
-
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
15
|
+
**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]
|
|
16
|
+
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
17
17
|
**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]
|
|
18
18
|
**source** | [**TransactionSource**](TransactionSource.md) | |
|
|
19
19
|
**destination** | [**TransactionDestination**](TransactionDestination.md) | |
|
|
@@ -12,8 +12,8 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**status** | [**TransactionStatus**](TransactionStatus.md) | |
|
|
13
13
|
**sub_status** | [**TransactionSubStatus**](TransactionSubStatus.md) | | [optional]
|
|
14
14
|
**failed_reason** | **String** | (This property is applicable to approval failures and signature failures only) The reason why the transaction failed. | [optional]
|
|
15
|
-
**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](/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
16
|
-
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
15
|
+
**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]
|
|
16
|
+
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
17
17
|
**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]
|
|
18
18
|
**source** | [**TransactionSource**](TransactionSource.md) | |
|
|
19
19
|
**destination** | [**TransactionDestination**](TransactionDestination.md) | |
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**used_nonce** | **Number** | The transaction nonce. | [optional]
|
|
8
|
-
**selected_utxos** | [**[
|
|
8
|
+
**selected_utxos** | [**[TransactionSelectedUtxo]**](TransactionSelectedUtxo.md) | The selected UTXOs to be consumed in the transaction. | [optional]
|
|
9
9
|
**raw_tx** | **String** | The raw transaction data. | [optional]
|
|
10
10
|
|
|
11
11
|
|
package/docs/TransactionRbf.md
CHANGED
|
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**source** | [**TransactionRbfSource**](TransactionRbfSource.md) | | [optional]
|
|
10
10
|
**category_names** | **[String]** | The custom category for you to identify your transactions. | [optional]
|
|
11
11
|
**description** | **String** | The description of the RBF transaction. | [optional]
|
|
12
|
+
**auto_fuel** | [**AutoFuelType**](AutoFuelType.md) | | [optional]
|
|
12
13
|
|
|
13
14
|
|