@console-wallet/dapp-sdk 1.1.0 → 1.1.1

package/CHANGELOG.md

@@ -1,4 +1,31 @@
-# Changelog
+# Changelog 1.1.1
+
+Human‑readable diff between `1.1.0` and `1.1.1` .
+
+## Update — 2025-12-22
+
+- Added support for batch transaction signing.
+
+### Features
+
+- Added `signBatch(data)` request to sign and broadcast multiple transactions in a single call.
+- Introduced `SignBatchRequest` and `SignBatchResponse` types to support batch operations.
+
+### Requests Exports
+
+- Exported `signBatch` from `src/requests/index.ts`.
+
+### Documentation
+
+- Updated README Supported Requests table to include `signBatch`.
+
+# -
+# -
+# -
+# - 
+# -
+
+# Changelog 1.1.0
 
 Human‑readable diff between `1.0.0` and `1.1.0` .
 
@@ -34,3 +61,212 @@ Human‑readable diff between `1.0.0` and `1.1.0` .
 ### Internal
 
 - Tweaked `communication.types.ts` to keep request routing constants consistent.
+
+# -
+# -
+# -
+# - 
+# -
+
+# Changelog 1.0.0
+
+Human‑readable diff between `0.0.24` and `1.0.0` .
+
+## What Changed
+
+### New APIs
+
+- `status()` — returns current connection status (`ConnectResponse`).
+- Watch helpers:
+  - `onAccountsChanged(onChange)` — callback receives `GetAccountResponse`.
+  - `onConnectionStatusChanged(onChange)` — callback receives `ConnectResponse`.
+  - `onTxStatusChanged(onChange)` — callback receives `TxChangedEvent`.
+
+### API Renames and Alignments
+
+- `signSend(...)` → `submitCommands(...)` (same payload/flow, updated name).
+- `getActiveAccount()` → `getPrimaryAccount()` (clarifies the wallet-selected account).
+- `getTransfers(...)` → `getTokenTransfers(...)` (name reflects token transfer history).
+
+### Request/Response Types
+
+- Requests: `SignSendRequest`, `SignMessageRequest`, `TokenTransfersRequest`, `OffersRequest`, `TransferRequest`, `GetBalanceRequest`.
+- Responses: `SignSendResponse`, `SignedMessageResponse`, `TokenTransfersResponse`, `OffersResponse`, `TransferResponse`, `GetBalanceResponse`.
+- Connection: `ConnectRequest`, `ConnectResponse`, `DisconnectResponse`, `NetworkStatus`.
+- Network metadata: `Network`, `CANTON_NETWORK_VARIANTS`.
+
+### Type Updates (Network, Wallet)
+
+- `Network` (in `src/types/token.types.ts`): clarified fields and added documentation for `nativeTokenId`.
+  - Shape: `{ id: CANTON_NETWORK_VARIANTS; name; description; shortName?; icon?; synchronizerId?; identityProviderId; baseUrl; explorerUrl?; nativeTokenId }`
+  - Example:
+    ```ts
+    const network: Network = {
+      id: CANTON_NETWORK_VARIANTS.CANTON_NETWORK_DEV,
+      name: 'Canton Devnet',
+      description: 'Development network',
+      identityProviderId: 'auth-dev',
+      baseUrl: 'https://devnet.ccview.io',
+      explorerUrl: 'https://explorer.devnet.ccview.io',
+      nativeTokenId: 'CANTON_COIN',
+    };
+    ```
+
+- `Wallet` (in `src/types/account.type.ts`): clarified fields and associated helper types.
+  - Key fields: `primary`, `status ('initialized' | 'allocated')`, `partyId` (template literal type `${string}::${string}`), `hint`, `publicKey`, `namespace`, `networkId: CANTON_NETWORK_VARIANTS`, `signingProviderId`, `externalTxId?`, `topologyTransactions?`.
+  - Responses:
+    - `GetAccountsResponse = Wallet[] | undefined`
+    - `GetAccountResponse = Wallet | undefined`
+  - Example:
+    ```ts
+    const wallet: Wallet = {
+      primary: true,
+      status: 'initialized',
+      partyId: 'partyHint::partyId',
+      hint: 'partyHint',
+      publicKey: '0xabcdef...',
+      namespace: 'namespace-1',
+      networkId: CANTON_NETWORK_VARIANTS.CANTON_NETWORK_DEV,
+      signingProviderId: 'provider-123',
+    };
+    ```
+
+- `TokenData` / Balance types:
+  - `TokenData` includes `price` and optional `balanceUsd` for convenience.
+  - `GetBalanceResponse` returns `{ tokens: TokenData[]; isSplitedBalance: boolean; price: string }`.
+
+These updates are documentation‑focused (no breaking changes), improving intellisense and clarity around type shapes.
+
+### Additional Type Updates
+
+- Connection types (in `src/types/connect.type.ts`):
+  - `ConnectRequest`: `{ icon?: string; name?: string }`
+  - `ConnectStatus`: `'connected' | 'disconnected'`
+  - `NetworkStatus`: `boolean`
+  - `ConnectResponse`: `ConnectStatus`
+  - `DisconnectResponse`: `ConnectStatus`
+  - `ConnectRequestInternal`: `{ referer: `http://${string}` | `https://${string}` }` (wallet-internal)
+  - Example:
+    ```ts
+    const connectPayload: ConnectRequest = { name: 'My dApp', icon: 'https://...' };
+    const status: ConnectResponse = 'connected';
+    ```
+
+- Signing types (in `src/types/signed.type.ts`):
+  - `SignMessageRequest`: `{ message: { hex } | { base64 }; metaData?: Record<string,string> }`
+  - `SignedMessageResponse`: `string | undefined`
+  - `SignSendRequest`: `{ from; to; amount; expireDate; waitForFinalization?: number }`
+  - `SignSendResponse`: `{ status: boolean; signature?: string; confirmationData?: SendConfirmationDataType } | undefined`
+  - Example:
+    ```ts
+    const msgReq: SignMessageRequest = { message: { hex: '0xabc123' } };
+    const txReq: SignSendRequest = {
+      from: 'party::A',
+      to: 'party::B',
+      amount: '10',
+      expireDate: '2025-01-01',
+    };
+    ```
+
+- History/indexer types (in `src/types/history.types.ts`):
+  - `TokenTransfersQuery`: parameters of `api.indexer.tokenTransferByPartyIdV2`
+  - `TokenTransfersRequest`: `{ query: TokenTransfersQuery; network: CANTON_NETWORK_VARIANTS }`
+  - `TokenTransfersResponse`: `PagedByCombinedCursorResponseTokenTransferSummary | null`
+  - `OffersQuery`: parameters of `api.indexer.offerBySenderPartyV2`
+  - `OffersRequest`: `{ query: OffersQuery; network: CANTON_NETWORK_VARIANTS }`
+  - `OffersResponse`: `PagedByCombinedCursorResponseOffer | null`
+  - `TransferRequest`: `{ eventId: string; network: CANTON_NETWORK_VARIANTS }`
+  - `TransferResponse`: `Awaited<ReturnType<typeof api.indexer.tokenTransferByEventIdV2>> | null`
+
+- Helper utility types (in `src/types/helpers.types.ts`):
+  - `DiscriminantKeys<T>`: keys of `T` when object
+  - `ChildOf<T, K>`: type of property `K` from `T`
+  - `ElementType<T>`: element type of array `T`
+
+- Trigger types (in `src/types/txTriggers.type.ts`):
+  - `TxEventStatus`: `'pending' | 'signed' | 'executed' | 'failed'`
+  - Event payloads: `TxChangedSignedPayload`, `TxChangedExecutedPayload`
+  - Event unions: `TxChangedEvent = Pending | Signed | Executed | Failed`
+  - Example:
+    ```ts
+    const evSigned: TxChangedEvent = {
+      status: TxEventStatus.SIGNED,
+      commandId: 'cmd-123',
+      payload: { signature: '0x..', signedBy: 'party::A', party: 'party::A' },
+    };
+    ```
+
+### Documentation and Hints
+
+- README updated:
+  - Supported Requests table aligned to new names and types.
+  - New Watch Requests table (subscribe methods with payload types).
+- JSDoc standardized across requests and types for consistent intellisense.
+
+## Migration Guide (Before → After)
+
+### Signing and Sending
+
+- Before: `signSend(data)`
+- After: `submitCommands(data)`
+
+Example:
+
+```ts
+// before
+const res = await consoleWalletPixelplex.signSend({ from, to, amount, expireDate });
+
+// after
+const res = await consoleWalletPixelplex.submitCommands({ from, to, amount, expireDate });
+```
+
+### Account Access
+
+- Before: `getActiveAccount()`
+- After: `getPrimaryAccount()`
+
+```ts
+const account = await consoleWalletPixelplex.getPrimaryAccount();
+```
+
+### Transfers
+
+- Before: `getTransfers({ ... })`
+- After: `getTokenTransfers({ query, network })`
+
+```ts
+const transfers = await consoleWalletPixelplex.getTokenTransfers({ query, network });
+```
+
+### Connection Status
+
+- New: `status()` returns `ConnectResponse` (`'connected' | 'disconnected'`).
+- `isConnected()` returns `NetworkStatus` (`boolean`).
+
+```ts
+const s = await consoleWalletPixelplex.status(); // 'connected' | 'disconnected'
+const ok = await consoleWalletPixelplex.isConnected(); // true | false
+```
+
+### Watchers
+
+```ts
+onAccountsChanged((acc) => {
+  /* acc: GetAccountResponse */
+});
+onConnectionStatusChanged((st) => {
+  /* st: ConnectResponse */
+});
+onTxStatusChanged((ev) => {
+  /* ev: TxChangedEvent */
+});
+```
+
+## File‑Level Diff (Curated)
+
+- Added: `src/requests/getStatus.ts` (new `status()` request).
+- Added: `src/triggersNative/index.ts`, `onAccountsChanged.ts`, `onConnectionStatusChanged.ts`, `onTxChanged.ts`.
+- Added: `src/types/txTriggers.type.ts`.
+- Renamed: `src/requests/signSend.ts` → `src/requests/submitCommands.ts`.
+- Updated: request modules and types to reflect new names and stricter typing.
+- Updated: `README.md` to include the Watch Requests section and revised Supported Requests.

package/README.md

@@ -88,6 +88,7 @@ Each request is automatically tagged with a **unique request ID** to ensure reli
 | `getActiveNetwork()`     | Returns the currently selected network metadata.                            | —                                 | `Network`                         |
 | `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`               |
 | `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`                 |
 | `isConnected()`          | Checks if the network available.                                            | —                                 | `NetworkStatus`                   |

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

@@ -10,8 +10,9 @@ 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>;
-            proxyIndexerControllerProxyLegacy: (data: import("./generated-wallet-api").ProxyRequestDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetOffersSearchResponseDTO | import("./generated-wallet-api").GetPartyDetailsResponseDTO | import("./generated-wallet-api").GetPricesResponseDTO | import("./generated-wallet-api").GetTokenTransfersByPartyResponseDTO | import("./generated-wallet-api").GetTransferDetailsResponseDTO>;
+            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>;
             proxyW3AControllerProxy: (data: import("./generated-wallet-api").ProxyBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").ProxyResponseDTO>;
             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>;
@@ -22,15 +23,19 @@ export declare const api: {
                 partyId: string;
             }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").CoinsBalancesResponseDTO>;
             tokenStandardControllerGetPendingTransactions: (query: {
+                limit?: number | undefined;
+                offset?: number | undefined;
                 partyId: string;
             }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetPendingTransactionsResponseDTO>;
             tokenStandardControllerGetPendingTransactionsFull: (query: {
+                limit?: number | undefined;
+                offset?: number | undefined;
                 partyId: string;
             }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetPendingTransactionsFullResponseDTO>;
             tokenStandardControllerListUtxoHoldings: (query: {
                 partyId: string;
             }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").ListUtxosResponseDTO>;
-            transferControllerGetTransferPreApproval: (query: {
+            transferControllerGetTransferPreApprovalOrFail: (query: {
                 partyId: string;
             }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetTransferPreApprovalResponseDTO>;
             transferControllerPrepareBatchTransfer: (data: import("./generated-wallet-api").PrepareBatchTransferBodyDTO, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").PrepareBatchTransferResponseDTO>;
@@ -46,11 +51,13 @@ export declare const api: {
             }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").WaitForTxCompletionResponseDTO>;
             transferHistoryControllerGetTransfer: (id: number, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").TransferResponseDTO>;
             transferHistoryControllerGetTransfers: (query: {
-                coin: "CC" | "CBTC" | "USDCx";
+                coin?: "CC" | "CBTC" | "USDCx" | undefined;
                 filter?: "ALL" | "Pending" | "Accepted" | "Rejected" | undefined;
                 limit?: number | undefined;
                 offset?: number | undefined;
                 partyId: string;
+                receiver?: string | undefined;
+                sender?: string | undefined;
                 sortBy?: "createdAt" | undefined;
                 sortDirection?: "ASC" | "DESC" | undefined;
             }, params?: import("./generated-wallet-api").RequestParams) => Promise<import("./generated-wallet-api").GetTransfersHistoryResponseDTO>;