@aa-sdk/core 4.0.0-alpha.0

package/src/signer/local-account.ts

@@ -0,0 +1,59 @@
+import {
+  type HDAccount,
+  type HDOptions,
+  type Hex,
+  type LocalAccount,
+  type PrivateKeyAccount,
+  type SignableMessage,
+  type TypedData,
+  type TypedDataDefinition,
+} from "viem";
+import { mnemonicToAccount, privateKeyToAccount } from "viem/accounts";
+import type { SmartAccountSigner } from "./types.js";
+
+export class LocalAccountSigner<
+  T extends HDAccount | PrivateKeyAccount | LocalAccount
+> implements SmartAccountSigner<T>
+{
+  inner: T;
+  signerType: string;
+
+  constructor(inner: T) {
+    this.inner = inner;
+    this.signerType = inner.type; //  type: "local"
+  }
+
+  readonly signMessage: (message: SignableMessage) => Promise<`0x${string}`> = (
+    message
+  ) => {
+    return this.inner.signMessage({ message });
+  };
+
+  readonly signTypedData = async <
+    const TTypedData extends TypedData | { [key: string]: unknown },
+    TPrimaryType extends string = string
+  >(
+    params: TypedDataDefinition<TTypedData, TPrimaryType>
+  ): Promise<Hex> => {
+    return this.inner.signTypedData(params);
+  };
+
+  readonly getAddress: () => Promise<`0x${string}`> = async () => {
+    return this.inner.address;
+  };
+
+  static mnemonicToAccountSigner(
+    key: string,
+    opts?: HDOptions
+  ): LocalAccountSigner<HDAccount> {
+    const signer = mnemonicToAccount(key, opts);
+    return new LocalAccountSigner(signer);
+  }
+
+  static privateKeyToAccountSigner(
+    key: Hex
+  ): LocalAccountSigner<PrivateKeyAccount> {
+    const signer = privateKeyToAccount(key);
+    return new LocalAccountSigner(signer);
+  }
+}

package/src/signer/schema.ts

@@ -0,0 +1,16 @@
+import { z } from "zod";
+import type { SmartAccountSigner } from "./types";
+
+export const isSigner = (signer: any): signer is SmartAccountSigner => {
+  return (
+    signer != null &&
+    typeof signer === "object" &&
+    "signerType" in signer &&
+    "signMessage" in signer &&
+    "signTypedData" in signer &&
+    "getAddress" in signer &&
+    "inner" in signer
+  );
+};
+
+export const SignerSchema = z.custom<SmartAccountSigner>(isSigner);

package/src/signer/types.ts

@@ -0,0 +1,46 @@
+import type { Address } from "abitype";
+import type {
+  Hex,
+  SignableMessage,
+  TypedData,
+  TypedDataDefinition,
+} from "viem";
+
+// [!region SmartAccountAuthenticator]
+/**
+ * Extends the @interface SmartAccountSigner interface with authentication.
+ *
+ * @template AuthParams - the generic type of the authentication parameters
+ * @template AuthDetails - the generic type of the authentication details
+ * @template Inner - the generic type of the inner client that the signer wraps to provide functionality such as signing, etc.
+ */
+export interface SmartAccountAuthenticator<AuthParams, AuthDetails, Inner = any>
+  extends SmartAccountSigner<Inner> {
+  authenticate: (params: AuthParams) => Promise<AuthDetails>;
+
+  getAuthDetails: () => Promise<AuthDetails>;
+}
+// [!endregion SmartAccountAuthenticator]
+
+// [!region SmartAccountSigner]
+/**
+ * A signer that can sign messages and typed data.
+ *
+ * @template Inner - the generic type of the inner client that the signer wraps to provide functionality such as signing, etc.
+ */
+export interface SmartAccountSigner<Inner = any> {
+  signerType: string;
+  inner: Inner;
+
+  getAddress: () => Promise<Address>;
+
+  signMessage: (message: SignableMessage) => Promise<Hex>;
+
+  signTypedData: <
+    const TTypedData extends TypedData | { [key: string]: unknown },
+    TPrimaryType extends string = string
+  >(
+    params: TypedDataDefinition<TTypedData, TPrimaryType>
+  ) => Promise<Hex>;
+}
+// [!endregion SmartAccountSigner]

package/src/signer/utils.ts

@@ -0,0 +1,68 @@
+import {
+  concat,
+  encodeAbiParameters,
+  parseAbiParameters,
+  type Address,
+  type Hash,
+  type Hex,
+  type PublicClient,
+} from "viem";
+
+export type SignWith6492Params = {
+  factoryAddress: Address;
+  factoryCalldata: Hex;
+  signature: Hash;
+};
+
+type VerifyEIP6492SignatureParams = {
+  signer: Address;
+  hash: Hash;
+  signature: Hash;
+  client: PublicClient;
+};
+
+export const wrapSignatureWith6492 = ({
+  factoryAddress,
+  factoryCalldata,
+  signature,
+}: SignWith6492Params): Hash => {
+  // wrap the signature as follows: https://eips.ethereum.org/EIPS/eip-6492
+  // concat(
+  //  abi.encode(
+  //    (create2Factory, factoryCalldata, originalERC1271Signature),
+  //    (address, bytes, bytes)),
+  //    magicBytes
+  // )
+  return concat([
+    encodeAbiParameters(parseAbiParameters("address, bytes, bytes"), [
+      factoryAddress,
+      factoryCalldata,
+      signature,
+    ]),
+    "0x6492649264926492649264926492649264926492649264926492649264926492",
+  ]);
+};
+
+// defined in https://github.com/AmbireTech/signature-validator/blob/main/index.ts#L13C17-L13C17
+const universalValidatorByteCode =
+  "0x60806040523480156200001157600080fd5b50604051620007003803806200070083398101604081905262000034916200056f565b6000620000438484846200004f565b9050806000526001601ff35b600080846001600160a01b0316803b806020016040519081016040528181526000908060200190933c90507f6492649264926492649264926492649264926492649264926492649264926492620000a68462000451565b036200021f57600060608085806020019051810190620000c79190620005ce565b8651929550909350915060000362000192576000836001600160a01b031683604051620000f5919062000643565b6000604051808303816000865af19150503d806000811462000134576040519150601f19603f3d011682016040523d82523d6000602084013e62000139565b606091505b5050905080620001905760405162461bcd60e51b815260206004820152601e60248201527f5369676e617475726556616c696461746f723a206465706c6f796d656e74000060448201526064015b60405180910390fd5b505b604051630b135d3f60e11b808252906001600160a01b038a1690631626ba7e90620001c4908b90869060040162000661565b602060405180830381865afa158015620001e2573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906200020891906200069d565b6001600160e01b031916149450505050506200044a565b805115620002b157604051630b135d3f60e11b808252906001600160a01b03871690631626ba7e9062000259908890889060040162000661565b602060405180830381865afa15801562000277573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906200029d91906200069d565b6001600160e01b031916149150506200044a565b8251604114620003195760405162461bcd60e51b815260206004820152603a6024820152600080516020620006e083398151915260448201527f3a20696e76616c6964207369676e6174757265206c656e677468000000000000606482015260840162000187565b620003236200046b565b506020830151604080850151855186939260009185919081106200034b576200034b620006c9565b016020015160f81c9050601b81148015906200036b57508060ff16601c14155b15620003cf5760405162461bcd60e51b815260206004820152603b6024820152600080516020620006e083398151915260448201527f3a20696e76616c6964207369676e617475726520762076616c75650000000000606482015260840162000187565b6040805160008152602081018083528a905260ff83169181019190915260608101849052608081018390526001600160a01b038a169060019060a0016020604051602081039080840390855afa1580156200042e573d6000803e3d6000fd5b505050602060405103516001600160a01b031614955050505050505b9392505050565b60006020825110156200046357600080fd5b508051015190565b60405180606001604052806003906020820280368337509192915050565b6001600160a01b03811681146200049f57600080fd5b50565b634e487b7160e01b600052604160045260246000fd5b60005b83811015620004d5578181015183820152602001620004bb565b50506000910152565b600082601f830112620004f057600080fd5b81516001600160401b03808211156200050d576200050d620004a2565b604051601f8301601f19908116603f01168101908282118183101715620005385762000538620004a2565b816040528381528660208588010111156200055257600080fd5b62000565846020830160208901620004b8565b9695505050505050565b6000806000606084860312156200058557600080fd5b8351620005928162000489565b6020850151604086015191945092506001600160401b03811115620005b657600080fd5b620005c486828701620004de565b9150509250925092565b600080600060608486031215620005e457600080fd5b8351620005f18162000489565b60208501519093506001600160401b03808211156200060f57600080fd5b6200061d87838801620004de565b935060408601519150808211156200063457600080fd5b50620005c486828701620004de565b6000825162000657818460208701620004b8565b9190910192915050565b828152604060208201526000825180604084015262000688816060850160208701620004b8565b601f01601f1916919091016060019392505050565b600060208284031215620006b057600080fd5b81516001600160e01b0319811681146200044a57600080fd5b634e487b7160e01b600052603260045260246000fdfe5369676e617475726556616c696461746f72237265636f7665725369676e6572";
+
+export const verifyEIP6492Signature = async ({
+  signer,
+  hash,
+  signature,
+  client,
+}: VerifyEIP6492SignatureParams): Promise<boolean> => {
+  const result = await client.call({
+    data: concat([
+      universalValidatorByteCode,
+      encodeAbiParameters(parseAbiParameters("address, bytes32, bytes"), [
+        signer,
+        hash,
+        signature,
+      ]),
+    ]),
+  });
+
+  return result.data === "0x01";
+};

package/src/signer/wallet-client.ts

@@ -0,0 +1,49 @@
+import {
+  getAddress,
+  type Hex,
+  type SignableMessage,
+  type TypedData,
+  type TypedDataDefinition,
+  type WalletClient,
+} from "viem";
+import { InvalidSignerTypeError } from "../errors/signer.js";
+import type { SmartAccountSigner } from "./types";
+
+export class WalletClientSigner implements SmartAccountSigner<WalletClient> {
+  signerType: string;
+  inner: WalletClient;
+
+  constructor(client: WalletClient, signerType: string) {
+    this.inner = client;
+    if (!signerType) {
+      throw new InvalidSignerTypeError(signerType);
+    }
+    this.signerType = signerType;
+  }
+
+  getAddress: () => Promise<`0x${string}`> = async () => {
+    let addresses = await this.inner.getAddresses();
+    return getAddress(addresses[0]);
+  };
+
+  readonly signMessage: (message: SignableMessage) => Promise<`0x${string}`> =
+    async (message) => {
+      const account = this.inner.account ?? (await this.getAddress());
+
+      return this.inner.signMessage({ message, account });
+    };
+
+  signTypedData = async <
+    const TTypedData extends TypedData | { [key: string]: unknown },
+    TPrimaryType extends string = string
+  >(
+    typedData: TypedDataDefinition<TTypedData, TPrimaryType>
+  ): Promise<Hex> => {
+    const account = this.inner.account ?? (await this.getAddress());
+
+    return this.inner.signTypedData({
+      account,
+      ...typedData,
+    });
+  };
+}

package/src/transport/split.ts

@@ -0,0 +1,69 @@
+import { custom, type CustomTransport, type Transport } from "viem";
+
+export interface SplitTransportParams {
+  overrides: {
+    methods: string[];
+    transport: Transport;
+  }[];
+  fallback: Transport;
+}
+
+/**
+ * The Split Transport allows you to split RPC traffic for specific methods across
+ * different RPC providers. This is done by specifying the methods you want handled
+ * specially as overrides and providing a fallback transport for all other methods.
+ *
+ * @example
+ * ```ts
+ * import { createPublicClient, http } from "viem";
+ * import { split } from "@aa-sdk/core";
+ *
+ * const bundlerMethods = [
+ *  "eth_sendUserOperation",
+ *  "eth_estimateUserOperationGas",
+ *  "eth_getUserOperationReceipt",
+ *  "eth_getUserOperationByHash",
+ *  "eth_supportedEntryPoints"
+ * ];
+ *
+ * const clientWithSplit = createPublicClient({
+ *  transport: split({
+ *      overrides: [{
+ *          methods: bundlerMethods,
+ *          transport: http(BUNDLER_RPC_URL)
+ *      }]
+ *      fallback: http(OTHER_RPC_URL)
+ *  }),
+ * });
+ * ```
+ *
+ * @param params {@link SplitTransportParams} split transport configuration containing the methods overrides and fallback transport
+ * @returns a {@link CustomTransport} that splits traffic
+ */
+export const split = (params: SplitTransportParams): CustomTransport => {
+  const overrideMap = params.overrides.reduce((accum, curr) => {
+    curr.methods.forEach((method) => {
+      if (accum.has(method) && accum.get(method) !== curr.transport) {
+        throw new Error(
+          "A method cannot be handled by more than one transport"
+        );
+      }
+
+      accum.set(method, curr.transport);
+    });
+
+    return accum;
+  }, new Map<string, Transport>());
+
+  return (opts) =>
+    custom({
+      request: async (args) => {
+        const transportOverride = overrideMap.get(args.method);
+        if (transportOverride != null) {
+          return transportOverride(opts).request(args);
+        }
+
+        return params.fallback(opts).request(args);
+      },
+    })(opts);
+};