@console-wallet/dapp-sdk 1.2.1 → 2.0.0

package/CHANGELOG.md

@@ -1,3 +1,38 @@
+# Changelog 2.0.0
+
+Human‑readable diff between `1.2.0` and `2.0.0`.
+
+## Update — 2026-02-09
+
+### Features
+
+- Added `submitInstructionChoice(data)` request to interact with pending Transfer Instructions.
+- Added `ledgerApi(request)` request for raw ledger API interactions.
+- Added `getWalletVersion()` request to fetch the connected wallet version.
+- **Error Capability**: `ConsoleWalletError` is now fully capable/compatible with [EIP-1474](https://eips.ethereum.org/EIPS/eip-1474#error-codes) standard.
+- **Version Checks**: `checkExtensionAvailability()` now includes version validation logic (`isExtensionCapableByVersion`) against `MINIMAL_CAPABLE_VERSION`.
+
+### Documentation
+
+- Added [CIP-0103](https://github.com/mjuchli-da/cips/blob/205eb941031b476a990a56734ff1a73fd87ef743/cip-0103/cip-0103.md) compatibility.
+- Expanded **Error Handling** section with detailed EIP-1474 error codes and `ConsoleWalletError` interface.
+- Updated **API Methods** tables in README to reflect current return types and new methods.
+
+### Breaking Changes / Type Updates
+
+- `status()` now returns `StatusEvent`.
+- `isConnected()` now returns `ConnectResponse`.
+
+# -
+
+# -
+
+# -
+
+# -
+
+# -
+
 # Changelog 1.2.0
 
 Human‑readable diff between `1.1.2` and `1.2.0` .

package/README.md

@@ -1,53 +1,12 @@
-# 🧩 Console DApp SDK
+# Console DApp SDK
 
-> A lightweight SDK for connecting your Web3 applications to the **Console Wallet Extension** — enabling account access, connection status, message signing, and sending **Canton Coin** with ease.
+Console DApp SDK allows dApps to connect to a Console Wallet account. The Console wallet is a browser extension. All interaction happens inside the dApp. For signing, users will be prompted to sign in their Console Wallet browser extension.
 
----
+This SDK is compatible with the [CIP-0103](https://github.com/mjuchli-da/cips/blob/205eb941031b476a990a56734ff1a73fd87ef743/cip-0103/cip-0103.md) protocol.
 
-## 🚀 Overview
+## Installation
 
-**Console DApp SDK** is a developer-friendly library that allows any decentralized application (DApp) to seamlessly integrate with the **Console Wallet** browser extension.
-
-It provides simple APIs to:
-
-- 🔗 **Connect** your DApp to a user’s Console Wallet
-- 👤 **Access** the active account and connection state
-- ✍️ **Request message signing** to the wallet
-- 💰 **Send Canton Coin** transactions securely and reliably
-
-With just a few lines of code, you can authenticate users, sign data, or trigger Canton blockchain transactions — all through a unified SDK built for simplicity and safety.
-
----
-
-## ⚙️ Key Features
-
-| Feature                    | Description                                                      |
-| -------------------------- |------------------------------------------------------------------|
-| 🔌 **Easy Integration**    | One SDK import connects your app to Console Wallet instantly     |
-| 👛 **Account Access**      | Retrieve connected account address and chain info                |
-| 🧾 **Message Signing**     | Sign arbitrary messages or typed data directly from the wallet   |
-| 💸 **Transaction Support** | Send Canton Coin with a simple API call                          |
-| 🔒 **Secure by Design**    | Uses wallet’s native permissions and confirmation flows          |
-| 🧠 **Framework Agnostic**  | Works with React, Vue, Angular, Svelte or vanilla JS apps        |
-| 📊 **Balance & History**   | Query balances, transfers, and transaction history               |
-| 🔄 **Real-time Updates**   | Subscribe to account, connection, and transaction status changes |
-
----
-
-## 🧠 Why Use Console DApp SDK?
-
-Instead of manually handling RPC connections or building custom wallet logic, `@console-wallet/dapp-sdk` provides a **clean, unified interface** for interacting with the Canton ecosystem.
-
-It’s ideal for:
-
-- Light start with Canton blockchain
-- Web3 DApps that need wallet connection and signing
-- Any app that interacts with Canton
-- Applications requiring transaction history and balance queries
-
----
-
-## 📦 Installation
+To use the Console DApp SDK, you first need to install it from NPM:
 
 ```bash
 npm install @console-wallet/dapp-sdk
@@ -55,7 +14,7 @@ npm install @console-wallet/dapp-sdk
 yarn add @console-wallet/dapp-sdk
 ```
 
-If you don't want to implement a build process, you can include the file directly with `unpkg`:
+Note that, if you don't want to implement a build process, you can include the file directly with `unpkg`:
 
 ```html
 <script type="module">
@@ -63,39 +22,7 @@ If you don't want to implement a build process, you can include the file directl
 </script>
 ```
 
----
-
-## 🧠 Core Functionality
-
-The **Console DApp SDK** provides a communication layer between your Web3 application and the **Console Wallet Extension** using the browser’s native `window.postMessage` API.
-
-It handles all low-level messaging logic automatically, so you can focus on building your DApp — not managing communication details.
-
-### 🔄 How It Works
-
-1. When your DApp sends a request (e.g., `connect()`, `signMessage()`, or `submitCommands()`),  
-   the SDK transmits a structured message to the **Console Wallet Extension** via `window.postMessage`.
-
-2. Each outgoing request is assigned a **unique request ID**, which is included in both the request and the extension’s response.
-
-3. The SDK listens for incoming responses from the extension, matches them to their original request using the ID,  
-   and automatically resolves the corresponding Promise in your application.
-
-This approach ensures **reliable, asynchronous communication** between the DApp and the extension — preventing race conditions, mismatched responses, or orphaned message handlers.
-
-### 🧩 Benefits
-
-- ✅ Fully **type-safe and asynchronous** API
-- 🧭 No manual message listeners required
-- 🛡️ Prevents **response mismatch errors** with per-request unique IDs
-- ⚡ Lightweight and dependency-free
-- 🧠 Extensible for future Console Wallet capabilities (multi-chain support, session management, etc.)
-
-> In short: the SDK abstracts all the complex message passing between your DApp and the wallet, providing a **stable and predictable communication layer** out of the box.
-
----
-
-## 🔌 Quick Start
+## Usage Guide
 
 ### 1. Import the SDK
 
@@ -105,18 +32,24 @@ import { consoleWalletPixelplex } from '@console-wallet/dapp-sdk';
 
 ### 2. Check Wallet Availability
 
-Before attempting to connect, check if the Console Wallet extension is installed:
+Before attempting to connect, check if the Console Wallet extension is installed and capable by version:
 
 ```typescript
 const checkWallet = async () => {
   try {
     const availability = await consoleWalletPixelplex.checkExtensionAvailability();
-    if (availability === 'installed') {
+    if (availability.status === 'installed') {
       console.log('Console Wallet is installed');
     } else {
       console.log('Console Wallet is not installed');
       // Show installation instructions to the user
     }
+
+    if (availability.isExtensionCapableByVersion) {
+      console.log('Console Wallet is capable by version');
+    } else {
+      console.log('Console Wallet is not capable by version');
+    }
   } catch (error) {
     console.error('Error checking wallet availability:', error);
   }
@@ -131,7 +64,7 @@ You can check the current connection status at any time:
 const checkStatus = async () => {
   try {
     const status = await consoleWalletPixelplex.status();
-    console.log('Connection status:', status); // 'connected' or 'disconnected'
+    console.log('Connection status:', status.isConnected); // 'connected' or 'disconnected'
   } catch (error) {
     console.error('Error checking status:', error);
   }
@@ -149,7 +82,7 @@ const handleConnect = async () => {
       name: 'My Awesome dApp',
       icon: 'https://example.com/icon.png', // Optional: absolute URL to your dApp icon
     });
-    
+
     if (status === 'connected') {
       console.log('Successfully connected to Console Wallet');
       // Proceed with your dApp logic
@@ -179,50 +112,48 @@ const getAccount = async () => {
 };
 ```
 
----
-
-## 📡 Supported Requests
+## API Methods
 
-The SDK exposes several high-level request methods that communicate with the **Console Wallet Extension** through secure message passing.  
-Each request is automatically tagged with a **unique request ID** to ensure reliable response matching.
+The SDK exposes several high-level request methods that communicate with the Console Wallet Extension through secure message passing. Each request is automatically tagged with a unique request ID to ensure reliable response matching.
 
 ### Connection & Account Management
 
-| Method                   | Description                                                                 | Request Payload                   | Response                          |
-| ------------------------ | --------------------------------------------------------------------------- | --------------------------------- | --------------------------------- |
-| `connect(data)`          | Prompts the user to connect their Console Wallet to the DApp.               | `ConnectRequest`                  | `ConnectResponse`                 |
-| `status()`               | Returns current connection status for the dApp origin.                      | —                                 | `ConnectResponse`                 |
-| `disconnect()`           | Disconnects the DApp from the wallet.                                       | —                                 | `DisconnectResponse`              |
-| `checkExtensionAvailability()`    | Checks whether the wallet browser extension is installed.                   | —                                 | `AvailabilityResponse`            |
-| `isConnected()`          | Checks if the network is available.                                         | —                                 | `NetworkStatus`                   |
-| `getAccounts()`          | Retrieves all account(s) basic data.                                        | —                                 | `GetAccountsResponse`             |
-| `getPrimaryAccount()`    | Returns the currently selected account in the Wallet.                       | —                                 | `GetAccountResponse`              |
-| `getActiveNetwork()`     | Returns the currently selected network metadata.                            | —                                 | `Network`                         |
+| Method                         | Description                                                   | Request Payload    | Response               |
+| ------------------------------ | ------------------------------------------------------------- | ------------------ | ---------------------- |
+| `connect(data)`                | Prompts the user to connect their Console Wallet to the DApp. | `ConnectRequest`   | `ConnectResponse`      |
+| `status()`                     | Returns current connection status for the dApp origin.        | —                  | `StatusEvent`          |
+| `disconnect()`                 | Disconnects the DApp from the wallet.                         | —                  | `DisconnectResponse`   |
+| `checkExtensionAvailability()` | Checks whether the wallet browser extension is installed.     | —                  | `AvailabilityResponse` |
+| `isConnected()`                | Checks if the network is available.                           | —                  | `ConnectResponse`      |
+| `getAccounts()`                | Retrieves all account(s) basic data.                          | —                  | `GetAccountsResponse`  |
+| `getPrimaryAccount()`          | Returns the currently selected account in the Wallet.         | —                  | `GetAccountResponse`   |
+| `getActiveNetwork()`           | Returns the currently selected network metadata.              | —                  | `Network`              |
+| `getWalletVersion()`           | Fetches wallet version.                                       | —                  | `WalletVersion`        |
+| `ledgerApi(request)`           | Raw data request to ledger API.                               | `LedgerApiRequest` | `LedgerApiResponse`    |
 
 ### Signing & Transactions
 
-| Method                   | Description                                                                 | Request Payload                   | Response                          |
-| ------------------------ | --------------------------------------------------------------------------- | --------------------------------- | --------------------------------- |
-| `signMessage(message)`   | Requests the user to sign a message (hex/base64).                           | `SignMessageRequest`              | `SignedMessageResponse`           |
-| `submitCommands(data)`   | Signs and broadcasts a transaction to send Canton Coin.                     | `SignSendRequest`                 | `SignSendResponse`                |
-| `signBatch(data)`        | Signs and broadcasts a batch of transactions.                               | `SignBatchRequest`                | `SignBatchResponse`               |
+| Method                          | Description                                             | Request Payload                | Response                |
+| ------------------------------- | ------------------------------------------------------- | ------------------------------ | ----------------------- |
+| `signMessage(message)`          | Requests the user to sign a message (hex/base64).       | `SignMessageRequest`           | `SignedMessageResponse` |
+| `submitCommands(data)`          | Signs and broadcasts a transaction to send Canton Coin. | `SignSendRequest`              | `SignSendResponse`      |
+| `signBatch(data)`               | Signs and broadcasts a batch of transactions.           | `SignBatchRequest`             | `SignBatchResponse`     |
+| `submitInstructionChoice(data)` | Request user to interact with pending Transfer Instruction. | `SignInstructionChoiceRequest` | `SignInstructionChoiceResponse`      |
 
 ### Balance & History Queries
 
-| Method                   | Description                                                                 | Request Payload                   | Response                          |
-| ------------------------ | --------------------------------------------------------------------------- | --------------------------------- | --------------------------------- |
-| `getBalance()`           | Check party balance; includes current Canton Coin price.                     | `GetBalanceRequest`               | `GetBalanceResponse`              |
-| `getCoinsBalance()`      | Check balances and prices for supported coins.                              | `GetBalanceRequest`               | `GetCoinsResponse`                |
-| `getTokenTransfers()`    | Check party token transfers with pagination (indexer).                       | `TokenTransfersRequest`           | `TokenTransfersResponse`          |
-| `getTransfer()`          | Check party token transfer details (indexer).                                | `TransferRequest`                 | `TransferResponse`                |
-| `getOffers()`            | Check party offers with pagination (indexer).                                | `OffersRequest`                   | `OffersResponse`                  |
-| `getNodeTransfers()`     | Check standard coin transfers with pagination (wallet node).                 | `CoinTransfersFromNodeRequest`    | `CoinTransfersFromNodeResponse`   |
-| `getNodeTransfer()`      | Check single transfer details (wallet node).                                 | `TransferFromNodeRequest`         | `TransferFromNodeResponse`        |
-| `getNodeOffers()`        | Check pending transactions/offers with pagination (wallet node).             | `OffersFromNodeRequest`           | `OffersFromNodeResponse`          |
+| Method                | Description                                                      | Request Payload                | Response                        |
+| --------------------- | ---------------------------------------------------------------- | ------------------------------ | ------------------------------- |
+| `getBalance()`        | Check party balance; includes current Canton Coin price.         | `GetBalanceRequest`            | `GetBalanceResponse`            |
+| `getCoinsBalance()`   | Check balances and prices for supported coins.                   | `GetBalanceRequest`            | `GetCoinsResponse`              |
+| `getTokenTransfers()` | Check party token transfers with pagination (indexer).           | `TokenTransfersRequest`        | `TokenTransfersResponse`        |
+| `getTransfer()`       | Check party token transfer details (indexer).                    | `TransferRequest`              | `TransferResponse`              |
+| `getOffers()`         | Check party offers with pagination (indexer).                    | `OffersRequest`                | `OffersResponse`                |
+| `getNodeTransfers()`  | Check standard coin transfers with pagination (wallet node).     | `CoinTransfersFromNodeRequest` | `CoinTransfersFromNodeResponse` |
+| `getNodeTransfer()`   | Check single transfer details (wallet node).                     | `TransferFromNodeRequest`      | `TransferFromNodeResponse`      |
+| `getNodeOffers()`     | Check pending transactions/offers with pagination (wallet node). | `OffersFromNodeRequest`        | `OffersFromNodeResponse`        |
 
----
-
-## 💻 Usage Examples
+## Usage Examples
 
 ### Sign a Message
 
@@ -267,7 +198,7 @@ const sendTransaction = async () => {
   try {
     // Get the active account first
     const activeAccount = await consoleWalletPixelplex.getPrimaryAccount();
-    
+
     if (!activeAccount) {
       throw new Error('No active account found');
     }
@@ -308,7 +239,7 @@ Sign and send multiple transactions in a batch:
 const signBatchTransactions = async () => {
   try {
     const activeAccount = await consoleWalletPixelplex.getPrimaryAccount();
-    
+
     if (!activeAccount) {
       throw new Error('No active account found');
     }
@@ -351,14 +282,14 @@ const signBatchTransactions = async () => {
 
 ### Get Balance
 
-Check the balance for a party (СС balance only):
+Check the balance for a party (CC balance only):
 
 ```typescript
 const checkBalance = async () => {
   try {
     const activeAccount = await consoleWalletPixelplex.getPrimaryAccount();
     const activeNetwork = await consoleWalletPixelplex.getActiveNetwork();
-    
+
     if (!activeAccount || !activeNetwork) {
       throw new Error('No active account or network found');
     }
@@ -368,7 +299,7 @@ const checkBalance = async () => {
       network: activeNetwork.id,
     });
 
-    console.log('СС utxos:', balance.tokens);
+    console.log('CC utxos:', balance.tokens);
     console.log('Is split balance:', balance.isSplitedBalance);
     console.log('1 CC price:', balance.price);
     // Access individual token balances
@@ -390,7 +321,7 @@ const getCoinsBalance = async () => {
   try {
     const activeAccount = await consoleWalletPixelplex.getPrimaryAccount();
     const activeNetwork = await consoleWalletPixelplex.getActiveNetwork();
-    
+
     if (!activeAccount || !activeNetwork) {
       throw new Error('No active account or network found');
     }
@@ -416,7 +347,7 @@ Query transaction history with pagination:
 const getTransactionHistory = async () => {
   try {
     const activeAccount = await consoleWalletPixelplex.getPrimaryAccount();
-    
+
     if (!activeAccount) {
       throw new Error('No active account found');
     }
@@ -432,11 +363,11 @@ const getTransactionHistory = async () => {
 
     // Get token transfers directly from node (separated by token) *Preferred
     const cip56Transfers = await consoleWalletPixelplex.getNodeTransfers({
-      query: { partyId: partyId, limit: 10, coin: "CBTC", offset: 0 },
+      query: { partyId: partyId, limit: 10, coin: 'CBTC', offset: 0 },
       network,
     });
-    
-    console.log('Transfers', cip56Transfers?.items)
+
+    console.log('Transfers', cip56Transfers?.items);
 
     // Get offers from indexer (Only CC)
     const offers = await consoleWalletPixelplex.getOffers({
@@ -452,26 +383,23 @@ const getTransactionHistory = async () => {
       query: { party_id: partyId, limit: 10, cursor: '0' },
       network,
     });
-    
-    console.log('nodeOffers', nodeOffers?.items)
 
+    console.log('nodeOffers', nodeOffers?.items);
   } catch (error) {
     console.error('Error getting transaction history:', error);
   }
 };
 ```
 
----
+## Subscriptions
 
-## 👀 Watch Requests (Subscriptions)
+The SDK provides subscription-style helpers to watch for changes from the Console Wallet. These functions register a callback and invoke it whenever the corresponding state changes.
 
-The SDK also provides subscription-style helpers to watch for changes from the Console Wallet. These functions register a callback and invoke it whenever the corresponding state changes.
-
-| Method                         | Description                                               | Callback Payload         |
-| ------------------------------ | --------------------------------------------------------- | ------------------------ |
-| `onAccountsChanged(onChange)`  | Subscribes to active account changes                      | `GetAccountResponse`     |
-| `onConnectionStatusChanged(onChange)` | Subscribes to wallet connection status changes       | `ConnectResponse`        |
-| `onTxStatusChanged(onChange)`  | Subscribes to transaction status lifecycle updates        | `TxChangedEvent`         |
+| Method                                | Description                                        | Callback Payload     |
+| ------------------------------------- | -------------------------------------------------- | -------------------- |
+| `onAccountsChanged(onChange)`         | Subscribes to active account changes               | `GetAccountResponse` |
+| `onConnectionStatusChanged(onChange)` | Subscribes to wallet connection status changes     | `ConnectResponse`    |
+| `onTxStatusChanged(onChange)`         | Subscribes to transaction status lifecycle updates | `TxChangedEvent`     |
 
 ### Example: Watch Account Changes
 
@@ -511,12 +439,44 @@ consoleWalletPixelplex.onTxStatusChanged((event) => {
 });
 ```
 
----
-
-## ⚠️ Error Handling
+## Error Handling
 
 All request helpers return Promises and can reject with a `ConsoleWalletError` when something goes wrong.
 
+The `ConsoleWalletError` is fully compatible with [EIP-1474](https://eips.ethereum.org/EIPS/eip-1474#error-codes) error codes, ensuring a standardized error handling experience similar to other blockchain ecosystems.
+
+### ConsoleWalletError Interface
+
+```typescript
+type ConsoleWalletError = Error & {
+  name: string;
+  message: string;
+  code: number; // EIP-1474 error code
+  data?: unknown;
+};
+```
+
+### Common Error Codes
+
+| Code   | Name               | Description                                |
+| ------ | ------------------ | ------------------------------------------ |
+| 4001   | UserRejected       | User rejected the request.                 |
+| 4100   | Unauthorized       | Unauthorized.                              |
+| 4200   | UnsupportedMethod  | Unsupported method.                        |
+| 4900   | Disconnected       | Disconnected from the wallet.              |
+| 4901   | ChainDisconnected  | Disconnected from the chain.               |
+| -32700 | ParseError         | Parse error.                               |
+| -32600 | InvalidRequest     | Invalid request.                           |
+| -32601 | MethodNotFound     | Method not found.                          |
+| -32602 | InvalidParams      | Invalid params.                            |
+| -32603 | InternalError      | Internal error.                            |
+| -32000 | InvalidInput       | Invalid input.                             |
+| -32001 | ResourceNotFound   | Resource not found.                        |
+| -32002 | ResourceUnavailable| Resource unavailable.                      |
+| -32003 | TransactionRejected| Transaction rejected.                      |
+| -32004 | MethodNotSupported | Method not supported.                      |
+| -32005 | LimitExceeded      | Limit exceeded.                            |
+
 - User-driven errors (rejection, invalid input, permission issues) are reported by the wallet and surfaced as rejected Promises with a `ConsoleWalletError` payload.
 - Transport-level issues (extension not installed, no response within the timeout) are also represented as `ConsoleWalletError` rejections where applicable (for example, account and network queries).
 - Some helpers, such as `checkAvailability()`, internally handle timeouts and resolve with a best-effort status instead of rejecting.
@@ -528,15 +488,16 @@ try {
   const accounts = await consoleWalletPixelplex.getAccounts();
   // happy path
 } catch (error) {
-  // error is typically a ConsoleWalletError with message/code
+  const err = error as ConsoleWalletError;
+  if (err.code === 4001) {
+    console.log('User rejected the request');
+  } else {
+    console.error('An error occurred:', err.message);
+  }
 }
 ```
 
----
-
-## 🔐 Transaction Metadata
-
-### Transaction Metadata
+## Transaction Metadata
 
 When submitting transactions, you can include optional metadata:
 
@@ -553,56 +514,25 @@ const transactionWithMetadata = await consoleWalletPixelplex.submitCommands({
 
 The `memo` field allows you to attach additional information to the transaction, which is stored as transfer metadata and can be retrieved when querying transaction history.
 
-### Cost Estimation
+## Transaction Costs
 
 All transactions on Canton are free. There are no transaction fees, traffic consumption costs, or native token costs for transaction processing.
 
----
-
-## 🎯 Signing Any Transaction Type
-
-The SDK supports signing various types of transactions:
+## How It Works
 
-### 1. Standard Token Transfers
+The Console DApp SDK provides a communication layer between your Web3 application and the Console Wallet Extension using the browser's native `window.postMessage` API.
 
-```typescript
-await consoleWalletPixelplex.submitCommands({
-  from: 'sender::fingerprint',
-  to: 'receiver::fingerprint',
-  token: 'CC',
-  amount: '10.0',
-  expireDate: new Date(Date.now() + 24 * 60 * 60 * 1000).toISOString(),
-});
-```
-
-### 2. Batch Transactions
-
-```typescript
-await consoleWalletPixelplex.signBatch({
-  batchType: 'SEND',
-  requests: [
-    // Multiple transfer requests
-  ],
-});
-```
+It handles all low-level messaging logic automatically, so you can focus on building your DApp — not managing communication details.
 
-### 3. Arbitrary Message Signing
+1. When your DApp sends a request (e.g., `connect()`, `signMessage()`, or `submitCommands()`), the SDK transmits a structured message to the Console Wallet Extension via `window.postMessage`.
 
-Sign any message for authentication or verification purposes:
+2. Each outgoing request is assigned a unique request ID, which is included in both the request and the extension's response.
 
-```typescript
-await consoleWalletPixelplex.signMessage({
-  message: { hex: '0x...' }, // or { base64: '...' }
-  metaData: {
-    purpose: 'authentication',
-    // Any additional metadata
-  },
-});
-```
+3. The SDK listens for incoming responses from the extension, matches them to their original request using the ID, and automatically resolves the corresponding Promise in your application.
 
----
+This approach ensures reliable, asynchronous communication between the DApp and the extension — preventing race conditions, mismatched responses, or orphaned message handlers.
 
-## 📚 API Reference
+## API Reference
 
 For detailed API reference, see the TypeScript type definitions in `src/types/`. All methods are fully typed and include JSDoc comments.
 
@@ -648,8 +578,6 @@ utils.equalBytes(a: Uint8Array, b: Uint8Array): boolean
 
 These utilities are essential for converting data between different formats (hex, base64, bytes) that the network and extension expect.
 
----
-
-## 📝 Changelog
+## Changelog
 
 See [CHANGELOG.md](./CHANGELOG.md) for a list of changes and version history.

package/dist/cjs/api/client.api.d.ts

@@ -1,6 +1,33 @@
 export declare const api: {
     wallet: {
         api: {
+            authControllerCreateSessionToken: (data: import("./generated-wallet-api").CreateSessionBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<void>;
+            cbtcBridgeControllerExecuteDeposit: (data: import("./generated-wallet-api").ExecuteDepositBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").ExecuteDepositResponseDTO>;
+            cbtcBridgeControllerExecuteWithdrawInit: (data: import("./generated-wallet-api").ExecuteWithdrawInitBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").ExecuteWithdrawInitResponseDTO>;
+            cbtcBridgeControllerExecuteWithdrawRequest: (data: import("./generated-wallet-api").ExecuteWithdrawRequestBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").ExecuteWithdrawRequestResponseDTO>;
+            cbtcBridgeControllerGetDepositAccounts: (query: {
+                partyId: string;
+            }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").DepositAccountsResponseDTO>;
+            cbtcBridgeControllerGetHoldings: (query: {
+                partyId: string;
+            }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").HoldingsResponseDTO>;
+            cbtcBridgeControllerGetWithdrawAccounts: (query: {
+                partyId: string;
+            }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").WithdrawAccountsResponseDTO>;
+            cbtcBridgeControllerGetWithdrawalHistory: (query: {
+                partyId: string;
+            }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").WithdrawalHistoryResponseDTO>;
+            cbtcBridgeControllerGetWithdrawRequests: (query: {
+                partyId: string;
+            }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").WithdrawRequestsResponseDTO>;
+            cbtcBridgeControllerPrepareDeposit: (data: import("./generated-wallet-api").PrepareDepositBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").PrepareDepositResponseDTO>;
+            cbtcBridgeControllerPrepareWithdrawInit: (data: import("./generated-wallet-api").PrepareWithdrawInitBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").PrepareWithdrawInitResponseDTO>;
+            cbtcBridgeControllerPrepareWithdrawRequest: (data: import("./generated-wallet-api").PrepareWithdrawRequestBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").PrepareWithdrawRequestResponseDTO>;
+            evmControllerAddUserEvmWalletAddress: (partyId: string, data: import("./generated-wallet-api").CreateUserEvmAddressDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetUserEvmAddressResponseDTO>;
+            evmControllerAddUserEvmWalletAddresses: (partyId: string, data: import("./generated-wallet-api").CreateUserEvmAddressBulkBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").CreateUserEvmAddressBulkResponseDTO>;
+            externalPartyControllerGetPartyByFingerprint: (query: {
+                fingerprint: string;
+            }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetPartyByFingerprintResponseDTO>;
             externalPartyControllerPrepareExternalParty: (data: import("./generated-wallet-api").PrepareExternalPartyBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").PrepareExternalPartyResponseDTO>;
             externalPartyControllerSubmitExternalParty: (data: import("./generated-wallet-api").SubmitExternalPartyBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").SubmitExternalPartyResponseDTO>;
             invitationsControllerRequestInvitation: (data: import("./generated-wallet-api").RequestInvitationBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").RequestInvitationResponseDTO>;
@@ -10,10 +37,14 @@ export declare const api: {
             }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetMergeUtxosStatusResponseDTO>;
             mergeDelegationControllerPrepareMergeDelegation: (data: import("./generated-wallet-api").PrepareMergeDelegationBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").PrepareMergeDelegationResponseDTO>;
             mergeDelegationControllerSubmitMergeDelegation: (data: import("./generated-wallet-api").SubmitMergeDelegationBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").SubmitMergeDelegationResponseDTO>;
+            proxyCcviewUserApiControllerGetDevice: (deviceId: string, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetDeviceResponseDTO>;
+            proxyCcviewUserApiControllerSubscribe: (data: import("./generated-wallet-api").SubscribeDeviceDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").SubscribeResponseDTO>;
+            proxyCcviewUserApiControllerUnsubscribe: (data: import("./generated-wallet-api").UnsubscribeDeviceDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").UnsubscribeResponseDTO>;
             proxyIndexerControllerProxyLegacy: (data: import("./generated-wallet-api").ProxyRequestDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetAnsContextListEntryDTO | import("./generated-wallet-api").GetAnsListEntryDTO | import("./generated-wallet-api").GetGeneralSearchResultResponseDTO | import("./generated-wallet-api").GetOffersSearchResponseDTO | import("./generated-wallet-api").GetPartyDetailsResponseDTO | import("./generated-wallet-api").GetPricesProxyResponseDTO | import("./generated-wallet-api").GetPricesResponseDTO | import("./generated-wallet-api").GetTokenTransfersByPartyResponseDTO | import("./generated-wallet-api").GetTransferDetailsResponseDTO>;
             proxyIndexerControllerProxyMapped: (data: import("./generated-wallet-api").ProxyRequestDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").ProxyIndexerResponseDTO>;
-            proxyPriceApiControllerProxy: (data: import("./generated-wallet-api").CryptoAPIProxyBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<any>;
+            proxyPriceApiControllerProxy: (data: import("./generated-wallet-api").CryptoAPIProxyBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").CryptoAPIProxyResponseDTO>;
             proxyW3AControllerProxy: (data: import("./generated-wallet-api").ProxyBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").ProxyResponseDTO>;
+            sdkLedgerProxyControllerProxyRequest: (data: import("./generated-wallet-api").SdkLedgerProxyBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").SdkLedgerProxyResponseDTO>;
             settingControllerCreateSetting: (data: import("./generated-wallet-api").CreateSettingBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").CreateSettingResponseDTO>;
             settingControllerDeleteSetting: (id: number, params?: import("./generated-wallet-api").RequestParams) => Promise<void>;
             settingControllerGetSettings: (params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetSettingsResponseDTO>;
@@ -23,11 +54,13 @@ export declare const api: {
                 partyId: string;
             }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").CoinsBalancesResponseDTO>;
             tokenStandardControllerGetPendingTransactions: (query: {
+                coin?: "CC" | "CBTC" | "USDCx" | undefined;
                 limit?: number | undefined;
                 offset?: number | undefined;
                 partyId: string;
             }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetPendingTransactionsResponseDTO>;
             tokenStandardControllerGetPendingTransactionsFull: (query: {
+                coin?: "CC" | "CBTC" | "USDCx" | undefined;
                 limit?: number | undefined;
                 offset?: number | undefined;
                 partyId: string;
@@ -38,6 +71,7 @@ export declare const api: {
             transferControllerGetTransferPreApprovalOrFail: (query: {
                 partyId: string;
             }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetTransferPreApprovalResponseDTO>;
+            transferControllerGetTransferPreApprovals: (data: import("./generated-wallet-api").GetTransferPreApprovalsBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetTransferPreApprovalsResponseDTO>;
             transferControllerPrepareBatchTransfer: (data: import("./generated-wallet-api").PrepareBatchTransferBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").PrepareBatchTransferResponseDTO>;
             transferControllerPrepareResolveTransfer: (data: import("./generated-wallet-api").PrepareResolveTransferBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").PrepareResolveTransferResponseDTO>;
             transferControllerPrepareTransfer: (data: import("./generated-wallet-api").PrepareTransferBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").PrepareTransferResponseDTO>;
@@ -65,6 +99,10 @@ export declare const api: {
             transferPreapprovalControllerPrepareCreateTransferPreapproval: (data: import("./generated-wallet-api").PrepareCreateTransferPreapprovalBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").PrepareCreateTransferPreapprovalResponseDTO>;
             transferPreapprovalControllerSubmitCancelTransferPreapproval: (data: import("./generated-wallet-api").SubmitCancelTransferPreapprovalBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").SubmitCancelTransferPreapprovalResponseDTO>;
             transferPreapprovalControllerSubmitCreateTransferPreapproval: (data: import("./generated-wallet-api").SubmitCreateTransferPreapprovalBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").SubmitCreateTransferPreapprovalResponseDTO>;
+            userControllerGetUserWithInfo: (partyId: string, query?: {
+                address?: string | undefined;
+                networkId?: number | undefined;
+            } | undefined, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetUserInfoWithEvmAddressResponseDTO>;
         };
         setSecurityData: (data: unknown) => void;
         request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: import("./generated-wallet-api").FullRequestParams) => Promise<T>;