Console Wallet DApp SDK

https://www.npmjs.com/package/@console-wallet/dapp-sdk
Admin
A lightweight SDK for connecting Web3 applications to the Console Wallet Extension, enabling account...
Tokens:13,886
Snippets:108
Trust Score:9.6
Update:9 months ago
Show doc for...
Tokens:
Raw
### Example Usage

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/1.1_activeTab=dependents

Example of how to use the SDK to sign and send a transaction.

```APIDOC
### Example

```javascript
const handleSignSend = async () => {
  if (!amount || !receiver || !expireDate) {
    alert('Please fill all fields');
    return;
  }

  try {
    const activeAccount = await consoleWalletPixelplex.getActiveAccount();
    const signResult = await consoleWalletPixelplex.signSend({
      to: receiver,
      from: activeAccount.party,
      amount,
      expireDate,
    });

    setResult(signResult.status ? 'Transaction signed successfully' : 'Transaction error');
  } catch (error) {
    console.error('Error signing transaction:', error);
    setResult('Error signing transaction');
  }
};
```

### `signSend(data)`

**Description**: Signs and broadcasts a transaction to send Canton Coin.

**Method**: N/A (Function call)

**Endpoint**: N/A

**Parameters**:
  * **data** (object) - Required - `SignSendRequest` payload, including `to`, `from`, `amount`, and `expireDate`.

**Response**: `SignSendResponse`
```

--------------------------------

### Installation and Initialization

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk_activeTab=versions

Instructions for installing the SDK and initializing a connection session with the Console Wallet Extension.

```APIDOC
## Installation

```bash
npm install @console-wallet/dapp-sdk
# or
yarn add @console-wallet/dapp-sdk
```

## Initialization

Before your DApp can interact with the **Console Wallet Extension**, it needs to **initialize a connection session**. This step establishes secure communication between your web application and the user’s wallet.
```

--------------------------------

### Installation

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/1.2

Instructions on how to install the Console Wallet Dapp SDK using npm or yarn.

```APIDOC
## Installation

To install the Console Wallet Dapp SDK, use either npm or yarn:

```bash
npm install @console-wallet/dapp-sdk
# or
yarn add @console-wallet/dapp-sdk
```

### Initialization

Before your DApp can interact with the **Console Wallet Extension**, it needs to **initialize a connection session**. This step establishes secure communication between your web application and the user’s wallet.
```

--------------------------------

### Install Console Wallet Dapp SDK

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=readme

Instructions for installing the console-wallet-dapp-templ package using either npm or yarn. This is a prerequisite for integrating the SDK into your DApp.

```bash
npm install console-wallet-dapp-templ
# or
yarn add console-wallet-dapp-templ

```

--------------------------------

### Connect DApp to Console Wallet Extension

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0

This example shows how to initiate a connection between your DApp and the Console Wallet Extension using the SDK. It includes methods for both connecting and checking the current connection status. The `connect` method requires a name and icon for your DApp.

```javascript
import { consoleWalletPixelplex } from 'console-wallet-dapp-templ';

const handleConnect = async () => {
  try {
    await consoleWalletPixelplex.connect({ name, icon });
  } catch (error) {
    console.error('Error checking connection:', error);
  }
};

const handleCheckConnection = async () => {
  try {
    const isConnected = await consoleWalletPixelplex.getIsConnected();
    setConnectionStatus(isConnected ? 'Connected' : 'Not connected');
  } catch (error) {
    console.error('Error checking connection:', error);
  }
};
```

--------------------------------

### Install Console Wallet Dapp SDK using npm or yarn

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/1.0

Instructions for installing the Console Wallet Dapp SDK package using either npm or yarn package managers.

```bash
npm install @console-wallet/dapp-sdk
# or
yarn add @console-wallet/dapp-sdk
```

--------------------------------

### Install Console Wallet Dapp SDK

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0

Instructions for installing the console-wallet-dapp-sdk using either npm or yarn package managers. This step is required before your DApp can interact with the Console Wallet Extension.

```bash
npm install console-wallet-dapp-templ
# or
yarn add console-wallet-dapp-templ
```

--------------------------------

### Connect DApp to Console Wallet Extension

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=readme

This example shows how to connect your DApp to the Console Wallet Extension using the SDK. It includes a function to initiate the connection and another to check the current connection status. The `connect` method requires a name and icon for the DApp, and `getIsConnected` returns a boolean indicating the connection state. Errors during connection are logged to the console.

```javascript
import { consoleWalletPixelplex } from 'console-wallet-dapp-templ';

const handleConnect = async () => {
  try {
    await consoleWalletPixelplex.connect({ name, icon });
  } catch (error) {
    console.error('Error checking connection:', error);
  }
};

const handleCheckConnection = async () => {
  try {
    const isConnected = await consoleWalletPixelplex.getIsConnected();
    setConnectionStatus(isConnected ? 'Connected' : 'Not connected');
  } catch (error) {
    console.error('Error checking connection:', error);
  }
};

```

--------------------------------

### Example Usage: Sign and Send Transaction

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0

An example demonstrating how to use the `signSend` method to sign and broadcast a transaction.

```APIDOC
### 🪄 Example: Sign and Send Transaction

```javascript
const handleSignSend = async () => {
  if (!amount || !receiver || !expireDate) {
    alert('Please fill all fields');
    return;
  }

  try {
    const activeAccount = await consoleWalletPixelplex.getActiveAccount();
    const signResult = await consoleWalletPixelplex.signSend({
      to: receiver,
      from: activeAccount.party,
      amount,
      expireDate,
    });

    setResult(signResult.status ? 'Transaction signed successfully' : 'Transaction error');
  } catch (error) {
    console.error('Error signing transaction:', error);
    setResult('Error signing transaction');
  }
};
```
```

--------------------------------

### Install Console Wallet Dapp SDK using npm

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=code

Command to install a specific version of the @console-wallet/dapp-sdk package using npm. This is useful for managing dependencies and ensuring compatibility.

```bash
npm i @console-wallet/dapp-sdk@0.0.24

```

--------------------------------

### Sign and Broadcast Transaction with Console Wallet SDK

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=readme

This example demonstrates how to sign and broadcast a transaction to send Canton Coin using the consoleWalletPixelplex SDK. It includes input validation for amount, receiver, and expiration date, retrieves the active account, and handles potential errors during the signing process. Dependencies include the consoleWalletPixelplex object.

```javascript
const handleSignSend = async () => {
  if (!amount || !receiver || !expireDate) {
    alert('Please fill all fields');
    return;
  }

  try {
    const activeAccount = await consoleWalletPixelplex.getActiveAccount();
    const signResult = await consoleWalletPixelplex.signSend({
      to: receiver,
      from: activeAccount.party,
      amount,
      expireDate,
    });

    setResult(signResult.status ? 'Transaction signed successfully' : 'Transaction error');
  } catch (error) {
    console.error('Error signing transaction:', error);
    setResult('Error signing transaction');
  }
};

```

--------------------------------

### Sign and submit a transaction using the SDK

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/1.0

An example function that retrieves the active account, signs a transaction with specified details (receiver, amount, expiry date), and handles the response or errors.

```javascript
const handleSignSend = async () => {
  if (!amount || !receiver || !expireDate) {
    alert('Please fill all fields');
    return;
  }

  try {
    const activeAccount = await consoleWalletPixelplex.getActiveAccount();
    const signResult = await consoleWalletPixelplex.signSend({
      to: receiver,
      from: activeAccount.party,
      amount,
      expireDate,
    });

    setResult(signResult.status ? 'Transaction signed successfully' : 'Transaction error');
  } catch (error) {
    console.error('Error signing transaction:', error);
    setResult('Error signing transaction');
  }
};
```

--------------------------------

### Connecting Your DApp

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/1.0

Initialize a connection session to establish secure communication between your web application and the user’s wallet.

```APIDOC
## Connecting Your DApp

Before your DApp can interact with the **Console Wallet Extension**, it needs to **initialize a connection session**. This step establishes secure communication between your web application and the user’s wallet.

### `connect({ name, icon })`

**Description**: Prompts the user to connect their Console Wallet to the DApp.

**Method**: POST

**Endpoint**: `/api/connect`

**Parameters**:
#### Request Body
- **name** (string) - Required - The name of your DApp.
- **icon** (string) - Optional - The icon URL for your DApp.

**Example**:
```javascript
import { consoleWalletPixelplex } from 'console-wallet-dapp-templ';

const handleConnect = async () => {
  try {
    await consoleWalletPixelplex.connect({ name: 'My DApp', icon: 'https://example.com/icon.png' });
  } catch (error) {
    console.error('Error connecting to wallet:', error);
  }
};
```

### `status()`

**Description**: Returns the current connection status for the dApp origin.

**Method**: GET

**Endpoint**: `/api/status`

**Response Example**:
```json
{
  "isConnected": true,
  "name": "Console Wallet",
  "icon": "https://example.com/wallet-icon.png"
}
```
```

--------------------------------

### Connecting Your DApp

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/1.0_activeTab=readme

Before your DApp can interact with the Console Wallet Extension, it needs to initialize a connection session. This step establishes secure communication between your web application and the user’s wallet.

```APIDOC
### Connecting Your DApp

The SDK provides a simple `connect()` method that requests permission from the user’s Console Wallet.

```javascript
import { consoleWalletPixelplex } from 'console-wallet-dapp-templ';

const handleConnect = async () => {
  try {
    await consoleWalletPixelplex.connect({ name, icon });
  } catch (error) {
    console.error('Error checking connection:', error);
  }
};

const handleCheckConnection = async () => {
  try {
    const connected = await consoleWalletPixelplex.status();
    setConnectionStatus(connected);
  } catch (error) {
    console.error('Error checking connection:', error);
  }
};
```

### `connect(data)`

**Description**: Prompts the user to connect their Console Wallet to the DApp.

**Method**: POST (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (`ConnectRequest`) - Required - Connection request details (e.g., `{ name: 'My DApp', icon: 'url_to_icon.png' }`).

**Response**: `ConnectResponse`

### `status()`

**Description**: Returns current connection status for the dApp origin.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Response**: `ConnectResponse`
```

--------------------------------

### Connecting Your DApp

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0

Before your DApp can interact with the Console Wallet Extension, it needs to initialize a connection session. This step establishes secure communication between your web application and the user’s wallet.

```APIDOC
### 🔌 Connecting Your DApp

The SDK provides a simple `connect()` method that requests permission from the user’s Console Wallet.

```javascript
import { consoleWalletPixelplex } from 'console-wallet-dapp-templ';

const handleConnect = async () => {
  try {
    await consoleWalletPixelplex.connect({ name: 'My DApp', icon: 'my-dapp-icon.png' });
  } catch (error) {
    console.error('Error checking connection:', error);
  }
};

const handleCheckConnection = async () => {
  try {
    const isConnected = await consoleWalletPixelplex.getIsConnected();
    setConnectionStatus(isConnected ? 'Connected' : 'Not connected');
  } catch (error) {
    console.error('Error checking connection:', error);
  }
};
```
```

--------------------------------

### Connect DApp to Console Wallet and check connection status

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/1.0

Demonstrates how to initiate a connection with the Console Wallet Extension and check the current connection status. It requires importing the SDK and handling potential connection errors.

```javascript
import { consoleWalletPixelplex } from 'console-wallet-dapp-templ';

const handleConnect = async () => {
  try {
    await consoleWalletPixelplex.connect({ name, icon });
  } catch (error) {
    console.error('Error checking connection:', error);
  }
};

const handleCheckConnection = async () => {
  try {
    const connected = await consoleWalletPixelplex.status();
    setConnectionStatus(connected);
  } catch (error) {
    console.error('Error checking connection:', error);
  }
};
```

--------------------------------

### connect

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=dependents

Prompts the user to connect their Console Wallet to the DApp.

```APIDOC
## POST /connect

### Description
Prompts the user to connect their Console Wallet to the DApp.

### Method
POST

### Endpoint
/connect

### Parameters
#### Query Parameters
None

#### Request Body
- **data** (object) - Optional - Connection details.
  - **name** (string) - Optional - The name of the DApp.
  - **icon** (string) - Optional - The icon URL of the DApp.

### Request Example
```json
{
  "data": {
    "name": "My DApp",
    "icon": "https://example.com/icon.png"
  }
}
```

### Response
#### Success Response (200)
- **connected** (boolean) - Indicates if the connection was successful.

#### Response Example
```json
{
  "connected": true
}
```
```

--------------------------------

### getOffers

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=dependents

Retrieves a list of offers for a given party, with pagination support.

```APIDOC
## POST /get-offers

### Description
Check party offers with pagination.

### Method
POST

### Endpoint
/get-offers

### Parameters
#### Query Parameters
None

#### Request Body
- **data** (object) - Required - The request details.
  - **party** (string) - Required - The party whose offers to retrieve.
  - **limit** (number) - Optional - The maximum number of offers to return per page.
  - **offset** (number) - Optional - The number of offers to skip (for pagination).
  - **networkId** (string) - Optional - The network ID to check offers on. Defaults to the active network.

### Request Example
```json
{
  "data": {
    "party": "partyAddress",
    "limit": 5,
    "offset": 0
  }
}
```

### Response
#### Success Response (200)
- **offers** (array) - An array of offer objects.
- **total** (number) - The total number of offers available.

#### Response Example
```json
{
  "offers": [
    {
      "id": "offer1",
      "type": "buy",
      "amount": 100,
      "currency": "CC",
      "status": "active",
      "createdAt": "2023-10-27T09:00:00Z"
    }
  ],
  "total": 50
}
```
```

--------------------------------

### Handle errors when making requests with Console Wallet SDK

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/index

Demonstrates how to use a try-catch block to handle potential errors when making requests using the Console Wallet SDK. It specifically mentions catching `ConsoleWalletError` for user-driven or transport-level issues.

```javascript
try {
  const accounts = await consoleWalletPixelplex.getAccounts();
  // happy path
} catch (error) {
  // error is typically a ConsoleWalletError with message/code
}
```

--------------------------------

### Error Handling

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/1.2_activeTab=dependents

All request helpers return Promises and can reject with a `ConsoleWalletError` when something goes wrong. It is recommended to wrap calls in `try`/`catch` blocks.

```APIDOC
## Error Handling

### Description
Details on how errors are handled by the SDK, including user-driven errors, transport-level issues, and recommended practices for handling rejections.

### Error Types

- **User-driven errors**: Rejections due to user actions (rejection, invalid input, permission issues), reported by the wallet as `ConsoleWalletError` payloads.
- **Transport-level issues**: Errors like extension not installed or timeouts, also represented as `ConsoleWalletError` rejections.
- **Best-effort status**: Some helpers (e.g., `checkAvailability()`) handle timeouts internally and resolve with a status instead of rejecting.

### Recommended Practice

Always wrap SDK method calls in `try`/`catch` blocks to handle potential `ConsoleWalletError` exceptions.

### Example
```javascript
try {
  const accounts = await consoleWalletPixelplex.getAccounts();
  // Handle successful account retrieval
} catch (error) {
  // error is typically a ConsoleWalletError with message/code
  console.error('An error occurred:', error);
  // Handle the error appropriately
}
```
```

--------------------------------

### Watch Requests

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/1.0

Subscription-style helpers to watch for changes from the Console Wallet. These functions register a callback and invoke it whenever the corresponding state changes.

```APIDOC
## Watch Requests

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.

### `onAccountsChanged(onChange)`

**Description**: Subscribes to active account changes.

**Method**: SUBSCRIBE

**Endpoint**: `/api/subscribe/accounts/changed`

**Parameters**:
#### Request Body
- **onChange** (function) - Required - Callback function to be invoked when accounts change.

**Callback Payload**: `GetAccountResponse`

### `onConnectionStatusChanged(onChange)`

**Description**: Subscribes to wallet connection status changes.

**Method**: SUBSCRIBE

**Endpoint**: `/api/subscribe/connection/status/changed`

**Parameters**:
#### Request Body
- **onChange** (function) - Required - Callback function to be invoked when connection status changes.

**Callback Payload**: `ConnectResponse`

### `onTxStatusChanged(onChange)`

**Description**: Subscribes to transaction status lifecycle updates.

**Method**: SUBSCRIBE

**Endpoint**: `/api/subscribe/tx/status/changed`

**Parameters**:
#### Request Body
- **onChange** (function) - Required - Callback function to be invoked when transaction status changes.

**Callback Payload**: `TxChangedEvent`
```

--------------------------------

### Supported Requests API

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/1.0_activeTab=readme

This section details the high-level request methods provided by the SDK to interact with the Console Wallet Extension. Each request is automatically tagged with a unique request ID for reliable response matching.

```APIDOC
## Supported Requests

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.

### `getAccounts()`

**Description**: Retrieves the account(s) basic data.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Response**: `GetAccountsResponse`

### `getPrimaryAccount()`

**Description**: Returns the currently selected account in the Wallet.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Response**: `GetAccountResponse`

### `getActiveNetwork()`

**Description**: Returns the currently selected network metadata.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Response**: `Network`

### `signMessage(message)`

**Description**: Requests the user to sign a message (hex/base64).

**Method**: POST (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **message** (string) - Required - The message to sign (hex/base64).

**Response**: `SignedMessageResponse`

### `submitCommands(data)`

**Description**: Signs and broadcasts a transaction to send Canton Coin.

**Method**: POST (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (`SignSendRequest`) - Required - The transaction details.

**Response**: `SignSendResponse`

### `connect(data)`

**Description**: Prompts the user to connect their Console Wallet to the DApp.

**Method**: POST (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (`ConnectRequest`) - Required - Connection request details.

**Response**: `ConnectResponse`

### `status()`

**Description**: Returns current connection status for the dApp origin.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Response**: `ConnectResponse`

### `isConnected()`

**Description**: Checks if the network is available.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Response**: `NetworkStatus`

### `disconnect()`

**Description**: Disconnects the DApp from the wallet.

**Method**: POST (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Response**: `DisconnectResponse`

### `getBalance()`

**Description**: Check party balance; includes current Canton Coin price.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (`GetBalanceRequest`) - Required - Balance request details.

**Response**: `GetBalanceResponse`

### `getTokenTransfers()`

**Description**: Check party token transfers with pagination.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (`TokenTransfersRequest`) - Required - Token transfer request details.

**Response**: `TokenTransfersResponse`

### `getTransfer()`

**Description**: Check party token transfer details.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (`TransferRequest`) - Required - Transfer request details.

**Response**: `TransferResponse`

### `getOffers()`

**Description**: Check party offers with pagination.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (`OffersRequest`) - Required - Offers request details.

**Response**: `OffersResponse`
```

--------------------------------

### Supported Requests API

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk_activeTab=dependencies

This section details the high-level request methods provided by the SDK to communicate with the Console Wallet Extension. Each request is uniquely tagged for reliable response matching.

```APIDOC
## Supported Requests

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.

### `getAccounts()`

**Description**: Retrieves the account(s) basic data.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Response**: `GetAccountsResponse`

### `getPrimaryAccount()`

**Description**: Returns the currently selected account in the Wallet.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Response**: `GetAccountResponse`

### `getActiveNetwork()`

**Description**: Returns the currently selected network metadata.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Response**: `Network`

### `signMessage(message)`

**Description**: Requests the user to sign a message (hex/base64).

**Method**: POST (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **message** (string) - Required - The message to sign (hex/base64).

**Response**: `SignedMessageResponse`

### `submitCommands(data)`

**Description**: Signs and broadcasts a transaction to send Canton Coin.

**Method**: POST (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (object) - Required - `SignSendRequest` payload.

**Response**: `SignSendResponse`

### `signBatch(data)`

**Description**: Signs and broadcasts a batch of transactions.

**Method**: POST (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (object) - Required - `SignBatchRequest` payload.

**Response**: `SignBatchResponse`

### `connect(data)`

**Description**: Prompts the user to connect their Console Wallet to the DApp.

**Method**: POST (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (object) - Required - `ConnectRequest` payload.

**Response**: `ConnectResponse`

### `status()`

**Description**: Returns current connection status for the dApp origin.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Response**: `ConnectResponse`

### `checkAvailability()`

**Description**: Checks whether the wallet browser extension is installed.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Response**: `AvailabilityResponse`

### `isConnected()`

**Description**: Checks if the network available.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Response**: `NetworkStatus`

### `disconnect()`

**Description**: Disconnects the DApp from the wallet.

**Method**: POST (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Response**: `DisconnectResponse`

### `getBalance()`

**Description**: Check party balance; includes current Canton Coin price.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (object) - Required - `GetBalanceRequest` payload.

**Response**: `GetBalanceResponse`

### `getCoinsBalance()`

**Description**: Check balances and prices for supported coins.

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (object) - Required - `GetBalanceRequest` payload.

**Response**: `GetCoinsResponse`

### `getTokenTransfers()`

**Description**: Check party token transfers with pagination (indexer).

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (object) - Required - `TokenTransfersRequest` payload.

**Response**: `TokenTransfersResponse`

### `getTransfer()`

**Description**: Check party token transfer details (indexer).

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (object) - Required - `TransferRequest` payload.

**Response**: `TransferResponse`

### `getOffers()`

**Description**: Check party offers with pagination (indexer).

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (object) - Required - `OffersRequest` payload.

**Response**: `OffersResponse`

### `getNodeTransfers()`

**Description**: Check standard coin transfers with pagination (wallet node).

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (object) - Required - `CoinTransfersFromNodeRequest` payload.

**Response**: `CoinTransfersFromNodeResponse`

### `getNodeTransfer()`

**Description**: Check single transfer details (wallet node).

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (object) - Required - `TransferFromNodeRequest` payload.

**Response**: `TransferFromNodeResponse`

### `getNodeOffers()`

**Description**: Check pending transactions/offers with pagination (wallet node).

**Method**: GET (Implicit)

**Endpoint**: N/A (Internal SDK method)

**Parameters**: 
#### Request Body
- **data** (object) - Required - `OffersFromNodeRequest` payload.

**Response**: `OffersFromNodeResponse`
```

--------------------------------

### getIsConnected

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=dependents

Checks if the DApp is already connected to the Console Wallet.

```APIDOC
## GET /is-connected

### Description
Checks if the DApp is already connected to the wallet.

### Method
GET

### Endpoint
/is-connected

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **isConnected** (boolean) - True if the DApp is connected, false otherwise.

#### Response Example
```json
{
  "isConnected": true
}
```
```

--------------------------------

### Supported Requests

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/1.0

High-level request methods to communicate with the Console Wallet Extension via secure message passing. Each request is tagged with a unique request ID for reliable response matching.

```APIDOC
## Supported Requests

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.

### `getAccounts()`

**Description**: Retrieves the account(s) basic data.

**Method**: GET

**Endpoint**: `/api/accounts`

**Response**: `GetAccountsResponse`

### `getPrimaryAccount()`

**Description**: Returns the currently selected account in the Wallet.

**Method**: GET

**Endpoint**: `/api/account/primary`

**Response**: `GetAccountResponse`

### `getActiveNetwork()`

**Description**: Returns the currently selected network metadata.

**Method**: GET

**Endpoint**: `/api/network/active`

**Response**: `Network`

### `signMessage(message)`

**Description**: Requests the user to sign a message (hex/base64).

**Method**: POST

**Endpoint**: `/api/message/sign`

**Parameters**:
#### Request Body
- **message** (string) - Required - The message to sign (hex/base64).

**Response**: `SignedMessageResponse`

### `submitCommands(data)`

**Description**: Signs and broadcasts a transaction to send Canton Coin.

**Method**: POST

**Endpoint**: `/api/transaction/submit`

**Parameters**:
#### Request Body
- **data** (object) - Required - `SignSendRequest` object containing transaction details.

**Response**: `SignSendResponse`

### `connect(data)`

**Description**: Prompts the user to connect their Console Wallet to the DApp.

**Method**: POST

**Endpoint**: `/api/connect`

**Parameters**:
#### Request Body
- **data** (object) - Required - `ConnectRequest` object containing DApp name and icon.

**Response**: `ConnectResponse`

### `status()`

**Description**: Returns current connection status for the dApp origin.

**Method**: GET

**Endpoint**: `/api/status`

**Response**: `ConnectResponse`

### `isConnected()`

**Description**: Checks if the network is available.

**Method**: GET

**Endpoint**: `/api/network/status`

**Response**: `NetworkStatus`

### `disconnect()`

**Description**: Disconnects the DApp from the wallet.

**Method**: POST

**Endpoint**: `/api/disconnect`

**Response**: `DisconnectResponse`

### `getBalance()`

**Description**: Check party balance; includes current Canton Coin price.

**Method**: GET

**Endpoint**: `/api/balance`

**Parameters**:
#### Query Parameters
- **request** (object) - Required - `GetBalanceRequest` object.

**Response**: `GetBalanceResponse`

### `getTokenTransfers()`

**Description**: Check party token transfers with pagination.

**Method**: GET

**Endpoint**: `/api/transfers/token`

**Parameters**:
#### Query Parameters
- **request** (object) - Required - `TokenTransfersRequest` object.

**Response**: `TokenTransfersResponse`

### `getTransfer()`

**Description**: Check party token transfer details.

**Method**: GET

**Endpoint**: `/api/transfer`

**Parameters**:
#### Query Parameters
- **request** (object) - Required - `TransferRequest` object.

**Response**: `TransferResponse`

### `getOffers()`

**Description**: Check party offers with pagination.

**Method**: GET

**Endpoint**: `/api/offers`

**Parameters**:
#### Query Parameters
- **request** (object) - Required - `OffersRequest` object.

**Response**: `OffersResponse`
```

--------------------------------

### getActiveNetwork

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=dependents

Returns the currently selected network in the Console Wallet.

```APIDOC
## GET /active-network

### Description
Returns the currently selected network.

### Method
GET

### Endpoint
/active-network

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **network** (string) - The name of the currently active network.

#### Response Example
```json
{
  "network": "mainnet"
}
```
```

--------------------------------

### getAccounts

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=dependents

Retrieves the basic data for all accounts associated with the Console Wallet.

```APIDOC
## GET /accounts

### Description
Retrieves the account(s) basic data.

### Method
GET

### Endpoint
/accounts

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **accounts** (array) - An array of account objects, each containing basic account data.

#### Response Example
```json
{
  "accounts": [
    {
      "party": "party1",
      "name": "Account 1"
    },
    {
      "party": "party2",
      "name": "Account 2"
    }
  ]
}
```
```

--------------------------------

### Error Handling

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk_activeTab=dependencies

Details on how errors are handled within the SDK, including user-driven errors, transport-level issues, and recommended practices for error management.

```APIDOC
## Error Handling

All request helpers return Promises and can reject with a `ConsoleWalletError` when something goes wrong.

### User-Driven Errors
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
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).

### Best-Effort Status
Some helpers, such as `checkAvailability()`, internally handle timeouts and resolve with a best-effort status instead of rejecting.

### Recommended Practice
You should always wrap calls in `try`/`catch` and handle both expected and unexpected errors:

```javascript
try {
  const accounts = await consoleWalletPixelplex.getAccounts();
  // happy path
} catch (error) {
  // error is typically a ConsoleWalletError with message/code
}
```
```

--------------------------------

### Error Handling for Requests

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/1.2

All request helpers return Promises and can reject with a `ConsoleWalletError` when something goes wrong. This section details how to handle various error scenarios.

```APIDOC
## Error Handling for Requests

All request helpers return Promises and can reject with a `ConsoleWalletError` when something goes wrong.

### User-Driven Errors
*   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
*   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).

### Best-Effort Status
*   Some helpers, such as `checkAvailability()`, internally handle timeouts and resolve with a best-effort status instead of rejecting.

### Recommended Usage

You should always wrap calls in `try`/`catch` and handle both expected and unexpected errors:

```javascript
try {
  const accounts = await consoleWalletPixelplex.getAccounts();
  // happy path
} catch (error) {
  // error is typically a ConsoleWalletError with message/code
  console.error('An error occurred:', error);
}
```
```

--------------------------------

### getBalance

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=dependents

Checks the party balance on any network and provides the current Canton Coin price.

```APIDOC
## POST /get-balance

### Description
Check party balance on any network. Also provide current Canton Coin price.

### Method
POST

### Endpoint
/get-balance

### Parameters
#### Query Parameters
None

#### Request Body
- **data** (object) - Required - The request details.
  - **party** (string) - Required - The party whose balance to check.
  - **networkId** (string) - Optional - The network ID to check the balance on. Defaults to the active network.

### Request Example
```json
{
  "data": {
    "party": "partyAddress",
    "networkId": "testnet"
  }
}
```

### Response
#### Success Response (200)
- **balance** (object) - The balance information.
  - **amount** (number) - The balance amount.
  - **currency** (string) - The currency of the balance.
- **price** (object) - The current price information.
  - **amount** (number) - The price amount.
  - **currency** (string) - The currency of the price.

#### Response Example
```json
{
  "balance": {
    "amount": 1000,
    "currency": "CC"
  },
  "price": {
    "amount": 0.5,
    "currency": "USD"
  }
}
```
```

--------------------------------

### signMessage

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=dependents

Requests the user to sign a message, which can be in hex or base64 format.

```APIDOC
## POST /sign-message

### Description
Requests the user to sign a message in hex or base64 format.

### Method
POST

### Endpoint
/sign-message

### Parameters
#### Query Parameters
None

#### Request Body
- **message** (string) - Required - The message to be signed. Can be in hex or base64 format.

### Request Example
```json
{
  "message": "0x123abc..."
}
```

### Response
#### Success Response (200)
- **signedMessage** (string) - The signature of the message.

#### Response Example
```json
{
  "signedMessage": "0xabcdef..."
}
```
```

--------------------------------

### getActiveAccount

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=dependents

Returns the currently selected account in the Console Wallet.

```APIDOC
## GET /active-account

### Description
Returns the currently selected account in the Wallet.

### Method
GET

### Endpoint
/active-account

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **account** (object) - An object containing the basic data of the currently active account.

#### Response Example
```json
{
  "account": {
    "party": "activeParty",
    "name": "Selected Account"
  }
}
```
```

--------------------------------

### disconnect

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=dependents

Disconnects the DApp from the Console Wallet.

```APIDOC
## POST /disconnect

### Description
Disconnects the DApp from the wallet.

### Method
POST

### Endpoint
/disconnect

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **disconnected** (boolean) - Indicates if the disconnection was successful.

#### Response Example
```json
{
  "disconnected": true
}
```
```

--------------------------------

### signSend

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=dependents

Signs and broadcasts a transaction to send Canton Coin.

```APIDOC
## POST /sign-send

### Description
Signs and broadcasts a transaction to send Canton Coin.

### Method
POST

### Endpoint
/sign-send

### Parameters
#### Query Parameters
None

#### Request Body
- **data** (object) - Required - The transaction details.
  - **to** (string) - Required - The recipient's address.
  - **from** (string) - Required - The sender's address.
  - **amount** (number) - Required - The amount of Canton Coin to send.
  - **expireDate** (string) - Required - The expiration date of the transaction.

### Request Example
```json
{
  "data": {
    "to": "recipientAddress",
    "from": "senderAddress",
    "amount": 100,
    "expireDate": "2023-12-31T23:59:59Z"
  }
}
```

### Response
#### Success Response (200)
- **status** (boolean) - Indicates if the transaction was signed successfully.

#### Response Example
```json
{
  "status": true
}
```
```

--------------------------------

### getTokenTransfers

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=dependents

Retrieves a list of token transfers for a given party, with pagination support.

```APIDOC
## POST /get-token-transfers

### Description
Check party token transfers with pagination.

### Method
POST

### Endpoint
/get-token-transfers

### Parameters
#### Query Parameters
None

#### Request Body
- **data** (object) - Required - The request details.
  - **party** (string) - Required - The party whose token transfers to retrieve.
  - **limit** (number) - Optional - The maximum number of transfers to return per page.
  - **offset** (number) - Optional - The number of transfers to skip (for pagination).
  - **networkId** (string) - Optional - The network ID to check transfers on. Defaults to the active network.

### Request Example
```json
{
  "data": {
    "party": "partyAddress",
    "limit": 10,
    "offset": 0
  }
}
```

### Response
#### Success Response (200)
- **transfers** (array) - An array of token transfer objects.
- **total** (number) - The total number of token transfers available.

#### Response Example
```json
{
  "transfers": [
    {
      "id": "transfer1",
      "from": "senderParty",
      "to": "recipientParty",
      "amount": 50,
      "currency": "TOKEN_A",
      "timestamp": "2023-10-27T10:00:00Z"
    }
  ],
  "total": 100
}
```
```

--------------------------------

### getTokenTransfer

Source: https://www.npmjs.com/package/@console-wallet/dapp-sdk/package/%40console-wallet/dapp-sdk/v/0.0_activeTab=dependents

Retrieves the details of a specific token transfer.

```APIDOC
## POST /get-token-transfer

### Description
Check party token transfer details.

### Method
POST

### Endpoint
/get-token-transfer

### Parameters
#### Query Parameters
None

#### Request Body
- **data** (object) - Required - The request details.
  - **transferId** (string) - Required - The ID of the token transfer to retrieve.
  - **party** (string) - Required - The party associated with the transfer.
  - **networkId** (string) - Optional - The network ID where the transfer occurred. Defaults to the active network.

### Request Example
```json
{
  "data": {
    "transferId": "transfer1",
    "party": "partyAddress"
  }
}
```

### Response
#### Success Response (200)
- **transfer** (object) - The details of the token transfer.

#### Response Example
```json
{
  "transfer": {
    "id": "transfer1",
    "from": "senderParty",
    "to": "recipientParty",
    "amount": 50,
    "currency": "TOKEN_A",
    "timestamp": "2023-10-27T10:00:00Z"
  }
}
```
```
Tokens:
Raw