@cobo/cobo-waas2 1.5.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (166) hide show
  1. package/README.md +31 -5
  2. package/dist/ApiClient.js +56 -6
  3. package/dist/ServerDemo.js +80 -0
  4. package/dist/api/DevelopersApi.js +79 -0
  5. package/dist/api/DevelopersWebhooksApi.js +2 -2
  6. package/dist/api/OAuthApi.js +8 -8
  7. package/dist/api/StakingsApi.js +91 -7
  8. package/dist/api/TransactionsApi.js +4 -4
  9. package/dist/api/WalletsApi.js +58 -57
  10. package/dist/crypto/Ed25519Signer.js +36 -0
  11. package/dist/crypto/Secp256k1Signer.js +36 -0
  12. package/dist/index.js +153 -13
  13. package/dist/model/Activity.js +4 -8
  14. package/dist/model/ActivityAction.js +20 -0
  15. package/dist/model/ActivityType.js +5 -0
  16. package/dist/model/AddressTransferDestination.js +2 -2
  17. package/dist/model/AddressTransferDestinationUtxoOutputsInner.js +6 -17
  18. package/dist/model/AutoFuelType.js +61 -0
  19. package/dist/model/BabylonStakeEstimatedFee.js +118 -0
  20. package/dist/model/BabylonValidator.js +9 -12
  21. package/dist/model/CheckAddressChainsValidity200ResponseInner.js +121 -0
  22. package/dist/model/ContractCallParams.js +9 -0
  23. package/dist/model/CoreStakeExtra.js +170 -0
  24. package/dist/model/CoreStakingExtra.js +187 -0
  25. package/dist/model/CreateClaimActivity.js +139 -0
  26. package/dist/model/CreateClaimActivityRequest.js +182 -0
  27. package/dist/model/CreateSmartContractWalletParams.js +1 -1
  28. package/dist/model/CreateStakeActivity.js +4 -8
  29. package/dist/model/CreateStakeActivityExtra.js +94 -8
  30. package/dist/model/CreateStakeActivityRequest.js +5 -10
  31. package/dist/model/CreateUnstakeActivity.js +16 -0
  32. package/dist/model/CreateUnstakeActivityExtra.js +159 -0
  33. package/dist/model/CreateUnstakeActivityRequest.js +20 -0
  34. package/dist/model/CreateWithdrawActivity.js +0 -13
  35. package/dist/model/CreateWithdrawActivityRequest.js +0 -18
  36. package/dist/model/EstimateClaimFee.js +145 -0
  37. package/dist/model/EstimateContractCallFeeParams.js +6 -8
  38. package/dist/model/EstimateFeeParams.js +1 -1
  39. package/dist/model/EstimateStakeFee.js +5 -10
  40. package/dist/model/EstimateTransferFeeParams.js +4 -8
  41. package/dist/model/EstimateUnstakeFee.js +20 -0
  42. package/dist/model/EstimateWithdrawFee.js +0 -18
  43. package/dist/model/EstimatedEvmEip1559FeeSlow.js +3 -5
  44. package/dist/model/EstimatedEvmLegacyFeeSlow.js +3 -5
  45. package/dist/model/EstimatedFee.js +1 -1
  46. package/dist/model/EstimatedFixedFee.js +4 -4
  47. package/dist/model/EstimatedUtxoFeeSlow.js +3 -3
  48. package/dist/model/EthStakeEstimatedFee.js +112 -0
  49. package/dist/model/EthStakeExtra.js +131 -0
  50. package/dist/model/EthStakingExtra.js +162 -0
  51. package/dist/model/EthStakingExtraAllOfBeaconValidators.js +140 -0
  52. package/dist/model/EthUnstakeExtra.js +131 -0
  53. package/dist/model/FeeAmount.js +1 -1
  54. package/dist/model/FeeGasLimit.js +1 -2
  55. package/dist/model/FeeRate.js +1 -1
  56. package/dist/model/FixedFeeRate.js +2 -2
  57. package/dist/model/GetApiKeyInfo200Response.js +251 -0
  58. package/dist/model/GetStakingEstimationFee201Response.js +144 -43
  59. package/dist/model/GetStakingEstimationFeeRequest.js +41 -19
  60. package/dist/model/{GetToken200Response.js → GetToken2XXResponse.js} +21 -21
  61. package/dist/model/GetToken4XXResponse.js +12 -10
  62. package/dist/model/MPCDelegate.js +1 -1
  63. package/dist/model/MPCProject.js +4 -4
  64. package/dist/model/MpcTransferSource.js +2 -2
  65. package/dist/model/Pagination.js +2 -2
  66. package/dist/model/{RefreshToken201Response.js → RefreshToken2XXResponse.js} +21 -21
  67. package/dist/model/RoleScopes.js +128 -0
  68. package/dist/model/Scopes.js +142 -0
  69. package/dist/model/SmartContractWalletInfo.js +1 -1
  70. package/dist/model/StakingPoolId.js +81 -0
  71. package/dist/model/StakingPoolType.js +10 -0
  72. package/dist/model/Stakings.js +10 -14
  73. package/dist/model/StakingsExtra.js +95 -8
  74. package/dist/model/TransactionEvmEip1559Fee.js +2 -4
  75. package/dist/model/TransactionEvmLegacyFee.js +2 -4
  76. package/dist/model/TransactionFee.js +1 -2
  77. package/dist/model/TransactionRbf.js +9 -0
  78. package/dist/model/TransactionRbfSource.js +1 -1
  79. package/dist/model/TransactionRequestEvmEip1559Fee.js +2 -3
  80. package/dist/model/TransactionRequestEvmLegacyFee.js +2 -3
  81. package/dist/model/TransactionRequestFee.js +1 -2
  82. package/dist/model/TransactionRequestFixedFee.js +1 -1
  83. package/dist/model/TransactionRequestUtxoFee.js +1 -1
  84. package/dist/model/TransactionSource.js +1 -1
  85. package/dist/model/TransactionTransferToAddressDestinationUtxoOutputsInner.js +0 -13
  86. package/dist/model/TransferDestination.js +2 -2
  87. package/dist/model/TransferParams.js +9 -0
  88. package/docs/Activity.md +1 -1
  89. package/docs/ActivityAction.md +8 -0
  90. package/docs/ActivityType.md +2 -0
  91. package/docs/AddressTransferDestination.md +2 -2
  92. package/docs/AddressTransferDestinationUtxoOutputsInner.md +1 -2
  93. package/docs/AutoFuelType.md +12 -0
  94. package/docs/BabylonStakeEstimatedFee.md +12 -0
  95. package/docs/BabylonValidator.md +6 -4
  96. package/docs/CheckAddressChainsValidity200ResponseInner.md +10 -0
  97. package/docs/ContractCallParams.md +1 -0
  98. package/docs/CoreStakeExtra.md +13 -0
  99. package/docs/CoreStakingExtra.md +14 -0
  100. package/docs/CreateClaimActivity.md +11 -0
  101. package/docs/CreateClaimActivityRequest.md +12 -0
  102. package/docs/CreateStakeActivity.md +1 -1
  103. package/docs/CreateStakeActivityExtra.md +5 -0
  104. package/docs/CreateStakeActivityRequest.md +1 -1
  105. package/docs/CreateUnstakeActivity.md +1 -0
  106. package/docs/CreateUnstakeActivityExtra.md +10 -0
  107. package/docs/CreateUnstakeActivityRequest.md +1 -0
  108. package/docs/CreateWithdrawActivity.md +0 -1
  109. package/docs/CreateWithdrawActivityRequest.md +0 -1
  110. package/docs/DevelopersApi.md +55 -0
  111. package/docs/DevelopersWebhooksApi.md +1 -1
  112. package/docs/EstimateClaimFee.md +11 -0
  113. package/docs/EstimateContractCallFeeParams.md +2 -2
  114. package/docs/EstimateFeeParams.md +2 -2
  115. package/docs/EstimateStakeFee.md +1 -1
  116. package/docs/EstimateTransferFeeParams.md +2 -2
  117. package/docs/EstimateUnstakeFee.md +1 -0
  118. package/docs/EstimateWithdrawFee.md +0 -1
  119. package/docs/EstimatedEvmEip1559FeeSlow.md +1 -1
  120. package/docs/EstimatedEvmLegacyFeeSlow.md +1 -1
  121. package/docs/EstimatedFee.md +1 -1
  122. package/docs/EstimatedFixedFee.md +1 -1
  123. package/docs/EstimatedUtxoFeeSlow.md +1 -1
  124. package/docs/EthStakeEstimatedFee.md +11 -0
  125. package/docs/EthStakeExtra.md +10 -0
  126. package/docs/EthStakingExtra.md +11 -0
  127. package/docs/EthStakingExtraAllOfBeaconValidators.md +14 -0
  128. package/docs/EthUnstakeExtra.md +10 -0
  129. package/docs/FeeAmount.md +1 -1
  130. package/docs/FeeGasLimit.md +1 -1
  131. package/docs/FeeRate.md +1 -1
  132. package/docs/FixedFeeRate.md +1 -1
  133. package/docs/GetApiKeyInfo200Response.md +30 -0
  134. package/docs/GetStakingEstimationFee201Response.md +3 -0
  135. package/docs/GetStakingEstimationFeeRequest.md +3 -4
  136. package/docs/{GetToken200Response.md → GetToken2XXResponse.md} +1 -1
  137. package/docs/GetToken4XXResponse.md +1 -1
  138. package/docs/MPCProject.md +1 -1
  139. package/docs/MpcTransferSource.md +1 -1
  140. package/docs/OAuthApi.md +4 -4
  141. package/docs/Pagination.md +1 -1
  142. package/docs/PoolDetailsAllOfValidatorsInfo.md +6 -4
  143. package/docs/{RefreshToken201Response.md → RefreshToken2XXResponse.md} +1 -1
  144. package/docs/RoleScopes.md +10 -0
  145. package/docs/Scopes.md +13 -0
  146. package/docs/StakingPoolId.md +20 -0
  147. package/docs/StakingPoolType.md +4 -0
  148. package/docs/Stakings.md +2 -2
  149. package/docs/StakingsApi.md +108 -2
  150. package/docs/StakingsExtra.md +5 -0
  151. package/docs/TransactionEvmEip1559Fee.md +1 -1
  152. package/docs/TransactionEvmLegacyFee.md +1 -1
  153. package/docs/TransactionFee.md +1 -1
  154. package/docs/TransactionRbf.md +1 -0
  155. package/docs/TransactionRbfSource.md +1 -1
  156. package/docs/TransactionRequestEvmEip1559Fee.md +1 -1
  157. package/docs/TransactionRequestEvmLegacyFee.md +1 -1
  158. package/docs/TransactionRequestFee.md +1 -1
  159. package/docs/TransactionTransferToAddressDestinationUtxoOutputsInner.md +0 -1
  160. package/docs/TransactionsApi.md +2 -2
  161. package/docs/TransferDestination.md +2 -2
  162. package/docs/TransferParams.md +1 -0
  163. package/docs/WalletsApi.md +54 -54
  164. package/package.json +4 -2
  165. package/dist/model/StakingsValidatorInfo.js +0 -140
  166. package/docs/StakingsValidatorInfo.md +0 -13
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **account_output** | [**AddressTransferDestinationAccountOutput**](AddressTransferDestinationAccountOutput.md) | | [optional]
9
9
  **utxo_outputs** | [**[AddressTransferDestinationUtxoOutputsInner]**](AddressTransferDestinationUtxoOutputsInner.md) | | [optional]
10
10
  **change_address** | **String** | The address used to receive the remaining funds or change from the transaction. | [optional]
11
- **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_internal` as `true`. | [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. Please do not set both `force_internal` and `force_internal` as `true`. | [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. Please do not set both `force_internal` and `force_external` as `true`. | [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. Please do not set both `force_internal` and `force_external` as `true`. | [optional]
13
13
 
14
14
 
@@ -5,7 +5,6 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **address** | **String** | The destination address. |
8
- **amount** | **String** | The transfer amount. For example, if you trade 1.5 BTC, then the value is `1.5`. | [optional]
9
- **script** | **String** | The script of the output. It is a programmable code fragment that defines the conditions under which the UTXO can be spent. | [optional]
8
+ **amount** | **String** | The transfer amount. For example, if you trade 1.5 BTC, then the value is `1.5`. |
10
9
 
11
10
 
@@ -0,0 +1,12 @@
1
+ # CoboWaas2.AutoFuelType
2
+
3
+ ## Enum
4
+
5
+
6
+ * `PassiveAutoFuel` (value: `"PassiveAutoFuel"`)
7
+
8
+ * `ProActiveAutoFuel` (value: `"ProActiveAutoFuel"`)
9
+
10
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # CoboWaas2.BabylonStakeEstimatedFee
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **pool_type** | [**StakingPoolType**](StakingPoolType.md) | | [optional]
8
+ **fee_type** | [**FeeType**](FeeType.md) | | [optional]
9
+ **fee_amount** | **String** | The amount of the estimated fee. | [optional]
10
+ **token_id** | **String** | The token ID of the staking fee. | [optional]
11
+
12
+
@@ -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
 
@@ -21,6 +21,8 @@ Name | Type | Description | Notes
21
21
 
22
22
  * `Cosmos` (value: `"Cosmos"`)
23
23
 
24
+ * `Ethereum` (value: `"Ethereum"`)
25
+
24
26
  * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
25
27
 
26
28
 
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.CheckAddressChainsValidity200ResponseInner
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. |
8
+ **validity** | **Boolean** | Whether the address is valid for the specified chain. - `true`: The address is valid. - `false`: The address is invalid. |
9
+
10
+
@@ -11,5 +11,6 @@ Name | Type | Description | Notes
11
11
  **description** | **String** | The description of the contract call transaction. | [optional]
12
12
  **category_names** | **[String]** | The custom category for you to identify your transactions. | [optional]
13
13
  **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
14
+ **auto_fuel** | [**AutoFuelType**](AutoFuelType.md) | | [optional]
14
15
 
15
16
 
@@ -0,0 +1,13 @@
1
+ # CoboWaas2.CoreStakeExtra
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **pool_type** | [**StakingPoolType**](StakingPoolType.md) | |
8
+ **timelock** | **Number** | The Unix timestamp (in seconds) when the staking position will be unlocked and available for withdrawal. |
9
+ **change_address** | **String** | The change address on the Bitcoin chain. If not provided, the source wallet's address will be used as the change address. | [optional]
10
+ **validator_address** | **String** | The validator's EVM address. |
11
+ **reward_address** | **String** | The EVM address to receive staking rewards. |
12
+
13
+
@@ -0,0 +1,14 @@
1
+ # CoboWaas2.CoreStakingExtra
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **pool_type** | [**StakingPoolType**](StakingPoolType.md) | |
8
+ **pos_chain** | **String** | The Proof-of-Stake (PoS) chain. |
9
+ **staker_address** | **String** | The staker's Bitcoin address. |
10
+ **validator_address** | **String** | The validator's EVM address. |
11
+ **reward_address** | **String** | The EVM address to receive staking rewards. |
12
+ **timelock** | **Number** | The Unix timestamp (in seconds) when the staking position will be unlocked and available for withdrawal. |
13
+
14
+
@@ -0,0 +1,11 @@
1
+ # CoboWaas2.CreateClaimActivity
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **request_id** | **String** | The request ID that is used to track a request. The request ID is provided by you and must be unique within your organization. | [optional]
8
+ **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-staking-positions). |
9
+ **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
10
+
11
+
@@ -0,0 +1,12 @@
1
+ # CoboWaas2.CreateClaimActivityRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **request_id** | **String** | The request ID that is used to track a request. The request ID is provided by you and must be unique within your organization. | [optional]
8
+ **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-staking-positions). |
9
+ **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
10
+ **app_initiator** | **String** | The initiator of the staking activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator. | [optional]
11
+
12
+
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **request_id** | **String** | The request ID that is used to track a request. The request ID is provided by you and must be unique within your organization. | [optional]
8
8
  **source** | [**StakingSource**](StakingSource.md) | | [optional]
9
- **pool_id** | **String** | The ID of the staking pool. |
9
+ **pool_id** | [**StakingPoolId**](StakingPoolId.md) | |
10
10
  **amount** | **String** | The amount to stake. |
11
11
  **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
12
12
  **extra** | [**CreateStakeActivityExtra**](CreateStakeActivityExtra.md) | |
@@ -8,5 +8,10 @@ Name | Type | Description | Notes
8
8
  **finality_provider_public_key** | **String** | The public key of the finality provider. |
9
9
  **stake_block_time** | **Number** | The number of blocks that need to be processed before the locked tokens are unlocked and become accessible. |
10
10
  **auto_broadcast** | **Boolean** | Whether to automatically broadcast the transaction. The default value is `true`. - `true`: Automatically broadcast the transaction. - `false`: The transaction will not be submitted to the blockchain automatically. You can call [Broadcast signed transactions](/v2/api-references/transactions/broadcast-signed-transactions) to broadcast the transaction to the blockchain, or retrieve the signed raw transaction data `raw_tx` by calling [Get transaction information](/v2/api-references/transactions/get-transaction-information) and broadcast it yourself. | [optional]
11
+ **provider_name** | **String** | The name of the provider. |
12
+ **timelock** | **Number** | The Unix timestamp (in seconds) when the staking position will be unlocked and available for withdrawal. |
13
+ **change_address** | **String** | The change address on the Bitcoin chain. If not provided, the source wallet's address will be used as the change address. | [optional]
14
+ **validator_address** | **String** | The validator's EVM address. |
15
+ **reward_address** | **String** | The EVM address to receive staking rewards. |
11
16
 
12
17
 
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **request_id** | **String** | The request ID that is used to track a request. The request ID is provided by you and must be unique within your organization. | [optional]
8
8
  **source** | [**StakingSource**](StakingSource.md) | | [optional]
9
- **pool_id** | **String** | The ID of the staking pool. |
9
+ **pool_id** | [**StakingPoolId**](StakingPoolId.md) | |
10
10
  **amount** | **String** | The amount to stake. |
11
11
  **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
12
12
  **extra** | [**CreateStakeActivityExtra**](CreateStakeActivityExtra.md) | |
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
8
8
  **staking_id** | **String** | The ID of the corresponding staking position. |
9
9
  **amount** | **String** | The amount to unstake. For the Babylon protocol, this property is ignored. | [optional]
10
10
  **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
11
+ **extra** | [**CreateUnstakeActivityExtra**](CreateUnstakeActivityExtra.md) | | [optional]
11
12
 
12
13
 
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.CreateUnstakeActivityExtra
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **pool_type** | [**StakingPoolType**](StakingPoolType.md) | |
8
+ **validator_pubkeys** | **[String]** | A list of public keys identifying the validators to unstake from the Ethereum Beacon Chain. |
9
+
10
+
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  **staking_id** | **String** | The ID of the corresponding staking position. |
9
9
  **amount** | **String** | The amount to unstake. For the Babylon protocol, this property is ignored. | [optional]
10
10
  **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
11
+ **extra** | [**CreateUnstakeActivityExtra**](CreateUnstakeActivityExtra.md) | | [optional]
11
12
  **app_initiator** | **String** | The initiator of the staking activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator. | [optional]
12
13
 
13
14
 
@@ -7,7 +7,6 @@ Name | Type | Description | Notes
7
7
  **request_id** | **String** | The request ID that is used to track a request. The request ID is provided by you and must be unique within your organization. | [optional]
8
8
  **staking_id** | **String** | The ID of the corresponding staking position. |
9
9
  **amount** | **String** | The amount to withdraw. | [optional]
10
- **address** | **String** | The withdrawal address. | [optional]
11
10
  **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
12
11
 
13
12
 
@@ -7,7 +7,6 @@ Name | Type | Description | Notes
7
7
  **request_id** | **String** | The request ID that is used to track a request. The request ID is provided by you and must be unique within your organization. | [optional]
8
8
  **staking_id** | **String** | The ID of the corresponding staking position. |
9
9
  **amount** | **String** | The amount to withdraw. | [optional]
10
- **address** | **String** | The withdrawal address. | [optional]
11
10
  **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
12
11
  **app_initiator** | **String** | The initiator of the staking activity. If you do not specify this property, the WaaS service will automatically designate the API key as the initiator. | [optional]
13
12
 
@@ -0,0 +1,55 @@
1
+ # CoboWaas2.DevelopersApi
2
+
3
+ All URIs are relative to *https://api.dev.cobo.com/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**getApiKeyInfo**](DevelopersApi.md#getApiKeyInfo) | **GET** /developers/api_key_info | Get API key information
8
+
9
+
10
+
11
+ ## getApiKeyInfo
12
+
13
+ > GetApiKeyInfo200Response getApiKeyInfo()
14
+
15
+ Get API key information
16
+
17
+ This operation retrieves the details of the API key that you are using.
18
+
19
+ ### Example
20
+
21
+ ```javascript
22
+ const CoboWaas2 = require('@cobo/cobo-waas2');
23
+ // Initialize the API client
24
+ const apiClient = CoboWaas2.ApiClient.instance
25
+ // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
26
+ apiClient.setEnv(CoboWaas2.Env.DEV);
27
+ // Replace `<YOUR_PRIVATE_KEY>` with your private key
28
+ apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
29
+ // Call the API
30
+ const apiInstance = new CoboWaas2.DevelopersApi();
31
+ apiInstance.getApiKeyInfo().then((data) => {
32
+ console.log('API called successfully. Returned data: ' + data);
33
+ }, (error) => {
34
+ console.error(error);
35
+ });
36
+
37
+ ```
38
+
39
+ ### Parameters
40
+
41
+ This endpoint does not need any parameter.
42
+
43
+ ### Return type
44
+
45
+ [**GetApiKeyInfo200Response**](GetApiKeyInfo200Response.md)
46
+
47
+ ### Authorization
48
+
49
+ [CoboAuth](../README.md#CoboAuth)
50
+
51
+ ### HTTP request headers
52
+
53
+ - **Content-Type**: Not defined
54
+ - **Accept**: application/json
55
+
@@ -457,7 +457,7 @@ Name | Type | Description | Notes
457
457
 
458
458
  Trigger test event
459
459
 
460
- This operation tests the functionality of your webhook endpoint by triggering a test webhook event. You only need to provide the event type. By default, the payload contains dummy data with no impact on your real business transactions or activities. You can optionally provide the &#x60;override_data&#x60; property to customize the payload.
460
+ This operation tests the functionality of your webhook endpoint by triggering a test webhook event. The test event will be sent to all the endpoints you have registered on Cobo Portal. You only need to provide the event type. By default, the payload contains dummy data with no impact on your real business transactions or activities. You can optionally provide the &#x60;override_data&#x60; property to customize the payload.
461
461
 
462
462
  ### Example
463
463
 
@@ -0,0 +1,11 @@
1
+ # CoboWaas2.EstimateClaimFee
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **activity_type** | [**ActivityType**](ActivityType.md) | |
8
+ **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-staking-positions). | [optional]
9
+ **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
10
+
11
+
@@ -4,9 +4,9 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. |
7
+ **request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. | [optional]
8
8
  **request_type** | [**EstimateFeeRequestType**](EstimateFeeRequestType.md) | |
9
- **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). |
9
+ **chain_id** | **String** | The chain ID of the chain on which the smart contract is deployed. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). |
10
10
  **source** | [**ContractCallSource**](ContractCallSource.md) | |
11
11
  **destination** | [**ContractCallDestination**](ContractCallDestination.md) | |
12
12
  **fee_type** | [**FeeType**](FeeType.md) | | [optional]
@@ -4,12 +4,12 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. |
7
+ **request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. | [optional]
8
8
  **request_type** | [**EstimateFeeRequestType**](EstimateFeeRequestType.md) | |
9
9
  **source** | [**ContractCallSource**](ContractCallSource.md) | |
10
10
  **token_id** | **String** | The token ID of the transferred token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). |
11
11
  **destination** | [**ContractCallDestination**](ContractCallDestination.md) | |
12
12
  **fee_type** | [**FeeType**](FeeType.md) | | [optional]
13
- **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). |
13
+ **chain_id** | **String** | The chain ID of the chain on which the smart contract is deployed. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). |
14
14
 
15
15
 
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  **activity_type** | [**ActivityType**](ActivityType.md) | |
8
8
  **request_id** | **String** | The request ID that is used to track a request. The request ID is provided by you and must be unique within your organization. | [optional]
9
9
  **source** | [**StakingSource**](StakingSource.md) | | [optional]
10
- **pool_id** | **String** | The ID of the staking pool. |
10
+ **pool_id** | [**StakingPoolId**](StakingPoolId.md) | |
11
11
  **amount** | **String** | The amount to stake. |
12
12
  **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
13
13
  **extra** | [**CreateStakeActivityExtra**](CreateStakeActivityExtra.md) | |
@@ -4,11 +4,11 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. |
7
+ **request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. It is recommended to use the same request ID as the transaction for which you want to estimate the transaction fee. | [optional]
8
8
  **request_type** | [**EstimateFeeRequestType**](EstimateFeeRequestType.md) | |
9
9
  **source** | [**TransferSource**](TransferSource.md) | |
10
10
  **token_id** | **String** | The token ID of the transferred token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](/v2/api-references/wallets/list-enabled-tokens). |
11
- **destination** | [**TransferDestination**](TransferDestination.md) | |
11
+ **destination** | [**TransferDestination**](TransferDestination.md) | | [optional]
12
12
  **fee_type** | [**FeeType**](FeeType.md) | | [optional]
13
13
 
14
14
 
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
9
9
  **staking_id** | **String** | The ID of the corresponding staking position. |
10
10
  **amount** | **String** | The amount to unstake. For the Babylon protocol, this property is ignored. | [optional]
11
11
  **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
12
+ **extra** | [**CreateUnstakeActivityExtra**](CreateUnstakeActivityExtra.md) | | [optional]
12
13
 
13
14
 
@@ -8,7 +8,6 @@ Name | Type | Description | Notes
8
8
  **request_id** | **String** | The request ID that is used to track a request. The request ID is provided by you and must be unique within your organization. | [optional]
9
9
  **staking_id** | **String** | The ID of the corresponding staking position. |
10
10
  **amount** | **String** | The amount to withdraw. | [optional]
11
- **address** | **String** | The withdrawal address. | [optional]
12
11
  **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
13
12
 
14
13
 
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **max_fee_per_gas** | **String** | The maximum gas fee per gas unit used on the chain, in wei. |
8
8
  **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. |
9
- **gas_limit** | **String** | The gas limit. It represents the maximum number of gas units that you are willing to pay for the execution of a transaction or Ethereum Virtual Machine (EVM) operation. The gas unit cost of each operation varies. | [default to &#39;21000&#39;]
9
+ **gas_limit** | **String** | The gas limit. It represents the maximum number of gas units that you are willing to pay for the execution of a transaction or Ethereum Virtual Machine (EVM) operation. The gas unit cost of each operation varies. |
10
10
 
11
11
 
@@ -5,6 +5,6 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **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. |
8
- **gas_limit** | **String** | The gas limit. It represents the maximum number of gas units that you are willing to pay for the execution of a transaction or Ethereum Virtual Machine (EVM) operation. The gas unit cost of each operation varies. | [default to &#39;21000&#39;]
8
+ **gas_limit** | **String** | The gas limit. It represents the maximum number of gas units that you are willing to pay for the execution of a transaction or Ethereum Virtual Machine (EVM) operation. The gas unit cost of each operation varies. |
9
9
 
10
10
 
@@ -7,7 +7,7 @@ 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
  **is_loop** | **Boolean** | Whether the transaction was executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - &#x60;true&#x60;: The transaction was executed as a Cobo Loop transfer. - &#x60;false&#x60;: The transaction was not executed as a Cobo Loop transfer. | [optional]
10
- **fee_amount** | **String** | The fee that you need to pay for the transaction. |
10
+ **fee_amount** | **String** | The transaction fee that you need to pay for the transaction. |
11
11
  **slow** | [**EstimatedUtxoFeeSlow**](EstimatedUtxoFeeSlow.md) | | [optional]
12
12
  **recommended** | [**EstimatedUtxoFeeSlow**](EstimatedUtxoFeeSlow.md) | |
13
13
  **fast** | [**EstimatedUtxoFeeSlow**](EstimatedUtxoFeeSlow.md) | | [optional]
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **fee_amount** | **String** | The fee that you need to pay for the transaction. |
7
+ **fee_amount** | **String** | The transaction fee that you need to pay for the transaction. |
8
8
  **fee_type** | [**FeeType**](FeeType.md) | |
9
9
  **token_id** | **String** | The token ID of the transaction fee. |
10
10
  **is_loop** | **Boolean** | Whether the transaction was executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - &#x60;true&#x60;: The transaction was executed as a Cobo Loop transfer. - &#x60;false&#x60;: The transaction was not executed as a Cobo Loop transfer. | [optional]
@@ -5,6 +5,6 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **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. |
8
- **fee_amount** | **String** | The fee that you need to pay for the transaction. |
8
+ **fee_amount** | **String** | The transaction fee that you need to pay for the transaction. |
9
9
 
10
10
 
@@ -0,0 +1,11 @@
1
+ # CoboWaas2.EthStakeEstimatedFee
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **pool_type** | [**StakingPoolType**](StakingPoolType.md) | | [optional]
8
+ **fee** | [**EstimatedFee**](EstimatedFee.md) | | [optional]
9
+ **validator_pubkeys** | **[String]** | A list of public keys associated with the Ethereum validators for this staking operation. | [optional]
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.EthStakeExtra
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **pool_type** | [**StakingPoolType**](StakingPoolType.md) | |
8
+ **provider_name** | **String** | The name of the provider. |
9
+
10
+
@@ -0,0 +1,11 @@
1
+ # CoboWaas2.EthStakingExtra
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **pool_type** | [**StakingPoolType**](StakingPoolType.md) | |
8
+ **pos_chain** | **String** | The Proof-of-Stake (PoS) chain. |
9
+ **beacon_validators** | [**[EthStakingExtraAllOfBeaconValidators]**](EthStakingExtraAllOfBeaconValidators.md) | The list of validator information. | [optional]
10
+
11
+
@@ -0,0 +1,14 @@
1
+ # CoboWaas2.EthStakingExtraAllOfBeaconValidators
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **pubkey** | **String** | The public key of the validator. | [optional]
8
+ **status** | [**AmountStatus**](AmountStatus.md) | | [optional]
9
+ **apy** | **Number** | The annual percentage yield (APY) of the validator. | [optional]
10
+ **staked_amount** | **String** | The staked amount. | [optional]
11
+ **rewards_received** | **String** | The rewards received. | [optional]
12
+ **updated_timestamp** | **Number** | The time when the validator&#39;s status was last updated, in Unix timestamp format and measured in milliseconds. | [optional]
13
+
14
+
@@ -0,0 +1,10 @@
1
+ # CoboWaas2.EthUnstakeExtra
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **pool_type** | [**StakingPoolType**](StakingPoolType.md) | |
8
+ **validator_pubkeys** | **[String]** | A list of public keys identifying the validators to unstake from the Ethereum Beacon Chain. |
9
+
10
+
package/docs/FeeAmount.md CHANGED
@@ -4,6 +4,6 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **fee_amount** | **String** | The fee that you need to pay for the transaction. | [optional]
7
+ **fee_amount** | **String** | The transaction fee that you need to pay for the transaction. | [optional]
8
8
 
9
9
 
@@ -4,6 +4,6 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **gas_limit** | **String** | The gas limit. It represents the maximum number of gas units that you are willing to pay for the execution of a transaction or Ethereum Virtual Machine (EVM) operation. The gas unit cost of each operation varies. | [optional] [default to &#39;21000&#39;]
7
+ **gas_limit** | **String** | The gas limit. It represents the maximum number of gas units that you are willing to pay for the execution of a transaction or Ethereum Virtual Machine (EVM) operation. The gas unit cost of each operation varies. | [optional]
8
8
 
9
9
 
package/docs/FeeRate.md CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **fee_type** | [**FeeType**](FeeType.md) | |
8
8
  **token_id** | **String** | The token ID of the transaction fee. |
9
- **fee_amount** | **String** | The fee that you need to pay for the transaction. | [optional]
9
+ **fee_amount** | **String** | The transaction fee that you need to pay for the transaction. | [optional]
10
10
  **slow** | [**UtxoFeeBasePrice**](UtxoFeeBasePrice.md) | | [optional]
11
11
  **recommended** | [**UtxoFeeBasePrice**](UtxoFeeBasePrice.md) | |
12
12
  **fast** | [**UtxoFeeBasePrice**](UtxoFeeBasePrice.md) | | [optional]
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **fee_amount** | **String** | The fee that you need to pay for the transaction. | [optional]
7
+ **fee_amount** | **String** | The transaction fee that you need to pay for the transaction. | [optional]
8
8
  **fee_type** | [**FeeType**](FeeType.md) | |
9
9
  **token_id** | **String** | The token ID of the transaction fee. |
10
10
 
@@ -0,0 +1,30 @@
1
+ # CoboWaas2.GetApiKeyInfo200Response
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | The API key name. |
8
+ **curve_type** | **String** | The curve type used for the API key, which determines the cryptographic algorithm for key generation and signing. Possible values include: - &#x60;ED25519&#x60;: Ed25519 - &#x60;SECP256K1&#x60;: Secp256k1 |
9
+ **key** | **String** | The API key value. |
10
+ **callback_url** | **String** | The URL of the callback endpoint that receives callback messages triggered by this API key. | [optional]
11
+ **valid_ips** | **[String]** | (Applicable to permanent API keys only) The list of IP addresses that are allowed to use this API key. | [optional]
12
+ **created_timestamp** | **Number** | The time when the API key was registered, in Unix timestamp format, measured in milliseconds. |
13
+ **updated_timestamp** | **Number** | The time when the API key information was last updated, in Unix timestamp format, measured in milliseconds. |
14
+ **expired_timestamp** | **Number** | The time when the API key expires, in Unix timestamp format, measured in milliseconds. For permanent API keys, this property value is &#x60;null&#x60;. | [optional]
15
+ **role_scopes** | [**[RoleScopes]**](RoleScopes.md) | The list of user roles and wallet scopes associated with the API key. | [optional]
16
+
17
+
18
+
19
+ ## Enum: CurveTypeEnum
20
+
21
+
22
+ * `ED25519` (value: `"ED25519"`)
23
+
24
+ * `SECP256K1` (value: `"SECP256K1"`)
25
+
26
+ * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
27
+
28
+
29
+
30
+
@@ -4,6 +4,9 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
+ **pool_type** | [**StakingPoolType**](StakingPoolType.md) | | [optional]
8
+ **fee** | [**EstimatedFee**](EstimatedFee.md) | | [optional]
9
+ **validator_pubkeys** | **[String]** | A list of public keys associated with the Ethereum validators for this staking operation. | [optional]
7
10
  **fee_type** | [**FeeType**](FeeType.md) | | [optional]
8
11
  **fee_amount** | **String** | The amount of the estimated fee. | [optional]
9
12
  **token_id** | **String** | The token ID of the staking fee. | [optional]
@@ -7,11 +7,10 @@ Name | Type | Description | Notes
7
7
  **activity_type** | [**ActivityType**](ActivityType.md) | |
8
8
  **request_id** | **String** | The request ID that is used to track a request. The request ID is provided by you and must be unique within your organization. | [optional]
9
9
  **source** | [**StakingSource**](StakingSource.md) | | [optional]
10
- **pool_id** | **String** | The ID of the staking pool. |
10
+ **pool_id** | [**StakingPoolId**](StakingPoolId.md) | |
11
11
  **amount** | **String** | The amount to withdraw. |
12
12
  **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | |
13
- **extra** | [**CreateStakeActivityExtra**](CreateStakeActivityExtra.md) | |
14
- **staking_id** | **String** | The ID of the corresponding staking position. |
15
- **address** | **String** | The withdrawal address. |
13
+ **extra** | [**CreateUnstakeActivityExtra**](CreateUnstakeActivityExtra.md) | |
14
+ **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-staking-positions). |
16
15
 
17
16
 
@@ -1,4 +1,4 @@
1
- # CoboWaas2.GetToken200Response
1
+ # CoboWaas2.GetToken2XXResponse
2
2
 
3
3
  ## Properties
4
4
 
@@ -5,6 +5,6 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **error** | **String** | The error name. |
8
- **error_message** | **String** | The error description. | [optional]
8
+ **error_description** | **String** | The error description. |
9
9
 
10
10