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

package/src/client/recovery/actions/recovery.ts

@@ -1,176 +0,0 @@
-import { type Account, type Address, type Chain, type Client, encodeFunctionData, type Hash, type Hex, keccak256, type Prettify, toHex, type TransactionReceipt, type Transport } from "viem";
-import { waitForTransactionReceipt } from "viem/actions";
-import { getGeneralPaymasterInput, sendTransaction } from "viem/zksync";
-
-import { GuardianRecoveryValidatorAbi } from "../../../abi/GuardianRecoveryValidator.js";
-import { noThrow } from "../../../utils/helpers.js";
-
-export type ProposeGuardianArgs = {
-  newGuardian: Address;
-  contracts: {
-    recovery: Address; // recovery module
-  };
-  origin?: string;
-  paymaster?: {
-    address: Address;
-    paymasterInput?: Hex;
-  };
-  onTransactionSent?: (hash: Hash) => void;
-};
-export type ProposeGuardianReturnType = {
-  transactionReceipt: TransactionReceipt;
-};
-export const proposeGuardian = async <
-  transport extends Transport,
-  chain extends Chain,
-  account extends Account,
->(client: Client<transport, chain, account>, args: Prettify<ProposeGuardianArgs>): Promise<Prettify<ProposeGuardianReturnType>> => {
-  let origin: string | undefined = args.origin;
-  if (!origin) {
-    try {
-      origin = window.location.origin;
-    } catch {
-      throw new Error("Can't identify expectedOrigin, please provide it manually");
-    }
-  }
-
-  const callData = encodeFunctionData({
-    abi: GuardianRecoveryValidatorAbi,
-    functionName: "proposeGuardian",
-    args: [keccak256(toHex(origin)), args.newGuardian],
-  });
-
-  const sendTransactionArgs = {
-    account: client.account,
-    to: args.contracts.recovery,
-    paymaster: args.paymaster?.address,
-    paymasterInput: args.paymaster?.address ? (args.paymaster?.paymasterInput || getGeneralPaymasterInput({ innerInput: "0x" })) : undefined,
-    data: callData,
-    gas: 10_000_000n, // TODO: Remove when gas estimation is fixed
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  } as any;
-
-  const transactionHash = await sendTransaction(client, sendTransactionArgs);
-  if (args.onTransactionSent) {
-    noThrow(() => args.onTransactionSent?.(transactionHash));
-  }
-
-  const transactionReceipt = await waitForTransactionReceipt(client, { hash: transactionHash });
-  if (transactionReceipt.status !== "success") throw new Error("proposeGuardian transaction reverted");
-
-  return {
-    transactionReceipt,
-  };
-};
-export type ConfirmGuardianArgs = {
-  accountToGuard: Address;
-  contracts: {
-    recovery: Address; // recovery module
-  };
-  origin?: string;
-  paymaster?: {
-    address: Address;
-    paymasterInput?: Hex;
-  };
-  onTransactionSent?: (hash: Hash) => void;
-};
-export type ConfirmGuardianReturnType = {
-  transactionReceipt: TransactionReceipt;
-};
-export const confirmGuardian = async <
-  transport extends Transport,
-  chain extends Chain,
-  account extends Account,
->(client: Client<transport, chain, account>, args: Prettify<ConfirmGuardianArgs>): Promise<Prettify<ConfirmGuardianReturnType>> => {
-  let origin: string | undefined = args.origin;
-  if (!origin) {
-    try {
-      origin = window.location.origin;
-    } catch {
-      throw new Error("Can't identify expectedOrigin, please provide it manually");
-    }
-  }
-  const callData = encodeFunctionData({
-    abi: GuardianRecoveryValidatorAbi,
-    functionName: "addGuardian",
-    args: [keccak256(toHex(origin)), args.accountToGuard],
-  });
-
-  const sendTransactionArgs = {
-    account: client.account,
-    to: args.contracts.recovery,
-    paymaster: args.paymaster?.address,
-    paymasterInput: args.paymaster?.address ? (args.paymaster?.paymasterInput || getGeneralPaymasterInput({ innerInput: "0x" })) : undefined,
-    data: callData,
-    gas: 10_000_000n, // TODO: Remove when gas estimation is fixed
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  } as any;
-
-  const transactionHash = await sendTransaction(client, sendTransactionArgs);
-  if (args.onTransactionSent) {
-    noThrow(() => args.onTransactionSent?.(transactionHash));
-  }
-
-  const transactionReceipt = await waitForTransactionReceipt(client, { hash: transactionHash });
-  if (transactionReceipt.status !== "success") throw new Error("confirmGuardian transaction reverted");
-
-  return {
-    transactionReceipt,
-  };
-};
-export type RemoveGuardianArgs = {
-  guardian: Address;
-  contracts: {
-    recovery: Address; // recovery module
-  };
-  origin?: string;
-  paymaster?: {
-    address: Address;
-    paymasterInput?: Hex;
-  };
-  onTransactionSent?: (hash: Hash) => void;
-};
-export type RemoveGuardianReturnType = {
-  transactionReceipt: TransactionReceipt;
-};
-export const removeGuardian = async <
-  transport extends Transport,
-  chain extends Chain,
-  account extends Account,
->(client: Client<transport, chain, account>, args: Prettify<RemoveGuardianArgs>): Promise<Prettify<RemoveGuardianReturnType>> => {
-  let origin: string | undefined = args.origin;
-  if (!origin) {
-    try {
-      origin = window.location.origin;
-    } catch {
-      throw new Error("Can't identify expectedOrigin, please provide it manually");
-    }
-  }
-  const callData = encodeFunctionData({
-    abi: GuardianRecoveryValidatorAbi,
-    functionName: "removeGuardian",
-    args: [keccak256(toHex(origin)), args.guardian],
-  });
-
-  const sendTransactionArgs = {
-    account: client.account,
-    to: args.contracts.recovery,
-    paymaster: args.paymaster?.address,
-    paymasterInput: args.paymaster?.address ? (args.paymaster?.paymasterInput || getGeneralPaymasterInput({ innerInput: "0x" })) : undefined,
-    data: callData,
-    gas: 10_000_000n, // TODO: Remove when gas estimation is fixed
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  } as any;
-
-  const transactionHash = await sendTransaction(client, sendTransactionArgs);
-  if (args.onTransactionSent) {
-    noThrow(() => args.onTransactionSent?.(transactionHash));
-  }
-
-  const transactionReceipt = await waitForTransactionReceipt(client, { hash: transactionHash });
-  if (transactionReceipt.status !== "success") throw new Error("removeGuardian transaction reverted");
-
-  return {
-    transactionReceipt,
-  };
-};

package/src/client/recovery/actions/sendEip712Transaction.ts

@@ -1,149 +0,0 @@
-import { type Account, assertRequest, type AssertRequestErrorType, type Chain, type Client, type ExactPartial, type Hash, type PublicActions, type RpcSchema, type SendTransactionRequest, type Transport, type WalletActions } from "viem";
-import { parseAccount } from "viem/accounts";
-import { prepareTransactionRequest, sendRawTransaction } from "viem/actions";
-import { type ChainEIP712, type SendEip712TransactionParameters, type SendEip712TransactionReturnType, type SendTransactionParameters, zksync } from "viem/zksync";
-
-import { InvalidEip712TransactionError, type InvalidEip712TransactionErrorType } from "../../utils/assertEip712Transaction.js";
-import { isEIP712Transaction } from "../../utils/isEip712Transaction.js";
-
-/**
- * Creates, signs, and sends a new EIP712 transaction to the network.
- *
- * @param client - Client to use
- * @param parameters - {@link SendEip712TransactionParameters}
- * @returns The [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. {@link SendTransactionReturnType}
- *
- * @example
- * import { createWalletClient, custom } from 'viem'
- * import { zksync } from 'viem/chains'
- * import { sendEip712Transaction } from 'viem/zksync'
- *
- * const client = createWalletClient({
- *   chain: zksync,
- *   transport: custom(window.ethereum),
- * })
- * const hash = await sendEip712Transaction(client, {
- *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
- *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
- *   value: 1000000000000000000n,
- * })
- *
- * @example
- * // Account Hoisting
- * import { createWalletClient, http } from 'viem'
- * import { privateKeyToAccount } from 'viem/accounts'
- * import { zksync } from 'viem/chains'
- * import { sendEip712Transaction } from 'viem/zksync'
- *
- * const client = createWalletClient({
- *   account: privateKeyToAccount('0x…'),
- *   chain: zksync,
- *   transport: http(),
- * })
- *
- * const hash = await sendEip712Transaction(client, {
- *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
- *   value: 1000000000000000000n,
- * })
- */
-export async function sendEip712Transaction<
-  chain extends ChainEIP712 | undefined,
-  account extends Account | undefined,
-  const request extends SendTransactionRequest<chain, chainOverride>,
-  chainOverride extends ChainEIP712 | undefined = undefined,
->(
-  client: Client<Transport, chain, account>,
-  parameters: SendEip712TransactionParameters<
-    chain,
-    account,
-    chainOverride,
-    request
-  >,
-): Promise<SendEip712TransactionReturnType> {
-  const {
-    account: account_ = client.account,
-    chain = client.chain,
-    ...rest
-  } = parameters;
-
-  if (!account_)
-    throw new Error("Account not found.");
-  const account = parseAccount(account_);
-
-  assertEip712Request(parameters);
-
-  const request = await getAction(
-    client,
-    prepareTransactionRequest,
-    "prepareTransactionRequest",
-  )({
-    account,
-    chain,
-    nonceManager: account.nonceManager,
-    ...rest,
-  } as any);
-
-  const serializer = chain?.serializers?.transaction;
-  const serializedTransaction = (await account.signTransaction!(request, {
-    serializer,
-  })) as Hash;
-
-  return await getAction(
-    client,
-    sendRawTransaction,
-    "sendRawTransaction",
-  )({
-    serializedTransaction,
-  });
-}
-
-/**
- * Retrieves and returns an action from the client (if exists), and falls
- * back to the tree-shakable action.
- *
- * Useful for extracting overridden actions from a client (ie. if a consumer
- * wants to override the `sendTransaction` implementation).
- */
-export function getAction<
-  transport extends Transport,
-  chain extends Chain | undefined,
-  account extends Account | undefined,
-  rpcSchema extends RpcSchema | undefined,
-  extended extends { [key: string]: unknown },
-  client extends Client<transport, chain, account, rpcSchema, extended>,
-  parameters,
-  returnType,
->(
-  client: client,
-  actionFn: (_: any, parameters: parameters) => returnType,
-  // cspell:ignore minifiers
-  // Some minifiers drop `Function.prototype.name`, or replace it with short letters,
-  // meaning that `actionFn.name` will not always work. For that case, the consumer
-  // needs to pass the name explicitly.
-  name: keyof PublicActions | keyof WalletActions | (string & {}),
-): (parameters: parameters) => returnType {
-  const action_implicit = client[actionFn.name];
-  if (typeof action_implicit === "function")
-    return action_implicit as (params: parameters) => returnType;
-
-  const action_explicit = client[name];
-  if (typeof action_explicit === "function")
-    return action_explicit as (params: parameters) => returnType;
-
-  return (params) => actionFn(client, params);
-}
-
-type AssertEip712RequestParameters = ExactPartial<
-  SendTransactionParameters<typeof zksync>
->;
-
-/** @internal */
-export type AssertEip712RequestErrorType =
-  | InvalidEip712TransactionErrorType
-  | AssertRequestErrorType;
-
-export function assertEip712Request(args: AssertEip712RequestParameters) {
-  if (!isEIP712Transaction(args as any))
-    throw new InvalidEip712TransactionError();
-  assertRequest(args as any);
-}

package/src/client/recovery/client.ts

@@ -1,102 +0,0 @@
-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 { toRecoveryAccount } from "./account.js";
-import { publicActionsRewrite } from "./decorators/publicActionsRewrite.js";
-import { type ZksyncSsoRecoveryActions, zksyncSsoRecoveryActions } from "./decorators/recovery.js";
-import { type ZksyncSsoWalletActions, zksyncSsoWalletActions } from "./decorators/wallet.js";
-
-export const signRecoveryTransaction = (recoveryValidatorAddress: `0x${string}`) => {
-  return encodeAbiParameters(
-    [
-      { type: "bytes", name: "unusedSignedHash" },
-      { type: "address", name: "recoveryContract" },
-      { type: "bytes", name: "validatorData" },
-    ],
-    [
-      "0x",
-      recoveryValidatorAddress,
-      "0x",
-    ],
-  );
-};
-
-export function createZksyncRecoveryGuardianClient<
-  transport extends Transport,
-  chain extends Chain,
-  rpcSchema extends RpcSchema | undefined = undefined,
->(_parameters: ZksyncSsoRecoveryClientConfig<transport, chain, rpcSchema>): ZksyncSsoRecoveryClient<transport, chain, rpcSchema> {
-  type WalletClientParameters = typeof _parameters;
-  const parameters: WalletClientParameters & {
-    key: NonNullable<WalletClientParameters["key"]>;
-    name: NonNullable<WalletClientParameters["name"]>;
-  } = {
-    ..._parameters,
-    address: getAddress(_parameters.address),
-    key: _parameters.key || "zksync-sso-recovery-wallet",
-    name: _parameters.name || "ZKsync SSO Recovery Client",
-  };
-
-  const account = toRecoveryAccount({
-    address: parameters.address,
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    signTransaction: async ({ hash: _ }) => {
-      return signRecoveryTransaction(parameters.contracts.recovery);
-    },
-  });
-  const client = createClient<transport, chain, Account, rpcSchema>({
-    ...parameters,
-    account,
-    type: "walletClient",
-  })
-    .extend(() => ({
-      contracts: parameters.contracts,
-    }))
-    .extend(publicActions)
-    .extend(publicActionsRewrite)
-    .extend(zksyncSsoWalletActions)
-    .extend(zksyncSsoRecoveryActions);
-  return client;
-}
-
-export type RecoveryRequiredContracts = {
-  recovery: Address; // Recovery
-  passkey: Address; // Passkey
-};
-type ZksyncSsoRecoveryData = {
-  contracts: RecoveryRequiredContracts;
-};
-
-export type ClientWithZksyncSsoRecoveryData<
-  transport extends Transport = Transport,
-  chain extends Chain = Chain,
-  account extends Account = Account,
-> = Client<transport, chain, account> & ZksyncSsoRecoveryData;
-
-export type ZksyncSsoRecoveryClient<
-  transport extends Transport = Transport,
-  chain extends Chain = Chain,
-  rpcSchema extends RpcSchema | undefined = undefined,
-  account extends Account = Account,
-> = Prettify<
-  Client<
-    transport,
-    chain,
-    account,
-    rpcSchema extends RpcSchema
-      ? [...PublicRpcSchema, ...WalletRpcSchema, ...rpcSchema]
-      : [...PublicRpcSchema, ...WalletRpcSchema],
-    ZksyncSsoWalletActions<chain, account> & ZksyncSsoRecoveryActions
-  > & ZksyncSsoRecoveryData
->;
-
-export interface ZksyncSsoRecoveryClientConfig<
-  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: RecoveryRequiredContracts;
-  key?: string;
-  name?: string;
-}

package/src/client/recovery/decorators/publicActionsRewrite.ts

@@ -1,38 +0,0 @@
-import { type Account, type Chain, type PublicActions, type Transport } from "viem";
-import { estimateContractGas, estimateGas, prepareTransactionRequest } from "viem/actions";
-
-import { type ClientWithZksyncSsoRecoveryData, signRecoveryTransaction } from "../client.js";
-
-export function publicActionsRewrite<
-  transport extends Transport,
-  chain extends Chain,
-  account extends Account,
->(
-  client: ClientWithZksyncSsoRecoveryData<transport, chain, account>,
-): Pick<PublicActions<transport, chain, account>, "estimateContractGas" | "estimateGas" | "prepareTransactionRequest"> {
-  return {
-    prepareTransactionRequest: async (args) => {
-      if (!("customSignature" in args)) {
-        (args as any).customSignature = signRecoveryTransaction(client.contracts.recovery);
-      }
-      const request = await prepareTransactionRequest(client, {
-        ...args,
-        type: "eip712",
-      } as any) as any;
-      return request;
-    },
-    estimateContractGas: (args) => {
-      if (!("customSignature" in args)) {
-        (args as any).customSignature = signRecoveryTransaction(client.contracts.recovery);
-      }
-      return estimateContractGas(client, args as any);
-    },
-    estimateGas: async (args) => {
-      if (!("customSignature" in args)) {
-        (args as any).customSignature = signRecoveryTransaction(client.contracts.recovery);
-      }
-      const estimated = await estimateGas(client, args);
-      return estimated;
-    },
-  };
-}

package/src/client/recovery/decorators/recovery.ts

@@ -1,22 +0,0 @@
-import { type Chain, type Transport } from "viem";
-
-import { addAccountOwnerPasskey, type AddAccountOwnerPasskeyArgs, type AddAccountOwnerPasskeyReturnType } from "../../passkey/index.js";
-import type { ClientWithZksyncSsoRecoveryData } from "../client.js";
-
-export type ZksyncSsoRecoveryActions = {
-  addAccountOwnerPasskey: (args: Omit<AddAccountOwnerPasskeyArgs, "contracts">) => Promise<AddAccountOwnerPasskeyReturnType>;
-};
-
-export function zksyncSsoRecoveryActions<
-  transport extends Transport,
-  chain extends Chain,
->(client: ClientWithZksyncSsoRecoveryData<transport, chain>): ZksyncSsoRecoveryActions {
-  return {
-    addAccountOwnerPasskey: async (args: Omit<AddAccountOwnerPasskeyArgs, "contracts">) => {
-      return await addAccountOwnerPasskey(client, {
-        ...args,
-        contracts: client.contracts,
-      });
-    },
-  };
-}

package/src/client/recovery/decorators/wallet.ts

@@ -1,59 +0,0 @@
-import { type Account, bytesToHex, type Chain, formatTransaction, type Transport, type WalletActions } from "viem";
-import { deployContract, getAddresses, getCallsStatus, getCapabilities, getChainId, prepareAuthorization, sendCalls, sendRawTransaction, showCallsStatus, signAuthorization, signMessage, signTypedData, waitForCallsStatus, writeContract } from "viem/actions";
-import { signTransaction, type ZksyncEip712Meta } from "viem/zksync";
-
-import { sendEip712Transaction } from "../actions/sendEip712Transaction.js";
-import type { ClientWithZksyncSsoRecoveryData } from "../client.js";
-
-export type ZksyncSsoWalletActions<chain extends Chain, account extends Account> = Omit<
-  WalletActions<chain, account>, "addChain" | "getPermissions" | "requestAddresses" | "requestPermissions" | "switchChain" | "watchAsset" | "prepareTransactionRequest"
->;
-
-export function zksyncSsoWalletActions<
-  transport extends Transport,
-  chain extends Chain,
-  account extends Account,
->(client: ClientWithZksyncSsoRecoveryData<transport, chain, account>): ZksyncSsoWalletActions<chain, account> {
-  return {
-    deployContract: (args) => deployContract(client, args),
-    getAddresses: () => getAddresses(client),
-    getChainId: () => getChainId(client),
-    sendRawTransaction: (args) => sendRawTransaction(client, args),
-    sendTransaction: async (args) => {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const unformattedTx: any = Object.assign({}, args);
-
-      if ("eip712Meta" in unformattedTx) {
-        const eip712Meta = unformattedTx.eip712Meta as ZksyncEip712Meta;
-        unformattedTx.gasPerPubdata = eip712Meta.gasPerPubdata ? BigInt(eip712Meta.gasPerPubdata) : undefined;
-        unformattedTx.factoryDeps = eip712Meta.factoryDeps;
-        unformattedTx.customSignature = eip712Meta.customSignature;
-        unformattedTx.paymaster = eip712Meta.paymasterParams?.paymaster;
-        unformattedTx.paymasterInput = eip712Meta.paymasterParams?.paymasterInput ? bytesToHex(new Uint8Array(eip712Meta.paymasterParams?.paymasterInput)) : undefined;
-        delete unformattedTx.eip712Meta;
-      }
-
-      const formatters = client.chain?.formatters;
-      const format = formatters?.transaction?.format || formatTransaction;
-
-      const tx = {
-        ...format(unformattedTx),
-        type: "eip712",
-      };
-
-      return await sendEip712Transaction(client, tx);
-    },
-    signMessage: (args) => signMessage(client, args),
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    signTransaction: (args) => signTransaction(client, args as any) as any,
-    signTypedData: (args) => signTypedData(client, args),
-    writeContract: (args) => writeContract(client, args),
-    signAuthorization: (args) => signAuthorization(client, args),
-    getCallsStatus: (args) => getCallsStatus(client, args),
-    getCapabilities: (args) => getCapabilities(client, args),
-    prepareAuthorization: (args) => prepareAuthorization(client, args),
-    sendCalls: (args) => sendCalls(client, args),
-    showCallsStatus: (args) => showCallsStatus(client, args),
-    waitForCallsStatus: (args) => waitForCallsStatus(client, args),
-  };
-}

package/src/client/recovery/index.ts

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