@gol/sdk 0.5.0 → 0.6.0

package/README.md

@@ -2,14 +2,16 @@
 
 TypeScript SDK for GOL Network bounded mandates with hosted, owner-paid network gas on Base Sepolia testnet (chain `84532`).
 
+Version 0.6.0 adds typed provisional inclusion fields and wait helpers for owner approval, sponsored child mandates, EIP-7702 setup, and actions or claims. The inclusion helpers check every second and can return `included`, `reverted`, `orphaned`, or `mismatch` while final confirmation and settlement continue. Existing final-confirmation helpers keep their 15-second default interval. Hosted API 0.6.0 on Base Sepolia verified signed Alchemy webhook inclusion for a sponsored setup, owner approval, and developer-relayed action on 2026-09-29. The webhook rollout is bounded, so clients must allow for reconciliation when a hook is unavailable. An `included` result is provisional and does not mean safe-head settlement or finalized observation.
+
 A developer's agent sends bounded USDC transfers from an end user's existing account. An owner-approved relayer, operated by GOL or by the developer, sends each action and fronts its network gas. The version 3 core meters the transaction and reimburses that relayer in native ETH from the same account in the same transaction, within caps the owner signed and a maximum the agent signed. With a GOL-operated relayer the owner can also consent to a later attested claim for a reverted transaction. The owner signs every authority in their own wallet and can pause, resume, or revoke without GOL.
 
-Version 0.5.0 implements hosted gas public API revision 2.0 for compatibility profile 4: the version 3 core (EIP-712 domain `GOL Mandate`, version `3`) and gas formula version 2. It covers five exact account configurations: Safe 1.4.1, Biconomy Nexus 1.0.0, ZeroDev Kernel v0.3.1, Alchemy Modular Account v2, and an owner's EOA delegated to Biconomy Nexus 1.3.3 under EIP-7702 (`nexus7702`). Support is stated only by an Active compatibility profile; check [docs.gol.network](https://docs.gol.network) for the current status. Approvals signed for the version 2 core (profiles 1 to 3) are not valid here. The transfer asset is Circle USDC on Base Sepolia. Read deployed addresses and limits from `getGasConfiguration`; do not hard-code them.
+Version 0.6.0 retains hosted gas public API revision 2.0 and the project display-name and audit cursor methods from 0.5.1. The version 3 core uses EIP-712 domain `GOL Mandate`, version `3`, and gas formula version 2. It covers five exact account configurations: Safe 1.4.1, Biconomy Nexus 1.0.0, ZeroDev Kernel v0.3.1, Alchemy Modular Account v2, and an owner's EOA delegated to Biconomy Nexus 1.3.3 under EIP-7702 (`nexus7702`). Support is stated only by an Active compatibility profile; check [docs.gol.network](https://docs.gol.network) for the current status. Approvals signed for the version 2 core (profiles 1 to 3) are not valid here. The transfer asset is Circle USDC on Base Sepolia. Read deployed addresses and limits from `getGasConfiguration`; do not hard-code them.
 
 ## Install
 
 ```sh
-pnpm add @gol/sdk@0.5.0
+pnpm add @gol/sdk@0.6.0
 ```
 
 Use Node.js 22 or later. The root entry point (`@gol/sdk`) is browser-safe: policy encoding, owner, agent, and EIP-7702 setup payloads, owner operations, and verification. API clients and webhook verification are in `@gol/sdk/server` and must run on your server, because they hold your API key.
@@ -18,7 +20,7 @@ Use Node.js 22 or later. The root entry point (`@gol/sdk`) is browser-safe: poli
 
 ## Integration flow
 
-Create a test project and an API key with `project:read`, `accounts:read`, `mandates:read`, `mandates:write`, `actions:submit`, and `webhooks:manage` at [console.gol.network](https://console.gol.network).
+With console access, create a test project and an API key with `project:read`, `accounts:read`, `mandates:read`, `mandates:write`, `actions:submit`, and `webhooks:manage` at [console.gol.network](https://console.gol.network). The hosted console is currently unpublished behind a password gate; project creation requires that access before the developer sign-in flow. Existing test API keys continue to authenticate directly to the public API.
 
 1. **Install the core on the owner's account.** `getAccountStatus` reports the detected family, its delegation for an EOA, and whether the core is installed.
    - Smart accounts: build the owner operation in the browser with `prepareOwnerInstallation` and `prepareOwnerOperation`, have the owner sign it with `signOwnerOperation`, and submit the returned transaction (a Safe transaction, or an EntryPoint v0.7 user operation for Nexus, Kernel, and Alchemy).
@@ -125,6 +127,12 @@ const gol = new GolManagementClient({
 });
 
 const projects = await gol.listProjects();
+const project = await gol.createProject({ name: "My test project" });
+await gol.updateProject(project.id, { name: "Renamed project" });
+const events = await gol.listAuditEvents(project.id, 100);
+if (events.nextCursor) {
+  await gol.listAuditEvents(project.id, 100, events.nextCursor);
+}
 ```
 
 ## Development

package/dist/generated/platform.d.ts

@@ -150,6 +150,22 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/projects/{projectId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch: operations["updateProject"];
+        trace?: never;
+    };
     "/v1/projects/{projectId}/api-keys": {
         parameters: {
             query?: never;
@@ -753,6 +769,26 @@ export interface components {
             relayerMode: "gol" | "developer" | null;
             submitter: string | null;
             state: string;
+            inclusion?: null | {
+                state: "pending" | "included" | "reverted" | "orphaned" | "mismatch";
+                workflow: string;
+                transactionHash: string;
+                blockHash: string | null;
+                blockNumber: string | null;
+                outcome: string | null;
+                observedAt: string | null;
+                finalizedAt: string | null;
+            };
+            inclusions?: {
+                state: "pending" | "included" | "reverted" | "orphaned" | "mismatch";
+                workflow: string;
+                transactionHash: string;
+                blockHash: string | null;
+                blockNumber: string | null;
+                outcome: string | null;
+                observedAt: string | null;
+                finalizedAt: string | null;
+            }[];
             quote: {
                 maxChargeWei: string;
                 acceptedOwnerMaximumWei: string;
@@ -956,6 +992,8 @@ export interface components {
             validFrom: number;
             expiresAt: number;
             creationTransactionHash: string | null;
+            submissionTransactionHash?: string | null;
+            inclusion?: "pending" | "included" | "reverted" | "orphaned" | "mismatch" | null;
             sponsored: boolean;
             /** Format: date-time */
             createdAt: string;
@@ -969,6 +1007,7 @@ export interface components {
             account: string;
             state: "accepted" | "signed" | "submitted" | "confirmed" | "failed";
             transactionHash: string | null;
+            inclusion?: "pending" | "included" | "reverted" | "orphaned" | "mismatch" | null;
             blockNumber: string | null;
             failureReason: string | null;
             /** Format: date-time */
@@ -2326,6 +2365,173 @@ export interface operations {
             };
         };
     };
+    updateProject: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    name: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: uuid */
+                        id: string;
+                        name: string;
+                        slug: string;
+                        /** Format: date-time */
+                        createdAt: string;
+                        environments: {
+                            name: "test" | "live";
+                            status: "active" | "unavailable";
+                        }[];
+                    };
+                };
+            };
+            /** @description Default Response */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: {
+                            code: string;
+                            message: string;
+                            /** Format: uuid */
+                            correlationId: string;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: {
+                            code: string;
+                            message: string;
+                            /** Format: uuid */
+                            correlationId: string;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: {
+                            code: string;
+                            message: string;
+                            /** Format: uuid */
+                            correlationId: string;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: {
+                            code: string;
+                            message: string;
+                            /** Format: uuid */
+                            correlationId: string;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: {
+                            code: string;
+                            message: string;
+                            /** Format: uuid */
+                            correlationId: string;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: {
+                            code: string;
+                            message: string;
+                            /** Format: uuid */
+                            correlationId: string;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: {
+                            code: string;
+                            message: string;
+                            /** Format: uuid */
+                            correlationId: string;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: {
+                            code: string;
+                            message: string;
+                            /** Format: uuid */
+                            correlationId: string;
+                        };
+                    };
+                };
+            };
+        };
+    };
     listApiKeys: {
         parameters: {
             query?: never;
@@ -3418,6 +3624,26 @@ export interface operations {
                         relayerMode: "gol" | "developer" | null;
                         submitter: string | null;
                         state: string;
+                        inclusion?: null | {
+                            state: "pending" | "included" | "reverted" | "orphaned" | "mismatch";
+                            workflow: string;
+                            transactionHash: string;
+                            blockHash: string | null;
+                            blockNumber: string | null;
+                            outcome: string | null;
+                            observedAt: string | null;
+                            finalizedAt: string | null;
+                        };
+                        inclusions?: {
+                            state: "pending" | "included" | "reverted" | "orphaned" | "mismatch";
+                            workflow: string;
+                            transactionHash: string;
+                            blockHash: string | null;
+                            blockNumber: string | null;
+                            outcome: string | null;
+                            observedAt: string | null;
+                            finalizedAt: string | null;
+                        }[];
                         quote: {
                             maxChargeWei: string;
                             acceptedOwnerMaximumWei: string;
@@ -3530,6 +3756,26 @@ export interface operations {
                         relayerMode: "gol" | "developer" | null;
                         submitter: string | null;
                         state: string;
+                        inclusion?: null | {
+                            state: "pending" | "included" | "reverted" | "orphaned" | "mismatch";
+                            workflow: string;
+                            transactionHash: string;
+                            blockHash: string | null;
+                            blockNumber: string | null;
+                            outcome: string | null;
+                            observedAt: string | null;
+                            finalizedAt: string | null;
+                        };
+                        inclusions?: {
+                            state: "pending" | "included" | "reverted" | "orphaned" | "mismatch";
+                            workflow: string;
+                            transactionHash: string;
+                            blockHash: string | null;
+                            blockNumber: string | null;
+                            outcome: string | null;
+                            observedAt: string | null;
+                            finalizedAt: string | null;
+                        }[];
                         quote: {
                             maxChargeWei: string;
                             acceptedOwnerMaximumWei: string;
@@ -3790,6 +4036,26 @@ export interface operations {
                         relayerMode: "gol" | "developer" | null;
                         submitter: string | null;
                         state: string;
+                        inclusion?: null | {
+                            state: "pending" | "included" | "reverted" | "orphaned" | "mismatch";
+                            workflow: string;
+                            transactionHash: string;
+                            blockHash: string | null;
+                            blockNumber: string | null;
+                            outcome: string | null;
+                            observedAt: string | null;
+                            finalizedAt: string | null;
+                        };
+                        inclusions?: {
+                            state: "pending" | "included" | "reverted" | "orphaned" | "mismatch";
+                            workflow: string;
+                            transactionHash: string;
+                            blockHash: string | null;
+                            blockNumber: string | null;
+                            outcome: string | null;
+                            observedAt: string | null;
+                            finalizedAt: string | null;
+                        }[];
                         quote: {
                             maxChargeWei: string;
                             acceptedOwnerMaximumWei: string;
@@ -4010,6 +4276,7 @@ export interface operations {
         parameters: {
             query?: {
                 limit?: number;
+                cursor?: string;
             };
             header?: never;
             path: {
@@ -4039,6 +4306,7 @@ export interface operations {
                             /** Format: date-time */
                             createdAt: string;
                         }[];
+                        nextCursor: string | null;
                     };
                 };
             };
@@ -4387,6 +4655,26 @@ export interface operations {
                         relayerMode: "gol" | "developer" | null;
                         submitter: string | null;
                         state: string;
+                        inclusion?: null | {
+                            state: "pending" | "included" | "reverted" | "orphaned" | "mismatch";
+                            workflow: string;
+                            transactionHash: string;
+                            blockHash: string | null;
+                            blockNumber: string | null;
+                            outcome: string | null;
+                            observedAt: string | null;
+                            finalizedAt: string | null;
+                        };
+                        inclusions?: {
+                            state: "pending" | "included" | "reverted" | "orphaned" | "mismatch";
+                            workflow: string;
+                            transactionHash: string;
+                            blockHash: string | null;
+                            blockNumber: string | null;
+                            outcome: string | null;
+                            observedAt: string | null;
+                            finalizedAt: string | null;
+                        }[];
                         quote: {
                             maxChargeWei: string;
                             acceptedOwnerMaximumWei: string;
@@ -5791,8 +6079,7 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        /** @enum {string} */
-                        status: "observing";
+                        status: "observing" | "included" | "reverted" | "orphaned" | "mismatch";
                         transactionHash: string;
                         /** Format: uuid */
                         draftId?: string;
@@ -6521,8 +6808,7 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        /** @enum {string} */
-                        status: "observing";
+                        status: "observing" | "included" | "reverted" | "orphaned" | "mismatch";
                         transactionHash: string;
                         /** Format: uuid */
                         draftId?: string;
@@ -7181,8 +7467,7 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        /** @enum {string} */
-                        status: "observing";
+                        status: "observing" | "included" | "reverted" | "orphaned" | "mismatch";
                         transactionHash: string;
                         /** Format: uuid */
                         draftId?: string;
@@ -7538,8 +7823,7 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        /** @enum {string} */
-                        status: "observing";
+                        status: "observing" | "included" | "reverted" | "orphaned" | "mismatch";
                         transactionHash: string;
                         /** Format: uuid */
                         draftId?: string;