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

package/dist/index.js

@@ -419,6 +419,11 @@ var HealthResource = class {
   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" });
   }
@@ -429,7 +434,21 @@ var NodesResource = class {
   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",
@@ -444,7 +463,15 @@ var OperatorsResource = class {
   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" });
   }
@@ -486,10 +513,16 @@ var TokensResource = class {
     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({
@@ -504,7 +537,20 @@ var TriggersResource = class {
   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",
@@ -519,13 +565,29 @@ var WalletsResource = class {
   constructor(transport) {
     this.transport = transport;
   }
-  /** GET /wallets */
+  /**
+   * GET /wallets — every smart wallet owned by the authenticated
+   * EOA on the JWT's audience chain.
+   *
+   * Hidden wallets (`isHidden=true`) are excluded by default. The
+   * response is an envelope `{ data: Wallet[] }`, not a bare array.
+   */
   list() {
     return this.transport.request({ path: "/wallets" });
   }
   /**
    * POST /wallets — idempotent "ensure exists". Derives the CREATE2
-   * address from (owner, salt, factory) and persists the record.
+   * address from `(owner, salt, factory)` and persists the record;
+   * calling twice with the same triple returns the same address.
+   *
+   * The on-chain account is **not** deployed by this call — deployment
+   * happens lazily as part of the first UserOp (workflow execution or
+   * `withdraw`) via the `initCode` field, so the smart wallet costs
+   * zero gas until it's first used.
+   *
+   * Per-owner cap is enforced by `max_wallets_per_owner` in the
+   * aggregator config; the call returns 429 `WALLETS_LIMIT_REACHED`
+   * when exceeded.
    */
   create(req) {
     return this.transport.request({
@@ -535,8 +597,11 @@ var WalletsResource = class {
     });
   }
   /**
-   * PATCH /wallets/{address} — partial update. Today the only
-   * mutable field is `isHidden`.
+   * PATCH /wallets/{address} — partial update. The only mutable
+   * field today is `isHidden`, used by the Studio UI's hide/unhide
+   * wallet action. Keyed by **address**, not salt — callers that
+   * still think in salts must look up the address first via
+   * `create({ salt })`.
    */
   update(address, body) {
     return this.transport.request({
@@ -545,7 +610,18 @@ var WalletsResource = class {
       body
     });
   }
-  /** POST /wallets/{address}:withdraw — UserOp-driven withdraw. */
+  /**
+   * POST /wallets/{address}:withdraw — transfer ETH or an ERC-20 out
+   * of the smart wallet via a UserOp through the bundler + paymaster.
+   *
+   * Per-chain config (bundler URL, paymaster address, RPC) is resolved
+   * by the gateway from the JWT's `aud` claim or `body.chainId`.
+   * The response's `status` is one of `pending | confirmed | failed`:
+   * `confirmed` means the bundler returned a receipt synchronously,
+   * `pending` means it accepted the UserOp but the receipt hasn't
+   * landed yet, `failed` means the bundler rejected the op or it
+   * reverted before inclusion.
+   */
   withdraw(address, req) {
     return this.transport.request({
       path: `/wallets/${encodeURIComponent(address)}:withdraw`,
@@ -553,7 +629,14 @@ var WalletsResource = class {
       body: req
     });
   }
-  /** GET /wallets/{address}:getNonce */
+  /**
+   * GET /wallets/{address}:getNonce — current AA nonce for the wallet.
+   *
+   * Used when an external signer needs to assemble a UserOp outside
+   * the SDK's bundler path. Most callers don't need this directly —
+   * `workflows.simulate` and `wallets.withdraw` handle nonce sourcing
+   * internally.
+   */
   getNonce(address) {
     return this.transport.request({
       path: `/wallets/${encodeURIComponent(address)}:getNonce`
@@ -801,7 +884,8 @@ var Nodes = Object.freeze({
         url: opts.url,
         method: opts.method,
         ...opts.body ? { body: opts.body } : {},
-        ...opts.headers ? { headers: opts.headers } : {}
+        ...opts.headers ? { headers: opts.headers } : {},
+        ...opts.options ? { options: opts.options } : {}
       }
     };
   },

package/dist/index.mjs

@@ -374,6 +374,11 @@ var HealthResource = class {
   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" });
   }
@@ -384,7 +389,21 @@ var NodesResource = class {
   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",
@@ -399,7 +418,15 @@ var OperatorsResource = class {
   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" });
   }
@@ -441,10 +468,16 @@ var TokensResource = class {
     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({
@@ -459,7 +492,20 @@ var TriggersResource = class {
   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",
@@ -474,13 +520,29 @@ var WalletsResource = class {
   constructor(transport) {
     this.transport = transport;
   }
-  /** GET /wallets */
+  /**
+   * GET /wallets — every smart wallet owned by the authenticated
+   * EOA on the JWT's audience chain.
+   *
+   * Hidden wallets (`isHidden=true`) are excluded by default. The
+   * response is an envelope `{ data: Wallet[] }`, not a bare array.
+   */
   list() {
     return this.transport.request({ path: "/wallets" });
   }
   /**
    * POST /wallets — idempotent "ensure exists". Derives the CREATE2
-   * address from (owner, salt, factory) and persists the record.
+   * address from `(owner, salt, factory)` and persists the record;
+   * calling twice with the same triple returns the same address.
+   *
+   * The on-chain account is **not** deployed by this call — deployment
+   * happens lazily as part of the first UserOp (workflow execution or
+   * `withdraw`) via the `initCode` field, so the smart wallet costs
+   * zero gas until it's first used.
+   *
+   * Per-owner cap is enforced by `max_wallets_per_owner` in the
+   * aggregator config; the call returns 429 `WALLETS_LIMIT_REACHED`
+   * when exceeded.
    */
   create(req) {
     return this.transport.request({
@@ -490,8 +552,11 @@ var WalletsResource = class {
     });
   }
   /**
-   * PATCH /wallets/{address} — partial update. Today the only
-   * mutable field is `isHidden`.
+   * PATCH /wallets/{address} — partial update. The only mutable
+   * field today is `isHidden`, used by the Studio UI's hide/unhide
+   * wallet action. Keyed by **address**, not salt — callers that
+   * still think in salts must look up the address first via
+   * `create({ salt })`.
    */
   update(address, body) {
     return this.transport.request({
@@ -500,7 +565,18 @@ var WalletsResource = class {
       body
     });
   }
-  /** POST /wallets/{address}:withdraw — UserOp-driven withdraw. */
+  /**
+   * POST /wallets/{address}:withdraw — transfer ETH or an ERC-20 out
+   * of the smart wallet via a UserOp through the bundler + paymaster.
+   *
+   * Per-chain config (bundler URL, paymaster address, RPC) is resolved
+   * by the gateway from the JWT's `aud` claim or `body.chainId`.
+   * The response's `status` is one of `pending | confirmed | failed`:
+   * `confirmed` means the bundler returned a receipt synchronously,
+   * `pending` means it accepted the UserOp but the receipt hasn't
+   * landed yet, `failed` means the bundler rejected the op or it
+   * reverted before inclusion.
+   */
   withdraw(address, req) {
     return this.transport.request({
       path: `/wallets/${encodeURIComponent(address)}:withdraw`,
@@ -508,7 +584,14 @@ var WalletsResource = class {
       body: req
     });
   }
-  /** GET /wallets/{address}:getNonce */
+  /**
+   * GET /wallets/{address}:getNonce — current AA nonce for the wallet.
+   *
+   * Used when an external signer needs to assemble a UserOp outside
+   * the SDK's bundler path. Most callers don't need this directly —
+   * `workflows.simulate` and `wallets.withdraw` handle nonce sourcing
+   * internally.
+   */
   getNonce(address) {
     return this.transport.request({
       path: `/wallets/${encodeURIComponent(address)}:getNonce`
@@ -756,7 +839,8 @@ var Nodes = Object.freeze({
         url: opts.url,
         method: opts.method,
         ...opts.body ? { body: opts.body } : {},
-        ...opts.headers ? { headers: opts.headers } : {}
+        ...opts.headers ? { headers: opts.headers } : {},
+        ...opts.options ? { options: opts.options } : {}
       }
     };
   },

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

@@ -61,6 +61,9 @@ export declare const Nodes: Readonly<{
         method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
         body?: string;
         headers?: Record<string, string>;
+        options?: {
+            summarize?: boolean;
+        };
     }): v4.Node;
     branch(opts: {
         id: string;

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

@@ -1 +1 @@
-{"version":3,"file":"nodes.d.ts","sourceRoot":"","sources":["../../../src/v4/builders/nodes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C;;;;;;;;;GASG;AACH,eAAO,MAAM,KAAK;sBACE;QAChB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,EAAE,CAAC,IAAI;wBAaS;QAClB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,eAAe,EAAE,MAAM,CAAC;QACxB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QAC7C,WAAW,CAAC,EAAE,KAAK,CAAC;YAClB,UAAU,EAAE,MAAM,CAAC;YACnB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;YACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;SAC1B,CAAC,CAAC;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,EAAE,CAAC,IAAI;uBAkBQ;QACjB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,eAAe,EAAE,MAAM,CAAC;QACxB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QAC7C,WAAW,CAAC,EAAE,KAAK,CAAC;YAClB,UAAU,EAAE,MAAM,CAAC;YACnB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;YACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;SAC1B,CAAC,CAAC;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,EAAE,CAAC,IAAI;uBAcQ;QACjB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACpC,GAAG,EAAE,CAAC,IAAI;kBAaG;QACZ,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;QACpD,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC,GAAG,EAAE,CAAC,IAAI;iBAcE;QACX,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,KAAK,CAAC;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,UAAU,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,IAAI,GAAG,QAAQ,GAAG,MAAM,CAAA;SAAE,CAAC,CAAC;KACxF,GAAG,EAAE,CAAC,IAAI;iBASE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,GAAG,EAAE,CAAC,IAAI;eASnF;QACT,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,aAAa,EAAE,MAAM,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC;KACjB,GAAG,EAAE,CAAC,IAAI;qBAaM;QACf,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC;KAChB,GAAG,EAAE,CAAC,IAAI;kBAYG;QACZ,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,GAAG,EAAE,CAAC,IAAI;EAcX,CAAC"}
+{"version":3,"file":"nodes.d.ts","sourceRoot":"","sources":["../../../src/v4/builders/nodes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C;;;;;;;;;GASG;AACH,eAAO,MAAM,KAAK;sBACE;QAChB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,EAAE,CAAC,IAAI;wBAaS;QAClB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,eAAe,EAAE,MAAM,CAAC;QACxB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QAC7C,WAAW,CAAC,EAAE,KAAK,CAAC;YAClB,UAAU,EAAE,MAAM,CAAC;YACnB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;YACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;SAC1B,CAAC,CAAC;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,EAAE,CAAC,IAAI;uBAkBQ;QACjB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,eAAe,EAAE,MAAM,CAAC;QACxB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QAC7C,WAAW,CAAC,EAAE,KAAK,CAAC;YAClB,UAAU,EAAE,MAAM,CAAC;YACnB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;YACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;SAC1B,CAAC,CAAC;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,EAAE,CAAC,IAAI;uBAcQ;QACjB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACpC,GAAG,EAAE,CAAC,IAAI;kBAaG;QACZ,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;QACpD,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACjC,OAAO,CAAC,EAAE;YAAE,SAAS,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC;KACnC,GAAG,EAAE,CAAC,IAAI;iBAeE;QACX,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,KAAK,CAAC;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,UAAU,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,IAAI,GAAG,QAAQ,GAAG,MAAM,CAAA;SAAE,CAAC,CAAC;KACxF,GAAG,EAAE,CAAC,IAAI;iBASE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,GAAG,EAAE,CAAC,IAAI;eASnF;QACT,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,aAAa,EAAE,MAAM,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC;KACjB,GAAG,EAAE,CAAC,IAAI;qBAaM;QACf,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC;KAChB,GAAG,EAAE,CAAC,IAAI;kBAYG;QACZ,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,GAAG,EAAE,CAAC,IAAI;EAcX,CAAC"}

package/dist/v4/builders/nodes.js

@@ -73,6 +73,7 @@ export const Nodes = Object.freeze({
                 method: opts.method,
                 ...(opts.body ? { body: opts.body } : {}),
                 ...(opts.headers ? { headers: opts.headers } : {}),
+                ...(opts.options ? { options: opts.options } : {}),
             },
         };
     },

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",

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

@@ -1,25 +1,72 @@
 import type { v4 } from "@avaprotocol/types";
 import { Transport } from "../internal/transport";
+/**
+ * `client.wallets.*` — smart-wallet CRUD plus the UserOp-driven
+ * withdraw action. A "wallet" here is an ERC-6900 / ERC-4337 smart
+ * account derived deterministically from `(owner, factory, salt)` —
+ * the SDK never creates an EOA, it ensures-and-registers smart
+ * accounts owned by the authenticated user's EOA.
+ *
+ * All endpoints require auth and operate on wallets owned by the
+ * JWT's subject EOA.
+ */
 export declare class WalletsResource {
     private readonly transport;
     constructor(transport: Transport);
-    /** GET /wallets */
+    /**
+     * GET /wallets — every smart wallet owned by the authenticated
+     * EOA on the JWT's audience chain.
+     *
+     * Hidden wallets (`isHidden=true`) are excluded by default. The
+     * response is an envelope `{ data: Wallet[] }`, not a bare array.
+     */
     list(): Promise<v4.WalletList>;
     /**
      * POST /wallets — idempotent "ensure exists". Derives the CREATE2
-     * address from (owner, salt, factory) and persists the record.
+     * address from `(owner, salt, factory)` and persists the record;
+     * calling twice with the same triple returns the same address.
+     *
+     * The on-chain account is **not** deployed by this call — deployment
+     * happens lazily as part of the first UserOp (workflow execution or
+     * `withdraw`) via the `initCode` field, so the smart wallet costs
+     * zero gas until it's first used.
+     *
+     * Per-owner cap is enforced by `max_wallets_per_owner` in the
+     * aggregator config; the call returns 429 `WALLETS_LIMIT_REACHED`
+     * when exceeded.
      */
     create(req: v4.CreateWalletRequest): Promise<v4.Wallet>;
     /**
-     * PATCH /wallets/{address} — partial update. Today the only
-     * mutable field is `isHidden`.
+     * PATCH /wallets/{address} — partial update. The only mutable
+     * field today is `isHidden`, used by the Studio UI's hide/unhide
+     * wallet action. Keyed by **address**, not salt — callers that
+     * still think in salts must look up the address first via
+     * `create({ salt })`.
      */
     update(address: string, body: {
         isHidden?: boolean;
     }): Promise<v4.Wallet>;
-    /** POST /wallets/{address}:withdraw — UserOp-driven withdraw. */
+    /**
+     * POST /wallets/{address}:withdraw — transfer ETH or an ERC-20 out
+     * of the smart wallet via a UserOp through the bundler + paymaster.
+     *
+     * Per-chain config (bundler URL, paymaster address, RPC) is resolved
+     * by the gateway from the JWT's `aud` claim or `body.chainId`.
+     * The response's `status` is one of `pending | confirmed | failed`:
+     * `confirmed` means the bundler returned a receipt synchronously,
+     * `pending` means it accepted the UserOp but the receipt hasn't
+     * landed yet, `failed` means the bundler rejected the op or it
+     * reverted before inclusion.
+     */
     withdraw(address: string, req: v4.WithdrawRequest): Promise<v4.WithdrawResponse>;
-    /** GET /wallets/{address}:getNonce */
+    /**
+     * GET /wallets/{address}:getNonce — current AA nonce for the wallet.
+     *
+     * Used when an external signer needs to assemble a UserOp outside
+     * the SDK's bundler path. Most callers don't need this directly —
+     * `workflows.simulate` and `wallets.withdraw` handle nonce sourcing
+     * internally.
+     */
     getNonce(address: string): Promise<v4.NonceResponse>;
 }
 //# sourceMappingURL=wallets.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"wallets.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/wallets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,mBAAmB;IACnB,IAAI,IAAI,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC;IAI9B;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAmB,GAAG,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC;IAQvD;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC;IAQzE,iEAAiE;IACjE,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,eAAe,GAAG,OAAO,CAAC,EAAE,CAAC,gBAAgB,CAAC;IAQhF,sCAAsC;IACtC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC;CAKrD"}
+{"version":3,"file":"wallets.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/wallets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD;;;;;;;;;GASG;AACH,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD;;;;;;OAMG;IACH,IAAI,IAAI,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC;IAI9B;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAmB,GAAG,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC;IAQvD;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC;IAQzE;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,eAAe,GAAG,OAAO,CAAC,EAAE,CAAC,gBAAgB,CAAC;IAQhF;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC;CAKrD"}

package/dist/v4/resources/wallets.js

@@ -1,14 +1,40 @@
+/**
+ * `client.wallets.*` — smart-wallet CRUD plus the UserOp-driven
+ * withdraw action. A "wallet" here is an ERC-6900 / ERC-4337 smart
+ * account derived deterministically from `(owner, factory, salt)` —
+ * the SDK never creates an EOA, it ensures-and-registers smart
+ * accounts owned by the authenticated user's EOA.
+ *
+ * All endpoints require auth and operate on wallets owned by the
+ * JWT's subject EOA.
+ */
 export class WalletsResource {
     constructor(transport) {
         this.transport = transport;
     }
-    /** GET /wallets */
+    /**
+     * GET /wallets — every smart wallet owned by the authenticated
+     * EOA on the JWT's audience chain.
+     *
+     * Hidden wallets (`isHidden=true`) are excluded by default. The
+     * response is an envelope `{ data: Wallet[] }`, not a bare array.
+     */
     list() {
         return this.transport.request({ path: "/wallets" });
     }
     /**
      * POST /wallets — idempotent "ensure exists". Derives the CREATE2
-     * address from (owner, salt, factory) and persists the record.
+     * address from `(owner, salt, factory)` and persists the record;
+     * calling twice with the same triple returns the same address.
+     *
+     * The on-chain account is **not** deployed by this call — deployment
+     * happens lazily as part of the first UserOp (workflow execution or
+     * `withdraw`) via the `initCode` field, so the smart wallet costs
+     * zero gas until it's first used.
+     *
+     * Per-owner cap is enforced by `max_wallets_per_owner` in the
+     * aggregator config; the call returns 429 `WALLETS_LIMIT_REACHED`
+     * when exceeded.
      */
     create(req) {
         return this.transport.request({
@@ -18,8 +44,11 @@ export class WalletsResource {
         });
     }
     /**
-     * PATCH /wallets/{address} — partial update. Today the only
-     * mutable field is `isHidden`.
+     * PATCH /wallets/{address} — partial update. The only mutable
+     * field today is `isHidden`, used by the Studio UI's hide/unhide
+     * wallet action. Keyed by **address**, not salt — callers that
+     * still think in salts must look up the address first via
+     * `create({ salt })`.
      */
     update(address, body) {
         return this.transport.request({
@@ -28,7 +57,18 @@ export class WalletsResource {
             body,
         });
     }
-    /** POST /wallets/{address}:withdraw — UserOp-driven withdraw. */
+    /**
+     * POST /wallets/{address}:withdraw — transfer ETH or an ERC-20 out
+     * of the smart wallet via a UserOp through the bundler + paymaster.
+     *
+     * Per-chain config (bundler URL, paymaster address, RPC) is resolved
+     * by the gateway from the JWT's `aud` claim or `body.chainId`.
+     * The response's `status` is one of `pending | confirmed | failed`:
+     * `confirmed` means the bundler returned a receipt synchronously,
+     * `pending` means it accepted the UserOp but the receipt hasn't
+     * landed yet, `failed` means the bundler rejected the op or it
+     * reverted before inclusion.
+     */
     withdraw(address, req) {
         return this.transport.request({
             path: `/wallets/${encodeURIComponent(address)}:withdraw`,
@@ -36,7 +76,14 @@ export class WalletsResource {
             body: req,
         });
     }
-    /** GET /wallets/{address}:getNonce */
+    /**
+     * GET /wallets/{address}:getNonce — current AA nonce for the wallet.
+     *
+     * Used when an external signer needs to assemble a UserOp outside
+     * the SDK's bundler path. Most callers don't need this directly —
+     * `workflows.simulate` and `wallets.withdraw` handle nonce sourcing
+     * internally.
+     */
     getNonce(address) {
         return this.transport.request({
             path: `/wallets/${encodeURIComponent(address)}:getNonce`,

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

@@ -24,6 +24,16 @@ export interface CountWorkflowsParams {
     status?: v4.WorkflowStatus[];
     chainId?: number;
 }
+/**
+ * `client.workflows.*` — the primary surface for creating and
+ * controlling automations. A "workflow" is one trigger + a DAG of
+ * nodes that fires when the trigger condition matches. This resource
+ * covers the full lifecycle: create, list, retrieve, pause / resume,
+ * cancel, manual trigger, dry-run simulation, and fee estimation.
+ *
+ * Executions produced by these workflows are read via
+ * [`ExecutionsResource`](ExecutionsResource.mdx).
+ */
 export declare class WorkflowsResource {
     private readonly transport;
     constructor(transport: Transport);

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

@@ -1 +1 @@
-{"version":3,"file":"workflows.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/workflows.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD;;;;;;;;GAQG;AACH,MAAM,WAAW,mBAAmB;IAClC,uEAAuE;IACvE,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,wDAAwD;IACxD,MAAM,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE,CAAC;IAC7B,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,oBAAoB;IACnC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,MAAM,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,qBAAa,iBAAiB;IAChB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,sBAAsB;IACtB,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,qBAAqB,GAAG,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC;IAQ3D,qBAAqB;IACrB,IAAI,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC;IAO5D,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC;IAM1C;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOjC,iCAAiC;IACjC,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC;IAOvC,kCAAkC;IAClC,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC;IAOxC,mCAAmC;IACnC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,sBAAsB,GAAG,OAAO,CAAC,EAAE,CAAC,uBAAuB,CAAC;IAQxF,0DAA0D;IAC1D,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,uBAAuB,GAAG,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC;IAQhE,mCAAmC;IACnC,YAAY,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAmB,GAAG,OAAO,CAAC,EAAE,CAAC,oBAAoB,CAAC;IAQ3E,2BAA2B;IAC3B,KAAK,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC;CAMhE"}
+{"version":3,"file":"workflows.d.ts","sourceRoot":"","sources":["../../../src/v4/resources/workflows.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD;;;;;;;;GAQG;AACH,MAAM,WAAW,mBAAmB;IAClC,uEAAuE;IACvE,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,wDAAwD;IACxD,MAAM,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE,CAAC;IAC7B,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,oBAAoB;IACnC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,MAAM,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;GASG;AACH,qBAAa,iBAAiB;IAChB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,sBAAsB;IACtB,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,qBAAqB,GAAG,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC;IAQ3D,qBAAqB;IACrB,IAAI,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC;IAO5D,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC;IAM1C;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOjC,iCAAiC;IACjC,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC;IAOvC,kCAAkC;IAClC,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC;IAOxC,mCAAmC;IACnC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,sBAAsB,GAAG,OAAO,CAAC,EAAE,CAAC,uBAAuB,CAAC;IAQxF,0DAA0D;IAC1D,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,uBAAuB,GAAG,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC;IAQhE,mCAAmC;IACnC,YAAY,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAmB,GAAG,OAAO,CAAC,EAAE,CAAC,oBAAoB,CAAC;IAQ3E,2BAA2B;IAC3B,KAAK,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC;CAMhE"}

package/dist/v4/resources/workflows.js

@@ -1,3 +1,13 @@
+/**
+ * `client.workflows.*` — the primary surface for creating and
+ * controlling automations. A "workflow" is one trigger + a DAG of
+ * nodes that fires when the trigger condition matches. This resource
+ * covers the full lifecycle: create, list, retrieve, pause / resume,
+ * cancel, manual trigger, dry-run simulation, and fee estimation.
+ *
+ * Executions produced by these workflows are read via
+ * [`ExecutionsResource`](ExecutionsResource.mdx).
+ */
 export class WorkflowsResource {
     constructor(transport) {
         this.transport = transport;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avaprotocol/sdk-js",
-  "version": "4.0.0-dev.0",
+  "version": "4.0.0-dev.1",
   "description": "TypeScript SDK for Ava Protocol's AVS REST API (v4). Resource-grouped sub-clients, fetch transport, EIP-191 auth.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -27,12 +27,17 @@
     "build:declarations": "tsc -b tsconfig.json",
     "build:js": "tsup src/index.ts --format cjs,esm",
     "build": "yarn build:declarations && yarn build:js",
-    "clean": "rm -rf node_modules dist tsconfig.tsbuildinfo",
+    "clean": "rm -rf node_modules dist tsconfig.tsbuildinfo docs-api",
+    "docs": "typedoc && node scripts/flatten-docs.js",
     "prepare": "node ../../scripts/prepare-package.js"
   },
   "dependencies": {
     "@avaprotocol/types": "4.0.0-dev.0",
     "dotenv": "^16.4.5",
     "ethers": "^6.13.2"
+  },
+  "devDependencies": {
+    "typedoc": "^0.28.19",
+    "typedoc-plugin-markdown": "^4.11.0"
   }
 }