@account-kit/smart-contracts 4.0.0-alpha.0 → 4.0.0-alpha.10

package/src/light-account/accounts/multiOwner.ts

@@ -17,12 +17,12 @@ import {
 import { MultiOwnerLightAccountAbi } from "../abis/MultiOwnerLightAccountAbi.js";
 import { MultiOwnerLightAccountFactoryAbi } from "../abis/MultiOwnerLightAccountFactoryAbi.js";
 import type {
-  GetEntryPointForLightAccountVersion,
-  GetLightAccountVersion,
+  LightAccountEntryPointVersion,
+  LightAccountVersion,
 } from "../types.js";
 import {
-  AccountVersionRegistry,
   defaultLightAccountVersion,
+  getDefaultMultiOwnerLightAccountFactoryAddress,
 } from "../utils.js";
 import {
   createLightAccountBase,
@@ -32,19 +32,11 @@ import {
 
 export type MultiOwnerLightAccount<
   TSigner extends SmartAccountSigner = SmartAccountSigner,
-  TLightAccountVersion extends GetLightAccountVersion<"MultiOwnerLightAccount"> = GetLightAccountVersion<"MultiOwnerLightAccount">,
-  TEntryPointVersion extends GetEntryPointForLightAccountVersion<
-    "MultiOwnerLightAccount",
-    TLightAccountVersion
-  > = GetEntryPointForLightAccountVersion<
-    "MultiOwnerLightAccount",
-    TLightAccountVersion
-  >
+  TLightAccountVersion extends LightAccountVersion<"MultiOwnerLightAccount"> = LightAccountVersion<"MultiOwnerLightAccount">
 > = LightAccountBase<
   TSigner,
   "MultiOwnerLightAccount",
-  TLightAccountVersion,
-  TEntryPointVersion
+  TLightAccountVersion
 > & {
   encodeUpdateOwners: (
     ownersToAdd: Address[],
@@ -56,69 +48,82 @@ export type MultiOwnerLightAccount<
 export type CreateMultiOwnerLightAccountParams<
   TTransport extends Transport = Transport,
   TSigner extends SmartAccountSigner = SmartAccountSigner,
-  TLightAccountVersion extends GetLightAccountVersion<"MultiOwnerLightAccount"> = GetLightAccountVersion<"MultiOwnerLightAccount">,
-  TEntryPointVersion extends GetEntryPointForLightAccountVersion<
-    "MultiOwnerLightAccount",
-    TLightAccountVersion
-  > = GetEntryPointForLightAccountVersion<
-    "MultiOwnerLightAccount",
-    TLightAccountVersion
-  >
+  TLightAccountVersion extends LightAccountVersion<"MultiOwnerLightAccount"> = LightAccountVersion<"MultiOwnerLightAccount">
 > = Omit<
   CreateLightAccountBaseParams<
-    TTransport,
-    TSigner,
     "MultiOwnerLightAccount",
     TLightAccountVersion,
-    TEntryPointVersion
+    TTransport,
+    TSigner
   >,
-  "getAccountInitCode" | "entryPoint" | "version" | "abi" | "accountAddress"
+  | "getAccountInitCode"
+  | "entryPoint"
+  | "version"
+  | "abi"
+  | "accountAddress"
+  | "type"
 > & {
   salt?: bigint;
   initCode?: Hex;
   accountAddress?: Address;
   factoryAddress?: Address;
   version?: TLightAccountVersion;
-  entryPoint?: EntryPointDef<TEntryPointVersion, Chain>;
+  entryPoint?: EntryPointDef<
+    LightAccountEntryPointVersion<
+      "MultiOwnerLightAccount",
+      TLightAccountVersion
+    >,
+    Chain
+  >;
   owners?: Address[];
 };
 
 export async function createMultiOwnerLightAccount<
   TTransport extends Transport = Transport,
   TSigner extends SmartAccountSigner = SmartAccountSigner,
-  TLightAccountVersion extends GetLightAccountVersion<"MultiOwnerLightAccount"> = GetLightAccountVersion<"MultiOwnerLightAccount">,
-  TEntryPointVersion extends GetEntryPointForLightAccountVersion<
-    "MultiOwnerLightAccount",
-    TLightAccountVersion
-  > = GetEntryPointForLightAccountVersion<
-    "MultiOwnerLightAccount",
-    TLightAccountVersion
-  >
+  TLightAccountVersion extends LightAccountVersion<"MultiOwnerLightAccount"> = LightAccountVersion<"MultiOwnerLightAccount">
 >(
   config: CreateMultiOwnerLightAccountParams<
     TTransport,
     TSigner,
-    TLightAccountVersion,
-    TEntryPointVersion
+    TLightAccountVersion
   >
-): Promise<
-  MultiOwnerLightAccount<TSigner, TLightAccountVersion, TEntryPointVersion>
->;
+): Promise<MultiOwnerLightAccount<TSigner, TLightAccountVersion>>;
 
+/**
+ * Creates a multi-owner light account using the provided parameters, including transport, chain, signer, initialization code, version, account address, factory address, salt, and owners. Ensures the owners list is deduplicated, ordered, and valid.
+ *
+ * @example
+ * ```ts
+ * import { createMultiOwnerLightAccount } from "@account-kit/smart-contracts";
+ * import { LocalAccountSigner } from "@aa-sdk/core";
+ * import { sepolia } from "viem/chains";
+ * import { http, generatePrivateKey } from "viem"
+ *
+ * const account = await createMultiOwnerLightAccount({
+ *  chain: sepolia,
+ *  transport: http("RPC_URL"),
+ *  signer: LocalAccountSigner.privateKeyToAccountSigner(generatePrivateKey())
+ * });
+ * ```
+ *
+ * @param {CreateMultiOwnerLightAccountParams} config The parameters for creating a multi-owner light account
+ * @returns {Promise<MultiOwnerLightAccount>} A promise that resolves to a `MultiOwnerLightAccount` object containing the created account information and methods
+ */
 export async function createMultiOwnerLightAccount({
   transport,
   chain,
   signer,
   initCode,
-  version = defaultLightAccountVersion("MultiOwnerLightAccount"),
+  version = defaultLightAccountVersion(),
   entryPoint = getEntryPoint(chain, {
-    version:
-      AccountVersionRegistry["MultiOwnerLightAccount"][version]
-        .entryPointVersion,
+    version: "0.7.0",
   }),
   accountAddress,
-  factoryAddress = AccountVersionRegistry["MultiOwnerLightAccount"][version]
-    .address[chain.id].factory,
+  factoryAddress = getDefaultMultiOwnerLightAccountFactoryAddress(
+    chain,
+    version
+  ),
   salt: salt_ = 0n,
   owners = [],
 }: CreateMultiOwnerLightAccountParams): Promise<MultiOwnerLightAccount> {
@@ -160,15 +165,17 @@ export async function createMultiOwnerLightAccount({
   });
 
   const account = await createLightAccountBase<
+    "MultiOwnerLightAccount",
+    LightAccountVersion<"MultiOwnerLightAccount">,
     Transport,
-    SmartAccountSigner,
-    "MultiOwnerLightAccount"
+    SmartAccountSigner
   >({
     transport,
     chain,
     signer,
     abi: MultiOwnerLightAccountAbi,
-    version: AccountVersionRegistry["MultiOwnerLightAccount"][version],
+    version,
+    type: "MultiOwnerLightAccount",
     entryPoint,
     accountAddress: address,
     getAccountInitCode,

package/src/light-account/actions/transferOwnership.ts

@@ -22,7 +22,32 @@ export type TransferLightAccountOwnershipParams<
 } & GetAccountParameter<TAccount, LightAccount<TSigner>> &
   UserOperationOverridesParameter<TEntryPointVersion>;
 
-export const transferOwnership: <
+/**
+ * Transfers the ownership of a light account to a new owner.
+ * This function ensures that the client is a compatible smart acccount client and that a Light Account is provided.
+ * If the waitForTxn parameter is true, it will wait for the transaction to be completed before returning.
+ *
+ * @example
+ * ```ts
+ * import { transferOwnership, createLightAccountClient } from "@account-kit/smart-contracts";
+ *
+ * const lightAccountClient = createLightAccountClient({
+ *  signer,
+ *  transport,
+ *  chain,
+ * });
+ *
+ * const txHash = await transferOwnership(lightAccountClient, {
+ *  newOwner: newOwnerSigner,
+ *  waitForTxn: true, // set to false to return a uoHash instead
+ * });
+ * ```
+ *
+ * @param {Client<TTransport, TChain, TAccount>} client The smart account client instance used to execute the transfer
+ * @param {TransferLightAccountOwnershipParams<TSigner, TAccount>} args The parameters for transferring ownership
+ * @returns {Promise<Hex>} The transaction or UO hash as a Hex string
+ */
+export const transferOwnership = async <
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,
   TSigner extends SmartAccountSigner = SmartAccountSigner,
@@ -32,10 +57,8 @@ export const transferOwnership: <
 >(
   client: Client<TTransport, TChain, TAccount>,
   args: TransferLightAccountOwnershipParams<TSigner, TAccount>
-) => Promise<Hex> = async (
-  client,
-  { newOwner, waitForTxn, overrides, account = client.account }
-) => {
+): Promise<Hex> => {
+  const { newOwner, waitForTxn, overrides, account = client.account } = args;
   if (!account) {
     throw new AccountNotFoundError();
   }

package/src/light-account/actions/updateOwners.ts

@@ -23,6 +23,30 @@ export type UpdateMultiOwnerLightAccountOwnersParams<
 } & GetAccountParameter<TAccount, MultiOwnerLightAccount<TSigner>> &
   UserOperationOverridesParameter<TEntryPointVersion>;
 
+/**
+ * Updates the owners of a multi-owner light account. This includes adding new owners and removing existing ones.
+ *
+ * @example
+ * ```ts
+ * import { updateOwners, createLightAccountClient } from "@account-kit/smart-contracts";
+ *
+ * const lightAccountClient = createLightAccountClient({
+ *  signer,
+ *  transport,
+ *  chain,
+ * });
+ *
+ * const txHash = await updateOwners(lightAccountClient, {
+ *  ownerstoAdd: [newOwnerAddress], // or empty if you just want to remove owners
+ *  ownersToRemove: [oldOwnerAddress], // or empty if you just want to add owners
+ *  waitForTxn: true, // set to false to return a uoHash instead
+ * });
+ * ```
+ *
+ * @param {Client<TTransport, TChain, TAccount>} client The client instance used to interact with the account
+ * @param {UpdateMultiOwnerLightAccountOwnersParams<TSigner, TAccount>} args The parameters for updating the account owners
+ * @returns {Promise<Hex>} A promise that resolves to the transaction hash or the full transaction result if `waitForTxn` is `true`
+ */
 export const updateOwners: <
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,

package/src/light-account/clients/alchemyClient.ts

@@ -1,3 +1,4 @@
+import type { HttpTransport, SmartAccountSigner } from "@aa-sdk/core";
 import {
   AlchemyProviderConfigSchema,
   createAlchemyPublicRpcClient,
@@ -12,7 +13,6 @@ import {
   type LightAccount,
   type LightAccountClientActions,
 } from "@account-kit/smart-contracts";
-import type { HttpTransport, SmartAccountSigner } from "@aa-sdk/core";
 import { custom, type Chain, type CustomTransport, type Transport } from "viem";
 
 export type AlchemyLightAccountClientConfig<
@@ -39,6 +39,26 @@ export async function createLightAccountAlchemyClient<
   >
 >;
 
+/**
+ * Creates an Alchemy smart account client connected to a Light Account instance.
+ *
+ * @example
+ * ```ts
+ * import { createLightAccountAlchemyClient } from "@account-kit/smart-contracts";
+ * import { sepolia } from "@account-kit/infra";
+ * import { LocalAccountSigner } from "@aa-sdk/core";
+ * import { generatePrivateKey } from "viem"
+ *
+ * const lightAccountClient = await createLightAccountAlchemyClient({
+ *  apiKey: "your-api-key",
+ *  chain: sepolia,
+ *  signer: LocalAccountSigner.privateKeyToAccountSigner(generatePrivateKey())
+ * });
+ * ```
+ *
+ * @param {AlchemyLightAccountClientConfig} config The configuration for setting up the Alchemy Light Account Client
+ * @returns {Promise<AlchemySmartAccountClient>} A promise that resolves to an `AlchemySmartAccountClient` object containing the created client
+ */
 export async function createLightAccountAlchemyClient(
   config: AlchemyLightAccountClientConfig
 ): Promise<AlchemySmartAccountClient> {

package/src/light-account/clients/client.ts

@@ -48,12 +48,33 @@ export function createLightAccountClient<
   >
 >;
 
-export async function createLightAccountClient({
-  account,
-  transport,
-  chain,
-  ...clientConfig
-}: CreateLightAccountClientParams): Promise<SmartAccountClient> {
+/**
+ * Creates a light account client using the provided parameters, including account information, transport mechanism, blockchain chain, and additional client configurations. This function first creates a light account and then uses it to create a smart account client, extending it with light account client actions.
+ *
+ * @example
+ * ```ts
+ * import { createLightAccountClient } from "@account-kit/smart-contracts";
+ * import { LocalAccountSigner } from "@aa-sdk/core";
+ * import { sepolia } from "viem/chains";
+ * import { http, generatePrivateKey } from "viem"
+ *
+ * const account = await createLightAccountClient({
+ *  chain: sepolia,
+ *  transport: http("RPC_URL"),
+ *  account: {
+ *    signer: LocalAccountSigner.privateKeyToAccountSigner(generatePrivateKey())
+ *  }
+ * });
+ * ```
+ *
+ * @param {CreateLightAccountClientParams} params The parameters for creating a light account client
+ * @returns {Promise<SmartAccountClient>} A promise that resolves to a `SmartAccountClient` object containing the created account information and methods
+ */
+export async function createLightAccountClient(
+  params: CreateLightAccountClientParams
+): Promise<SmartAccountClient> {
+  const { account, transport, chain, ...clientConfig } = params;
+
   const lightAccount = await createLightAccount({
     ...account,
     transport,

package/src/light-account/clients/multiOwnerAlchemyClient.ts

@@ -1,3 +1,4 @@
+import type { HttpTransport, SmartAccountSigner } from "@aa-sdk/core";
 import {
   AlchemyProviderConfigSchema,
   createAlchemyPublicRpcClient,
@@ -12,14 +13,13 @@ import {
   type MultiOwnerLightAccount,
   type MultiOwnerLightAccountClientActions,
 } from "@account-kit/smart-contracts";
-import type { HttpTransport, SmartAccountSigner } from "@aa-sdk/core";
 import { custom, type Chain, type CustomTransport, type Transport } from "viem";
 
 export type AlchemyMultiOwnerLightAccountClientConfig<
   TSigner extends SmartAccountSigner = SmartAccountSigner
 > = Omit<
   CreateMultiOwnerLightAccountParams<HttpTransport, TSigner>,
-  "transport" | "chain"
+  "transport" | "chain" | "type"
 > &
   Omit<
     AlchemySmartAccountClientConfig<
@@ -43,6 +43,26 @@ export async function createMultiOwnerLightAccountAlchemyClient<
   >
 >;
 
+/**
+ * Creates a multi-owner light account Alchemy client using the provided configuration.
+ *
+ * @example
+ * ```ts
+ * import { createMultiOwnerLightAccountAlchemyClient } from "@account-kit/smart-contracts";
+ * import { sepolia } from "@account-kit/infra";
+ * import { LocalAccountSigner } from "@aa-sdk/core";
+ * import { generatePrivateKey } from "viem"
+ *
+ * const lightAccountClient = await createMultiOwnerLightAccountAlchemyClient({
+ *  apiKey: "your-api-key",
+ *  chain: sepolia,
+ *  signer: LocalAccountSigner.privateKeyToAccountSigner(generatePrivateKey())
+ * });
+ * ```
+ *
+ * @param {AlchemyMultiOwnerLightAccountClientConfig} config The configuration for creating the Alchemy client
+ * @returns {Promise<AlchemySmartAccountClient>} A promise that resolves to an `AlchemySmartAccountClient` object containing the created account information and methods
+ */
 export async function createMultiOwnerLightAccountAlchemyClient(
   config: AlchemyMultiOwnerLightAccountClientConfig
 ): Promise<AlchemySmartAccountClient> {

package/src/light-account/clients/multiOwnerLightAccount.ts

@@ -54,12 +54,33 @@ export function createMultiOwnerLightAccountClient<
   >
 >;
 
-export async function createMultiOwnerLightAccountClient({
-  account,
-  transport,
-  chain,
-  ...clientConfig
-}: CreateMultiOwnerLightAccountClientParams): Promise<SmartAccountClient> {
+/**
+ * Creates a multi-owner light account client using the provided parameters. It first creates a multi-owner light account and then creates a smart account client with the provided configurations.
+ *
+ * @example
+ * ```ts
+ * import { createMultiOwnerLightAccountClient } from "@account-kit/smart-contracts";
+ * import { LocalAccountSigner } from "@aa-sdk/core";
+ * import { sepolia } from "viem/chains";
+ * import { http, generatePrivateKey } from "viem"
+ *
+ * const account = await createMultiOwnerLightAccountClient({
+ *  chain: sepolia,
+ *  transport: http("RPC_URL"),
+ *  account: {
+ *    signer: LocalAccountSigner.privateKeyToAccountSigner(generatePrivateKey())
+ *  }
+ * });
+ * ```
+ *
+ * @param {CreateMultiOwnerLightAccountClientParams} params the configuration for creating the multi-owner light account client
+ * @returns {Promise<SmartAccountClient>} a promise that resolves to a `SmartAccountClient` containing the created account client and relevant methods
+ */
+export async function createMultiOwnerLightAccountClient(
+  params: CreateMultiOwnerLightAccountClientParams
+): Promise<SmartAccountClient> {
+  const { account, transport, chain, ...clientConfig } = params;
+
   const lightAccount = await createMultiOwnerLightAccount({
     ...account,
     transport,

package/src/light-account/decorators/lightAccount.ts

@@ -17,6 +17,25 @@ export type LightAccountClientActions<
   ) => Promise<Hex>;
 };
 
+/**
+ * Provides a set of actions for managing a light account client, including transferring ownership.
+ *
+ * @example
+ * ```ts
+ * import { lightAccountClientActions, createLightAccount } from "@account-kit/smart-contracts";
+ * import { createAlchemySmartAccountClient } from "@account-kit/infra";
+ * import { sepolia } from "@account-kit/infra";
+ *
+ * const smartAccountClient = createAlchemySmartAccountClient({
+ *  account: await createLightAccount(...),
+ *  apiKey: "your-api-key",
+ *  chain: sepolia,
+ * }).extend(lightAccountClientActions);
+ * ```
+ *
+ * @param {Client<TTransport, TChain, TAccount>} client The client instance for which to provide the light account actions
+ * @returns {LightAccountClientActions<TSigner, TAccount>} An object containing the available light account client actions
+ */
 export const lightAccountClientActions: <
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,

package/src/light-account/decorators/multiOwnerLightAccount.ts

@@ -17,6 +17,25 @@ export type MultiOwnerLightAccountClientActions<
   ) => Promise<Hex>;
 };
 
+/**
+ * Generates client actions for a multi-owner light account, including the ability to update owners.
+ *
+ * @example
+ * ```ts
+ * import { multiOwnerLightAccountClientActions, createMultiOwnerLightAccount } from "@account-kit/smart-contracts";
+ * import { createAlchemySmartAccountClient } from "@account-kit/infra";
+ * import { sepolia } from "@account-kit/infra";
+ *
+ * const smartAccountClient = createAlchemySmartAccountClient({
+ *  account: await createMultiOwnerLightAccount(...),
+ *  apiKey: "your-api-key",
+ *  chain: sepolia,
+ * }).extend(multiOwnerLightAccountClientActions);
+ * ```
+ *
+ * @param {Client<TTransport, TChain, TAccount>} client the client for interacting with the multi-owner light account
+ * @returns {MultiOwnerLightAccountClientActions<TSigner, TAccount>} an object containing the client actions specifically for a multi-owner light account
+ */
 export const multiOwnerLightAccountClientActions: <
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,