feat: add alchemy accounts context (#539)

* feat: add alchemy accounts context * style: address PR feedback Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com> * fix: address a few PR comments * docs(hooks): add initial react hooks docs (#561) * docs(hooks): add initial react hooks docs * refactor: apply suggestions from code review Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com> --------- Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com> --------- Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com>
alchemyplatform · Apr 10, 2024 · f92469e · f92469e
1 parent 12c02e9
commit f92469e
Show file tree

Hide file tree

Showing 58 changed files with 1,782 additions and 8 deletions.
diff --git a/packages/accounts/src/light-account/account.ts b/packages/accounts/src/light-account/account.ts
@@ -39,6 +39,7 @@ export type LightAccount<
   getOwnerAddress: () => Promise<Address>;
 };
 
+//#region CreateLightAccountParams
 export type CreateLightAccountParams<
   TTransport extends Transport = Transport,
   TSigner extends SmartAccountSigner = SmartAccountSigner
@@ -52,6 +53,7 @@ export type CreateLightAccountParams<
   initCode?: Hex;
   version?: LightAccountVersion;
 };
+//#endregion CreateLightAccountParams
 
 export async function createLightAccount<
   TTransport extends Transport = Transport,

diff --git a/packages/accounts/src/msca/account/multiOwnerAccount.ts b/packages/accounts/src/msca/account/multiOwnerAccount.ts
@@ -26,6 +26,7 @@ export type MultiOwnerModularAccount<
   TSigner extends SmartAccountSigner = SmartAccountSigner
 > = SmartContractAccountWithSigner<"MultiOwnerModularAccount", TSigner>;
 
+// #region CreateMultiOwnerModularAccountParams
 export type CreateMultiOwnerModularAccountParams<
   TTransport extends Transport = Transport,
   TSigner extends SmartAccountSigner = SmartAccountSigner
@@ -40,6 +41,7 @@ export type CreateMultiOwnerModularAccountParams<
   accountAddress?: Address;
   initCode?: Hex;
 };
+// #endregion CreateMultiOwnerModularAccountParams
 
 export async function createMultiOwnerModularAccount<
   TTransport extends Transport = Transport,

diff --git a/packages/alchemy/package.json b/packages/alchemy/package.json
@@ -26,6 +26,16 @@
       "import": "./dist/esm/index.js",
       "default": "./dist/cjs/index.js"
     },
+    "./config": {
+      "types": "./dist/types/config/index.d.ts",
+      "import": "./dist/esm/config/index.js",
+      "default": "./dist/cjs/config/index.js"
+    },
+    "./react": {
+      "types": "./dist/types/react/index.d.ts",
+      "import": "./dist/esm/react/index.js",
+      "default": "./dist/cjs/react/index.js"
+    },
     "./package.json": "./package.json"
   },
   "scripts": {
@@ -41,6 +51,9 @@
   },
   "devDependencies": {
     "@alchemy/aa-accounts": "*",
+    "@tanstack/react-query": "^5.28.9",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "typescript": "^5.0.4",
     "typescript-template": "*",
     "vitest": "^0.31.0"
@@ -56,8 +69,22 @@
     "zustand": "^4.5.2"
   },
   "peerDependencies": {
+    "@tanstack/react-query": "^5.28.9",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "viem": "2.8.6"
   },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    },
+    "@tanstack/react-query": {
+      "optional": true
+    }
+  },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"

diff --git a/packages/alchemy/src/client/smartAccountClient.ts b/packages/alchemy/src/client/smartAccountClient.ts
@@ -16,6 +16,7 @@ import { createAlchemySmartAccountClientFromRpcClient } from "./internal/smartAc
 import { createAlchemyPublicRpcClient } from "./rpcClient.js";
 import type { AlchemyRpcSchema } from "./types.js";
 
+// #region AlchemySmartAccountClientConfig
 export type AlchemySmartAccountClientConfig<
   transport extends Transport = Transport,
   chain extends Chain | undefined = Chain | undefined,
@@ -34,6 +35,7 @@ export type AlchemySmartAccountClientConfig<
     SmartAccountClientConfig<transport, chain, account, context>,
     "customMiddleware" | "feeEstimator" | "gasEstimator" | "signUserOperation"
   >;
+// #endregion AlchemySmartAccountClientConfig
 
 export type BaseAlchemyActions<
   chain extends Chain | undefined = Chain | undefined,

diff --git a/packages/alchemy/src/config/actions/createAccount.ts b/packages/alchemy/src/config/actions/createAccount.ts
@@ -0,0 +1,107 @@
+import {
+  createLightAccount,
+  createMultiOwnerModularAccount,
+  type CreateLightAccountParams,
+  type CreateMultiOwnerModularAccountParams,
+} from "@alchemy/aa-accounts";
+import { custom } from "viem";
+import { ClientOnlyPropertyError } from "../errors.js";
+import type {
+  AlchemyAccountsConfig,
+  SupportedAccountTypes,
+  SupportedAccounts,
+} from "../types";
+import { getSignerStatus } from "./getSignerStatus.js";
+
+export type AccountConfig<TAccount extends SupportedAccountTypes> =
+  TAccount extends "LightAccount"
+    ? Omit<CreateLightAccountParams, "signer" | "transport" | "chain">
+    : Omit<
+        CreateMultiOwnerModularAccountParams,
+        "signer" | "transport" | "chain"
+      >;
+
+export type CreateAccountParams<TAccount extends SupportedAccountTypes> = {
+  type: TAccount;
+  accountParams?: AccountConfig<TAccount>;
+};
+
+export async function createAccount<TAccount extends SupportedAccountTypes>(
+  { type, accountParams: params }: CreateAccountParams<TAccount>,
+  config: AlchemyAccountsConfig
+): Promise<SupportedAccounts> {
+  const clientStore = config.clientStore;
+  if (!clientStore) {
+    throw new ClientOnlyPropertyError("account");
+  }
+
+  const transport = custom(config.bundlerClient);
+  const chain = config.bundlerClient.chain;
+  const signer = config.signer;
+  const signerStatus = getSignerStatus(config);
+
+  if (!signerStatus.isConnected) {
+    throw new Error("Signer not connected");
+  }
+
+  const cachedAccount = clientStore.getState().accounts[type];
+  if (cachedAccount?.account) {
+    return cachedAccount.account;
+  }
+
+  const accountPromise = (() => {
+    switch (type) {
+      case "LightAccount":
+        return createLightAccount({
+          ...params,
+          signer,
+          transport: (opts) => transport({ ...opts, retryCount: 0 }),
+          chain,
+        });
+      case "MultiOwnerModularAccount":
+        return createMultiOwnerModularAccount({
+          ...params,
+          signer,
+          transport: (opts) => transport({ ...opts, retryCount: 0 }),
+          chain,
+        });
+      default:
+        throw new Error("Unsupported account type");
+    }
+  })();
+
+  clientStore.setState((state) => ({
+    accounts: {
+      ...state.accounts,
+      [type]: {
+        status: "INITIALIZING",
+        account: accountPromise,
+      },
+    },
+  }));
+
+  try {
+    const account = await accountPromise;
+    clientStore.setState((state) => ({
+      accounts: {
+        ...state.accounts,
+        [type]: {
+          status: "READY",
+          account,
+        },
+      },
+    }));
+  } catch (error) {
+    clientStore.setState((state) => ({
+      accounts: {
+        ...state.accounts,
+        [type]: {
+          status: "ERROR",
+          error,
+        },
+      },
+    }));
+  }
+
+  return accountPromise;
+}
diff --git a/packages/alchemy/src/config/actions/getAccount.ts b/packages/alchemy/src/config/actions/getAccount.ts
@@ -0,0 +1,22 @@
+import { ClientOnlyPropertyError } from "../errors.js";
+import type { AccountState } from "../store/types.js";
+import type { AlchemyAccountsConfig, SupportedAccountTypes } from "../types";
+import { type CreateAccountParams } from "./createAccount.js";
+
+export type GetAccountResult<TAccount extends SupportedAccountTypes> =
+  AccountState<TAccount>;
+
+export type GetAccountParams<TAccount extends SupportedAccountTypes> =
+  CreateAccountParams<TAccount>;
+
+export const getAccount = <TAccount extends SupportedAccountTypes>(
+  { type }: GetAccountParams<TAccount>,
+  config: AlchemyAccountsConfig
+): GetAccountResult<TAccount> => {
+  const clientStore = config.clientStore;
+  if (!clientStore) {
+    throw new ClientOnlyPropertyError("account");
+  }
+
+  return clientStore.getState().accounts[type];
+};
diff --git a/packages/alchemy/src/config/actions/getBundlerClient.ts b/packages/alchemy/src/config/actions/getBundlerClient.ts
@@ -0,0 +1,8 @@
+import type { ClientWithAlchemyMethods } from "../../client/types";
+import type { AlchemyAccountsConfig } from "../types";
+
+export const getBundlerClient = (
+  config: AlchemyAccountsConfig
+): ClientWithAlchemyMethods => {
+  return config.coreStore.getState().bundlerClient;
+};
diff --git a/packages/alchemy/src/config/actions/getSigner.ts b/packages/alchemy/src/config/actions/getSigner.ts
@@ -0,0 +1,11 @@
+import type { AlchemySigner } from "../../signer/signer.js";
+import { ClientOnlyPropertyError } from "../errors.js";
+import type { AlchemyAccountsConfig } from "../types";
+
+export const getSigner = (config: AlchemyAccountsConfig): AlchemySigner => {
+  if (config.clientStore == null) {
+    throw new ClientOnlyPropertyError("signer");
+  }
+
+  return config.clientStore.getState().signer;
+};
diff --git a/packages/alchemy/src/config/actions/getSignerStatus.ts b/packages/alchemy/src/config/actions/getSignerStatus.ts
@@ -0,0 +1,10 @@
+import { ClientOnlyPropertyError } from "../errors.js";
+import type { AlchemyAccountsConfig } from "../types";
+
+export const getSignerStatus = (config: AlchemyAccountsConfig) => {
+  if (config.clientStore == null) {
+    throw new ClientOnlyPropertyError("signerStatus");
+  }
+
+  return config.clientStore.getState().signerStatus;
+};
diff --git a/packages/alchemy/src/config/actions/getUser.ts b/packages/alchemy/src/config/actions/getUser.ts
@@ -0,0 +1,10 @@
+import { ClientOnlyPropertyError } from "../errors.js";
+import type { AlchemyAccountsConfig } from "../types";
+
+export const getUser = (config: AlchemyAccountsConfig) => {
+  if (config.clientStore == null) {
+    throw new ClientOnlyPropertyError("user");
+  }
+
+  return config.clientStore.getState().user;
+};
diff --git a/packages/alchemy/src/config/actions/watchAccount.ts b/packages/alchemy/src/config/actions/watchAccount.ts
@@ -0,0 +1,27 @@
+import { ClientOnlyPropertyError } from "../errors.js";
+import type { AlchemyAccountsConfig, SupportedAccountTypes } from "../types";
+import type { GetAccountResult } from "./getAccount";
+
+export const watchAccount =
+  <TAccount extends SupportedAccountTypes>(
+    type: TAccount,
+    config: AlchemyAccountsConfig
+  ) =>
+  (onChange: (account: GetAccountResult<TAccount>) => void) => {
+    if (config.clientStore == null) {
+      throw new ClientOnlyPropertyError("account");
+    }
+
+    return config.clientStore.subscribe(
+      ({ accounts }) => accounts[type],
+      onChange,
+      {
+        fireImmediately: true,
+        equalityFn(a, b) {
+          return a?.status === "READY" && b?.status === "READY"
+            ? a.account.address === b.account.address
+            : a?.status === b?.status;
+        },
+      }
+    );
+  };
diff --git a/packages/alchemy/src/config/actions/watchBundlerClient.ts b/packages/alchemy/src/config/actions/watchBundlerClient.ts
@@ -0,0 +1,12 @@
+import type { ClientWithAlchemyMethods } from "../../client/types";
+import type { AlchemyAccountsConfig } from "../types";
+
+export const watchBundlerClient =
+  (config: AlchemyAccountsConfig) =>
+  (onChange: (bundlerClient: ClientWithAlchemyMethods) => void) => {
+    return config.coreStore.subscribe(
+      ({ bundlerClient }) => bundlerClient,
+      onChange,
+      { fireImmediately: true }
+    );
+  };
diff --git a/packages/alchemy/src/config/actions/watchSigner.ts b/packages/alchemy/src/config/actions/watchSigner.ts
@@ -0,0 +1,15 @@
+import type { AlchemySigner } from "../../signer";
+import { ClientOnlyPropertyError } from "../errors.js";
+import type { AlchemyAccountsConfig } from "../types";
+
+export const watchSigner =
+  (config: AlchemyAccountsConfig) =>
+  (onChange: (signer: AlchemySigner) => void) => {
+    if (config.clientStore == null) {
+      throw new ClientOnlyPropertyError("signer");
+    }
+
+    return config.clientStore.subscribe(({ signer }) => signer, onChange, {
+      fireImmediately: true,
+    });
+  };
diff --git a/packages/alchemy/src/config/actions/watchSignerStatus.ts b/packages/alchemy/src/config/actions/watchSignerStatus.ts
@@ -0,0 +1,17 @@
+import { ClientOnlyPropertyError } from "../errors.js";
+import type { SignerStatus } from "../store/types.js";
+import type { AlchemyAccountsConfig } from "../types";
+
+export const watchSignerStatus =
+  (config: AlchemyAccountsConfig) =>
+  (onChange: (status: SignerStatus) => void) => {
+    if (config.clientStore == null) {
+      throw new ClientOnlyPropertyError("signerStatus");
+    }
+
+    return config.clientStore.subscribe(
+      ({ signerStatus }) => signerStatus,
+      onChange,
+      { fireImmediately: true }
+    );
+  };
diff --git a/packages/alchemy/src/config/actions/watchUser.ts b/packages/alchemy/src/config/actions/watchUser.ts
@@ -0,0 +1,14 @@
+import type { User } from "../../signer";
+import { ClientOnlyPropertyError } from "../errors.js";
+import type { AlchemyAccountsConfig } from "../types";
+
+export const watchUser =
+  (config: AlchemyAccountsConfig) => (onChange: (user?: User) => void) => {
+    if (config.clientStore == null) {
+      throw new ClientOnlyPropertyError("user");
+    }
+
+    return config.clientStore.subscribe(({ user }) => user, onChange, {
+      fireImmediately: true,
+    });
+  };