zksync-sso 0.3.2 → 0.4.0-beta.0

package/src/abi/WebAuthModule.ts

@@ -0,0 +1,297 @@
+export const WebAuthModuleAbi = [
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: "address",
+        name: "keyOwner",
+        type: "address",
+      },
+      {
+        indexed: false,
+        internalType: "string",
+        name: "originDomain",
+        type: "string",
+      },
+    ],
+    name: "PasskeyCreated",
+    type: "event",
+  },
+  {
+    inputs: [
+      {
+        internalType: "bytes",
+        name: "key",
+        type: "bytes",
+      },
+    ],
+    name: "addValidationKey",
+    outputs: [
+      {
+        internalType: "bool",
+        name: "",
+        type: "bool",
+      },
+    ],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      {
+        internalType: "string",
+        name: "originDomain",
+        type: "string",
+      },
+      {
+        internalType: "address",
+        name: "accountAddress",
+        type: "address",
+      },
+    ],
+    name: "lowerKeyHalf",
+    outputs: [
+      {
+        internalType: "bytes32",
+        name: "",
+        type: "bytes32",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      {
+        internalType: "bytes",
+        name: "data",
+        type: "bytes",
+      },
+    ],
+    name: "onInstall",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      {
+        internalType: "bytes",
+        name: "data",
+        type: "bytes",
+      },
+    ],
+    name: "onUninstall",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      {
+        internalType: "bytes32",
+        name: "message",
+        type: "bytes32",
+      },
+      {
+        internalType: "bytes32[2]",
+        name: "rs",
+        type: "bytes32[2]",
+      },
+      {
+        internalType: "bytes32[2]",
+        name: "pubKey",
+        type: "bytes32[2]",
+      },
+    ],
+    name: "rawVerify",
+    outputs: [
+      {
+        internalType: "bool",
+        name: "valid",
+        type: "bool",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      {
+        internalType: "bytes4",
+        name: "interfaceId",
+        type: "bytes4",
+      },
+    ],
+    name: "supportsInterface",
+    outputs: [
+      {
+        internalType: "bool",
+        name: "",
+        type: "bool",
+      },
+    ],
+    stateMutability: "pure",
+    type: "function",
+  },
+  {
+    inputs: [
+      {
+        internalType: "string",
+        name: "originDomain",
+        type: "string",
+      },
+      {
+        internalType: "address",
+        name: "accountAddress",
+        type: "address",
+      },
+    ],
+    name: "upperKeyHalf",
+    outputs: [
+      {
+        internalType: "bytes32",
+        name: "",
+        type: "bytes32",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      {
+        internalType: "bytes32",
+        name: "signedHash",
+        type: "bytes32",
+      },
+      {
+        internalType: "bytes",
+        name: "signature",
+        type: "bytes",
+      },
+    ],
+    name: "validateSignature",
+    outputs: [
+      {
+        internalType: "bool",
+        name: "",
+        type: "bool",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      {
+        internalType: "bytes32",
+        name: "signedHash",
+        type: "bytes32",
+      },
+      {
+        internalType: "bytes",
+        name: "signature",
+        type: "bytes",
+      },
+      {
+        components: [
+          {
+            internalType: "uint256",
+            name: "txType",
+            type: "uint256",
+          },
+          {
+            internalType: "uint256",
+            name: "from",
+            type: "uint256",
+          },
+          {
+            internalType: "uint256",
+            name: "to",
+            type: "uint256",
+          },
+          {
+            internalType: "uint256",
+            name: "gasLimit",
+            type: "uint256",
+          },
+          {
+            internalType: "uint256",
+            name: "gasPerPubdataByteLimit",
+            type: "uint256",
+          },
+          {
+            internalType: "uint256",
+            name: "maxFeePerGas",
+            type: "uint256",
+          },
+          {
+            internalType: "uint256",
+            name: "maxPriorityFeePerGas",
+            type: "uint256",
+          },
+          {
+            internalType: "uint256",
+            name: "paymaster",
+            type: "uint256",
+          },
+          {
+            internalType: "uint256",
+            name: "nonce",
+            type: "uint256",
+          },
+          {
+            internalType: "uint256",
+            name: "value",
+            type: "uint256",
+          },
+          {
+            internalType: "uint256[4]",
+            name: "reserved",
+            type: "uint256[4]",
+          },
+          {
+            internalType: "bytes",
+            name: "data",
+            type: "bytes",
+          },
+          {
+            internalType: "bytes",
+            name: "signature",
+            type: "bytes",
+          },
+          {
+            internalType: "bytes32[]",
+            name: "factoryDeps",
+            type: "bytes32[]",
+          },
+          {
+            internalType: "bytes",
+            name: "paymasterInput",
+            type: "bytes",
+          },
+          {
+            internalType: "bytes",
+            name: "reservedDynamic",
+            type: "bytes",
+          },
+        ],
+        internalType: "struct Transaction",
+        name: "",
+        type: "tuple",
+      },
+    ],
+    name: "validateTransaction",
+    outputs: [
+      {
+        internalType: "bool",
+        name: "",
+        type: "bool",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+] as const;

package/src/abi/index.ts

@@ -1,5 +1,9 @@
 export { AAFactoryAbi } from "./AAFactory.js";
+export { GuardianRecoveryModuleAbi } from "./GuardianRecoveryModule.js";
 export { GuardianRecoveryValidatorAbi } from "./GuardianRecoveryValidator.js";
+export { OidcKeyRegistryAbi } from "./OidcKeyRegistry.js";
+export { OidcRecoveryValidatorAbi } from "./OidcRecoveryValidator.js";
 export { SessionKeyValidatorAbi } from "./SessionKeyValidator.js";
 export { SsoAccountAbi } from "./SsoAccount.js";
+export { WebAuthModuleAbi } from "./WebAuthModule.js";
 export { WebAuthValidatorAbi } from "./WebAuthValidator.js";

package/src/client/oidc/account.ts

@@ -0,0 +1,65 @@
+import type { Address } from "abitype";
+import {
+  type CustomSource,
+  type Hash,
+  hashTypedData,
+  type Hex,
+  type LocalAccount,
+} from "viem";
+import { toAccount } from "viem/accounts";
+import { serializeTransaction, type ZksyncTransactionSerializableEIP712 } from "viem/zksync";
+
+import { getEip712Domain } from "../utils/getEip712Domain.js";
+
+export type ToOidcAccountParameters = {
+  address: Address;
+  signTransaction: (parameters: {
+    hash: Hash;
+  }) => Promise<Hex>;
+};
+
+export type OidcAccount = LocalAccount<"ssoOidcAccount"> & {
+  sign: NonNullable<CustomSource["sign"]>;
+};
+
+export function toOidcAccount(
+  parameters: ToOidcAccountParameters,
+): OidcAccount {
+  const { address, signTransaction } = parameters;
+
+  const account = toAccount({
+    address,
+    async signTransaction(transaction) {
+      const signableTransaction = {
+        ...transaction,
+        from: this.address!,
+        type: "eip712",
+      } as ZksyncTransactionSerializableEIP712;
+
+      const eip712DomainAndMessage = getEip712Domain(signableTransaction);
+      const digest = hashTypedData(eip712DomainAndMessage);
+
+      return serializeTransaction({
+        ...signableTransaction,
+        customSignature: await signTransaction({
+          hash: digest,
+        }),
+      });
+    },
+    async signMessage() {
+      throw new Error("Oidc account cannot sign messages");
+    },
+    async signTypedData(typedData) {
+      const digest = hashTypedData(typedData);
+      return signTransaction({
+        hash: digest,
+      });
+    },
+  });
+
+  return {
+    ...account,
+    source: "ssoOidcAccount",
+    type: "local",
+  } as OidcAccount;
+}

package/src/client/oidc/actions/addNewPasskeyViaOidc.ts

@@ -0,0 +1,54 @@
+import {
+  type Account,
+  type Address,
+  type Chain,
+  type Client, encodeFunctionData, type Hex,
+  type Prettify, type TransactionReceipt,
+  type Transport,
+} from "viem";
+import { waitForTransactionReceipt } from "viem/actions";
+import { sendTransaction } from "viem/zksync";
+
+import { WebAuthValidatorAbi } from "../../../abi/index.js";
+
+export type AddNewPasskeyViaOidcArgs = {
+  credentialId: Hex;
+  passkeyPubKey: [Hex, Hex];
+  passkeyDomain: string;
+  contracts: {
+    recoveryOidc: Address; // oidc recovery module
+    passkey: Address;
+  };
+};
+
+export async function addNewPasskeyViaOidc<
+  transport extends Transport,
+  chain extends Chain,
+  account extends Account,
+
+>(client: Client<transport, chain, account>, args: Prettify<AddNewPasskeyViaOidcArgs>): Promise<TransactionReceipt> {
+  const callData = encodeFunctionData({
+    abi: WebAuthValidatorAbi,
+    functionName: "addValidationKey",
+    args: [args.credentialId, args.passkeyPubKey, args.passkeyDomain],
+  });
+
+  const sendTransactionArgs = {
+    account: client.account,
+    to: args.contracts.passkey,
+    data: callData,
+    gas: 10_000_000n, // TODO: Remove when gas estimation is fixed
+    type: "eip712",
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  } as any;
+
+  const transactionHash = await sendTransaction(client, sendTransactionArgs);
+
+  const transactionReceipt = await waitForTransactionReceipt(client, { hash: transactionHash });
+
+  if (transactionReceipt.status !== "success") {
+    throw new Error("Add passkey via oidc reverted");
+  }
+
+  return transactionReceipt;
+}

package/src/client/oidc/actions/index.ts

@@ -0,0 +1,16 @@
+import type { Chain, Transport } from "viem";
+
+import type { ClientWithOidcData } from "../client.js";
+import type { ZksyncSsoOidcActions } from "../decorators/actions.js";
+import { addNewPasskeyViaOidc, type AddNewPasskeyViaOidcArgs } from "./addNewPasskeyViaOidc.js";
+
+export function zksyncSsoOidcActions<
+  transport extends Transport,
+  chain extends Chain,
+>(client: ClientWithOidcData<transport, chain>): ZksyncSsoOidcActions {
+  return {
+    addNewPasskeyViaOidc: async (args: Omit<AddNewPasskeyViaOidcArgs, "contracts">) => {
+      return addNewPasskeyViaOidc(client, { ...args, contracts: client.contracts });
+    },
+  };
+}

package/src/client/oidc/client.ts

@@ -0,0 +1,122 @@
+import {
+  type Account,
+  type Address,
+  type Chain,
+  type Client,
+  createClient,
+  encodeAbiParameters,
+  getAddress,
+  type Prettify,
+  publicActions,
+  type PublicRpcSchema,
+  type RpcSchema,
+  type Transport,
+  type WalletClientConfig,
+  type WalletRpcSchema,
+} from "viem";
+
+import { type ZksyncSsoWalletActions, zksyncSsoWalletActions } from "../recovery/decorators/wallet.js";
+import { type OidcAccount, toOidcAccount } from "./account.js";
+import { zksyncSsoOidcActions } from "./actions/index.js";
+import type { ZksyncSsoOidcActions } from "./decorators/actions.js";
+
+export const signOidcTransaction = (
+  recoveryValidatorAddress: Address,
+) => {
+  return encodeAbiParameters(
+    [
+      { type: "bytes", name: "signature" },
+      { type: "address", name: "recoveryContract" },
+      { type: "bytes[]", name: "validatorData" },
+    ],
+    [
+      "0x",
+      recoveryValidatorAddress,
+      ["0x"],
+    ],
+  );
+};
+
+export interface SsoClientConfig<
+  transport extends Transport = Transport,
+  chain extends Chain = Chain,
+  rpcSchema extends RpcSchema | undefined = undefined,
+> extends Omit<WalletClientConfig<transport, chain, Account, rpcSchema>, "account"> {
+  chain: NonNullable<chain>;
+  address: Address;
+  contracts: OidcRequiredContracts;
+  key?: string;
+  name?: string;
+}
+
+export type OidcRequiredContracts = {
+  passkey: Address; // Passkey
+  recovery: Address;
+  recoveryOidc: Address; // Oidc
+};
+
+export type ZKsyncSsoOidcData = {
+  contracts: OidcRequiredContracts;
+};
+
+export type ZkSyncSsoClient<
+  transport extends Transport = Transport,
+  chain extends Chain = Chain,
+  rpcSchema extends RpcSchema | undefined = undefined,
+> = Prettify<
+  Client<
+    transport,
+    chain,
+    OidcAccount,
+    rpcSchema extends RpcSchema
+      ? [...PublicRpcSchema, ...WalletRpcSchema, ...rpcSchema]
+      : [...PublicRpcSchema, ...WalletRpcSchema],
+    ZksyncSsoWalletActions<chain, OidcAccount> & ZksyncSsoOidcActions
+  > & ZKsyncSsoOidcData
+>;
+
+export type ClientWithOidcData<
+  transport extends Transport = Transport,
+  chain extends Chain = Chain,
+  account extends Account = Account,
+> = Client<transport, chain, account> & ZKsyncSsoOidcData;
+
+export function createZkSyncOidcClient<
+  transport extends Transport,
+  chain extends Chain,
+  rpcSchema extends RpcSchema | undefined = undefined,
+>(givenParams: SsoClientConfig<transport, chain, rpcSchema>): ZkSyncSsoClient<
+  transport,
+  chain,
+  rpcSchema
+> {
+  type WalletClientParameters = typeof givenParams;
+  const parameters: WalletClientParameters & {
+    key: NonNullable<WalletClientParameters["key"]>;
+    name: NonNullable<WalletClientParameters["name"]>;
+  } = {
+    ...givenParams,
+    address: getAddress(givenParams.address),
+    key: givenParams.key || "zksync-sso-oidc-wallet",
+    name: givenParams.name || "ZKsync SSO OIDC Client",
+  };
+
+  const account = toOidcAccount({
+    address: parameters.address,
+    signTransaction: async () => {
+      return signOidcTransaction(parameters.contracts.recoveryOidc);
+    },
+  });
+
+  return createClient<transport, chain, OidcAccount, rpcSchema>({
+    ...parameters,
+    account,
+    type: "walletClient",
+  })
+    .extend(() => ({
+      contracts: parameters.contracts,
+    }))
+    .extend(publicActions)
+    .extend(zksyncSsoWalletActions)
+    .extend(zksyncSsoOidcActions);
+}

package/src/client/oidc/decorators/actions.ts

@@ -0,0 +1,5 @@
+import { addNewPasskeyViaOidc, type AddNewPasskeyViaOidcArgs } from "../actions/addNewPasskeyViaOidc.js";
+
+export type ZksyncSsoOidcActions = {
+  addNewPasskeyViaOidc: (args: Omit<AddNewPasskeyViaOidcArgs, "contracts">) => ReturnType<typeof addNewPasskeyViaOidc>;
+};

package/src/client/oidc/index.ts

@@ -0,0 +1,3 @@
+export * from "./account.js";
+export * from "./client.js";
+export * from "./serialize.js";

package/src/client/oidc/serialize.ts

@@ -0,0 +1,10 @@
+import type { Hex } from "viem";
+
+export type OidcData = {
+  oidcDigest: Hex;
+  iss: string;
+  readyToRecover: boolean;
+  pendingPasskeyHash: Hex;
+  recoverNonce: bigint;
+  addedOn: bigint;
+};

package/src/client/passkey/actions/account.ts

@@ -52,6 +52,7 @@ export type DeployAccountArgs = {
     passkey: Address;
     session: Address;
     recovery: Address;
+    recoveryOidc: Address;
   };
   initialSession?: SessionConfig;
   onTransactionSent?: (hash: Hash) => void;
@@ -117,6 +118,11 @@ export const deployAccount = async <
     parameters: "0x",
   });
 
+  const encodedOidcRecoveryModuleData = encodeModuleData({
+    address: args.contracts.recoveryOidc,
+    parameters: "0x",
+  });
+
   let deployProxyArgs = {
     account: client.account!,
     chain: client.chain!,
@@ -125,7 +131,7 @@ export const deployAccount = async <
     functionName: "deployProxySsoAccount",
     args: [
       keccak256(toHex(accountId)),
-      [encodedPasskeyModuleData, encodedSessionKeyModuleData, encodedGuardianRecoveryModuleData],
+      [encodedPasskeyModuleData, encodedSessionKeyModuleData, encodedGuardianRecoveryModuleData, encodedOidcRecoveryModuleData],
       [],
     ],
   } as any;

package/src/client/passkey/client.ts

@@ -62,9 +62,11 @@ export function createZksyncPasskeyClient<
 }
 
 export type PasskeyRequiredContracts = {
+  oidcKeyRegistry: Address; // Oidc key registry
   session: Address; // Session, spend limit, etc.
   passkey: Address; // Validator for passkey signature
   recovery: Address; // Validator for account recovery
+  recoveryOidc: Address; // Validator for account recovery with OIDC
   accountFactory?: Address; // For account creation
 };
 type ZksyncSsoPasskeyData = {

package/src/client/passkey/decorators/passkey.ts

@@ -1,5 +1,11 @@
-import { type Chain, type Transport } from "viem";
+import { type Chain, type TransactionReceipt, type Transport } from "viem";
 
+import {
+  addOidcAccount,
+  type AddOidcAccountArgs,
+  type AddOidcAccountReturnType,
+  removeOidcAccount,
+} from "../../recovery/actions/oidc.js";
 import {
   confirmGuardian, type ConfirmGuardianArgs, type ConfirmGuardianReturnType,
   proposeGuardian, type ProposeGuardianArgs, type ProposeGuardianReturnType,
@@ -17,6 +23,8 @@ export type ZksyncSsoPasskeyActions = {
   proposeGuardian: (args: Omit<ProposeGuardianArgs, "contracts">) => Promise<ProposeGuardianReturnType>;
   confirmGuardian: (args: Omit<ConfirmGuardianArgs, "contracts">) => Promise<ConfirmGuardianReturnType>;
   removeGuardian: (args: Omit<RemoveGuardianArgs, "contracts">) => Promise<RemoveGuardianReturnType>;
+  addOidcAccount: (args: Omit<AddOidcAccountArgs, "contracts">) => Promise<AddOidcAccountReturnType>;
+  removeOidcAccount: () => Promise<TransactionReceipt>;
 };
 
 export function zksyncSsoPasskeyActions<
@@ -54,5 +62,16 @@ export function zksyncSsoPasskeyActions<
         contracts: client.contracts,
       });
     },
+    addOidcAccount: async (args: Omit<AddOidcAccountArgs, "contracts">) => {
+      return await addOidcAccount(client, {
+        ...args,
+        contracts: client.contracts,
+      });
+    },
+    removeOidcAccount: async () => {
+      return await removeOidcAccount(client, {
+        contracts: client.contracts,
+      });
+    },
   };
 }