@zerodev/sdk 4.5.5 → 5.0.0-beta.0

package/src/kernel-zerodev/owner/getCustodialOwner.ts

@@ -1,131 +0,0 @@
-import type { SignTypedDataParams, SmartAccountSigner } from "@alchemy/aa-core";
-import { API_URL } from "../constants.js";
-import axios from "axios";
-
-/**
- * Params to get a custodial owner
- * Priv / pub key combo or custodial file path should be in different types
- */
-type GetCustodialOwnerParams = {
-  // ZeroDev api url
-  apiUrl?: string;
-  // Turnkey client (if the client want to reuse it
-  turnKeyClient?: unknown;
-
-  // Direct access to priv / pub key
-  privateKey?: string;
-  publicKey?: string;
-  keyId?: string;
-
-  // Or read them from the custodial file path
-  custodialFilePath?: string;
-};
-
-/**
- * Returns a signer for a custodial wallet via TurnKey
- */
-export async function getCustodialOwner(
-  identifier: string,
-  {
-    custodialFilePath,
-    privateKey,
-    publicKey,
-    keyId,
-    apiUrl = API_URL,
-    turnKeyClient,
-  }: GetCustodialOwnerParams
-): Promise<SmartAccountSigner | undefined> {
-  // Extract data from the custodial file path if provided
-  if (custodialFilePath) {
-    let fsModule;
-    try {
-      fsModule = require.resolve("fs") && require("fs");
-    } catch (error) {
-      console.log("FS module not available. Skipping FS operation...");
-      return;
-    }
-    const data = fsModule.readFileSync(custodialFilePath, "utf8");
-    const values = data.split("\n");
-    // Override the values, if they are provided, to the one from the custodial file
-    [privateKey, publicKey, keyId] = values;
-  }
-
-  // Ensure we have the required values
-  if (!privateKey || !publicKey || !keyId) {
-    throw new Error(
-      "Must provide custodialFilePath or privateKey, publicKey, and keyId."
-    );
-  }
-
-  // Get our turnkey client (build it if needed)
-  if (!turnKeyClient) {
-    // Try to fetch turnkey client & api key stamper
-    let TurnkeyClient;
-    let ApiKeyStamper;
-    // TODO: Would be cleaner with something like radash and a tryit function?
-    try {
-      TurnkeyClient =
-        require.resolve("@turnkey/http") &&
-        require("@turnkey/http").TurnkeyClient;
-      ApiKeyStamper =
-        require.resolve("@turnkey/api-key-stamper") &&
-        require("@turnkey/api-key-stamper").ApiKeyStamper;
-    } catch (error) {
-      console.log(
-        "@turnkey/http or @turnkey/api-key-stamper module not available. Skipping FS operation..."
-      );
-      return;
-    }
-
-    // Build the turnkey client
-    turnKeyClient = new TurnkeyClient(
-      {
-        baseUrl: "https://api.turnkey.com",
-      },
-      new ApiKeyStamper({
-        apiPublicKey: publicKey,
-        apiPrivateKey: privateKey,
-      })
-    );
-  }
-
-  // Get the wallet identifier from the API
-  const response = await axios.post<any, { data: { walletId: string } }>(
-    `${apiUrl}/wallets/${identifier}`,
-    {
-      keyId,
-    }
-  );
-
-  // Build the turnkey viem account
-  let createAccount;
-  try {
-    createAccount =
-      require.resolve("@turnkey/viem") &&
-      require("@turnkey/viem").createAccount;
-  } catch (error) {
-    console.log("@turnkey/viem module not available. Skipping FS operation...");
-    return;
-  }
-  const turnkeySigner = await createAccount({
-    client: turnKeyClient,
-    organizationId: keyId,
-    privateKeyId: response.data.walletId,
-  });
-
-  // Return an alchemy AA signer from the turnkey signer
-  return {
-    getAddress: async () => turnkeySigner.address,
-    signMessage: async (msg: Uint8Array | string) => {
-      if (typeof msg === "string") {
-        // If the msg is a string, sign it directly
-        return turnkeySigner.signMessage({ message: msg });
-      } else {
-        // Otherwise, sign the raw data
-        return turnkeySigner.signMessage({ message: { raw: msg } });
-      }
-    },
-    signTypedData: async (params: SignTypedDataParams) =>
-      turnkeySigner.signTypedData(params),
-  };
-}

package/src/kernel-zerodev/owner/getRPCProviderOwner.ts

@@ -1,26 +0,0 @@
-import type { SignTypedDataParams, SmartAccountSigner } from "@alchemy/aa-core";
-import { Web3Provider, type ExternalProvider } from "@ethersproject/providers";
-import { fixSignedData } from "../utils.js";
-import type { Hex } from "viem";
-import { type TypedDataField } from "@ethersproject/abstract-signer";
-
-export function getRPCProviderOwner(web3Provider: any): SmartAccountSigner {
-  const provider = new Web3Provider(web3Provider as ExternalProvider);
-  const signer = provider.getSigner();
-
-  return {
-    getAddress: async () =>
-      Promise.resolve((await signer.getAddress()) as `0x${string}`),
-    signMessage: async (msg: Uint8Array | string) =>
-      (await signer.signMessage(msg)) as `0x${string}`,
-    signTypedData: async (params: SignTypedDataParams) => {
-      return fixSignedData(
-        (await signer._signTypedData(
-          params.domain!,
-          params.types as unknown as Record<string, TypedDataField[]>,
-          params.message
-        )) as Hex
-      );
-    },
-  };
-}

package/src/kernel-zerodev/owner/index.ts

@@ -1,2 +0,0 @@
-export { getCustodialOwner } from "./getCustodialOwner.js";
-export { getRPCProviderOwner } from "./getRPCProviderOwner.js";

package/src/kernel-zerodev/owner/passkey/createPasskeyOwner.ts

@@ -1,107 +0,0 @@
-import { getWebAuthnAttestation } from "@turnkey/http";
-import axios from "axios";
-import type { SignTypedDataParams, SmartAccountSigner } from "@alchemy/aa-core";
-import {
-  abortWebauthn,
-  base64UrlEncode,
-  es256,
-  generateRandomBuffer,
-  getCredentials,
-  publicKey,
-  signMessage,
-  signTypedData,
-} from "./utils.js";
-import { API_URL } from "../../constants.js";
-import { UsernameIsAlreadyUsed } from "./exceptions.js";
-
-export async function createPasskeyOwner({
-  name,
-  projectId,
-  withCredentials = false,
-  fallback,
-  apiUrl = API_URL,
-}: {
-  name: string;
-  projectId: string;
-  withCredentials?: boolean;
-  fallback?: () => Promise<SmartAccountSigner | undefined>;
-  apiUrl?: string;
-}): Promise<SmartAccountSigner | undefined> {
-  if (typeof window !== "undefined") {
-    const challenge = generateRandomBuffer();
-    let credentials = undefined;
-    if (withCredentials) {
-      credentials = await getCredentials(projectId, name);
-    }
-    if (credentials && credentials?.length >= 64) {
-      throw new UsernameIsAlreadyUsed();
-    }
-
-    try {
-      abortWebauthn();
-      const attestation = await getWebAuthnAttestation({
-        publicKey: {
-          rp: {
-            id: window.location.hostname,
-            name: window.location.hostname,
-          },
-          authenticatorSelection: {
-            residentKey: "required", // or 'preferred', 'discouraged'
-            userVerification: "required",
-          },
-          excludeCredentials: credentials,
-          extensions: { credProps: true },
-          challenge,
-          pubKeyCredParams: [
-            {
-              type: publicKey,
-              alg: es256,
-            },
-          ],
-          user: {
-            id: Uint8Array.from(name, (c) => c.charCodeAt(0)),
-            name,
-            displayName: name,
-          },
-        },
-      });
-      const response = await axios.post(
-        `${apiUrl}/projects/${projectId}/wallets`,
-        {
-          challenge: base64UrlEncode(challenge),
-          name,
-          attestation,
-        }
-      );
-      const { id, walletId, address } = await response.data;
-      const owner: SmartAccountSigner = {
-        getAddress: async () => address,
-        signMessage: (msg) =>
-          signMessage(
-            msg,
-            id,
-            walletId,
-            projectId,
-            attestation.credentialId,
-            apiUrl
-          ),
-        signTypedData: (params: SignTypedDataParams) =>
-          signTypedData(
-            params,
-            id,
-            walletId,
-            projectId,
-            attestation.credentialId,
-            apiUrl
-          ),
-      };
-      return owner;
-    } catch (e) {
-      if (e instanceof DOMException && e.name === "InvalidStateError") {
-        if (fallback) return await fallback();
-      }
-      console.log(e);
-    }
-  }
-  return;
-}

package/src/kernel-zerodev/owner/passkey/exceptions.ts

@@ -1,3 +0,0 @@
-export class UsernameIsAlreadyUsed extends Error {
-  message: string = "Username is already used.";
-}

package/src/kernel-zerodev/owner/passkey/getAutocompletePasskeyOwner.ts

@@ -1,81 +0,0 @@
-import { getWebAuthnAssertion } from "@turnkey/http/dist/webauthn";
-import axios from "axios";
-import type { SignTypedDataParams, SmartAccountSigner } from "@alchemy/aa-core";
-import {
-  abortController,
-  abortWebauthn,
-  base64UrlEncode,
-  generateRandomBuffer,
-  signMessage,
-  signTypedData,
-} from "./utils.js";
-import { API_URL } from "../../constants.js";
-
-export async function getAutocompletePasskeyOwner({
-  projectId,
-  apiUrl = API_URL,
-}: {
-  projectId: string;
-  name?: string;
-  apiUrl?: string;
-}): Promise<SmartAccountSigner | undefined> {
-  if (
-    //@ts-ignore
-    !PublicKeyCredential?.isConditionalMediationAvailable ||
-    //@ts-ignore
-    !PublicKeyCredential?.isConditionalMediationAvailable()
-  ) {
-    return;
-  }
-
-  if (typeof window !== "undefined") {
-    const challenge = generateRandomBuffer();
-    try {
-      abortWebauthn();
-      const assertion = JSON.parse(
-        await getWebAuthnAssertion(base64UrlEncode(challenge), {
-          mediation: "conditional",
-          publicKey: {
-            rpId: window.location.hostname,
-            userVerification: "required",
-          },
-          signal: abortController.controller.signal,
-        })
-      );
-      const response = await axios.post(
-        `${apiUrl}/projects/${projectId}/wallets/${assertion.credentialId}`,
-        {
-          challenge: base64UrlEncode(challenge),
-          assertion,
-        }
-      );
-      const { id, walletId, address } = await response.data;
-      console.log("owner", id, walletId, address);
-      const owner: SmartAccountSigner = {
-        getAddress: async () => address,
-        signMessage: (msg) =>
-          signMessage(
-            msg,
-            id,
-            walletId,
-            projectId,
-            assertion.credentialId,
-            apiUrl
-          ),
-        signTypedData: (params: SignTypedDataParams) =>
-          signTypedData(
-            params,
-            id,
-            walletId,
-            projectId,
-            assertion.credentialId,
-            apiUrl
-          ),
-      };
-      return owner;
-    } catch (e) {
-      console.log(e);
-    }
-  }
-  return;
-}

package/src/kernel-zerodev/owner/passkey/getPasskeyOwner.ts

@@ -1,75 +0,0 @@
-import { getWebAuthnAssertion } from "@turnkey/http/dist/webauthn";
-import axios from "axios";
-import type { SignTypedDataParams, SmartAccountSigner } from "@alchemy/aa-core";
-import {
-  abortWebauthn,
-  base64UrlEncode,
-  generateRandomBuffer,
-  getCredentials,
-  signMessage,
-  signTypedData,
-} from "./utils.js";
-import { API_URL } from "../../constants.js";
-
-export async function getPasskeyOwner({
-  projectId,
-  name,
-  apiUrl = API_URL,
-  withCredentials = false,
-}: {
-  projectId: string;
-  name?: string;
-  apiUrl?: string;
-  withCredentials?: boolean;
-}): Promise<SmartAccountSigner | undefined> {
-  if (typeof window !== "undefined") {
-    const challenge = generateRandomBuffer();
-    try {
-      abortWebauthn();
-      const assertion = JSON.parse(
-        await getWebAuthnAssertion(base64UrlEncode(challenge), {
-          publicKey: {
-            rpId: window.location.hostname,
-            userVerification: "required",
-            allowCredentials: withCredentials
-              ? await getCredentials(projectId, name)
-              : undefined,
-          },
-        })
-      );
-      const response = await axios.post(
-        `${apiUrl}/projects/${projectId}/wallets/${assertion.credentialId}`,
-        {
-          challenge: base64UrlEncode(challenge),
-          assertion,
-        }
-      );
-      const { id, walletId, address } = await response.data;
-      const owner: SmartAccountSigner = {
-        getAddress: async () => address,
-        signMessage: (msg) =>
-          signMessage(
-            msg,
-            id,
-            walletId,
-            projectId,
-            assertion.credentialId,
-            apiUrl
-          ),
-        signTypedData: (params: SignTypedDataParams) =>
-          signTypedData(
-            params,
-            id,
-            walletId,
-            projectId,
-            assertion.credentialId,
-            apiUrl
-          ),
-      };
-      return owner;
-    } catch (e) {
-      console.log(e);
-    }
-  }
-  return;
-}

package/src/kernel-zerodev/owner/passkey/index.ts

@@ -1,4 +0,0 @@
-export { abortWebauthn } from "./utils.js";
-export { getPasskeyOwner } from "./getPasskeyOwner.js";
-export { createPasskeyOwner } from "./createPasskeyOwner.js";
-export { getAutocompletePasskeyOwner } from "./getAutocompletePasskeyOwner.js";

package/src/kernel-zerodev/owner/passkey/types.ts

@@ -1,18 +0,0 @@
-export type ByteArray = Uint8Array;
-export type Hex = `0x${string}`;
-export type Hash = `0x${string}`;
-export type LogTopic = Hex | Hex[] | null;
-export type SignableMessage =
-  | string
-  | {
-      /** Raw data representation of the message. */
-      raw: Hex | ByteArray;
-    };
-export type Signature = {
-  // TODO(v2): Make `bigint`
-  r: Hex;
-  // TODO(v2): Make `bigint`
-  s: Hex;
-  // TODO(v2): `v` to `recovery`
-  v: bigint;
-};

package/src/kernel-zerodev/owner/passkey/utils.ts

@@ -1,174 +0,0 @@
-import { browserInit, TurnkeyApi } from "@turnkey/http";
-import axios from "axios";
-import { API_URL } from "../../constants.js";
-import type { SignTypedDataParams } from "@alchemy/aa-core";
-import { hashTypedData, signatureToHex, hashMessage } from "viem";
-
-browserInit({
-  baseUrl: "https://api.turnkey.com",
-});
-
-export const abortController = {
-  controller: new AbortController(),
-};
-
-export function abortWebauthn() {
-  abortController.controller.abort("ZeroDev: Reset previous Webauthn request");
-  abortController.controller = new AbortController();
-}
-
-export const publicKey = "public-key";
-
-export const es256 = -7;
-
-export const generateRandomBuffer = (): ArrayBuffer => {
-  const arr = new Uint8Array(32);
-  crypto.getRandomValues(arr);
-  return arr.buffer;
-};
-
-export const base64UrlEncode = (challenge: ArrayBuffer): string => {
-  return Buffer.from(challenge)
-    .toString("base64")
-    .replace(/\+/g, "-")
-    .replace(/\//g, "_")
-    .replace(/=/g, "");
-};
-
-export const signMessageImplementation = async (
-  msg: string,
-  id: string,
-  walletId: string,
-  projectId: string,
-  credentialId: string,
-  apiUrl = API_URL
-) => {
-  abortWebauthn();
-  const signedRequest = await TurnkeyApi.signSignRawPayload(
-    {
-      body: {
-        type: "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD",
-        organizationId: id,
-        parameters: {
-          privateKeyId: walletId,
-          payload: msg,
-          encoding: "PAYLOAD_ENCODING_HEXADECIMAL",
-          hashFunction: "HASH_FUNCTION_NO_OP",
-        },
-        timestampMs: String(Date.now()),
-      },
-    },
-    {
-      publicKey: {
-        allowCredentials: [
-          {
-            id: base64URLStringToBuffer(credentialId),
-            type: publicKey,
-          },
-        ],
-      },
-    }
-  );
-  const proxyResponse = await axios.post(
-    `${apiUrl}/projects/${projectId}/wallets/proxy`,
-    {
-      signedRequest,
-    }
-  );
-  const { activity } = await proxyResponse.data;
-  if (activity.status === "ACTIVITY_STATUS_COMPLETED") {
-    let result = activity?.result?.signRawPayloadResult;
-
-    if (result) {
-      const signatureHex = signatureToHex({
-        r: `0x${result.r}`,
-        s: `0x${result.s}`,
-        v: result.v === "00" ? 27n : 28n,
-      });
-      if (signatureHex) {
-        return signatureHex;
-      }
-    }
-  }
-  return "0x";
-};
-
-export const signMessage = async (
-  msg: string | Uint8Array,
-  id: string,
-  walletId: string,
-  projectId: string,
-  credentialId: string,
-  apiUrl = API_URL
-) => {
-  return await signMessageImplementation(
-    hashMessage(typeof msg === "string" ? msg : { raw: msg }),
-    id,
-    walletId,
-    projectId,
-    credentialId,
-    apiUrl
-  );
-};
-
-export const signTypedData = async (
-  params: SignTypedDataParams,
-  id: string,
-  walletId: string,
-  projectId: string,
-  credentialId: string,
-  apiUrl = API_URL
-) => {
-  const hashToSign = hashTypedData(params);
-  return await signMessageImplementation(
-    hashToSign,
-    id,
-    walletId,
-    projectId,
-    credentialId,
-    apiUrl
-  );
-};
-
-export const getCredentials = async (
-  projectId: string,
-  name?: string,
-  apiUrl = API_URL
-) => {
-  const url =
-    `${apiUrl}/projects/${projectId}/wallets` + (name ? `/${name}` : "");
-  const response = await axios.get(url);
-  const credentials = response.data;
-  return credentials.map((credential: string) => ({
-    id: base64URLStringToBuffer(credential),
-    type: "public-key",
-  }));
-};
-
-// https://github.com/MasterKale/SimpleWebAuthn/blob/master/packages/browser/src/helpers/base64URLStringToBuffer.ts#L8
-export function base64URLStringToBuffer(base64URLString: string): ArrayBuffer {
-  // Convert from Base64URL to Base64
-  const base64 = base64URLString.replace(/-/g, "+").replace(/_/g, "/");
-  /**
-   * Pad with '=' until it's a multiple of four
-   * (4 - (85 % 4 = 1) = 3) % 4 = 3 padding
-   * (4 - (86 % 4 = 2) = 2) % 4 = 2 padding
-   * (4 - (87 % 4 = 3) = 1) % 4 = 1 padding
-   * (4 - (88 % 4 = 0) = 4) % 4 = 0 padding
-   */
-  const padLength = (4 - (base64.length % 4)) % 4;
-  const padded = base64.padEnd(base64.length + padLength, "=");
-
-  // Convert to a binary string
-  const binary = atob(padded);
-
-  // Convert binary string to buffer
-  const buffer = new ArrayBuffer(binary.length);
-  const bytes = new Uint8Array(buffer);
-
-  for (let i = 0; i < binary.length; i++) {
-    bytes[i] = binary.charCodeAt(i);
-  }
-
-  return buffer;
-}