@account-kit/wallet-client 0.0.1-alpha.1

package/src/abi/MultiOwnerModularAccountFactoryAbi_V1_0_0.ts

@@ -0,0 +1,178 @@
+export const MultiOwnerModularAccountFactoryAbi_V1_0_0 = [
+  {
+    inputs: [
+      { internalType: "address", name: "owner", type: "address" },
+      { internalType: "address", name: "multiOwnerPlugin", type: "address" },
+      { internalType: "address", name: "implementation", type: "address" },
+      {
+        internalType: "bytes32",
+        name: "multiOwnerPluginManifestHash",
+        type: "bytes32",
+      },
+      {
+        internalType: "contract IEntryPoint",
+        name: "entryPoint",
+        type: "address",
+      },
+    ],
+    stateMutability: "nonpayable",
+    type: "constructor",
+  },
+  { inputs: [], name: "InvalidAction", type: "error" },
+  { inputs: [], name: "InvalidOwner", type: "error" },
+  { inputs: [], name: "OwnersArrayEmpty", type: "error" },
+  { inputs: [], name: "OwnersLimitExceeded", type: "error" },
+  { inputs: [], name: "TransferFailed", type: "error" },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: "address",
+        name: "previousOwner",
+        type: "address",
+      },
+      {
+        indexed: true,
+        internalType: "address",
+        name: "newOwner",
+        type: "address",
+      },
+    ],
+    name: "OwnershipTransferStarted",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: "address",
+        name: "previousOwner",
+        type: "address",
+      },
+      {
+        indexed: true,
+        internalType: "address",
+        name: "newOwner",
+        type: "address",
+      },
+    ],
+    name: "OwnershipTransferred",
+    type: "event",
+  },
+  {
+    inputs: [],
+    name: "ENTRYPOINT",
+    outputs: [
+      { internalType: "contract IEntryPoint", name: "", type: "address" },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "IMPL",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "MULTI_OWNER_PLUGIN",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "acceptOwnership",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "uint32", name: "unstakeDelay", type: "uint32" },
+      { internalType: "uint256", name: "amount", type: "uint256" },
+    ],
+    name: "addStake",
+    outputs: [],
+    stateMutability: "payable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "uint256", name: "salt", type: "uint256" },
+      { internalType: "address[]", name: "owners", type: "address[]" },
+    ],
+    name: "createAccount",
+    outputs: [{ internalType: "address", name: "addr", type: "address" }],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "uint256", name: "salt", type: "uint256" },
+      { internalType: "address[]", name: "owners", type: "address[]" },
+    ],
+    name: "getAddress",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "owner",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "pendingOwner",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "renounceOwnership",
+    outputs: [],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "newOwner", type: "address" }],
+    name: "transferOwnership",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "unlockStake",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "address payable", name: "to", type: "address" },
+      { internalType: "address", name: "token", type: "address" },
+      { internalType: "uint256", name: "amount", type: "uint256" },
+    ],
+    name: "withdraw",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address payable", name: "to", type: "address" }],
+    name: "withdrawStake",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  { stateMutability: "payable", type: "receive" },
+] as const;

package/src/abi/MultisigModularAccountFactoryAbi_V1_0_0.ts

@@ -0,0 +1,181 @@
+export const MultisigModularAccountFactoryAbi_V1_0_0 = [
+  {
+    inputs: [
+      { internalType: "address", name: "owner", type: "address" },
+      { internalType: "address", name: "multisigPlugin", type: "address" },
+      { internalType: "address", name: "implementation", type: "address" },
+      {
+        internalType: "bytes32",
+        name: "multisigPluginManifestHash",
+        type: "bytes32",
+      },
+      {
+        internalType: "contract IEntryPoint",
+        name: "entryPoint",
+        type: "address",
+      },
+    ],
+    stateMutability: "nonpayable",
+    type: "constructor",
+  },
+  { inputs: [], name: "InvalidAction", type: "error" },
+  { inputs: [], name: "InvalidOwner", type: "error" },
+  { inputs: [], name: "InvalidThreshold", type: "error" },
+  { inputs: [], name: "OwnersArrayEmpty", type: "error" },
+  { inputs: [], name: "OwnersLimitExceeded", type: "error" },
+  { inputs: [], name: "TransferFailed", type: "error" },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: "address",
+        name: "previousOwner",
+        type: "address",
+      },
+      {
+        indexed: true,
+        internalType: "address",
+        name: "newOwner",
+        type: "address",
+      },
+    ],
+    name: "OwnershipTransferStarted",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: "address",
+        name: "previousOwner",
+        type: "address",
+      },
+      {
+        indexed: true,
+        internalType: "address",
+        name: "newOwner",
+        type: "address",
+      },
+    ],
+    name: "OwnershipTransferred",
+    type: "event",
+  },
+  {
+    inputs: [],
+    name: "ENTRYPOINT",
+    outputs: [
+      { internalType: "contract IEntryPoint", name: "", type: "address" },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "IMPL",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "MULTISIG_PLUGIN",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "acceptOwnership",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "uint32", name: "unstakeDelay", type: "uint32" },
+      { internalType: "uint256", name: "amount", type: "uint256" },
+    ],
+    name: "addStake",
+    outputs: [],
+    stateMutability: "payable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "uint256", name: "salt", type: "uint256" },
+      { internalType: "address[]", name: "owners", type: "address[]" },
+      { internalType: "uint128", name: "threshold", type: "uint128" },
+    ],
+    name: "createAccount",
+    outputs: [{ internalType: "address", name: "addr", type: "address" }],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "uint256", name: "salt", type: "uint256" },
+      { internalType: "address[]", name: "owners", type: "address[]" },
+      { internalType: "uint128", name: "threshold", type: "uint128" },
+    ],
+    name: "getAddress",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "owner",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "pendingOwner",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "renounceOwnership",
+    outputs: [],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "newOwner", type: "address" }],
+    name: "transferOwnership",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "unlockStake",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "address payable", name: "to", type: "address" },
+      { internalType: "address", name: "token", type: "address" },
+      { internalType: "uint256", name: "amount", type: "uint256" },
+    ],
+    name: "withdraw",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address payable", name: "to", type: "address" }],
+    name: "withdrawStake",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  { stateMutability: "payable", type: "receive" },
+] as const;

package/src/abi/index.ts

@@ -0,0 +1,8 @@
+export { LightAccountFactoryAbi_V1_0_1 } from "./LightAccountFactoryAbi_V1_0_1";
+export { LightAccountFactoryAbi_V1_0_2 } from "./LightAccountFactoryAbi_V1_0_2";
+export { LightAccountFactoryAbi_V1_1_0 } from "./LightAccountFactoryAbi_V1_1_0";
+export { LightAccountFactoryAbi_V2_0_0 } from "./LightAccountFactoryAbi_V2_0_0";
+export { ModularAccountFactoryAbi_V2_0_0 } from "./ModularAccountFactoryAbi_V2_0_0";
+export { MultiOwnerLightAccountFactoryAbi_V2_0_0 } from "./MultiOwnerLightAccountFactoryAbi_V2_0_0";
+export { MultiOwnerModularAccountFactoryAbi_V1_0_0 } from "./MultiOwnerModularAccountFactoryAbi_V1_0_0";
+export { MultisigModularAccountFactoryAbi_V1_0_0 } from "./MultisigModularAccountFactoryAbi_V1_0_0";

package/src/capabilities/index.ts

@@ -0,0 +1,11 @@
+import { Type } from "@sinclair/typebox";
+import { PaymasterCapability } from "./paymaster";
+import { PermissionsCapability } from "./permissions";
+
+export const Capabilities = Type.Object(
+  {
+    permissions: Type.Optional(PermissionsCapability),
+    paymasterService: Type.Optional(PaymasterCapability),
+  },
+  { minProperties: 1 },
+);

package/src/capabilities/paymaster.ts

@@ -0,0 +1,5 @@
+import { Type } from "@sinclair/typebox";
+
+export const PaymasterCapability = Type.Object({
+  policyId: Type.String(),
+});

package/src/capabilities/permissions/index.ts

@@ -0,0 +1,124 @@
+import { PermissionType } from "@account-kit/smart-contracts/experimental";
+import {
+  Type,
+  type TLiteral,
+  type TLiteralValue,
+  type TObject,
+  type TSchema,
+} from "@sinclair/typebox";
+import { KeySigner, TypeAddress, TypeHex } from "../../schemas";
+
+const Permission = <
+  TData extends TSchema,
+  TLiteralVal extends TLiteralValue,
+  TType extends TLiteral<TLiteralVal>,
+>(
+  type: TLiteralVal,
+  data: TData,
+  description: string,
+): TObject<{ type: TType; data: TData }> => {
+  return Type.Object(
+    {
+      type: Type.Literal(type),
+      data,
+    },
+    { description: description },
+  ) as never;
+};
+
+const NativeTokenTransfer = Permission(
+  PermissionType.NATIVE_TOKEN_TRANSFER,
+  Type.Object({
+    allowance: TypeHex(),
+  }),
+  "allows transfer of native tokens from the account",
+);
+
+const Erc20TokenTransfer = Permission(
+  PermissionType.ERC20_TOKEN_TRANSFER,
+  Type.Object({
+    allowance: TypeHex(),
+    address: TypeAddress,
+  }),
+  "allows transfer or approval of erc20 tokens from the account",
+);
+
+const GasLimit = Permission(
+  PermissionType.GAS_LIMIT,
+  Type.Object({
+    limit: TypeHex(),
+  }),
+  "allows the key to spend gas for UOs",
+);
+
+const ContractAccess = Permission(
+  PermissionType.CONTRACT_ACCESS,
+  Type.Object({
+    address: TypeAddress,
+  }),
+  "grants access to all functions in a contract",
+);
+
+const AccountFunction = Permission(
+  PermissionType.ACCOUNT_FUNCTIONS,
+  Type.Object({
+    functions: Type.Array(TypeHex(), { minItems: 1 }),
+  }),
+  "grants access to functions in the account",
+);
+
+const AllExternalFunctionAccess = Permission(
+  PermissionType.FUNCTIONS_ON_ALL_CONTRACTS,
+  Type.Object({
+    functions: Type.Array(TypeHex(), { minItems: 1 }),
+  }),
+  "access to a function selector in any address or contract",
+);
+
+const ContractFunctionAccess = Permission(
+  PermissionType.FUNCTIONS_ON_CONTRACT,
+  Type.Object({
+    address: TypeAddress,
+    functions: Type.Array(TypeHex(), { minItems: 1 }),
+  }),
+  "grants access to specified functions on a specific contract",
+);
+
+const Root = Permission(
+  PermissionType.ROOT,
+  Type.Optional(Type.Never()),
+  "grants full access to everything",
+);
+
+export const PermissionsArray = Type.Array(
+  Type.Union([
+    // 7715 permissions
+    NativeTokenTransfer,
+    Erc20TokenTransfer,
+    GasLimit,
+    // additional permissions
+    ContractAccess,
+    AccountFunction,
+    AllExternalFunctionAccess,
+    ContractFunctionAccess,
+    Root,
+  ]),
+  { minItems: 1 },
+);
+
+export const PermissionsContext = Type.Object({
+  context: TypeHex(),
+});
+
+export const PermissionsData = Type.Object({
+  chainId: TypeHex(),
+  expiry: Type.Optional(Type.Number()),
+  key: KeySigner,
+  permissions: PermissionsArray,
+});
+
+export const PermissionsCapability = Type.Union([
+  PermissionsContext,
+  // TODO: support permissions object here instead of only context-encoded permissions
+  // PermissionsData,
+]);

package/src/capabilities/permissions/mav2.ts

@@ -0,0 +1,127 @@
+import { PermissionType } from "@account-kit/smart-contracts/experimental";
+import type { Static } from "@sinclair/typebox";
+import { concatHex, sliceHex, type Hex } from "viem";
+import type { PermissionsData } from ".";
+import type { KeySigner } from "../../schemas";
+import { assertNever } from "../../utils";
+
+export const SESSION_ID_LENGTH_BYTES = 16;
+export const ENTITY_ID_LENGTH_BYTES = 4;
+
+export const PermissionsContextVersion = {
+  REMOTE_MODE_DEFERRED_ACTION: "0x00",
+  LOCAL_MODE_DEFERRED_ACTION: "0x01",
+  NON_DEFERRED_ACTION: "0x02",
+} as const;
+
+type ContextVersionHex =
+  (typeof PermissionsContextVersion)[keyof typeof PermissionsContextVersion];
+
+type DecodedPermissionsContext = {
+  contextVersion: keyof typeof PermissionsContextVersion;
+} & (
+  | {
+      contextVersion: "REMOTE_MODE_DEFERRED_ACTION";
+      sessionId: Hex;
+      signature: Hex;
+      deferredAction?: never;
+    }
+  | {
+      contextVersion: "LOCAL_MODE_DEFERRED_ACTION";
+      deferredAction: Hex;
+      sessionId?: never;
+      signature?: never;
+    }
+  | {
+      contextVersion: "NON_DEFERRED_ACTION";
+      deferredAction?: never;
+      sessionId?: never;
+      signature?: never;
+      entityId: Hex;
+      isGlobalValidation: boolean;
+    }
+);
+
+export const encodePermissionsContext = (
+  context: DecodedPermissionsContext,
+): Hex => {
+  switch (context.contextVersion) {
+    case "REMOTE_MODE_DEFERRED_ACTION":
+      return concatHex([
+        PermissionsContextVersion.REMOTE_MODE_DEFERRED_ACTION,
+        context.sessionId,
+        context.signature,
+      ]);
+    case "LOCAL_MODE_DEFERRED_ACTION":
+      return concatHex([
+        PermissionsContextVersion.LOCAL_MODE_DEFERRED_ACTION,
+        context.deferredAction,
+      ]);
+    case "NON_DEFERRED_ACTION":
+      return concatHex([
+        PermissionsContextVersion.NON_DEFERRED_ACTION,
+        context.isGlobalValidation ? "0x01" : "0x00",
+        context.entityId,
+      ]);
+    default:
+      return assertNever(context, "Unexpected context version");
+  }
+};
+
+export const decodePermissionsContext = (
+  input: Hex,
+): DecodedPermissionsContext => {
+  const contextVersion = sliceHex(input, 0, 1) as ContextVersionHex;
+  switch (contextVersion) {
+    case "0x00": {
+      const sessionId = sliceHex(input, 1, SESSION_ID_LENGTH_BYTES + 1);
+      const signature = sliceHex(input, SESSION_ID_LENGTH_BYTES + 1);
+      return {
+        contextVersion: "REMOTE_MODE_DEFERRED_ACTION",
+        sessionId,
+        signature,
+      };
+    }
+    case "0x01": {
+      const deferredAction = sliceHex(input, 1);
+      return {
+        contextVersion: "LOCAL_MODE_DEFERRED_ACTION",
+        deferredAction,
+      };
+    }
+    case "0x02": {
+      const isGlobalValidation = sliceHex(input, 1, 2) === "0x01";
+      const entityId = sliceHex(input, 2, ENTITY_ID_LENGTH_BYTES + 2);
+      return {
+        contextVersion: "NON_DEFERRED_ACTION",
+        isGlobalValidation,
+        entityId,
+      };
+    }
+    default:
+      return assertNever(
+        contextVersion,
+        `Unexpected context version: ${contextVersion}`,
+      );
+  }
+};
+
+export const prefixSignatureKeyType = (
+  sig: Hex,
+  type: KeySigner["type"],
+): Hex => {
+  switch (type) {
+    case "secp256k1":
+      return concatHex(["0x00", sig]);
+    case "contract":
+      return concatHex(["0x01", sig]);
+    default:
+      return assertNever(type, "Unexpected session key type");
+  }
+};
+
+export const isGlobalValidation = (
+  data: Pick<Static<typeof PermissionsData>, "permissions">,
+): boolean => {
+  return data.permissions.some((p) => p.type === PermissionType.ROOT);
+};

package/src/client/actions/createAccount.ts

@@ -0,0 +1,28 @@
+import type { SmartAccountSigner } from "@aa-sdk/core";
+import type { Static } from "@sinclair/typebox";
+import type { Address } from "abitype";
+import type { wallet_createAccount } from "../../rpc/request";
+import type { InnerWalletApiClient } from "../../types";
+
+export type CreateAccountParams = Omit<
+  Extract<
+    Static<typeof wallet_createAccount>["Request"]["params"][0],
+    { signerAddress: Address }
+  >,
+  "signerAddress"
+>;
+
+export type CreateAccountResult = Static<
+  typeof wallet_createAccount
+>["ReturnType"];
+
+export async function createAccount(
+  client: InnerWalletApiClient,
+  signer: SmartAccountSigner,
+  params: CreateAccountParams,
+): Promise<CreateAccountResult> {
+  return client.request({
+    method: "wallet_createAccount",
+    params: [{ signerAddress: await signer.getAddress(), ...params }],
+  });
+}

package/src/client/actions/getCallsStatus.ts

@@ -0,0 +1,29 @@
+import type { Address, JsonRpcAccount } from "viem";
+import type {
+  GetCallsStatusParams as IsomorphicGetCallsStatusParams,
+  GetCallsStatusResponse as IsomorphicGetCallsStatusResult,
+} from "../../isomorphic/actions/getCallsStatus";
+import type { InnerWalletApiClient } from "../../types";
+
+export type GetCallsStatusParams = IsomorphicGetCallsStatusParams;
+
+export type GetCallsStatusResult = IsomorphicGetCallsStatusResult;
+
+export async function getCallsStatus<
+  TAccount extends JsonRpcAccount<Address> | undefined =
+    | JsonRpcAccount<Address>
+    | undefined,
+>(
+  client: InnerWalletApiClient<TAccount>,
+  params: GetCallsStatusParams,
+): Promise<GetCallsStatusResult>;
+
+export async function getCallsStatus(
+  client: InnerWalletApiClient,
+  params: GetCallsStatusParams,
+): Promise<GetCallsStatusResult> {
+  return await client.request({
+    method: "wallet_getCallsStatus",
+    params: [params],
+  });
+}