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

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.2",
   "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"
   }
 }