@cobo/cobo-waas2 1.8.0 → 1.10.0

package/docs/GuardPubkeyStatus.md

@@ -0,0 +1,24 @@
+# CoboWaas2.GuardPubkeyStatus
+
+## Enum
+
+
+* `New` (value: `"New"`)
+
+* `ChangeNew` (value: `"ChangeNew"`)
+
+* `WaitSelfConfirm` (value: `"WaitSelfConfirm"`)
+
+* `WaitConfirm` (value: `"WaitConfirm"`)
+
+* `WaitActive` (value: `"WaitActive"`)
+
+* `Active` (value: `"Active"`)
+
+* `Freeze` (value: `"Freeze"`)
+
+* `Invalid` (value: `"Invalid"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/ListAddressBalancesByToken200Response.md

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

package/docs/ListBabylonAirdropRegistrations200Response.md

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

package/docs/ListBabylonEligibleAirdrops200Response.md

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

package/docs/ListBabylonEligibleStakings200Response.md

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

package/docs/ListBabylonEligibleStakings200ResponseDataInner.md

@@ -0,0 +1,13 @@
+# CoboWaas2.ListBabylonEligibleStakings200ResponseDataInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**staking_id** | **String** | The ID of the Phase-1 BTC staking position. | [optional] 
+**btc_address** | [**StakingSource**](StakingSource.md) |  | [optional] 
+**babylon_address** | [**StakingSource**](StakingSource.md) |  | [optional] 
+**staked_amount** | **String** | The current amount of BTC staked. | [optional] 
+**status** | [**BabylonRegistrationStatus**](BabylonRegistrationStatus.md) |  | [optional] 
+
+

package/docs/ListBabylonStakingRegistrations200Response.md

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

package/docs/ListEnableTokenPairs200Response.md

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

package/docs/ListKeyShareHolders200Response.md

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

package/docs/ListSwapActivities200Response.md

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

package/docs/MessageSignDestination.md

@@ -7,5 +7,6 @@ Name | Type | Description | Notes
 **destination_type** | [**MessageSignDestinationType**](MessageSignDestinationType.md) |  | 
 **message** | **String** | The raw data of the message to be signed, encoded in Base64 format. | 
 **structured_data** | **{String: Object}** | The structured data to be signed, formatted as a JSON object according to the EIP-712 standard. | 
+**msg_hash** | **String** | Message hash to be signed, in hexadecimal format. | 
 
 

package/docs/MessageSignDestinationType.md

@@ -3,9 +3,13 @@
 ## Enum
 
 
-* `191_Signature` (value: `"EVM_EIP_191_Signature"`)
+* `EVM_EIP_191_Signature` (value: `"EVM_EIP_191_Signature"`)
 
-* `712_Signature` (value: `"EVM_EIP_712_Signature"`)
+* `EVM_EIP_712_Signature` (value: `"EVM_EIP_712_Signature"`)
+
+* `BTC_EIP_191_Signature` (value: `"BTC_EIP_191_Signature"`)
+
+* `Raw_Message_Signature` (value: `"Raw_Message_Signature"`)
 
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 

package/docs/MessageSignSource.md

@@ -7,5 +7,6 @@ Name | Type | Description | Notes
 **source_type** | [**MessageSignSourceType**](MessageSignSourceType.md) |  | 
 **wallet_id** | **String** | The wallet ID. | 
 **address** | **String** | The wallet address. | 
+**mpc_used_key_share_holder_group** | [**MpcSigningGroup**](MpcSigningGroup.md) |  | [optional] 
 
 

package/docs/MpcContractCallSource.md

@@ -7,5 +7,6 @@ Name | Type | Description | Notes
 **source_type** | [**ContractCallSourceType**](ContractCallSourceType.md) |  | 
 **wallet_id** | **String** | The wallet ID. | 
 **address** | **String** | The wallet address. | 
+**mpc_used_key_share_holder_group** | [**MpcSigningGroup**](MpcSigningGroup.md) |  | [optional] 
 
 

package/docs/MpcMessageSignSource.md

@@ -7,5 +7,6 @@ Name | Type | Description | Notes
 **source_type** | [**MessageSignSourceType**](MessageSignSourceType.md) |  | 
 **wallet_id** | **String** | The wallet ID. | 
 **address** | **String** | The wallet address. | 
+**mpc_used_key_share_holder_group** | [**MpcSigningGroup**](MpcSigningGroup.md) |  | [optional] 
 
 

package/docs/MpcSigningGroup.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**used_key_share_holder_group_id** | **String** | The ID of the Signing Group. | [optional] 
+**used_key_share_holder_group_id** | **String** | The ID of the Signing Group. | 
 **used_tss_node_ids** | **[String]** | The ID of the TSS Nodes that are required to participate in the signature. | [optional] 
 
 

package/docs/MpcTransferSource.md

@@ -9,5 +9,6 @@ Name | Type | Description | Notes
 **address** | **String** | The wallet address. If you want to specify the UTXOs to be used, please provide the `included_utxos` property. If you specify both the `address` and `included_utxos` properties, the specified included UTXOs must belong to the address. It is recommended to specify no more than 100 included UTXOs to ensure optimal transaction processing.  You need to provide either the `address` or `included_utxos` property. If neither property is provided, the transfer will fail.  | [optional] 
 **included_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) |  | [optional] 
 **excluded_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) |  | [optional] 
+**mpc_used_key_share_holder_group** | [**MpcSigningGroup**](MpcSigningGroup.md) |  | [optional] 
 
 

package/docs/OrgInfo.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**org_id** | **String** | The ID of the owning organization. | 
+**org_id** | **String** | The organization ID. | 
 **name** | **String** | The organization name. | [optional] 
 **created_timestamp** | **Number** | The organization's creation time in Unix timestamp format, measured in milliseconds. | [optional] 
 

package/docs/PrimeBrokerApi.md

@@ -0,0 +1,318 @@
+# CoboWaas2.PrimeBrokerApi
+
+All URIs are relative to *https://api.dev.cobo.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**changeGuardPubkey**](PrimeBrokerApi.md#changeGuardPubkey) | **PUT** /prime_broker/user/{user_id}/guard_pubkey | Change Guard pubkey binding
+[**createGuardPubkey**](PrimeBrokerApi.md#createGuardPubkey) | **POST** /prime_broker/user/{user_id}/guard_pubkey | Create Guard pubkey binding
+[**createPrimeBrokerAddress**](PrimeBrokerApi.md#createPrimeBrokerAddress) | **POST** /prime_broker/user/{user_id}/addresses | Bind addresses to a broker user
+[**deleteGuardPubkey**](PrimeBrokerApi.md#deleteGuardPubkey) | **POST** /prime_broker/user/{user_id}/guard_pubkey/delete | Delete Guard pubkey binding
+[**queryApprovalStatement**](PrimeBrokerApi.md#queryApprovalStatement) | **GET** /prime_broker/approval_statement/{statement_id} | Query approval statement
+[**queryGuardPubkey**](PrimeBrokerApi.md#queryGuardPubkey) | **GET** /prime_broker/user/{user_id}/guard_pubkey | Query a Guard pubkey
+
+
+
+## changeGuardPubkey
+
+> ChangeGuardPubkey200Response changeGuardPubkey(user_id)
+
+Change Guard pubkey binding
+
+This operation updates an existing binding to associate a broker user ID with a new Cobo Guard public key. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PrimeBrokerApi();
+const user_id = "168108513539918";
+apiInstance.changeGuardPubkey(user_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| The user ID. | 
+
+### Return type
+
+[**ChangeGuardPubkey200Response**](ChangeGuardPubkey200Response.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## createGuardPubkey
+
+> ChangeGuardPubkey200Response createGuardPubkey(user_id)
+
+Create Guard pubkey binding
+
+This operation creates a binding between a broker user ID and a Cobo Guard public key.  
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PrimeBrokerApi();
+const user_id = "168108513539918";
+apiInstance.createGuardPubkey(user_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| The user ID. | 
+
+### Return type
+
+[**ChangeGuardPubkey200Response**](ChangeGuardPubkey200Response.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## createPrimeBrokerAddress
+
+> CreatePrimeBrokerAddress201Response createPrimeBrokerAddress(user_id, opts)
+
+Bind addresses to a broker user
+
+This operation binds addresses to a broker user. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PrimeBrokerApi();
+const user_id = "168108513539918";
+const opts = {
+  'CreatePrimeBrokerAddressRequest': new CoboWaas2.CreatePrimeBrokerAddressRequest()
+};
+apiInstance.createPrimeBrokerAddress(user_id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| The user ID. | 
+ **CreatePrimeBrokerAddressRequest** | [**CreatePrimeBrokerAddressRequest**](CreatePrimeBrokerAddressRequest.md)| The request body to bind addresses to a broker user. | [optional] 
+
+### Return type
+
+[**CreatePrimeBrokerAddress201Response**](CreatePrimeBrokerAddress201Response.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## deleteGuardPubkey
+
+> DeleteGuardPubkey201Response deleteGuardPubkey(user_id)
+
+Delete Guard pubkey binding
+
+This operation deletes a binding between a broker user ID and a Cobo Guard public key. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PrimeBrokerApi();
+const user_id = "168108513539918";
+apiInstance.deleteGuardPubkey(user_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| The user ID. | 
+
+### Return type
+
+[**DeleteGuardPubkey201Response**](DeleteGuardPubkey201Response.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## queryApprovalStatement
+
+> QueryApprovalStatement200Response queryApprovalStatement(statement_id)
+
+Query approval statement
+
+This operation queries an approval statement. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PrimeBrokerApi();
+const statement_id = "168108513539918";
+apiInstance.queryApprovalStatement(statement_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **statement_id** | **String**| The approval statement ID. | 
+
+### Return type
+
+[**QueryApprovalStatement200Response**](QueryApprovalStatement200Response.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## queryGuardPubkey
+
+> QueryGuardPubkey200Response queryGuardPubkey(user_id)
+
+Query a Guard pubkey
+
+This operation retrieves the current Cobo Guard public key binding details for a broker user. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PrimeBrokerApi();
+const user_id = "168108513539918";
+apiInstance.queryGuardPubkey(user_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| The user ID. | 
+
+### Return type
+
+[**QueryGuardPubkey200Response**](QueryGuardPubkey200Response.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

package/docs/QueryApprovalStatement200Response.md

@@ -0,0 +1,12 @@
+# CoboWaas2.QueryApprovalStatement200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The approval statement ID. | [optional] 
+**user_id** | **String** | The user ID of the approver. | [optional] 
+**pubkey** | **String** | The Cobo Guard public key of the approver. | [optional] 
+**status** | [**ApprovalStatementStatus**](ApprovalStatementStatus.md) |  | [optional] 
+
+

package/docs/QueryGuardPubkey200Response.md

@@ -0,0 +1,11 @@
+# CoboWaas2.QueryGuardPubkey200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pubkey** | **String** | The Cobo Guard's public key. | [optional] 
+**status** | [**GuardPubkeyStatus**](GuardPubkeyStatus.md) |  | [optional] 
+**addresses** | [**[QueryGuardPubkey200ResponseAddressesInner]**](QueryGuardPubkey200ResponseAddressesInner.md) |  | [optional] 
+
+

package/docs/QueryGuardPubkey200ResponseAddressesInner.md

@@ -0,0 +1,10 @@
+# CoboWaas2.QueryGuardPubkey200ResponseAddressesInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | **String** | The wallet address. | 
+**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). | 
+
+

package/docs/RootPubkey.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**root_pubkey** | **String** | The vault's [root extended public key](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/tss-node-deployment#tss-node-on-cobo-portal-and-mpc-root-extended-public-key). | [optional] 
+**root_pubkey** | **String** | The vault's [root extended public key](https://www.cobo.com/developers/v2/guides/mpc-wallets/get-started-ocw#root-extended-public-keys). | [optional] 
 **curve** | [**CurveType**](CurveType.md) |  | [optional] 
 
 

package/docs/SelfCustodyWallet.md

@@ -5,8 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) |  | 
-**self_custody_wallet_challenge** | **String** | The challenge obtained from a previous operation. | 
-**self_custody_wallet_address** | **String** | The address of the self-custodial wallet. | 
-**self_custody_wallet_sign** | **String** | The signed message from the self-custodial wallet. | 
+**self_custody_wallet_challenge** | **String** | The message obtained from the `Retrieve transaction limitations` operation. This message is used to verify wallet ownership through signing. | 
+**self_custody_wallet_address** | **String** | The address of the self-custody wallet. | 
+**self_custody_wallet_sign** | **String** | The signature created by signing the challenge message with the wallet's private key. | 
 
 

package/docs/StakingPoolId.md

@@ -17,6 +17,18 @@
 
 * `sky_farm_eth_usdc` (value: `"sky_farm_eth_usdc"`)
 
+* `bithive_signet` (value: `"bithive_signet"`)
+
+* `bithive` (value: `"bithive"`)
+
+* `beacon_bera` (value: `"beacon_bera"`)
+
+* `beacon_bera_testnet` (value: `"beacon_bera_testnet"`)
+
+* `berachain_bgt` (value: `"berachain_bgt"`)
+
+* `berachain_bgt_testnet` (value: `"berachain_bgt_testnet"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/StakingPoolType.md

@@ -11,6 +11,12 @@
 
 * `SkyFarm` (value: `"SkyFarm"`)
 
+* `BitHive` (value: `"BitHive"`)
+
+* `BERABeacon` (value: `"BERABeacon"`)
+
+* `BeraChainBGT` (value: `"BeraChainBGT"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)