@avaprotocol/sdk-js 4.0.0-dev.0 → 4.0.0-dev.2

package/dist/v4/protocols/uniswap-v3.js

@@ -0,0 +1,197 @@
+// Uniswap V3 whitelist context — Router02 / QuoterV2 / Permit2 / Factory
+// / NonfungiblePositionManager addresses per chain, plus the ABI
+// fragments templates routinely need to compose swaps and quotes.
+//
+// Address parity with studio's per-chain data files:
+//   sepolia       → app/lib/uniswap/v3/data/sepolia.json
+//   ethereum      → app/lib/uniswap/v3/data/ethereum.json
+//   base          → app/lib/uniswap/v3/data/base.json
+//   base-sepolia  → app/lib/uniswap/v3/data/base-sepolia.json
+//
+// Studio's per-chain pool registries (`pools[]`) intentionally NOT
+// migrated — they're 25+ entries per chain, change frequently, and
+// belong to studio's UI discovery layer. Template tests that need a
+// specific pool address pass it inline; the catalog ships the
+// canonical contract addresses, not the indexed pool universe.
+import { Chains } from "../chains";
+/** SwapRouter02 — the entry point for exactInput/exactOutput swaps. */
+const swapRouter02 = {
+    [Chains.EthereumMainnet]: "0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45",
+    [Chains.Sepolia]: "0x3bFA4769FB09eefC5a80d6E87c3B9C650f7Ae48E",
+    [Chains.BaseMainnet]: "0x2626664c2603336E57B271c5C0b26F421741e481",
+    [Chains.BaseSepolia]: "0x94cC0AaC535CCDB3C01d6787D6413C739ae12bc4",
+};
+/** QuoterV2 — off-chain quote helper for swap previews. */
+const quoterV2 = {
+    [Chains.EthereumMainnet]: "0x61fFE014bA17989E743c5F6cB21bF9697530B21e",
+    [Chains.Sepolia]: "0xEd1f6473345F45b75F8179591dd5bA1888cf2FB3",
+    [Chains.BaseMainnet]: "0x3d4e44Eb1374240CE5F1B871ab261CD16335B76a",
+    [Chains.BaseSepolia]: "0xC5290058841028F1614F3A6F0F5816cAd0df5E27",
+};
+/**
+ * Permit2 — Uniswap's universal token-permit contract. Deployed at the
+ * SAME address across all chains in the catalog.
+ */
+const permit2 = {
+    [Chains.EthereumMainnet]: "0x000000000022d473030F116dDEE9F6B43aC78BA3",
+    [Chains.Sepolia]: "0x000000000022d473030F116dDEE9F6B43aC78BA3",
+    [Chains.BaseMainnet]: "0x000000000022d473030F116dDEE9F6B43aC78BA3",
+    [Chains.BaseSepolia]: "0x000000000022d473030F116dDEE9F6B43aC78BA3",
+};
+/** Uniswap V3 Factory — derives the deterministic pool address per token-pair+fee. */
+const factory = {
+    [Chains.EthereumMainnet]: "0x1F98431c8aD98523631AE4a59f267346ea31F984",
+    [Chains.Sepolia]: "0x0227628f3F023bb0B980b67D528571c95c6DaC1c",
+    [Chains.BaseMainnet]: "0x33128a8fC17869897dcE68Ed026d694621f6FDfD",
+    [Chains.BaseSepolia]: "0x4752ba5DBc23f44D87826276BF6Fd6b1C372aD24",
+};
+/** NonfungiblePositionManager — LP NFT mint/burn/collect. */
+const nonfungiblePositionManager = {
+    [Chains.EthereumMainnet]: "0xC36442b4a4522E871399CD717aBDD847Ab11FE88",
+    [Chains.Sepolia]: "0x1238536071E1c677A632429e3655c799b22cDA52",
+    [Chains.BaseMainnet]: "0x03a520b32C04BF3bEEf7BEb72E919cf822Ed34f1",
+    [Chains.BaseSepolia]: "0x27F971cb582BF9E50F397e4d29a5C7A34f11faA2",
+};
+/** UniversalRouter — Uniswap's multi-step routing entrypoint (Permit2-aware). */
+const universalRouter = {
+    [Chains.EthereumMainnet]: "0x66a9893cc07d91d95644aedd05d03f95e1dba8af",
+    [Chains.Sepolia]: "0x3A9D48AB9751398BbFa63ad67599Bb04e4BdF98b",
+    [Chains.BaseMainnet]: "0x6ff5693b99212da76ad316178a184ab56d299b43",
+    [Chains.BaseSepolia]: "0x492e6456d9528771018deb9e87ef7750ef184104",
+};
+/**
+ * SwapRouter02 ABI — `exactInputSingle` + `exactOutputSingle`. These
+ * are the two single-hop swap methods stoploss-style and DCA-style
+ * templates use; multi-hop variants (`exactInput` / `exactOutput`)
+ * take a `path` bytes blob and aren't included until a template
+ * actually needs them.
+ */
+const swapRouter02Abi = Object.freeze([
+    {
+        inputs: [
+            {
+                components: [
+                    { internalType: "address", name: "tokenIn", type: "address" },
+                    { internalType: "address", name: "tokenOut", type: "address" },
+                    { internalType: "uint24", name: "fee", type: "uint24" },
+                    { internalType: "address", name: "recipient", type: "address" },
+                    { internalType: "uint256", name: "amountIn", type: "uint256" },
+                    { internalType: "uint256", name: "amountOutMinimum", type: "uint256" },
+                    { internalType: "uint160", name: "sqrtPriceLimitX96", type: "uint160" },
+                ],
+                internalType: "struct IV3SwapRouter.ExactInputSingleParams",
+                name: "params",
+                type: "tuple",
+            },
+        ],
+        name: "exactInputSingle",
+        outputs: [{ internalType: "uint256", name: "amountOut", type: "uint256" }],
+        stateMutability: "payable",
+        type: "function",
+    },
+    {
+        inputs: [
+            {
+                components: [
+                    { internalType: "address", name: "tokenIn", type: "address" },
+                    { internalType: "address", name: "tokenOut", type: "address" },
+                    { internalType: "uint24", name: "fee", type: "uint24" },
+                    { internalType: "address", name: "recipient", type: "address" },
+                    { internalType: "uint256", name: "amountOut", type: "uint256" },
+                    { internalType: "uint256", name: "amountInMaximum", type: "uint256" },
+                    { internalType: "uint160", name: "sqrtPriceLimitX96", type: "uint160" },
+                ],
+                internalType: "struct IV3SwapRouter.ExactOutputSingleParams",
+                name: "params",
+                type: "tuple",
+            },
+        ],
+        name: "exactOutputSingle",
+        outputs: [{ internalType: "uint256", name: "amountIn", type: "uint256" }],
+        stateMutability: "payable",
+        type: "function",
+    },
+]);
+/**
+ * QuoterV2 ABI — `quoteExactInputSingle` for off-chain price preview.
+ * Note: this is a state-changing call in QuoterV2 (the contract uses
+ * `revert` to return the quote) — eth_call against an archive node is
+ * the standard usage, which the SDK's `contractRead` supports.
+ */
+const quoterV2Abi = Object.freeze([
+    {
+        inputs: [
+            {
+                components: [
+                    { internalType: "address", name: "tokenIn", type: "address" },
+                    { internalType: "address", name: "tokenOut", type: "address" },
+                    { internalType: "uint256", name: "amountIn", type: "uint256" },
+                    { internalType: "uint24", name: "fee", type: "uint24" },
+                    { internalType: "uint160", name: "sqrtPriceLimitX96", type: "uint160" },
+                ],
+                internalType: "struct IQuoterV2.QuoteExactInputSingleParams",
+                name: "params",
+                type: "tuple",
+            },
+        ],
+        name: "quoteExactInputSingle",
+        outputs: [
+            { internalType: "uint256", name: "amountOut", type: "uint256" },
+            { internalType: "uint160", name: "sqrtPriceX96After", type: "uint160" },
+            { internalType: "uint32", name: "initializedTicksCrossed", type: "uint32" },
+            { internalType: "uint256", name: "gasEstimate", type: "uint256" },
+        ],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+]);
+/**
+ * Factory ABI — `getPool` resolves the canonical pool address for a
+ * (tokenA, tokenB, fee) triple. Useful when a template starts from a
+ * pair + fee tier rather than a known pool.
+ */
+const factoryAbi = Object.freeze([
+    {
+        inputs: [
+            { internalType: "address", name: "tokenA", type: "address" },
+            { internalType: "address", name: "tokenB", type: "address" },
+            { internalType: "uint24", name: "fee", type: "uint24" },
+        ],
+        name: "getPool",
+        outputs: [{ internalType: "address", name: "pool", type: "address" }],
+        stateMutability: "view",
+        type: "function",
+    },
+]);
+/**
+ * Reference token addresses on the testnet markets these templates
+ * routinely target. Mainnet tokens vary per template — pass them
+ * inline rather than relying on a global registry the catalog
+ * doesn't yet maintain.
+ */
+const tokens = Object.freeze({
+    WETH: {
+        [Chains.Sepolia]: "0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14",
+        [Chains.EthereumMainnet]: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+        [Chains.BaseMainnet]: "0x4200000000000000000000000000000000000006",
+        [Chains.BaseSepolia]: "0x4200000000000000000000000000000000000006",
+    },
+    USDC: {
+        [Chains.Sepolia]: "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238",
+        [Chains.EthereumMainnet]: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+        [Chains.BaseMainnet]: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
+        [Chains.BaseSepolia]: "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
+    },
+});
+export const uniswapV3 = Object.freeze({
+    swapRouter02,
+    quoterV2,
+    permit2,
+    factory,
+    nonfungiblePositionManager,
+    universalRouter,
+    swapRouter02Abi,
+    quoterV2Abi,
+    factoryAbi,
+    tokens,
+});

package/dist/v4/protocols/wrapped.d.ts

@@ -0,0 +1,6 @@
+import { type AbiFragment } from "./types";
+export declare const wrapped: Readonly<{
+    weth: Partial<Record<number, `0x${string}`>>;
+    wethAbi: readonly AbiFragment[];
+}>;
+//# sourceMappingURL=wrapped.d.ts.map

package/dist/v4/protocols/wrapped.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrapped.d.ts","sourceRoot":"","sources":["../../../src/v4/protocols/wrapped.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,WAAW,EAAuB,MAAM,SAAS,CAAC;AAkDhE,eAAO,MAAM,OAAO;;;EAGlB,CAAC"}

package/dist/v4/protocols/wrapped.js

@@ -0,0 +1,55 @@
+// Wrapped Ether (WETH) — the canonical native-ETH wrapping contract.
+// Mainnet WETH is a one-off; Base (and Base Sepolia) use the OP-stack
+// predeploy at 0x4200…0006. Sepolia is the Uniswap-deployed test WETH
+// used by AAVE Sepolia and Uniswap Sepolia.
+import { Chains } from "../chains";
+const weth = {
+    [Chains.EthereumMainnet]: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+    [Chains.Sepolia]: "0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14",
+    [Chains.BaseMainnet]: "0x4200000000000000000000000000000000000006",
+    [Chains.BaseSepolia]: "0x4200000000000000000000000000000000000006",
+};
+/**
+ * WETH9 ABI — `deposit` (payable wrap) + `withdraw` (unwrap) + the
+ * standard ERC-20 surface templates rely on. `deposit` is payable
+ * with no args; the wrap amount comes from `msg.value`, so the
+ * contractWrite node must surface an editable value field — keep
+ * stateMutability: "payable" so the SDK builder doesn't hide it.
+ */
+const wethAbi = Object.freeze([
+    {
+        inputs: [],
+        name: "deposit",
+        outputs: [],
+        stateMutability: "payable",
+        type: "function",
+    },
+    {
+        inputs: [{ internalType: "uint256", name: "wad", type: "uint256" }],
+        name: "withdraw",
+        outputs: [],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    {
+        inputs: [
+            { internalType: "address", name: "guy", type: "address" },
+            { internalType: "uint256", name: "wad", type: "uint256" },
+        ],
+        name: "approve",
+        outputs: [{ internalType: "bool", name: "", type: "bool" }],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    {
+        inputs: [{ internalType: "address", name: "", type: "address" }],
+        name: "balanceOf",
+        outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+        stateMutability: "view",
+        type: "function",
+    },
+]);
+export const wrapped = Object.freeze({
+    weth,
+    wethAbi,
+});

package/dist/v4/resources/executions.d.ts

@@ -31,6 +31,12 @@ export interface StreamExecutionParams {
     /** Optional AbortSignal to close the stream early. */
     signal?: AbortSignal;
 }
+/**
+ * `client.executions.*` — read-only access to past workflow runs and
+ * a live SSE stream for in-flight ones. Workflow executions are
+ * created by the operator when a trigger fires (or by `workflows.trigger`
+ * for manual runs); this resource never creates them, only reads.
+ */
 export declare class ExecutionsResource {
     private readonly transport;
     constructor(transport: Transport);

package/dist/v4/resources/executions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"executions.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/executions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,MAAM,WAAW,oBAAoB;IACnC,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,qBAAa,kBAAkB;IACjB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,sBAAsB;IACtB,IAAI,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC;IAO7D,gEAAgE;IAChE,eAAe,CACb,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC3D,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC;IAO5B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC;IAO5E,oDAAoD;IACpD,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,EAAE,CAAC,sBAAsB,CAAC;IAO1F,4BAA4B;IAC5B,KAAK,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,EAAE,CAAC,cAAc,CAAC;IAOjE,4BAA4B;IAC5B,KAAK,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,EAAE,CAAC,cAAc,CAAC;IAOhE;;;;;;OAMG;IACI,MAAM,CACX,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,GAC5B,cAAc,CAAC,EAAE,CAAC,sBAAsB,EAAE,IAAI,EAAE,SAAS,CAAC;IAwC7D;;;;OAIG;IACG,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,EAAE,CAAC,sBAAsB,CAAC;CAatC"}
+{"version":3,"file":"executions.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/executions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,MAAM,WAAW,oBAAoB;IACnC,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;;;;GAKG;AACH,qBAAa,kBAAkB;IACjB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,sBAAsB;IACtB,IAAI,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC;IAO7D,gEAAgE;IAChE,eAAe,CACb,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC3D,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC;IAO5B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC;IAO5E,oDAAoD;IACpD,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,EAAE,CAAC,sBAAsB,CAAC;IAO1F,4BAA4B;IAC5B,KAAK,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,EAAE,CAAC,cAAc,CAAC;IAOjE,4BAA4B;IAC5B,KAAK,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,EAAE,CAAC,cAAc,CAAC;IAOhE;;;;;;OAMG;IACI,MAAM,CACX,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,GAC5B,cAAc,CAAC,EAAE,CAAC,sBAAsB,EAAE,IAAI,EAAE,SAAS,CAAC;IAwC7D;;;;OAIG;IACG,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,EAAE,CAAC,sBAAsB,CAAC;CAatC"}

package/dist/v4/resources/executions.js

@@ -1,3 +1,9 @@
+/**
+ * `client.executions.*` — read-only access to past workflow runs and
+ * a live SSE stream for in-flight ones. Workflow executions are
+ * created by the operator when a trigger fires (or by `workflows.trigger`
+ * for manual runs); this resource never creates them, only reads.
+ */
 export class ExecutionsResource {
     constructor(transport) {
         this.transport = transport;

package/dist/v4/resources/health.d.ts

@@ -1,9 +1,19 @@
 import type { v4 } from "@avaprotocol/types";
 import { Transport } from "../internal/transport";
-/** `client.health.check()` — liveness probe; no auth required. */
+/**
+ * `client.health.*` — gateway liveness + version probes.
+ *
+ * Anonymous (no Bearer token required) — safe to call from
+ * unauthenticated browser code or external monitors.
+ */
 export declare class HealthResource {
     private readonly transport;
     constructor(transport: Transport);
+    /**
+     * GET /health — returns `{ status, chainId, version }` when the
+     * gateway is up. Use for liveness checks; do not rely on it for
+     * deep readiness (it doesn't probe worker connectivity).
+     */
     check(): Promise<v4.HealthStatus>;
 }
 //# sourceMappingURL=health.d.ts.map

package/dist/v4/resources/health.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"health.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/health.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,kEAAkE;AAClE,qBAAa,cAAc;IACb,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,KAAK,IAAI,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC;CAGlC"}
+{"version":3,"file":"health.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/health.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD;;;;;GAKG;AACH,qBAAa,cAAc;IACb,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC;CAGlC"}

package/dist/v4/resources/health.js

@@ -1,8 +1,18 @@
-/** `client.health.check()` — liveness probe; no auth required. */
+/**
+ * `client.health.*` — gateway liveness + version probes.
+ *
+ * Anonymous (no Bearer token required) — safe to call from
+ * unauthenticated browser code or external monitors.
+ */
 export class HealthResource {
     constructor(transport) {
         this.transport = transport;
     }
+    /**
+     * GET /health — returns `{ status, chainId, version }` when the
+     * gateway is up. Use for liveness checks; do not rely on it for
+     * deep readiness (it doesn't probe worker connectivity).
+     */
     check() {
         return this.transport.request({ path: "/health" });
     }

package/dist/v4/resources/nodes.d.ts

@@ -1,9 +1,29 @@
 import type { v4 } from "@avaprotocol/types";
 import { Transport } from "../internal/transport";
+/**
+ * `client.nodes.*` — execute a single node definition in isolation,
+ * without persisting a workflow. Used by the Studio UI's per-node
+ * "Run once" affordance and by SDK test suites that exercise a node
+ * shape against a live gateway.
+ */
 export declare class NodesResource {
     private readonly transport;
     constructor(transport: Transport);
-    /** POST /nodes:run — execute a single node against inline input. */
+    /**
+     * POST /nodes:run — execute one node against inline `inputVariables`.
+     *
+     * The request shape mirrors a single entry from `workflows.simulate`:
+     * a complete node definition + the variables the node would have seen
+     * inside a workflow. The gateway runs the node in-process (no worker
+     * delegation, no persistence) and returns the raw output keyed by
+     * node type — `{ success, output: { <nodeType>: {...} } }`.
+     *
+     * Chain context: the gateway resolves the target chain in this order:
+     * `body.chainId` → `inputVariables.settings.chain_id` → the JWT's
+     * `aud` claim → the gateway's default chain. Specify `chainId`
+     * explicitly when calling a contract that lives on a non-default
+     * chain (e.g. a sepolia oracle when the gateway defaults to mainnet).
+     */
     run(req: v4.RunNodeRequest): Promise<v4.RunNodeResponse>;
 }
 //# sourceMappingURL=nodes.d.ts.map

package/dist/v4/resources/nodes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nodes.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/nodes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,qBAAa,aAAa;IACZ,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,oEAAoE;IACpE,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,GAAG,OAAO,CAAC,EAAE,CAAC,eAAe,CAAC;CAOzD"}
+{"version":3,"file":"nodes.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/nodes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD;;;;;GAKG;AACH,qBAAa,aAAa;IACZ,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,GAAG,OAAO,CAAC,EAAE,CAAC,eAAe,CAAC;CAOzD"}

package/dist/v4/resources/nodes.js

@@ -1,8 +1,28 @@
+/**
+ * `client.nodes.*` — execute a single node definition in isolation,
+ * without persisting a workflow. Used by the Studio UI's per-node
+ * "Run once" affordance and by SDK test suites that exercise a node
+ * shape against a live gateway.
+ */
 export class NodesResource {
     constructor(transport) {
         this.transport = transport;
     }
-    /** POST /nodes:run — execute a single node against inline input. */
+    /**
+     * POST /nodes:run — execute one node against inline `inputVariables`.
+     *
+     * The request shape mirrors a single entry from `workflows.simulate`:
+     * a complete node definition + the variables the node would have seen
+     * inside a workflow. The gateway runs the node in-process (no worker
+     * delegation, no persistence) and returns the raw output keyed by
+     * node type — `{ success, output: { <nodeType>: {...} } }`.
+     *
+     * Chain context: the gateway resolves the target chain in this order:
+     * `body.chainId` → `inputVariables.settings.chain_id` → the JWT's
+     * `aud` claim → the gateway's default chain. Specify `chainId`
+     * explicitly when calling a contract that lives on a non-default
+     * chain (e.g. a sepolia oracle when the gateway defaults to mainnet).
+     */
     run(req) {
         return this.transport.request({
             path: "/nodes:run",

package/dist/v4/resources/operators.d.ts

@@ -1,9 +1,23 @@
 import type { v4 } from "@avaprotocol/types";
 import { Transport } from "../internal/transport";
+/**
+ * `client.operators.*` — read-only view of the operator pool the
+ * gateway is currently dispatching to. Used by dashboards and the
+ * Studio sidebar's network-health widget; not part of the workflow
+ * lifecycle.
+ */
 export declare class OperatorsResource {
     private readonly transport;
     constructor(transport: Transport);
-    /** GET /operators — connected operators + capabilities. */
+    /**
+     * GET /operators — every operator currently connected to the
+     * gateway, plus their advertised capabilities (block / time /
+     * event monitoring) and the timestamp of their last heartbeat.
+     *
+     * An empty array means no operators are connected — workflows will
+     * still accept, but won't execute until at least one operator
+     * comes online.
+     */
     list(): Promise<v4.OperatorList>;
 }
 //# sourceMappingURL=operators.d.ts.map

package/dist/v4/resources/operators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operators.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/operators.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,qBAAa,iBAAiB;IAChB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,2DAA2D;IAC3D,IAAI,IAAI,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC;CAGjC"}
+{"version":3,"file":"operators.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/operators.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD;;;;;GAKG;AACH,qBAAa,iBAAiB;IAChB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD;;;;;;;;OAQG;IACH,IAAI,IAAI,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC;CAGjC"}

package/dist/v4/resources/operators.js

@@ -1,8 +1,22 @@
+/**
+ * `client.operators.*` — read-only view of the operator pool the
+ * gateway is currently dispatching to. Used by dashboards and the
+ * Studio sidebar's network-health widget; not part of the workflow
+ * lifecycle.
+ */
 export class OperatorsResource {
     constructor(transport) {
         this.transport = transport;
     }
-    /** GET /operators — connected operators + capabilities. */
+    /**
+     * GET /operators — every operator currently connected to the
+     * gateway, plus their advertised capabilities (block / time /
+     * event monitoring) and the timestamp of their last heartbeat.
+     *
+     * An empty array means no operators are connected — workflows will
+     * still accept, but won't execute until at least one operator
+     * comes online.
+     */
     list() {
         return this.transport.request({ path: "/operators" });
     }

package/dist/v4/resources/secrets.d.ts

@@ -11,6 +11,16 @@ export interface DeleteSecretParams {
     workflowId?: string;
     orgId?: string;
 }
+/**
+ * `client.secrets.*` — write-only secret store, scoped to the
+ * authenticated user. Values are referenced from workflow nodes via
+ * `{{secrets.NAME}}` template variables and are decrypted server-side
+ * at execution time; the SDK never receives the plaintext value back.
+ *
+ * `put` is a single idempotent endpoint replacing v3's create + update
+ * split — sending the same name twice rotates the value silently
+ * rather than erroring.
+ */
 export declare class SecretsResource {
     private readonly transport;
     constructor(transport: Transport);

package/dist/v4/resources/secrets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"secrets.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/secrets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,MAAM,WAAW,iBAAiB;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,2DAA2D;IAC3D,IAAI,CAAC,MAAM,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC;IAOxD,0DAA0D;IAC1D,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ3D,6BAA6B;IAC7B,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;CAOjE"}
+{"version":3,"file":"secrets.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/secrets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,MAAM,WAAW,iBAAiB;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;GASG;AACH,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,2DAA2D;IAC3D,IAAI,CAAC,MAAM,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC;IAOxD,0DAA0D;IAC1D,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ3D,6BAA6B;IAC7B,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;CAOjE"}

package/dist/v4/resources/secrets.js

@@ -1,3 +1,13 @@
+/**
+ * `client.secrets.*` — write-only secret store, scoped to the
+ * authenticated user. Values are referenced from workflow nodes via
+ * `{{secrets.NAME}}` template variables and are decrypted server-side
+ * at execution time; the SDK never receives the plaintext value back.
+ *
+ * `put` is a single idempotent endpoint replacing v3's create + update
+ * split — sending the same name twice rotates the value silently
+ * rather than erroring.
+ */
 export class SecretsResource {
     constructor(transport) {
         this.transport = transport;

package/dist/v4/resources/tokens.d.ts

@@ -1,13 +1,25 @@
 import type { v4 } from "@avaprotocol/types";
 import { Transport } from "../internal/transport";
+/**
+ * `client.tokens.*` — ERC-20 metadata resolution backed by the
+ * aggregator's curated whitelist plus an on-chain `name/symbol/decimals`
+ * fallback. Used by the Studio token-picker, transfer-preview UI, and
+ * the notification cost-line renderer.
+ */
 export declare class TokensResource {
     private readonly transport;
     constructor(transport: Transport);
     /**
-     * GET /tokens/{address} — returns `{ found: false }` (not 404)
-     * when the token is not in the aggregator's whitelist and the
-     * on-chain fallback fails. Partial info (the address) is still
-     * useful to callers.
+     * GET /tokens/{address} — resolve a token by contract address.
+     *
+     * Returns `{ found: false, address }` (not 404) when the token
+     * isn't on the whitelist and the on-chain probe also fails — the
+     * partial response keeps the caller's UI from breaking on
+     * unrecognized tokens.
+     *
+     * `opts.chainId` picks which chain's whitelist + RPC to consult.
+     * Omit it to fall back to the JWT's `aud` chain (the gateway's
+     * default chain context for the authenticated user).
      */
     retrieve(address: string, opts?: {
         chainId?: number;

package/dist/v4/resources/tokens.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/tokens.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,qBAAa,cAAc;IACb,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,EAAE,CAAC,qBAAqB,CAAC;CAM1F"}
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/tokens.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD;;;;;GAKG;AACH,qBAAa,cAAc;IACb,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,EAAE,CAAC,qBAAqB,CAAC;CAM1F"}

package/dist/v4/resources/tokens.js

@@ -1,12 +1,24 @@
+/**
+ * `client.tokens.*` — ERC-20 metadata resolution backed by the
+ * aggregator's curated whitelist plus an on-chain `name/symbol/decimals`
+ * fallback. Used by the Studio token-picker, transfer-preview UI, and
+ * the notification cost-line renderer.
+ */
 export class TokensResource {
     constructor(transport) {
         this.transport = transport;
     }
     /**
-     * GET /tokens/{address} — returns `{ found: false }` (not 404)
-     * when the token is not in the aggregator's whitelist and the
-     * on-chain fallback fails. Partial info (the address) is still
-     * useful to callers.
+     * GET /tokens/{address} — resolve a token by contract address.
+     *
+     * Returns `{ found: false, address }` (not 404) when the token
+     * isn't on the whitelist and the on-chain probe also fails — the
+     * partial response keeps the caller's UI from breaking on
+     * unrecognized tokens.
+     *
+     * `opts.chainId` picks which chain's whitelist + RPC to consult.
+     * Omit it to fall back to the JWT's `aud` chain (the gateway's
+     * default chain context for the authenticated user).
      */
     retrieve(address, opts) {
         return this.transport.request({

package/dist/v4/resources/triggers.d.ts

@@ -1,9 +1,29 @@
 import type { v4 } from "@avaprotocol/types";
 import { Transport } from "../internal/transport";
+/**
+ * `client.triggers.*` — evaluate a trigger config in isolation,
+ * mirroring the per-node `nodes.run` shape. Use when designing or
+ * debugging a trigger before wiring it into a full workflow — e.g.
+ * confirming that an `eventTrigger` topic filter matches a known
+ * historical event, or that a cron expression parses.
+ */
 export declare class TriggersResource {
     private readonly transport;
     constructor(transport: Transport);
-    /** POST /triggers:run — evaluate a trigger config against inline input. */
+    /**
+     * POST /triggers:run — evaluate a trigger config against inline
+     * input and return the same shape an executor would see.
+     *
+     * For event triggers, the gateway uses Tenderly to simulate a
+     * matching event log against the request's `addresses` + `topics`
+     * filter, then returns the decoded log under `output.data` and
+     * the raw log under `output.metadata`.
+     *
+     * For time-based triggers (cron, fixedTime, block), the response
+     * carries the next scheduled fire time / block height.
+     *
+     * No workflow record is created and no execution is persisted.
+     */
     run(req: v4.RunTriggerRequest): Promise<v4.RunTriggerResponse>;
 }
 //# sourceMappingURL=triggers.d.ts.map

package/dist/v4/resources/triggers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"triggers.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/triggers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,qBAAa,gBAAgB;IACf,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,2EAA2E;IAC3E,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,iBAAiB,GAAG,OAAO,CAAC,EAAE,CAAC,kBAAkB,CAAC;CAO/D"}
+{"version":3,"file":"triggers.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/triggers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD;;;;;;GAMG;AACH,qBAAa,gBAAgB;IACf,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,iBAAiB,GAAG,OAAO,CAAC,EAAE,CAAC,kBAAkB,CAAC;CAO/D"}

package/dist/v4/resources/triggers.js

@@ -1,8 +1,28 @@
+/**
+ * `client.triggers.*` — evaluate a trigger config in isolation,
+ * mirroring the per-node `nodes.run` shape. Use when designing or
+ * debugging a trigger before wiring it into a full workflow — e.g.
+ * confirming that an `eventTrigger` topic filter matches a known
+ * historical event, or that a cron expression parses.
+ */
 export class TriggersResource {
     constructor(transport) {
         this.transport = transport;
     }
-    /** POST /triggers:run — evaluate a trigger config against inline input. */
+    /**
+     * POST /triggers:run — evaluate a trigger config against inline
+     * input and return the same shape an executor would see.
+     *
+     * For event triggers, the gateway uses Tenderly to simulate a
+     * matching event log against the request's `addresses` + `topics`
+     * filter, then returns the decoded log under `output.data` and
+     * the raw log under `output.metadata`.
+     *
+     * For time-based triggers (cron, fixedTime, block), the response
+     * carries the next scheduled fire time / block height.
+     *
+     * No workflow record is created and no execution is persisted.
+     */
     run(req) {
         return this.transport.request({
             path: "/triggers:run",