@cobo/cobo-waas2 1.2.1 → 1.3.0

package/docs/CreateWithdrawActivity.md

@@ -5,9 +5,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **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] 
-**staking_id** | **String** | The id of the related staking. | 
-**amount** | **String** | The amount to stake | [optional] 
-**address** | **String** | The withdraw to address. | [optional] 
+**staking_id** | **String** | The ID of the corresponding staking position. | 
+**amount** | **String** | The amount to withdraw. | [optional] 
+**address** | **String** | The withdrawal address. | [optional] 
 **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) |  | 
 
 

package/docs/CreateWithdrawActivityRequest.md

@@ -0,0 +1,14 @@
+# CoboWaas2.CreateWithdrawActivityRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**staking_id** | **String** | The ID of the corresponding staking position. | 
+**amount** | **String** | The amount to withdraw. | [optional] 
+**address** | **String** | The withdrawal address. | [optional] 
+**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) |  | 
+**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] 
+
+

package/docs/EigenLayerLstStakeExtra.md

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **pool_type** | [**StakingPoolType**](StakingPoolType.md) |  | 
-**operator** | **String** | The operator address. | [optional] 
+**operator** | **String** | The operator's address. | [optional] 
 
 

package/docs/EstimateStakeFee.md

@@ -7,8 +7,8 @@ Name | Type | Description | Notes
 **activity_type** | [**ActivityType**](ActivityType.md) |  | 
 **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] 
 **source** | [**StakingSource**](StakingSource.md) |  | [optional] 
-**pool_id** | **String** | The id of the staking pool | 
-**amount** | **String** | The amount to stake | 
+**pool_id** | **String** | The ID of the staking pool. | 
+**amount** | **String** | The amount to stake. | 
 **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) |  | 
 **extra** | [**CreateStakeActivityExtra**](CreateStakeActivityExtra.md) |  | 
 

package/docs/EstimateUnstakeFee.md

@@ -6,8 +6,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **activity_type** | [**ActivityType**](ActivityType.md) |  | 
 **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] 
-**staking_id** | **String** | The id of the related staking. | 
-**amount** | **String** | The amount to stake | [optional] 
+**staking_id** | **String** | The ID of the corresponding staking position. | 
+**amount** | **String** | The amount to unstake. For the Babylon protocol, this property is ignored. | [optional] 
 **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) |  | [optional] 
 
 

package/docs/EstimateWithdrawFee.md

@@ -6,9 +6,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **activity_type** | [**ActivityType**](ActivityType.md) |  | 
 **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] 
-**staking_id** | **String** | The id of the related staking. | 
-**amount** | **String** | The amount to stake | [optional] 
-**address** | **String** | The withdraw to address. | [optional] 
+**staking_id** | **String** | The ID of the corresponding staking position. | 
+**amount** | **String** | The amount to withdraw. | [optional] 
+**address** | **String** | The withdrawal address. | [optional] 
 **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) |  | 
 
 

package/docs/EvmContractCallDestination.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **destination_type** | [**ContractCallDestinationType**](ContractCallDestinationType.md) |  | 
 **address** | **String** | The destination address. | 
 **value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`.  | [optional] 
-**calldata** | **Blob** | The data that is used to invoke a specific function or method within the specified contract at the destination address.  | 
+**calldata** | **String** | The data that is used to invoke a specific function or method within the specified contract at the destination address.  | 
 
 

package/docs/ExchangeTransferDestination.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **destination_type** | [**TransferDestinationType**](TransferDestinationType.md) |  | 
 **wallet_id** | **String** | The wallet ID. | 
 **trading_account_type** | **String** | The trading account type. | 
-**amount** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`.  | 
+**amount** | **String** | The transfer amount. For example, if you trade 1.5 BTC, then the value is `1.5`.  | 
 
 

package/docs/ExtendedTokenInfo.md

@@ -15,5 +15,7 @@ Name | Type | Description | Notes
 **fee_token_id** | **String** | The fee token ID. A fee token is the token with which you pay transaction fees. | [optional] 
 **can_deposit** | **Boolean** | Whether the token can be deposited.  - `true`: The token can be deposited.  - `false`: The token cannot be deposited.  | [optional] [default to false]
 **can_withdraw** | **Boolean** | Whether the token can be withdrawn.  - `true`: The token can be withdrawn.  - `false`: The token cannot be withdrawn.  | [optional] [default to false]
+**dust_threshold** | **String** | The minimum withdrawal amount for Custodial Wallets. If your withdrawal amount is smaller than this threshold, the withdrawal request will receive an error.  Note: [Loop transfers](https://loop.top/) do not have this limitation.  | [optional] 
+**custodial_minimum_deposit_threshold** | **String** | The minimum deposit amount for Custodial Wallets. If the amount you deposit to a Custodial Wallet is smaller than this threshold, the deposit will not show up on Cobo Portal or trigger any webhook events.  Note: [Loop transfers](https://loop.top/) do not have this limitation.  | [optional] 
 
 

package/docs/GetStakingEstimationFee201Response.md

@@ -0,0 +1,11 @@
+# CoboWaas2.GetStakingEstimationFee201Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fee_type** | [**FeeType**](FeeType.md) |  | [optional] 
+**fee_amount** | **String** | The amount of the estimated fee. | [optional] 
+**token_id** | **String** | The token ID of the staking fee. | [optional] 
+
+

package/docs/GetStakingEstimationFeeRequest.md

@@ -0,0 +1,17 @@
+# CoboWaas2.GetStakingEstimationFeeRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**activity_type** | [**ActivityType**](ActivityType.md) |  | 
+**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] 
+**source** | [**StakingSource**](StakingSource.md) |  | [optional] 
+**pool_id** | **String** | The ID of the staking pool. | 
+**amount** | **String** | The amount to withdraw. | 
+**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) |  | 
+**extra** | [**CreateStakeActivityExtra**](CreateStakeActivityExtra.md) |  | 
+**staking_id** | **String** | The ID of the corresponding staking position. | 
+**address** | **String** | The withdrawal address. | 
+
+

package/docs/ListStakingActivities200Response.md

@@ -0,0 +1,10 @@
+# CoboWaas2.ListStakingActivities200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[Activity]**](Activity.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

package/docs/ListStakingPools200Response.md

@@ -0,0 +1,10 @@
+# CoboWaas2.ListStakingPools200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[PoolSummary]**](PoolSummary.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

package/docs/ListStakings200Response.md

@@ -0,0 +1,10 @@
+# CoboWaas2.ListStakings200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[Stakings]**](Stakings.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

package/docs/MpcStakeSource.md

@@ -0,0 +1,11 @@
+# CoboWaas2.MpcStakeSource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source_type** | [**StakeSourceType**](StakeSourceType.md) |  | 
+**wallet_id** | **String** | The wallet ID. | 
+**address** | **String** | The wallet address. | 
+
+

package/docs/OAuthApi.md

@@ -15,7 +15,7 @@ Method | HTTP request | Description
 
 Get access token
 
-<Note>This operation is only applicable to Cobo Portal App developers. To call this operation, you need to use the OAuth authentication method that requires an app key.</Note> This operation allows Cobo Portal Apps to get an access token and a refresh token with a specified App ID, Organization ID, and grant type.   Access tokens allow the app to signal to the WaaS service that it has received permission to access specific resources of the app user's [organization](https://manuals.cobo.com/en/portal/organization/introduction). Once the app has been granted permission by the organization's admin, it can use this operation to obtain both an access token and a refresh token.  For security purposes, access tokens expire after a certain period. Once they expire, the app needs to call [Refresh token](/v2/api-references/oauth/refresh-access-token) to get a new access token and a new refresh token. 
+<Note>This operation is only applicable to Cobo Portal App developers. To call this operation, you need to use the OAuth authentication method that requires an app key.</Note> This operation allows Cobo Portal Apps to get an access token and a refresh token with a specified App ID, Organization ID, and grant type.   Access tokens allow the app to signal to the WaaS service that it has received permission to access specific resources of the app user's [organization](https://manuals.cobo.com/en/portal/organization/introduction). Once the app has been granted permission by the organization's admin, it can use this operation to obtain both an access token and a refresh token.  For security purposes, access tokens expire after a certain period. Once they expire, the app needs to call [Refresh token](/v2/api-references/oauth/refresh-access-token) to get a new access token and a new refresh token.  
 
 ### Example
 
@@ -69,7 +69,7 @@ Name | Type | Description  | Notes
 
 Refresh access token
 
-<Note>This operation is only applicable to Cobo Portal Apps developers. To call this operation, you need to use the OAuth authentication method that requires an app key.</Note> This operation allows Cobo Portal Apps to obtain a new access token with a specified App ID, grant type and a refresh token.   For security purposes, access tokens expire after a certain period. Once they expire, the app needs to call this operation to get a new access token and a new refresh token. 
+<Note>This operation is only applicable to Cobo Portal Apps developers. To call this operation, you need to use the OAuth authentication method that requires an app key.</Note> This operation allows Cobo Portal Apps to obtain a new access token with a specified App ID, grant type and a refresh token.   For security purposes, access tokens expire after a certain period. Once they expire, the app needs to call this operation to get a new access token and a new refresh token.  
 
 ### Example
 

package/docs/PoolDetails.md

@@ -4,21 +4,21 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | The unique protocol id. | 
-**chain_id** | **String** | The unique chain id. | 
+**id** | **String** | The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. | 
+**chain_id** | **String** | The chain ID. | 
 **protocol** | **String** | The name of the protocol. | 
 **protocol_icon_url** | **String** | The URL of the protocol's icon. | 
-**supported_wallet_types** | [**[WalletType]**](WalletType.md) | The list of available wallet types. | 
-**supported_wallet_subtypes** | [**[WalletSubtype]**](WalletSubtype.md) | The list of available wallet types. | 
-**token_id** | **String** | The unique token id. | 
-**est_apr** | **Number** | The estimated APR. | 
+**supported_wallet_types** | [**[WalletType]**](WalletType.md) | The wallet type. Possible values include:  - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction)  - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction)  - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction)  - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction)  | 
+**supported_wallet_subtypes** | [**[WalletSubtype]**](WalletSubtype.md) | The wallet subtype. Possible values include: - `Asset`: Custodial Wallets (Asset Wallets). - `Web3`: Custodial Wallets (Web3  Wallets). - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets). - `User-Controlled`: MPC Wallets (User-Controlled Wallets). - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}). - `Main`: Exchange Wallets (Main Account). - `Sub`: Exchange Wallets (Sub Account).  | 
+**token_id** | **String** | The token ID. | 
+**est_apr** | **Number** | The estimated annual percentage rate (APR). | 
 **pool_type** | [**StakingPoolType**](StakingPoolType.md) |  | [optional] 
-**min_amount** | **String** | The minimum amount to stake. | [optional] 
-**max_amount** | **String** | The maximum amount to stake. | [optional] 
-**min_stake_period** | **Number** | The minimum staking period in days. | [optional] 
-**max_stake_period** | **Number** | The maximum staking period in days. | [optional] 
-**min_stake_blocks** | **Number** | The minimum staking blocks. | [optional] 
-**max_stake_blocks** | **Number** | The maximum staking blocks. | [optional] 
-**validators_info** | [**[PoolDetailsAllOfValidatorsInfo]**](PoolDetailsAllOfValidatorsInfo.md) | The list of validators. | 
+**min_amount** | **String** | The minimum amount that can be staked in one staking request. | [optional] 
+**max_amount** | **String** | The maximum amount that can be staked in one staking request. | [optional] 
+**min_stake_period** | **Number** | The minimum staking period, in days. | [optional] 
+**max_stake_period** | **Number** | The maximum staking period, in days. | [optional] 
+**min_stake_blocks** | **Number** | The minimum block number. A block number indicates the number of blocks that need to be processed before the locked tokens are unlocked and become accessible. | [optional] 
+**max_stake_blocks** | **Number** | The maximum block number. A block number indicates the number of blocks that need to be processed before the locked tokens are unlocked and become accessible. | [optional] 
+**validators_info** | [**[PoolDetailsAllOfValidatorsInfo]**](PoolDetailsAllOfValidatorsInfo.md) | A list of available validators. | 
 
 

package/docs/PoolDetailsAllOfValidatorsInfo.md

@@ -4,13 +4,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**pool_type** | [**StakingPoolType**](StakingPoolType.md) |  | 
 **icon_url** | **String** | The URL of the validator's icon. | 
-**name** | **String** | The name of validator. | 
-**priority** | **Number** | The priority of validator. | [optional] 
-**public_key** | **String** | The public key of validator. | 
-**commission_rate** | **Number** | The commission of validator. | 
-**supported_pos_chains** | **[String]** | The list of supported pos chains. | 
-**address** | **String** | The address of validator. | 
+**name** | **String** | The validator's name. | 
+**priority** | **Number** | This property can be ignored. | [optional] 
+**public_key** | **String** | The public key of the validator. | 
+**commission_rate** | **Number** | The commission rate of the validator. | 
+**supported_pos_chains** | **[String]** | A list of supported Proof-of-Stake (PoS) chains. | 
 
 
 

package/docs/PoolSummary.md

@@ -4,13 +4,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | The unique protocol id. | 
-**chain_id** | **String** | The unique chain id. | 
+**id** | **String** | The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. | 
+**chain_id** | **String** | The chain ID. | 
 **protocol** | **String** | The name of the protocol. | 
 **protocol_icon_url** | **String** | The URL of the protocol's icon. | 
-**supported_wallet_types** | [**[WalletType]**](WalletType.md) | The list of available wallet types. | 
-**supported_wallet_subtypes** | [**[WalletSubtype]**](WalletSubtype.md) | The list of available wallet types. | 
-**token_id** | **String** | The unique token id. | 
-**est_apr** | **Number** | The estimated APR. | 
+**supported_wallet_types** | [**[WalletType]**](WalletType.md) | The wallet type. Possible values include:  - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction)  - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction)  - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction)  - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction)  | 
+**supported_wallet_subtypes** | [**[WalletSubtype]**](WalletSubtype.md) | The wallet subtype. Possible values include: - `Asset`: Custodial Wallets (Asset Wallets). - `Web3`: Custodial Wallets (Web3  Wallets). - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets). - `User-Controlled`: MPC Wallets (User-Controlled Wallets). - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}). - `Main`: Exchange Wallets (Main Account). - `Sub`: Exchange Wallets (Sub Account).  | 
+**token_id** | **String** | The token ID. | 
+**est_apr** | **Number** | The estimated annual percentage rate (APR). | 
 
 

package/docs/RawMessageSignDestination.md

@@ -0,0 +1,10 @@
+# CoboWaas2.RawMessageSignDestination
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**destination_type** | [**MessageSignDestinationType**](MessageSignDestinationType.md) |  | 
+**msg_hash** | **String** | Message hash to be signed, in hexadecimal format. | 
+
+

package/docs/StakeSourceType.md

@@ -0,0 +1,10 @@
+# CoboWaas2.StakeSourceType
+
+## Enum
+
+
+* `Org-Controlled` (value: `"Org-Controlled"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/StakingPoolType.md

@@ -5,10 +5,6 @@
 
 * `Babylon` (value: `"Babylon"`)
 
-* `EigenLayerNativeETH` (value: `"EigenLayerNativeETH"`)
-
-* `EigenLayerLst` (value: `"EigenLayerLst"`)
-
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/StakingSource.md

@@ -4,10 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**source_type** | [**ContractCallSourceType**](ContractCallSourceType.md) |  | 
+**source_type** | [**StakeSourceType**](StakeSourceType.md) |  | 
 **wallet_id** | **String** | The wallet ID. | 
 **address** | **String** | The wallet address. | 
-**nonce** | **Number** | The transaction nonce. | [optional] 
-**delegate** | [**CoboSafeDelegate**](CoboSafeDelegate.md) |  | 
 
 

package/docs/Stakings.md

@@ -4,19 +4,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | The unique id of the stake. | 
-**wallet_id** | **String** | The unique wallet id. | 
-**address** | **String** | The staker wallet address. | 
-**amounts** | [**[AmountDetailsInner]**](AmountDetailsInner.md) | The staking amount details. | 
-**initiator** | **String** | The initiator of the stake. | [optional] 
-**unlock_timestamp** | **Number** | The unlock time. | [optional] 
-**unlock_block_height** | **Number** | The unlock block height. | [optional] 
-**pool_id** | **String** | The unique pool id. | 
-**token_id** | **String** | The token id. | 
-**pos_chain** | **String** | The pos chain of the stake. | [optional] 
-**rewards_info** | **Object** | The rewards info of the stake. | [optional] 
-**created_timestamp** | **Number** | The time when the stake was created. | 
-**updated_timestamp** | **Number** | The time when the stake was last updated. | 
+**id** | **String** | The ID of the staking position. | 
+**wallet_id** | **String** | The staker's wallet ID. | 
+**address** | **String** | The staker's wallet address. | 
+**amounts** | [**[AmountDetailsInner]**](AmountDetailsInner.md) | The details about the staking amount. | 
+**pool_id** | **String** | The ID of the staking pool. | 
+**token_id** | **String** | The token ID. | 
+**rewards_info** | **Object** | The information about the staking rewards. | [optional] 
+**created_timestamp** | **Number** | The time when the staking position was created. | 
+**updated_timestamp** | **Number** | The time when the staking position was last updated. | 
 **validator_info** | [**StakingsValidatorInfo**](StakingsValidatorInfo.md) |  | 
+**extra** | [**StakingsExtra**](StakingsExtra.md) |  | [optional]