zksync-sso 0.5.0-beta.3 → 1.0.0-beta.2

package/dist/_types/client/actions/deploy.d.ts

@@ -0,0 +1,108 @@
+import type { Address, Hex, Log } from "viem";
+/**
+ * Parameters for preparing a smart account deployment
+ */
+export type PrepareDeploySmartAccountParams = {
+    /** Contract addresses */
+    contracts: {
+        /** MSAFactory contract address */
+        factory: Address;
+        /** EOA validator address (required if eoaSigners provided) */
+        eoaValidator?: Address;
+        /** WebAuthn validator address (required if passkeySigners provided) */
+        webauthnValidator?: Address;
+        /** Session validator address (required if installing session support) */
+        sessionValidator?: Address;
+    };
+    /** Optional array of EOA signer addresses to install */
+    eoaSigners?: Address[];
+    /** Optional array of passkey signers to install */
+    passkeySigners?: Array<{
+        /** Hex-encoded credential ID */
+        credentialId: Hex;
+        /** Public key coordinates */
+        publicKey: {
+            x: Hex;
+            y: Hex;
+        };
+        /** Origin domain (e.g., "https://example.com" or window.location.origin) */
+        originDomain: string;
+    }>;
+    /** Optional: Install session validator module during deployment */
+    installSessionValidator?: boolean;
+    /** Optional array of executor module addresses to install during deployment */
+    executorModules?: Address[];
+    /** Optional user ID for deterministic account deployment. If provided, generates deterministic accountId from userId */
+    userId?: string;
+    /** Optional custom account ID (32-byte hex). If not provided, generated from userId (if provided) or random */
+    accountId?: Hex;
+};
+/**
+ * Result from prepareDeploySmartAccount containing transaction data
+ */
+export type PrepareDeploySmartAccountResult = {
+    /** Transaction to send to deploy the account */
+    transaction: {
+        /** Factory contract address */
+        to: Address;
+        /** Encoded deployAccount call data */
+        data: Hex;
+    };
+    /** Account ID used as salt */
+    accountId: Hex;
+};
+/**
+ * Prepare a deployment transaction for a smart account.
+ * This function does NOT send the transaction - it returns the transaction data
+ * that can be sent via any means (EOA, bundler, etc).
+ *
+ * Uses Rust WASM SDK for encoding (no RPC calls).
+ *
+ * @param params - Deployment parameters including contracts and signers
+ * @returns Transaction data
+ *
+ * @example
+ * ```typescript
+ * import { prepareDeploySmartAccount } from "zksync-sso/client-new/actions";
+ *
+ * const { transaction, accountId } = prepareDeploySmartAccount({
+ *   contracts: {
+ *     factory: "0x...",
+ *     eoaValidator: "0x...",
+ *     sessionValidator: "0x...",
+ *   },
+ *   eoaSigners: ["0x..."],
+ *   installSessionValidator: true,
+ * });
+ *
+ * // Send transaction via your preferred method
+ * const hash = await walletClient.sendTransaction(transaction);
+ *
+ * // Wait for receipt and extract deployed address from AccountCreated event
+ * const receipt = await publicClient.waitForTransactionReceipt({ hash });
+ * const deployedAddress = getAccountAddressFromLogs(receipt.logs);
+ * ```
+ */
+export declare function prepareDeploySmartAccount(params: PrepareDeploySmartAccountParams): PrepareDeploySmartAccountResult;
+/**
+ * Extract the deployed account address from transaction logs.
+ * Searches for the AccountCreated event emitted by MSAFactory.
+ *
+ * @param logs - Transaction logs from the deployment transaction
+ * @returns The deployed account address
+ * @throws Error if AccountCreated event is not found in the logs
+ *
+ * @example
+ * ```typescript
+ * import { prepareDeploySmartAccount, getAccountAddressFromLogs } from "zksync-sso/client-new/actions";
+ *
+ * const { transaction } = prepareDeploySmartAccount({ ... });
+ * const hash = await walletClient.sendTransaction(transaction);
+ * const receipt = await publicClient.waitForTransactionReceipt({ hash });
+ *
+ * const deployedAddress = getAccountAddressFromLogs(receipt.logs);
+ * console.log("Account deployed at:", deployedAddress);
+ * ```
+ */
+export declare function getAccountAddressFromLogs(logs: Log[]): Address;
+//# sourceMappingURL=deploy.d.ts.map

package/dist/_types/client/actions/deploy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../../../src/client/actions/deploy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAQ9C;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,yBAAyB;IACzB,SAAS,EAAE;QACT,kCAAkC;QAClC,OAAO,EAAE,OAAO,CAAC;QACjB,8DAA8D;QAC9D,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,uEAAuE;QACvE,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAC5B,yEAAyE;QACzE,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B,CAAC;IAEF,wDAAwD;IACxD,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC;IAEvB,mDAAmD;IACnD,cAAc,CAAC,EAAE,KAAK,CAAC;QACrB,gCAAgC;QAChC,YAAY,EAAE,GAAG,CAAC;QAClB,6BAA6B;QAC7B,SAAS,EAAE;YAAE,CAAC,EAAE,GAAG,CAAC;YAAC,CAAC,EAAE,GAAG,CAAA;SAAE,CAAC;QAC9B,4EAA4E;QAC5E,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC,CAAC;IAEH,mEAAmE;IACnE,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC,+EAA+E;IAC/E,eAAe,CAAC,EAAE,OAAO,EAAE,CAAC;IAE5B,wHAAwH;IACxH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,+GAA+G;IAC/G,SAAS,CAAC,EAAE,GAAG,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,gDAAgD;IAChD,WAAW,EAAE;QACX,+BAA+B;QAC/B,EAAE,EAAE,OAAO,CAAC;QACZ,sCAAsC;QACtC,IAAI,EAAE,GAAG,CAAC;KACX,CAAC;IACF,8BAA8B;IAC9B,SAAS,EAAE,GAAG,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,+BAA+B,GACtC,+BAA+B,CAuFjC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAgB9D"}

package/dist/_types/client/actions/index.d.ts

@@ -0,0 +1,10 @@
+export type { CreateSessionParams, CreateSessionReturnType, GetSessionStateParams, GetSessionStateReturnType, SessionState, SessionStateEvent, SessionStateEventCallback, } from "./sessions.js";
+export { createSession, getSessionState, SessionEventType, SessionStatus } from "./sessions.js";
+export type { PrepareDeploySmartAccountParams, PrepareDeploySmartAccountResult, } from "./deploy.js";
+export { getAccountAddressFromLogs, prepareDeploySmartAccount } from "./deploy.js";
+export type { AddPasskeyParams, AddPasskeyResult, FetchAccountParams, FetchAccountResult, FindAddressesByPasskeyParams, FindAddressesByPasskeyResult, } from "./passkey.js";
+export { addPasskey, fetchAccount, findAddressesByPasskey } from "./passkey.js";
+export type { IsModuleInstalledParams, IsModuleInstalledResult, } from "./modules.js";
+export { isGuardianModuleInstalled, isModuleInstalled, ModuleType } from "./modules.js";
+export { generateAccountId } from "./utils.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/_types/client/actions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/client/actions/index.ts"],"names":[],"mappings":"AACA,YAAY,EACV,mBAAmB,EACnB,uBAAuB,EACvB,qBAAqB,EACrB,yBAAyB,EACzB,YAAY,EACZ,iBAAiB,EACjB,yBAAyB,GAC1B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAGhG,YAAY,EACV,+BAA+B,EAC/B,+BAA+B,GAChC,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,yBAAyB,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAGnF,YAAY,EACV,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EAClB,4BAA4B,EAC5B,4BAA4B,GAC7B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAGhF,YAAY,EACV,uBAAuB,EACvB,uBAAuB,GACxB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,yBAAyB,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAGxF,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC"}

package/dist/_types/client/actions/modules.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Module management actions for ERC-7579 smart accounts
+ */
+import type { Address, Hex, PublicClient } from "viem";
+/**
+ * ERC-7579 module type IDs
+ */
+export declare const ModuleType: {
+    readonly VALIDATOR: 1n;
+    readonly EXECUTOR: 2n;
+    readonly FALLBACK: 3n;
+    readonly HOOK: 4n;
+};
+export type IsModuleInstalledParams = {
+    /** Public client for reading contract state */
+    client: PublicClient;
+    /** The smart account address to check */
+    accountAddress: Address;
+    /** The module address to check for installation */
+    moduleAddress: Address;
+    /** The module type ID (use ModuleType constants) */
+    moduleTypeId: bigint;
+    /** Optional additional context for module lookup (usually empty) */
+    additionalContext?: Hex;
+};
+export type IsModuleInstalledResult = {
+    /** Whether the module is installed on the account */
+    isInstalled: boolean;
+};
+/**
+ * Check if a module is installed on an ERC-7579 smart account
+ *
+ * @example
+ * ```typescript
+ * const result = await isModuleInstalled({
+ *   client: publicClient,
+ *   accountAddress: "0x...",
+ *   moduleAddress: "0x...",
+ *   moduleTypeId: ModuleType.EXECUTOR,
+ * });
+ * console.log("Guardian module installed:", result.isInstalled);
+ * ```
+ */
+export declare function isModuleInstalled(params: IsModuleInstalledParams): Promise<IsModuleInstalledResult>;
+/**
+ * Check if the guardian executor module is installed on an account
+ *
+ * @example
+ * ```typescript
+ * const result = await isGuardianModuleInstalled({
+ *   client: publicClient,
+ *   accountAddress: "0x...",
+ *   guardianExecutorAddress: "0x...",
+ * });
+ * if (!result.isInstalled) {
+ *   console.warn("Guardian module not installed on account");
+ * }
+ * ```
+ */
+export declare function isGuardianModuleInstalled(params: {
+    client: PublicClient;
+    accountAddress: Address;
+    guardianExecutorAddress: Address;
+}): Promise<IsModuleInstalledResult>;
+//# sourceMappingURL=modules.d.ts.map

package/dist/_types/client/actions/modules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modules.d.ts","sourceRoot":"","sources":["../../../../src/client/actions/modules.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEvD;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;CAKb,CAAC;AAmBX,MAAM,MAAM,uBAAuB,GAAG;IACpC,+CAA+C;IAC/C,MAAM,EAAE,YAAY,CAAC;IACrB,yCAAyC;IACzC,cAAc,EAAE,OAAO,CAAC;IACxB,mDAAmD;IACnD,aAAa,EAAE,OAAO,CAAC;IACvB,oDAAoD;IACpD,YAAY,EAAE,MAAM,CAAC;IACrB,oEAAoE;IACpE,iBAAiB,CAAC,EAAE,GAAG,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,qDAAqD;IACrD,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,uBAAuB,CAAC,CAiBlC;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,yBAAyB,CAAC,MAAM,EAAE;IACtD,MAAM,EAAE,YAAY,CAAC;IACrB,cAAc,EAAE,OAAO,CAAC;IACxB,uBAAuB,EAAE,OAAO,CAAC;CAClC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAMnC"}

package/dist/_types/client/actions/passkey.d.ts

@@ -0,0 +1,192 @@
+import type { Address, Hex, PublicClient } from "viem";
+/**
+ * Parameters for adding a passkey to a smart account
+ */
+export type AddPasskeyParams = {
+    /** Smart account address */
+    account: Address;
+    /** Contract addresses */
+    contracts: {
+        /** WebAuthn validator address */
+        webauthnValidator: Address;
+    };
+    /** Passkey signer to add */
+    passkeySigner: {
+        /** Hex-encoded credential ID */
+        credentialId: Hex;
+        /** Public key coordinates */
+        publicKey: {
+            x: Hex;
+            y: Hex;
+        };
+        /** Origin domain (e.g., "https://example.com" or window.location.origin) */
+        originDomain: string;
+    };
+};
+/**
+ * Result from addPasskey containing transaction data
+ */
+export type AddPasskeyResult = {
+    /** Transaction to send to add the passkey */
+    transaction: {
+        /** Smart account address */
+        to: Address;
+        /** Encoded execute() call data */
+        data: Hex;
+    };
+};
+/**
+ * Create a transaction to add a passkey to a smart account.
+ * This function does NOT send the transaction - it returns the transaction data
+ * that must be signed by an existing signer on the account and sent via any means
+ * (EOA, bundler, etc).
+ *
+ * Uses Rust WASM SDK for encoding (no RPC calls).
+ *
+ * @param params - Parameters including account address, passkey details, and validator
+ * @returns Transaction data to add the passkey
+ *
+ * @example
+ * ```typescript
+ * import { addPasskey } from "zksync-sso/client-new/actions";
+ *
+ * const { transaction } = addPasskey({
+ *   account: "0x...", // Your smart account address
+ *   contracts: {
+ *     webauthnValidator: "0x...",
+ *   },
+ *   passkeySigner: {
+ *     credentialId: "0x...",
+ *     publicKey: { x: "0x...", y: "0x..." },
+ *     originDomain: window.location.origin,
+ *   },
+ * });
+ *
+ * // Send transaction via your preferred method
+ * // Must be signed by an existing signer on the account
+ * const hash = await smartAccount.sendTransaction({
+ *   to: transaction.to,
+ *   data: transaction.data,
+ * });
+ * ```
+ */
+export declare function addPasskey(params: AddPasskeyParams): AddPasskeyResult;
+/**
+ * Parameters for finding addresses by passkey credential ID
+ */
+export type FindAddressesByPasskeyParams = {
+    /** Public client for making RPC calls */
+    client: PublicClient;
+    /** Contract addresses */
+    contracts: {
+        /** WebAuthn validator address */
+        webauthnValidator: Address;
+    };
+    /** Passkey credential details */
+    passkey: {
+        /** Hex-encoded credential ID */
+        credentialId: Hex;
+        /** Origin domain (e.g., "https://example.com" or window.location.origin) */
+        originDomain: string;
+    };
+};
+/**
+ * Result from finding addresses by passkey
+ */
+export type FindAddressesByPasskeyResult = {
+    /** Array of smart account addresses associated with this passkey */
+    addresses: Address[];
+};
+/**
+ * Find all smart account addresses associated with a passkey credential ID.
+ * This queries the WebAuthnValidator contract to get the list of accounts
+ * that have registered this specific passkey.
+ *
+ * Uses Rust WASM SDK for encoding/decoding with viem for RPC calls.
+ *
+ * @param params - Parameters including client, validator address, and passkey details
+ * @returns Array of addresses associated with the passkey
+ *
+ * @example
+ * ```typescript
+ * import { createPublicClient, http } from "viem";
+ * import { findAddressesByPasskey } from "zksync-sso-4337/client";
+ *
+ * const publicClient = createPublicClient({
+ *   chain: zkSyncSepoliaTestnet,
+ *   transport: http(),
+ * });
+ *
+ * const { addresses } = await findAddressesByPasskey({
+ *   client: publicClient,
+ *   contracts: {
+ *     webauthnValidator: "0x...",
+ *   },
+ *   passkey: {
+ *     credentialId: "0x...",
+ *     originDomain: window.location.origin,
+ *   },
+ * });
+ *
+ * console.log(`Found ${addresses.length} accounts for this passkey`);
+ * ```
+ */
+export declare function findAddressesByPasskey(params: FindAddressesByPasskeyParams): Promise<FindAddressesByPasskeyResult>;
+/**
+ * Parameters for fetching account details by passkey
+ */
+export type FetchAccountParams = {
+    /** Public client for making RPC calls */
+    client: PublicClient;
+    /** Contract addresses */
+    contracts: {
+        /** WebAuthn validator address */
+        webauthnValidator: Address;
+    };
+    /** Origin domain (e.g., "https://example.com" or window.location.origin) */
+    originDomain: string;
+    /** Optional: credential ID if known, otherwise will prompt user */
+    credentialId?: string;
+};
+/**
+ * Result from fetching account details
+ */
+export type FetchAccountResult = {
+    /** Credential ID (username) */
+    credentialId: string;
+    /** Smart account address */
+    address: Address;
+    /** Passkey public key as Uint8Array (COSE format) */
+    passkeyPublicKey: Uint8Array;
+};
+/**
+ * Fetch account details for a passkey credential.
+ * If credentialId is not provided, will prompt the user to select a passkey.
+ * This queries the WebAuthnValidator contract to get the account address and public key.
+ *
+ * @param params - Parameters including client, validator address, and optional credential ID
+ * @returns Account details including credentialId, address, and public key
+ *
+ * @example
+ * ```typescript
+ * import { createPublicClient, http } from "viem";
+ * import { fetchAccount } from "zksync-sso-4337/actions";
+ *
+ * const publicClient = createPublicClient({
+ *   chain: zkSyncSepoliaTestnet,
+ *   transport: http(),
+ * });
+ *
+ * const { credentialId, address, passkeyPublicKey } = await fetchAccount({
+ *   client: publicClient,
+ *   contracts: {
+ *     webauthnValidator: "0x...",
+ *   },
+ *   originDomain: window.location.origin,
+ * });
+ *
+ * console.log(`Account address: ${address}`);
+ * ```
+ */
+export declare function fetchAccount(params: FetchAccountParams): Promise<FetchAccountResult>;
+//# sourceMappingURL=passkey.d.ts.map

package/dist/_types/client/actions/passkey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"passkey.d.ts","sourceRoot":"","sources":["../../../../src/client/actions/passkey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAavD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,4BAA4B;IAC5B,OAAO,EAAE,OAAO,CAAC;IAEjB,yBAAyB;IACzB,SAAS,EAAE;QACT,iCAAiC;QACjC,iBAAiB,EAAE,OAAO,CAAC;KAC5B,CAAC;IAEF,4BAA4B;IAC5B,aAAa,EAAE;QACb,gCAAgC;QAChC,YAAY,EAAE,GAAG,CAAC;QAClB,6BAA6B;QAC7B,SAAS,EAAE;YAAE,CAAC,EAAE,GAAG,CAAC;YAAC,CAAC,EAAE,GAAG,CAAA;SAAE,CAAC;QAC9B,4EAA4E;QAC5E,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,6CAA6C;IAC7C,WAAW,EAAE;QACX,4BAA4B;QAC5B,EAAE,EAAE,OAAO,CAAC;QACZ,kCAAkC;QAClC,IAAI,EAAE,GAAG,CAAC;KACX,CAAC;CACH,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,gBAAgB,CA4BrE;AAED;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,yCAAyC;IACzC,MAAM,EAAE,YAAY,CAAC;IAErB,yBAAyB;IACzB,SAAS,EAAE;QACT,iCAAiC;QACjC,iBAAiB,EAAE,OAAO,CAAC;KAC5B,CAAC;IAEF,iCAAiC;IACjC,OAAO,EAAE;QACP,gCAAgC;QAChC,YAAY,EAAE,GAAG,CAAC;QAClB,4EAA4E;QAC5E,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,oEAAoE;IACpE,SAAS,EAAE,OAAO,EAAE,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,4BAA4B,GACnC,OAAO,CAAC,4BAA4B,CAAC,CAqBvC;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,yCAAyC;IACzC,MAAM,EAAE,YAAY,CAAC;IAErB,yBAAyB;IACzB,SAAS,EAAE;QACT,iCAAiC;QACjC,iBAAiB,EAAE,OAAO,CAAC;KAC5B,CAAC;IAEF,4EAA4E;IAC5E,YAAY,EAAE,MAAM,CAAC;IAErB,mEAAmE;IACnE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,+BAA+B;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,4BAA4B;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,qDAAqD;IACrD,gBAAgB,EAAE,UAAU,CAAC;CAC9B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,kBAAkB,CAAC,CA4E7B"}

package/dist/_types/client/actions/sessions.d.ts

@@ -0,0 +1,225 @@
+/**
+ * Actions for creating and querying sessions on smart accounts
+ */
+import type { Address, Chain, Client, Hash, Hex, PublicActions, Transport } from "viem";
+import { type SmartAccount } from "viem/account-abstraction";
+import { type SessionSpec } from "../session/types.js";
+/**
+ * Parameters for creating a session on a smart account
+ */
+export type CreateSessionParams = {
+    /**
+     * The session specification defining permissions and limits
+     */
+    sessionSpec: SessionSpec;
+    /**
+     * Proof of session key ownership (signature of session hash by session key)
+     */
+    proof: Hex;
+    /**
+     * Contract addresses
+     */
+    contracts: {
+        /**
+         * The SessionKeyValidator module address
+         */
+        sessionValidator: Address;
+    };
+};
+/**
+ * Return type for createSession action
+ */
+export type CreateSessionReturnType = {
+    /**
+     * The hash of the UserOperation sent to create the session
+     */
+    userOpHash: Hash;
+};
+/**
+ * Create a new session on a smart account
+ *
+ * This action sends a UserOperation to the SessionKeyValidator module to create
+ * a new session with the specified permissions and limits. The session can then
+ * be used to sign transactions using the session key.
+ *
+ * @param client - Viem client with smart account
+ * @param params - Session creation parameters
+ * @returns Promise resolving to the UserOperation hash
+ *
+ * @example
+ * ```typescript
+ * import { createSession } from "@zksync-sso/sdk-4337";
+ * import { createPublicClient, createWalletClient } from "viem";
+ * import { zkSyncSepoliaTestnet } from "viem/chains";
+ *
+ * const walletClient = createWalletClient({
+ *   chain: zkSyncSepoliaTestnet,
+ *   account: mySmartAccount,
+ * });
+ *
+ * const { userOpHash } = await createSession(walletClient, {
+ *   sessionSpec: {
+ *     signer: "0x...", // Session key address
+ *     expiresAt: 1735689600n, // Unix timestamp
+ *     feeLimit: { limitType: 0, limit: 0n, period: 0n }, // Unlimited
+ *     callPolicies: [
+ *       {
+ *         target: "0x...", // Contract address
+ *         selector: "0xa9059cbb", // transfer(address,uint256)
+ *         maxValuePerUse: 0n,
+ *         valueLimit: { limitType: 0, limit: 0n, period: 0n },
+ *         constraints: [],
+ *       },
+ *     ],
+ *     transferPolicies: [],
+ *   },
+ *   proof: "0x...", // Signature of session hash by session key
+ *   contracts: {
+ *     sessionValidator: "0x...", // SessionKeyValidator module address
+ *   },
+ * });
+ * ```
+ */
+export declare function createSession<TTransport extends Transport = Transport, TChain extends Chain | undefined = Chain | undefined, TAccount extends SmartAccount | undefined = SmartAccount | undefined>(client: Client<TTransport, TChain, TAccount>, params: CreateSessionParams): Promise<CreateSessionReturnType>;
+/**
+ * Session status as stored on-chain
+ */
+export declare enum SessionStatus {
+    NotInitialized = 0,
+    Active = 1,
+    Closed = 2
+}
+/**
+ * On-chain session state returned by SessionKeyValidator
+ */
+export type SessionState = {
+    /**
+     * Current status of the session
+     */
+    status: SessionStatus;
+    /**
+     * Remaining fee budget for this session
+     */
+    feesRemaining: bigint;
+    /**
+     * Value limits for transfer policies
+     */
+    transferValue: {
+        remaining: bigint;
+        target: Address;
+        selector: `0x${string}`;
+        index: bigint;
+    }[];
+    /**
+     * Value limits for call policies
+     */
+    callValue: {
+        remaining: bigint;
+        target: Address;
+        selector: `0x${string}`;
+        index: bigint;
+    }[];
+    /**
+     * Parameter constraint limits for call policies
+     */
+    callParams: {
+        remaining: bigint;
+        target: Address;
+        selector: `0x${string}`;
+        index: bigint;
+    }[];
+};
+/**
+ * Parameters for querying session state
+ */
+export type GetSessionStateParams = {
+    /**
+     * The smart account address
+     */
+    account: Address;
+    /**
+     * The session specification to query state for
+     */
+    sessionSpec: SessionSpec;
+    /**
+     * Contract addresses
+     */
+    contracts: {
+        /**
+         * The SessionKeyValidator module address
+         */
+        sessionValidator: Address;
+    };
+};
+/**
+ * Return type for getSessionState action
+ */
+export type GetSessionStateReturnType = {
+    /**
+     * The current on-chain state of the session
+     */
+    sessionState: SessionState;
+};
+/**
+ * Query the current on-chain state of a session
+ *
+ * This action reads the SessionKeyValidator contract to get the current state
+ * of a session, including remaining fee budget and usage limits.
+ *
+ * @param client - A viem public client with chain and transport
+ * @param params - Parameters including account address, session spec, and contract addresses
+ * @returns The current on-chain session state
+ *
+ * @example
+ * ```typescript
+ * const { sessionState } = await getSessionState(publicClient, {
+ *   account: smartAccountAddress,
+ *   sessionSpec: mySessionSpec,
+ *   contracts: {
+ *     sessionValidator: sessionValidatorAddress,
+ *   },
+ * });
+ *
+ * console.log("Session status:", sessionState.status);
+ * console.log("Fees remaining:", sessionState.feesRemaining);
+ *
+ * // Check if session is active
+ * if (sessionState.status === SessionStatus.Active) {
+ *   console.log("Session is active!");
+ * } else if (sessionState.status === SessionStatus.Closed) {
+ *   console.log("Session has been closed/revoked");
+ * }
+ * ```
+ */
+export declare function getSessionState<TTransport extends Transport = Transport, TChain extends Chain | undefined = Chain | undefined>(client: Client<TTransport, TChain> & PublicActions, params: GetSessionStateParams): Promise<GetSessionStateReturnType>;
+/**
+ * Event types for session state changes
+ */
+export declare enum SessionEventType {
+    Expired = "session_expired",
+    Revoked = "session_revoked",
+    Inactive = "session_inactive",
+    Warning = "session_warning"
+}
+/**
+ * Session state event
+ */
+export type SessionStateEvent = {
+    /**
+     * Type of event
+     */
+    type: SessionEventType;
+    /**
+     * Human-readable message describing the event
+     */
+    message: string;
+    /**
+     * Optional session state snapshot when event was triggered
+     */
+    sessionState?: SessionState;
+};
+/**
+ * Callback function for session state change events
+ */
+export type SessionStateEventCallback = (event: SessionStateEvent) => void;
+//# sourceMappingURL=sessions.d.ts.map

package/dist/_types/client/actions/sessions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sessions.d.ts","sourceRoot":"","sources":["../../../../src/client/actions/sessions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAExF,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAG7D,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAOvD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,GAAG,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE;QACT;;WAEG;QACH,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,UAAU,EAAE,IAAI,CAAC;CAClB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,wBAAsB,aAAa,CACjC,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,YAAY,GAAG,SAAS,GAAG,YAAY,GAAG,SAAS,EAEpE,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAC5C,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,uBAAuB,CAAC,CAiClC;AAMD;;GAEG;AACH,oBAAY,aAAa;IACvB,cAAc,IAAI;IAClB,MAAM,IAAI;IACV,MAAM,IAAI;CACX;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE;QACb,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,OAAO,CAAC;QAChB,QAAQ,EAAE,KAAK,MAAM,EAAE,CAAC;QACxB,KAAK,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;IAEJ;;OAEG;IACH,SAAS,EAAE;QACT,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,OAAO,CAAC;QAChB,QAAQ,EAAE,KAAK,MAAM,EAAE,CAAC;QACxB,KAAK,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;IAEJ;;OAEG;IACH,UAAU,EAAE;QACV,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,OAAO,CAAC;QAChB,QAAQ,EAAE,KAAK,MAAM,EAAE,CAAC;QACxB,KAAK,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE;QACT;;WAEG;QACH,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AA8HF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAsB,eAAe,CACnC,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EAEpD,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,aAAa,EAClD,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,yBAAyB,CAAC,CAyBpC;AAMD;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,OAAO,oBAAoB;IAC3B,OAAO,oBAAoB;IAC3B,QAAQ,qBAAqB;IAC7B,OAAO,oBAAoB;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,gBAAgB,CAAC;IAEvB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC"}

package/dist/_types/client/actions/utils.d.ts

@@ -0,0 +1,25 @@
+import type { Hex } from "viem";
+/**
+ * Generate an account ID (used as salt for counterfactual account addresses).
+ *
+ * If userId is provided, generates a deterministic account ID from the userId.
+ * If userId is not provided, generates a random account ID.
+ *
+ * Uses Rust WASM SDK for generation (no RPC calls).
+ *
+ * @param userId - Optional user ID for deterministic account generation
+ * @returns 32-byte hex account ID
+ *
+ * @example
+ * ```typescript
+ * import { generateAccountId } from "zksync-sso/client-new/actions";
+ *
+ * // Generate deterministic account ID from user ID
+ * const accountId = generateAccountId("user123");
+ *
+ * // Generate random account ID
+ * const randomAccountId = generateAccountId();
+ * ```
+ */
+export declare function generateAccountId(userId?: string): Hex;
+//# sourceMappingURL=utils.d.ts.map

package/dist/_types/client/actions/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/client/actions/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAKhC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,GAAG,CAEtD"}