@temple-digital-group/temple-canton-js 2.0.0-beta.4 → 2.0.0-beta.6

package/README.md

@@ -45,13 +45,13 @@ setWalletAdapter(loop);
 
 ## Supported Instruments
 
-| Asset  | Type        | Networks         |
-| ------ | ----------- | ---------------- |
-| CC     | Canton Coin | testnet, mainnet |
-| USDCx  | Utility     | testnet, mainnet |
-| CBTC   | Utility     | testnet, mainnet |
+| Asset | Type        | Networks         |
+| ----- | ----------- | ---------------- |
+| CC    | Canton Coin | testnet, mainnet |
+| USDCx | Utility     | testnet, mainnet |
+| CBTC  | Utility     | testnet, mainnet |
 
-> **Symbol normalization:** `CC` is automatically normalized to `Amulet` in all API methods that accept a symbol (e.g. `CC/USDCx` becomes `Amulet/USDCx`).
+> **Symbol normalization:** Use `CC` for Canton Coin in all SDK methods. The SDK handles the internal conversion to `Amulet` where required by the ledger. The `Amulet` symbol is deprecated — all API responses now return `CC`.
 
 ## Supported Trading Pairs
 
@@ -112,19 +112,19 @@ const result = await depositFunds(depositOpts);
 
 `depositFunds` accepts:
 
-| Option           | Required | Description                                                   |
-| ---------------- | -------- | ------------------------------------------------------------- |
-| `sender`         | Yes      | Party allocating the assets                                   |
-| `assetId`        | Yes      | Instrument symbol (`USDCx`, `Amulet`, `CBTC`)                |
-| `amount`         | Yes      | Amount to allocate                                            |
-| `holdingCids`    | Yes      | Holding contract IDs that fund the allocation                 |
-| `receiver`       | No       | Counterparty (defaults to sender)                             |
-| `settlementId`   | No       | Reference ID for the settlement                               |
-| `transferLegId`  | No       | Unique ID for this transfer leg                               |
-| `allocateBefore` | No       | ISO timestamp; allocation deadline (default: +1h)             |
-| `settleBefore`   | No       | ISO timestamp; settlement deadline (default: +2h)             |
-| `disclosures`    | No       | Pre-fetched Amulet disclosures (for FE without API access)    |
-| `userId`         | No       | User ID (falls back to wallet adapter / config)               |
+| Option           | Required | Description                                                |
+| ---------------- | -------- | ---------------------------------------------------------- |
+| `sender`         | Yes      | Party allocating the assets                                |
+| `assetId`        | Yes      | Instrument symbol (`USDCx`, `Amulet`, `CBTC`)              |
+| `amount`         | Yes      | Amount to allocate                                         |
+| `holdingCids`    | Yes      | Holding contract IDs that fund the allocation              |
+| `receiver`       | No       | Counterparty (defaults to sender)                          |
+| `settlementId`   | No       | Reference ID for the settlement                            |
+| `transferLegId`  | No       | Unique ID for this transfer leg                            |
+| `allocateBefore` | No       | ISO timestamp; allocation deadline (default: +1h)          |
+| `settleBefore`   | No       | ISO timestamp; settlement deadline (default: +2h)          |
+| `disclosures`    | No       | Pre-fetched Amulet disclosures (for FE without API access) |
+| `userId`         | No       | User ID (falls back to wallet adapter / config)            |
 
 For Amulet deposits, the SDK fetches disclosures automatically. You can also pass them manually via `opts.disclosures`.
 
@@ -228,8 +228,6 @@ Each entry in the returned array contains:
 }
 ```
 
-
-
 ### Merge Holdings
 
 ```javascript
@@ -252,6 +250,94 @@ const res = await walletProvider.submitTransaction(cmd);
 const counts = await getUtxoCount(partyId, "USDCx", walletProvider);
 ```
 
+## WebSocket — Real-Time Data
+
+Subscribe to live market data and user events via WebSocket. Works in both Node.js and browsers.
+
+The server has two types of data:
+
+- **Market data** — public channels you explicitly subscribe to (orderbook, trades, ticker, candles, oracle)
+- **User data** — automatically pushed after authentication, no subscribe needed (orders, trades, balances)
+
+```javascript
+import {
+	subscribeOrderbook,
+	subscribeTrades,
+	subscribeTicker,
+	subscribeCandles,
+	subscribeUserOrders,
+	subscribeUserTrades,
+	subscribeUserBalances,
+	disconnectWebSocket,
+} from "@temple-digital-group/temple-canton-js";
+
+// Market data — sends a subscribe message to the server
+const unsub = subscribeOrderbook("Amulet/USDCx", (data) => {
+	console.log("Orderbook update:", data);
+});
+subscribeTrades("Amulet/USDCx", (data) => console.log("Trade:", data));
+subscribeTicker("CBTC/USDCx", (data) => console.log("Ticker:", data));
+subscribeCandles("Amulet/USDCx", 60, (data) => console.log("1m candle:", data));
+
+// User data — auto-delivered after auth, no subscribe message needed
+subscribeUserOrders((data) => console.log("Order update:", data));
+subscribeUserTrades((data) => console.log("Trade fill:", data));
+subscribeUserBalances((data) => console.log("Balance update:", data));
+
+// Unsubscribe from a specific channel
+unsub();
+
+// Disconnect everything
+disconnectWebSocket();
+```
+
+### Market Data Channels
+
+These require an explicit subscribe message. The SDK handles this automatically.
+
+| Function                                    | Channel                          | Example                   |
+| ------------------------------------------- | -------------------------------- | ------------------------- |
+| `subscribeOrderbook(symbol, cb)`            | `orderbook:{symbol}`             | `orderbook:Amulet/USDCx` |
+| `subscribeTrades(symbol, cb)`               | `trades:{symbol}`                | `trades:Amulet/USDCx`    |
+| `subscribeTicker(symbol, cb)`               | `ticker:{symbol}`                | `ticker:CBTC/USDCx`      |
+| `subscribeCandles(symbol, granularity, cb)` | `candles:{symbol}:{granularity}` | `candles:Amulet/USDCx:60`|
+| `subscribeOracle(symbol, cb)`               | `oracle:{symbol}`                | `oracle:cc`               |
+| `subscribeOracleVolume(symbol, cb)`         | `oracle_volume:{symbol}`         | `oracle_volume:cc`        |
+
+**Candle granularity values:** `60` (1m), `300` (5m), `900` (15m), `3600` (1h), `14400` (4h), `86400` (1d)
+
+### User Data Events
+
+Pushed automatically by the server after authentication. No subscribe message is sent — you just register a local handler. Requires `API_KEY` (Node.js) or cookie auth (browser).
+
+| Function                   | Server Event   | Description                                        |
+| -------------------------- | -------------- | -------------------------------------------------- |
+| `subscribeUserOrders(cb)`  | `user_order`   | Order lifecycle updates (created, filled, cancelled)|
+| `subscribeUserTrades(cb)`  | `user_trade`   | Trade fill confirmations                           |
+| `subscribeUserBalances(cb)`| `user_balance` | Balance changes                                    |
+
+### Advanced Usage
+
+Use the `TempleWebSocket` class directly for full control:
+
+```javascript
+import { TempleWebSocket } from "@temple-digital-group/temple-canton-js";
+
+const ws = new TempleWebSocket();
+ws.onConnect = () => console.log("Connected");
+ws.onDisconnect = (code, reason) => console.log("Disconnected:", code, reason);
+ws.onAuth = (success, userId) => console.log("Auth:", success, userId);
+ws.onError = (err) => console.error("WS error:", err);
+ws.autoReconnect = true; // default — reconnects with exponential backoff
+ws.connect();
+
+// Market data — sends subscribe to server
+const unsub = ws.subscribe("orderbook:Amulet/USDCx", (data) => { ... });
+
+// User data — no subscribe message, just local handler
+const unsubOrder = ws.onUserEvent("user_order", (data) => { ... });
+```
+
 ## API Reference
 
 > Functions marked with **W** support Loop Wallet via the wallet adapter.
@@ -272,36 +358,36 @@ const counts = await getUtxoCount(partyId, "USDCx", walletProvider);
 
 ### Onboarding & Delegation
 
-| Function                              | Provider | Description                                            |
-| ------------------------------------- | -------- | ------------------------------------------------------ |
-| `isUserOnboarded(party)`              | **W**    | Check if user has a delegation contract on ledger      |
-| `onboardUser(party)`                  | **W**    | Create the delegation contract needed for trading      |
-| `withdrawDelegation(delegationId?, user?)` | **W** | Archive the delegation contract (user must re-onboard) |
+| Function                                   | Provider | Description                                            |
+| ------------------------------------------ | -------- | ------------------------------------------------------ |
+| `isUserOnboarded(party)`                   | **W**    | Check if user has a delegation contract on ledger      |
+| `onboardUser(party)`                       | **W**    | Create the delegation contract needed for trading      |
+| `withdrawDelegation(delegationId?, user?)` | **W**    | Archive the delegation contract (user must re-onboard) |
 
 ### Deposits & Withdrawals
 
-| Function                                 | Provider | Description                                                  |
-| ---------------------------------------- | -------- | ------------------------------------------------------------ |
-| `prepareDepositHoldings(amount, assetId)` | **W**   | Resolve holdings for a deposit amount                        |
-| `depositFunds(opts)`                     | **W**    | Deposit funds into the user's trading balance                |
-| `withdrawFunds({ asset_id, amount })`    | **W**    | Withdraw available trading balance back to wallet            |
-| `emergencyWithdrawFunds(opts)`           | **W**    | Cancel all orders and withdraw everything immediately        |
+| Function                                  | Provider | Description                                           |
+| ----------------------------------------- | -------- | ----------------------------------------------------- |
+| `prepareDepositHoldings(amount, assetId)` | **W**    | Resolve holdings for a deposit amount                 |
+| `depositFunds(opts)`                      | **W**    | Deposit funds into the user's trading balance         |
+| `withdrawFunds({ asset_id, amount })`     | **W**    | Withdraw available trading balance back to wallet     |
+| `emergencyWithdrawFunds(opts)`            | **W**    | Cancel all orders and withdraw everything immediately |
 
 ### Holdings
 
-| Function                                                          | Provider | Description                                                    |
-| ----------------------------------------------------------------- | -------- | -------------------------------------------------------------- |
-| `getUserBalances(party?, provider?)`                              | **W**    | Get all balances grouped by asset (Amulet, locked, and utility) |
-| `getAmuletHoldingsForParty(party, returnCommand, provider)`      | **W**    | Get Amulet holdings                                            |
-| `getLockedAmuletHoldingsForParty(party, returnCommand, provider)`| **W**    | Get locked Amulet holdings                                     |
-| `getUtilityHoldingsForParty(party, returnCommand, provider)`     | **W**    | Get utility token holdings                                     |
-| `getUtxoCount(party, assetId, provider)`                         | **W**    | Get UTXO summary: counts, largest unlocked amount, and total unlocked balance |
+| Function                                                          | Provider | Description                                                                   |
+| ----------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------- |
+| `getUserBalances(party?, provider?)`                              | **W**    | Get all balances grouped by asset (Amulet, locked, and utility)               |
+| `getAmuletHoldingsForParty(party, returnCommand, provider)`       | **W**    | Get Amulet holdings                                                           |
+| `getLockedAmuletHoldingsForParty(party, returnCommand, provider)` | **W**    | Get locked Amulet holdings                                                    |
+| `getUtilityHoldingsForParty(party, returnCommand, provider)`      | **W**    | Get utility token holdings                                                    |
+| `getUtxoCount(party, assetId, provider)`                          | **W**    | Get UTXO summary: counts, largest unlocked amount, and total unlocked balance |
 
 ### Holding Operations
 
-| Function                                                                                   | Provider | Description                    |
-| ------------------------------------------------------------------------------------------ | -------- | ------------------------------ |
-| `mergeAmuletHoldingsForParty(party, returnCommand, provider, maxUtxos, amuletDisclosures)` | **W**    | Merge Amulet holdings into one |
+| Function                                                                                   | Provider | Description                     |
+| ------------------------------------------------------------------------------------------ | -------- | ------------------------------- |
+| `mergeAmuletHoldingsForParty(party, returnCommand, provider, maxUtxos, amuletDisclosures)` | **W**    | Merge Amulet holdings into one  |
 | `mergeUtilityHoldingsForParty(party, utilityAsset, returnCommand, provider, maxUtxos)`     | **W**    | Merge utility holdings into one |
 
 ### Temple REST API
@@ -310,10 +396,10 @@ const counts = await getUtxoCount(partyId, "USDCx", walletProvider);
 
 #### Auth
 
-| Function                            | Description                                         |
-| ----------------------------------- | --------------------------------------------------- |
-| `setApiKey(key)`                    | Set the API key for REST API authentication         |
-| `getUserId()`                       | Get the stored user ID                              |
+| Function         | Description                                 |
+| ---------------- | ------------------------------------------- |
+| `setApiKey(key)` | Set the API key for REST API authentication |
+| `getUserId()`    | Get the stored user ID                      |
 
 #### Market Data
 
@@ -327,24 +413,40 @@ const counts = await getUtxoCount(partyId, "USDCx", walletProvider);
 
 #### Trading
 
-| Function                                    | Description                                    |
-| ------------------------------------------- | ---------------------------------------------- |
-| `createOrderRequest(opts)`                  | Place a buy/sell order via the trading backend  |
-| `cancelOrder(orderId)`                      | Cancel a specific order                        |
-| `cancelAllOrders(options?)`                 | Cancel all orders (options: `symbol` filter)   |
-| `getTradingBalance()`                       | Get user's trading balance (unlocked/locked/in-flight) |
-| `getActiveOrders(options?)`                 | Get active orders (options: `symbol`, `limit`) |
+| Function                    | Description                                            |
+| --------------------------- | ------------------------------------------------------ |
+| `createOrderRequest(opts)`  | Place a buy/sell order via the trading backend         |
+| `cancelOrder(orderId)`      | Cancel a specific order                                |
+| `cancelAllOrders(options?)` | Cancel all orders (options: `symbol` filter)           |
+| `getTradingBalance()`       | Get user's trading balance (unlocked/locked/in-flight) |
+| `getActiveOrders(options?)` | Get active orders (options: `symbol`, `limit`)         |
 
 #### Withdrawals
 
-| Function                                    | Description                                            |
-| ------------------------------------------- | ------------------------------------------------------ |
-| `createWithdrawalRequest(assetId, amount)`  | Submit a withdrawal request to the backend             |
-| `getWithdrawalRequestStatus(requestId)`     | Poll withdrawal status until ready                     |
+| Function                                   | Description                                |
+| ------------------------------------------ | ------------------------------------------ |
+| `createWithdrawalRequest(assetId, amount)` | Submit a withdrawal request to the backend |
+| `getWithdrawalRequestStatus(requestId)`    | Poll withdrawal status until ready         |
 
 #### Disclosures & Delegation
 
-| Function                  | Description                                                                     |
-| ------------------------- | ------------------------------------------------------------------------------- |
-| `getDisclosures(partyId)` | Get Amulet disclosure data (factory ID, choice context, disclosed contracts)    |
-| `getDelegation()`         | Get the user's delegation contract from the API                                 |
+| Function                  | Description                                                                  |
+| ------------------------- | ---------------------------------------------------------------------------- |
+| `getDisclosures(partyId)` | Get Amulet disclosure data (factory ID, choice context, disclosed contracts) |
+| `getDelegation()`         | Get the user's delegation contract from the API                              |
+
+### WebSocket
+
+| Function                                    | Description                                                    |
+| ------------------------------------------- | -------------------------------------------------------------- |
+| `createWebSocket()`                         | Get or create the shared WS instance (auto-connects)           |
+| `disconnectWebSocket()`                     | Disconnect and destroy the shared WS instance                  |
+| `subscribeOrderbook(symbol, cb)`            | Subscribe to orderbook updates                                 |
+| `subscribeTrades(symbol, cb)`               | Subscribe to trade updates                                     |
+| `subscribeTicker(symbol, cb)`               | Subscribe to ticker updates                                    |
+| `subscribeCandles(symbol, granularity, cb)` | Subscribe to candle updates                                    |
+| `subscribeOracle(symbol, cb)`               | Subscribe to oracle price updates                              |
+| `subscribeOracleVolume(symbol, cb)`         | Subscribe to oracle volume updates                             |
+| `subscribeUserOrders(cb)`                   | Listen to user order events (auto-pushed, no subscribe needed) |
+| `subscribeUserTrades(cb)`                   | Listen to user trade events (auto-pushed, no subscribe needed) |
+| `subscribeUserBalances(cb)`                 | Listen to user balance events (auto-pushed, no subscribe needed)|

package/dist/api/index.d.ts

@@ -1,5 +1,5 @@
-import type { ApiError, Ticker, OrderBook, OrderBookOptions, SymbolConfig, OpenInterest, Trade, RecentTradesOptions, ActiveOrder, ActiveOrdersOptions, CancelOrderResponse, CancelAllOrdersOptions, CancelAllOrdersResponse, CreateOrderRequestOpts, CreateOrderRequestResponse, DelegationResponse, WithdrawalResponse, WithdrawalStatusResponse, TradingBalanceResponse, AmuletDisclosure, DisclosuresResponse } from "./types.js";
-export type { ApiError, Ticker, OrderBook, OrderBookOptions, SymbolConfig, OpenInterest, Trade, RecentTradesOptions, ActiveOrder, ActiveOrdersOptions, CancelOrderResponse, CancelAllOrdersOptions, CancelAllOrdersResponse, CreateOrderRequestResponse, DelegationResponse, WithdrawalResponse, WithdrawalStatusResponse, TradingBalanceResponse, AmuletDisclosure, DisclosuresResponse, };
+import type { ApiError, Ticker, OrderBook, OrderBookOptions, SymbolConfig, OpenInterest, Trade, RecentTradesOptions, ActiveOrder, ActiveOrdersOptions, CancelOrderResponse, BatchCancelOrdersResponse, CancelAllOrdersOptions, CancelAllOrdersResponse, CreateOrderRequestOpts, CreateOrderRequestResponse, BatchCreateOrderRequestResponse, DelegationResponse, WithdrawalResponse, WithdrawalStatusResponse, TradingBalanceResponse, AmuletDisclosure, DisclosuresResponse } from "./types.js";
+export type { ApiError, Ticker, OrderBook, OrderBookOptions, SymbolConfig, OpenInterest, Trade, RecentTradesOptions, ActiveOrder, ActiveOrdersOptions, CancelOrderResponse, BatchCancelOrdersResponse, CancelAllOrdersOptions, CancelAllOrdersResponse, CreateOrderRequestResponse, BatchCreateOrderRequestResponse, DelegationResponse, WithdrawalResponse, WithdrawalStatusResponse, TradingBalanceResponse, AmuletDisclosure, DisclosuresResponse, };
 export { getUserId } from "./tokenStore.js";
 export { setWalletAdapter } from "../../src/config/index.js";
 /**
@@ -40,10 +40,15 @@ export declare function getRecentTrades(symbol: string, options?: RecentTradesOp
  */
 export declare function getActiveOrders(options?: ActiveOrdersOptions): Promise<ActiveOrder[] | ApiError>;
 /**
- * Cancel a specific order by ID.
+ * Cancel a single order by ID.
  * @param orderId - The order ID to cancel
  */
 export declare function cancelOrder(orderId: string): Promise<CancelOrderResponse | ApiError>;
+/**
+ * Cancel multiple orders by ID (max 20).
+ * @param orderIds - Array of order IDs to cancel
+ */
+export declare function cancelOrder(orderIds: string[]): Promise<BatchCancelOrdersResponse | ApiError>;
 /**
  * Cancel all active orders, optionally filtered by symbol.
  * @param options - Optional symbol filter
@@ -61,9 +66,10 @@ export declare function getDisclosures(partyId: string): Promise<DisclosuresResp
 export declare function getDelegation(): Promise<DelegationResponse | ApiError>;
 /**
  * Create an order request (limit buy/sell) on the Temple trading backend.
- * @param opts - Order parameters: symbol, side, quantity, price, order_type, expires_at
+ * @param opts - Single order or array of orders (max 20)
  */
 export declare function createOrderRequest(opts: CreateOrderRequestOpts): Promise<CreateOrderRequestResponse | ApiError>;
+export declare function createOrderRequest(opts: CreateOrderRequestOpts[]): Promise<BatchCreateOrderRequestResponse | ApiError>;
 /**
  * Create a withdrawal request.
  * @param assetId - Instrument symbol (e.g. "USDCx", "Amulet")

package/dist/api/index.js

@@ -154,15 +154,20 @@ export async function getActiveOrders(options = {}) {
         limit: options.limit,
     });
 }
-/**
- * Cancel a specific order by ID.
- * @param orderId - The order ID to cancel
- */
-export async function cancelOrder(orderId) {
-    if (!orderId) {
+export async function cancelOrder(orderIdOrIds) {
+    if (Array.isArray(orderIdOrIds)) {
+        if (orderIdOrIds.length === 0) {
+            return { error: true, status: null, code: "INVALID_PARAMS", message: "At least one order ID is required." };
+        }
+        if (orderIdOrIds.length > 20) {
+            return { error: true, status: null, code: "INVALID_PARAMS", message: "Maximum 20 order IDs per batch." };
+        }
+        return authenticatedPost("/api/trading/orders/cancel", { order_ids: orderIdOrIds });
+    }
+    if (!orderIdOrIds) {
         return { error: true, status: null, code: "INVALID_PARAMS", message: "Order ID is required." };
     }
-    return authenticatedPost(`/api/trading/orders/${encodeURIComponent(orderId)}/cancel`);
+    return authenticatedPost("/api/trading/orders/cancel", { order_id: orderIdOrIds });
 }
 /**
  * Cancel all active orders, optionally filtered by symbol.
@@ -190,12 +195,23 @@ export async function getDisclosures(partyId) {
 export async function getDelegation() {
     return authenticatedGet("/api/trading/delegation");
 }
-// ── Order Requests ──
-/**
- * Create an order request (limit buy/sell) on the Temple trading backend.
- * @param opts - Order parameters: symbol, side, quantity, price, order_type, expires_at
- */
 export async function createOrderRequest(opts) {
+    if (Array.isArray(opts)) {
+        if (opts.length === 0) {
+            return { error: true, status: null, code: "INVALID_PARAMS", message: "At least one order is required." };
+        }
+        if (opts.length > 20) {
+            return { error: true, status: null, code: "INVALID_PARAMS", message: "Maximum 20 orders per batch." };
+        }
+        const body = opts.map((o) => {
+            const { symbol: rawSymbol, side, quantity, price, order_type = "limit", expires_at } = o;
+            const order = { symbol: normalizeSymbol(rawSymbol), side, quantity: Number(quantity), price: Number(price), order_type };
+            if (expires_at)
+                order.expires_at = expires_at;
+            return order;
+        });
+        return authenticatedPost("/api/trading/orders", body);
+    }
     const { symbol: rawSymbol, side, quantity, price, order_type = "limit", expires_at } = opts || {};
     if (!rawSymbol || !side || quantity == null || price == null) {
         return { error: true, status: null, code: "INVALID_PARAMS", message: "symbol, side, quantity, and price are required." };

package/dist/api/types.d.ts

@@ -72,6 +72,13 @@ export interface CancelOrderResponse {
     already_queued: boolean;
     message: string;
 }
+export interface BatchCancelOrdersResponse {
+    success: boolean;
+    canceled: string[];
+    already_queued: string[];
+    not_found: string[];
+    message: string;
+}
 export interface CancelAllOrdersOptions {
     symbol?: string;
 }
@@ -98,6 +105,12 @@ export interface CreateOrderRequestOpts {
     order_type?: string;
     expires_at?: string;
 }
+export interface BatchCreateOrderRequestResponse {
+    success: boolean;
+    request_ids: number[];
+    count: number;
+    message: string;
+}
 export interface CreateOrderRequestResponse {
     [key: string]: unknown;
 }

package/dist/canton/deposits.d.ts

@@ -0,0 +1,52 @@
+export interface DepositFundsOpts {
+    sender: string;
+    receiver?: string;
+    assetId: string;
+    amount: string | number;
+    holdingCids?: string[];
+    settlementId?: string;
+    transferLegId?: string;
+    allocateBefore?: string;
+    settleBefore?: string;
+    disclosures?: Record<string, unknown>;
+    userId?: string;
+}
+export interface PreparedDeposit {
+    sender: string;
+    receiver: string;
+    assetId: string;
+    amount: string;
+    holdingCids: string[];
+}
+/**
+ * Prepare holdings for a deposit by selecting UTXOs from the wallet provider.
+ *
+ * Queries the provider for holdings, filters and sorts them, then greedily
+ * selects until the requested amount is covered.
+ */
+export declare function prepareDepositHoldings(amount: number | string, symbol: string): Promise<PreparedDeposit | {
+    error: string;
+    data?: Record<string, unknown>;
+}>;
+/**
+ * High-level deposit helper.
+ *
+ * Wraps `prepareDepositHoldings` and `depositFunds` into a single call.
+ * Validates the user has sufficient balance and reserves 10 CC for transaction fees.
+ *
+ * Requires:
+ * - Wallet adapter (for reading balances and submitting)
+ * - API connection (for disclosures on Amulet deposits)
+ */
+export declare function deposit(amount: number | string, symbol: string): Promise<Record<string, unknown>>;
+/**
+ * Create a CIP-56 Allocation.
+ * Fetches the AllocationFactory, then exercises AllocationFactory_Allocate
+ * to lock holdings for a settlement leg.
+ *
+ * Three resolution paths:
+ * 1. Localhost: resolve factory and context from ledger directly
+ * 2. Amulet via disclosures (FE/proxy path — no Scan API access)
+ * 3. Remote: Scan API / Registry API
+ */
+export declare function depositFunds(opts: DepositFundsOpts, returnCommand?: boolean): Promise<Record<string, unknown>>;