@latchprotocol/widgets 0.1.0

package/dist/adapters/viem.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Live protocol adapter, backed by viem.
+ *
+ * This is the implementation that produces **real calldata** and submits real
+ * transactions. It is the swap and liquidity call paths from `src/callpath/`
+ * wired to a viem `PublicClient` for reads and a wallet for writes.
+ *
+ * ## What it can and cannot do today
+ *
+ * Bounded honestly, feature by feature:
+ *
+ * - **Encoding** is complete and unit-tested. `buildSwap`, `buildAddLiquidity`
+ *   and `buildRemoveLiquidity` produce the exact calldata the router and
+ *   position managers decode, integrator fee step included.
+ * - **Launches** are read from the launch guards, keyed by pool id: CL pools
+ *   from `contracts.launchGuardHook`, Bin pools from `contracts.binLaunchGuardHook`.
+ *   With neither configured every launch read throws
+ *   `ChainConfigError` rather than guessing an address. On a chain with no
+ *   `LaunchGuardHook` deployed, that is the correct and only answer.
+ * - **Token, balance and allowance reads** are ordinary ERC-20 and Permit2
+ *   calls and will work against any chain that has them.
+ * - **Pool discovery** is not on-chain: the singleton has no pool enumeration.
+ *   Pass the pools you support, or wire an indexer (`@latchprotocol/sdk/indexer`
+ *   describes the schema).
+ * - **Quoting** requires either a deployed quoter or a host-supplied function.
+ *   Without one, `quoteSwap` throws {@link UnsupportedOperationError} rather
+ *   than inventing a number - a fabricated quote is worse than no quote.
+ */
+import { type Address, type Hex, type PublicClient } from "viem";
+import type { ChainConfig } from "../config/chain.js";
+import { type SwapHop } from "../callpath/swap.js";
+import { type AddLiquidityQuote, type AddLiquidityQuoteRequest, type PoolInfo, type PoolState, type PositionInfo, type ProtocolAdapter, type RemoveLiquidityQuote, type SwapQuoteRequest, type SwapQuoteResult, type TokenInfo } from "./protocol.js";
+/** Minimal wallet surface. Any wallet stack that can sign satisfies this. */
+export interface WidgetWallet {
+    /** Currently selected account, or `null`. */
+    getAccount(): Promise<Address | null>;
+    /** Submits a transaction and returns its hash. */
+    sendTransaction(request: {
+        to: Address;
+        data: Hex;
+        value: bigint;
+    }): Promise<Hex>;
+}
+/**
+ * Host-supplied functions for the parts the protocol cannot answer on its own.
+ *
+ * Each one is optional. Omitting a function makes the corresponding widget
+ * feature fail loudly with a named error instead of degrading to invented data.
+ */
+export interface ViemAdapterOverrides {
+    quoteSwap?: (request: SwapQuoteRequest, pools: readonly PoolInfo[]) => Promise<SwapQuoteResult>;
+    quoteAddLiquidity?: (request: AddLiquidityQuoteRequest) => Promise<AddLiquidityQuote>;
+    quoteRemoveLiquidity?: (position: PositionInfo, percentBps: number) => Promise<RemoveLiquidityQuote>;
+    listPositions?: (owner: Address, pool?: PoolInfo) => Promise<readonly PositionInfo[]>;
+    getPoolState?: (pool: PoolInfo) => Promise<PoolState>;
+    /** Resolves a route. Defaults to a direct pool match over `pools`. */
+    findRoute?: (tokenIn: TokenInfo, tokenOut: TokenInfo, pools: readonly PoolInfo[]) => readonly SwapHop[];
+}
+/** Options for {@link createViemAdapter}. */
+export interface ViemAdapterOptions {
+    readonly chain: ChainConfig;
+    readonly publicClient: PublicClient;
+    readonly wallet?: WidgetWallet;
+    /** Tokens offered in the picker. There is no on-chain token registry. */
+    readonly tokens: readonly TokenInfo[];
+    /**
+     * Pools this integrator supports. There is no on-chain pool enumeration.
+     *
+     * Launch pools live in this list too: a launch is a pool. `listLaunches`
+     * selects the ones whose key names `contracts.launchGuardHook`, so there is
+     * no separate launch list to keep in sync.
+     */
+    readonly pools: readonly PoolInfo[];
+    /**
+     * The block the position managers were deployed at (or any earlier one).
+     *
+     * Neither position manager enumerates a holder's positions, so
+     * `listPositions` reconstructs them from `Transfer` / `TransferBatch` logs
+     * addressed to the owner and confirms each against live state. The scan
+     * starts here. Without it `listPositions` throws rather than scanning from
+     * genesis, which public endpoints refuse and which would read as "no
+     * positions" when it silently returned nothing.
+     */
+    readonly positionsFromBlock?: bigint;
+    readonly overrides?: ViemAdapterOverrides;
+}
+/** Creates the live, viem-backed adapter. */
+export declare function createViemAdapter(options: ViemAdapterOptions): ProtocolAdapter;
+//# sourceMappingURL=viem.d.ts.map

package/dist/adapters/viem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"viem.d.ts","sourceRoot":"","sources":["../../src/adapters/viem.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,OAAO,EAML,KAAK,OAAO,EACZ,KAAK,GAAG,EACR,KAAK,YAAY,EAClB,MAAM,MAAM,CAAC;AA2Ld,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAStD,OAAO,EAAiB,KAAK,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAsBlE,OAAO,EAIL,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,EAG7B,KAAK,QAAQ,EAEb,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,KAAK,eAAe,EAEpB,KAAK,oBAAoB,EAEzB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,SAAS,EAGf,MAAM,eAAe,CAAC;AAIvB,6EAA6E;AAC7E,MAAM,WAAW,YAAY;IAC3B,6CAA6C;IAC7C,UAAU,IAAI,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IACtC,kDAAkD;IAClD,eAAe,CAAC,OAAO,EAAE;QACvB,EAAE,EAAE,OAAO,CAAC;QACZ,IAAI,EAAE,GAAG,CAAC;QACV,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,QAAQ,EAAE,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;IAChG,iBAAiB,CAAC,EAAE,CAAC,OAAO,EAAE,wBAAwB,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACtF,oBAAoB,CAAC,EAAE,CACrB,QAAQ,EAAE,YAAY,EACtB,UAAU,EAAE,MAAM,KACf,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACnC,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,SAAS,YAAY,EAAE,CAAC,CAAC;IACtF,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IACtD,sEAAsE;IACtE,SAAS,CAAC,EAAE,CACV,OAAO,EAAE,SAAS,EAClB,QAAQ,EAAE,SAAS,EACnB,KAAK,EAAE,SAAS,QAAQ,EAAE,KACvB,SAAS,OAAO,EAAE,CAAC;CACzB;AAED,6CAA6C;AAC7C,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC;IAC/B,yEAAyE;IACzE,QAAQ,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;IACtC;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;IACpC;;;;;;;;;OASG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,SAAS,CAAC,EAAE,oBAAoB,CAAC;CAC3C;AA2kCD,6CAA6C;AAC7C,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,eAAe,CAE9E"}

package/dist/callpath/constants.d.ts

@@ -0,0 +1,218 @@
+/**
+ * Command, action and sentinel constants for the LatchProtocol call path.
+ *
+ * These mirror the on-chain libraries and must be kept in step with them:
+ *
+ * - commands: `packages/router/src/libraries/Commands.sol`
+ * - actions:  `packages/periphery/src/libraries/Actions.sol`
+ * - sentinels:`packages/periphery/src/libraries/ActionConstants.sol`
+ *
+ * They are transcribed rather than imported because the Solidity is GPL-2.0 and
+ * this package is MIT. Constants carry no copyright; the encoding logic here is
+ * written against the ABI, not derived from the sources.
+ */
+import type { Address } from "viem";
+/** Universal-router command ids. */
+export declare const COMMANDS: {
+    readonly SWEEP: 4;
+    readonly TRANSFER: 5;
+    /** Pays a bps portion of the router's balance of a token to a recipient. */
+    readonly PAY_PORTION: 6;
+    readonly WRAP_ETH: 11;
+    readonly UNWRAP_WETH: 12;
+    /** Runs an encoded periphery action plan inside one vault lock. */
+    readonly INFI_SWAP: 16;
+};
+/** Periphery action ids. */
+export declare const ACTIONS: {
+    readonly CL_INCREASE_LIQUIDITY: 0;
+    readonly CL_DECREASE_LIQUIDITY: 1;
+    readonly CL_MINT_POSITION: 2;
+    readonly CL_BURN_POSITION: 3;
+    readonly CL_SWAP_EXACT_IN_SINGLE: 6;
+    readonly CL_SWAP_EXACT_IN: 7;
+    readonly CL_SWAP_EXACT_OUT_SINGLE: 8;
+    readonly CL_SWAP_EXACT_OUT: 9;
+    readonly SETTLE: 11;
+    readonly SETTLE_ALL: 12;
+    readonly SETTLE_PAIR: 13;
+    readonly TAKE: 14;
+    readonly TAKE_ALL: 15;
+    /** Takes a bps portion of the open credit straight to a recipient. */
+    readonly TAKE_PORTION: 16;
+    readonly TAKE_PAIR: 17;
+    readonly CLOSE_CURRENCY: 18;
+    readonly CLEAR_OR_TAKE: 19;
+    readonly SWEEP: 20;
+    readonly BIN_ADD_LIQUIDITY: 25;
+    readonly BIN_REMOVE_LIQUIDITY: 26;
+    readonly BIN_SWAP_EXACT_IN_SINGLE: 28;
+    readonly BIN_SWAP_EXACT_IN: 29;
+    readonly BIN_SWAP_EXACT_OUT_SINGLE: 30;
+    readonly BIN_SWAP_EXACT_OUT: 31;
+};
+/** Recipient sentinel: the account that called the router. */
+export declare const MSG_SENDER: Address;
+/** Recipient sentinel: the router contract itself. */
+export declare const ADDRESS_THIS: Address;
+/** Amount sentinel: use the whole open delta for this currency. */
+export declare const OPEN_DELTA = 0n;
+/** Amount sentinel: use the contract's entire balance. */
+export declare const CONTRACT_BALANCE: bigint;
+/** Address used by the router's payment helpers to mean native value. */
+export declare const NATIVE_SENTINEL: Address;
+/** Scale used by liquidity-book distribution weights. */
+export declare const BIN_DISTRIBUTION_SCALE: bigint;
+/** Minimal ABI for `UniversalRouter.execute`. */
+export declare const UNIVERSAL_ROUTER_ABI: readonly [{
+    readonly type: "function";
+    readonly name: "execute";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly name: "commands";
+        readonly type: "bytes";
+    }, {
+        readonly name: "inputs";
+        readonly type: "bytes[]";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [];
+}];
+/** Minimal ABI for the position managers' batched entry point. */
+export declare const POSITION_MANAGER_ABI: readonly [{
+    readonly type: "function";
+    readonly name: "modifyLiquidities";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly name: "unlockData";
+        readonly type: "bytes";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [];
+}];
+/** Minimal ERC-20 surface the widgets need. */
+export declare const ERC20_ABI: readonly [{
+    readonly type: "function";
+    readonly name: "approve";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "allowance";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "balanceOf";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "decimals";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "symbol";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "name";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+    }];
+}];
+/** Permit2's allowance surface, used for the second half of the approval flow. */
+export declare const PERMIT2_ABI: readonly [{
+    readonly type: "function";
+    readonly name: "allowance";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "user";
+        readonly type: "address";
+    }, {
+        readonly name: "token";
+        readonly type: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "amount";
+        readonly type: "uint160";
+    }, {
+        readonly name: "expiration";
+        readonly type: "uint48";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint48";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "approve";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint160";
+    }, {
+        readonly name: "expiration";
+        readonly type: "uint48";
+    }];
+    readonly outputs: readonly [];
+}];
+/** Largest value Permit2 will store as an allowance amount. */
+export declare const MAX_UINT160: bigint;
+/** Largest value Permit2 will store as an expiration. */
+export declare const MAX_UINT48: bigint;
+/** Largest ERC-20 allowance. */
+export declare const MAX_UINT256: bigint;
+//# sourceMappingURL=constants.d.ts.map

package/dist/callpath/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/callpath/constants.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEpC,oCAAoC;AACpC,eAAO,MAAM,QAAQ;;;IAGnB,4EAA4E;;;;IAI5E,mEAAmE;;CAE3D,CAAC;AAEX,4BAA4B;AAC5B,eAAO,MAAM,OAAO;;;;;;;;;;;;;;IAclB,sEAAsE;;;;;;;;;;;;CAY9D,CAAC;AAEX,8DAA8D;AAC9D,eAAO,MAAM,UAAU,EAAE,OAAsD,CAAC;AAEhF,sDAAsD;AACtD,eAAO,MAAM,YAAY,EAAE,OAAsD,CAAC;AAElF,mEAAmE;AACnE,eAAO,MAAM,UAAU,KAAK,CAAC;AAE7B,0DAA0D;AAC1D,eAAO,MAAM,gBAAgB,QAAa,CAAC;AAE3C,yEAAyE;AACzE,eAAO,MAAM,eAAe,EAAE,OAAsD,CAAC;AAErF,yDAAyD;AACzD,eAAO,MAAM,sBAAsB,QAAa,CAAC;AAEjD,iDAAiD;AACjD,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;EAYvB,CAAC;AAEX,kEAAkE;AAClE,eAAO,MAAM,oBAAoB;;;;;;;;;;;;EAWvB,CAAC;AAEX,+CAA+C;AAC/C,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiDZ,CAAC;AAEX,kFAAkF;AAClF,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4Bd,CAAC;AAEX,+DAA+D;AAC/D,eAAO,MAAM,WAAW,QAAoB,CAAC;AAE7C,yDAAyD;AACzD,eAAO,MAAM,UAAU,QAAmB,CAAC;AAE3C,gCAAgC;AAChC,eAAO,MAAM,WAAW,QAAoB,CAAC"}