@account-kit/wallet-client 0.0.1-alpha.1 → 0.1.0-alpha.0

package/src/capabilities/permissions/index.ts

@@ -13,20 +13,32 @@ const Permission = <
   TLiteralVal extends TLiteralValue,
   TType extends TLiteral<TLiteralVal>,
 >(
-  type: TLiteralVal,
+  typeString: TLiteralVal, // e.g., "root"
+  typeEnum: TLiteralVal, // e.g., PermissionType.ROOT
   data: TData,
   description: string,
 ): TObject<{ type: TType; data: TData }> => {
-  return Type.Object(
-    {
-      type: Type.Literal(type),
-      data,
-    },
-    { description: description },
-  ) as never;
+  return Type.Transform(
+    Type.Object(
+      {
+        type: Type.Literal(typeEnum),
+        data,
+      },
+      { description },
+    ),
+  )
+    .Decode((value) => ({
+      ...value,
+      type: typeString, // enum → string
+    }))
+    .Encode((value) => ({
+      ...value,
+      type: typeEnum, // string → enum
+    })) as never;
 };
 
 const NativeTokenTransfer = Permission(
+  "native-token-transfer",
   PermissionType.NATIVE_TOKEN_TRANSFER,
   Type.Object({
     allowance: TypeHex(),
@@ -35,6 +47,7 @@ const NativeTokenTransfer = Permission(
 );
 
 const Erc20TokenTransfer = Permission(
+  "erc20-token-transfer",
   PermissionType.ERC20_TOKEN_TRANSFER,
   Type.Object({
     allowance: TypeHex(),
@@ -44,6 +57,7 @@ const Erc20TokenTransfer = Permission(
 );
 
 const GasLimit = Permission(
+  "gas-limit",
   PermissionType.GAS_LIMIT,
   Type.Object({
     limit: TypeHex(),
@@ -52,6 +66,7 @@ const GasLimit = Permission(
 );
 
 const ContractAccess = Permission(
+  "contract-access",
   PermissionType.CONTRACT_ACCESS,
   Type.Object({
     address: TypeAddress,
@@ -60,6 +75,7 @@ const ContractAccess = Permission(
 );
 
 const AccountFunction = Permission(
+  "account-functions",
   PermissionType.ACCOUNT_FUNCTIONS,
   Type.Object({
     functions: Type.Array(TypeHex(), { minItems: 1 }),
@@ -68,6 +84,7 @@ const AccountFunction = Permission(
 );
 
 const AllExternalFunctionAccess = Permission(
+  "functions-on-all-contracts",
   PermissionType.FUNCTIONS_ON_ALL_CONTRACTS,
   Type.Object({
     functions: Type.Array(TypeHex(), { minItems: 1 }),
@@ -76,6 +93,7 @@ const AllExternalFunctionAccess = Permission(
 );
 
 const ContractFunctionAccess = Permission(
+  "functions-on-contract",
   PermissionType.FUNCTIONS_ON_CONTRACT,
   Type.Object({
     address: TypeAddress,
@@ -85,26 +103,26 @@ const ContractFunctionAccess = Permission(
 );
 
 const Root = Permission(
+  "root",
   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 TypePermission = Type.Union([
+  // 7715 permissions
+  NativeTokenTransfer,
+  Erc20TokenTransfer,
+  GasLimit,
+  // additional permissions
+  ContractAccess,
+  AccountFunction,
+  AllExternalFunctionAccess,
+  ContractFunctionAccess,
+  Root,
+]);
+
+export const PermissionsArray = Type.Array(TypePermission, { minItems: 1 });
 
 export const PermissionsContext = Type.Object({
   context: TypeHex(),

package/src/client/actions/grantPermissions.ts

@@ -27,7 +27,7 @@ export async function grantPermissions<
     | JsonRpcAccount<Address>
     | undefined,
 >(
-  client: InnerWalletApiClient,
+  client: InnerWalletApiClient<TAccount>,
   signer: SmartAccountSigner,
   params: GrantPermissionsParams<TAccount>,
 ): Promise<GrantPermissionsResult>;

package/src/client/actions/sendPreparedCalls.ts

@@ -1,10 +1,10 @@
-import type { Static } from "@sinclair/typebox";
+import type { Static, StaticDecode } from "@sinclair/typebox";
+import { toHex } from "viem";
 import type { wallet_sendPreparedCalls } from "../../rpc/request";
 import type { InnerWalletApiClient } from "../../types";
-import { toHex } from "viem";
 
 export type SendPreparedCallsParams = Omit<
-  Static<typeof wallet_sendPreparedCalls>["Request"]["params"][0],
+  StaticDecode<typeof wallet_sendPreparedCalls>["Request"]["params"][0],
   "chainId"
 >;
 

package/src/client/client.e2e-test.ts

@@ -3,7 +3,6 @@ import { alchemy, arbitrumSepolia } from "@account-kit/infra";
 import { describe, expect, it } from "bun:test";
 import { createPublicClient, zeroAddress, type Address } from "viem";
 import { createSmartWalletClient } from ".";
-import { PermissionType } from "@account-kit/smart-contracts/experimental";
 import { signSignatureRequest } from "./actions/signSignatureRequest";
 
 describe("Client E2E Tests", () => {
@@ -90,7 +89,7 @@ describe("Client E2E Tests", () => {
       const result = await client.sendPreparedCalls({
         ...preparedUO,
         signature: {
-          type: "ECDSA",
+          type: "ecdsa",
           signature,
         },
       });
@@ -110,7 +109,7 @@ describe("Client E2E Tests", () => {
           publicKey: await sessionKey.getAddress(),
           type: "secp256k1",
         },
-        permissions: [{ type: PermissionType.ROOT }],
+        permissions: [{ type: "root" }],
       });
 
       const preparedUO = await client.prepareCalls({
@@ -228,7 +227,7 @@ describe("Client E2E Tests", () => {
           publicKey: await sessionKey.getAddress(),
           type: "secp256k1",
         },
-        permissions: [{ type: PermissionType.ROOT }],
+        permissions: [{ type: "root" }],
       });
 
       const preparedUO = await client.prepareCalls({

package/src/client/decorator.ts

@@ -72,7 +72,7 @@ export type SmartWalletActions<
   signMessage: (params: SignableMessage) => Promise<Hex>;
   signTypedData: (params: TypedDataDefinition) => Promise<Hex>;
   grantPermissions: (
-    params: GrantPermissionsParams,
+    params: GrantPermissionsParams<TAccount>,
   ) => Promise<GrantPermissionsResult>;
 };
 

package/src/isomorphic/actions/createSession.ts

@@ -22,6 +22,8 @@ import {
 } from "@account-kit/smart-contracts/experimental";
 import { createDummySigner } from "../utils/createDummySigner";
 import { createAccount, isModularAccountV2 } from "../utils/createAccount";
+import { Value } from "@sinclair/typebox/value";
+import { TypePermission } from "../../capabilities/permissions";
 
 export type CreateSessionParams = Omit<
   Static<
@@ -100,7 +102,9 @@ export async function createSession(
       deadline: params.expiry,
     })
       .addPermissions({
-        permissions: params.permissions,
+        permissions: params.permissions.map((permission) =>
+          Value.Encode(TypePermission, permission),
+        ),
       })
       .compileDeferred();
 

package/src/isomorphic/actions/prepareCalls.ts

@@ -5,13 +5,13 @@ import {
 } from "@aa-sdk/core";
 import type { Static } from "@sinclair/typebox";
 import {
+  ChainNotFoundError,
   custom,
   fromHex,
+  toHex,
   zeroAddress,
   type Chain,
   type Transport,
-  ChainNotFoundError,
-  toHex,
 } from "viem";
 import type { wallet_prepareCalls } from "../../rpc/request";
 import type { WalletServerViemRpcSchema } from "../../rpc/schema";
@@ -76,6 +76,7 @@ export async function prepareCalls(
       value: x.value ? fromHex(x.value, "bigint") : undefined,
     })),
     account,
+    overrides: params.capabilities?.gasParamsOverride,
   });
 
   const uoRequest = deepHexlify(builtUo);

package/src/isomorphic/actions/sendPreparedCalls.ts

@@ -3,6 +3,8 @@ import {
   type SmartAccountClient,
   type SmartContractAccount,
 } from "@aa-sdk/core";
+import type { Static, StaticDecode } from "@sinclair/typebox";
+import { Value } from "@sinclair/typebox/value";
 import {
   ChainNotFoundError,
   concat,
@@ -15,12 +17,10 @@ import {
 import { decodePermissionsContext } from "../../capabilities/permissions/mav2";
 import type { wallet_sendPreparedCalls } from "../../rpc/request";
 import type { WalletServerViemRpcSchema } from "../../rpc/schema";
-import { Value } from "@sinclair/typebox/value";
 import { TypeCallId } from "../../schemas";
-import type { Static } from "@sinclair/typebox";
 
 export type SendPreparedCallsParams = Omit<
-  Static<
+  StaticDecode<
     (typeof wallet_sendPreparedCalls)["properties"]["Request"]["properties"]["params"]
   >[0],
   "chainId"

package/src/isomorphic/client.ts

@@ -6,30 +6,32 @@ import {
 } from "@aa-sdk/core";
 import {
   alchemyFeeEstimator,
+  alchemyGasAndPaymasterAndDataMiddleware,
   alchemyGasManagerMiddleware,
   type AlchemyTransport,
 } from "@account-kit/infra";
 import { type Chain, type Transport } from "viem";
 import type { WalletServerViemRpcSchema } from "../rpc/schema";
-import { prepareCalls, type PrepareCallsParams } from "./actions/prepareCalls";
 import {
-  sendPreparedCalls,
-  type SendPreparedCallsParams,
-} from "./actions/sendPreparedCalls";
+  createSession,
+  type CreateSessionParams,
+} from "./actions/createSession";
 import {
   getCallsStatus,
   type GetCallsStatusParams,
 } from "./actions/getCallsStatus";
+import { prepareCalls, type PrepareCallsParams } from "./actions/prepareCalls";
 import {
-  createSession,
-  type CreateSessionParams,
-} from "./actions/createSession";
+  sendPreparedCalls,
+  type SendPreparedCallsParams,
+} from "./actions/sendPreparedCalls";
 
 // let's start with something that takes in as many params as possible, then we can eliminate them as we don't need them
 type ClientParams = {
   chain: Chain;
   transport: Transport;
   policyId?: string;
+  useErc7677middleware?: boolean;
 };
 
 export function isomorphicClientActions(
@@ -58,6 +60,7 @@ export function createIsomorphicClient({
   chain,
   transport,
   policyId,
+  useErc7677middleware = true,
 }: ClientParams): SmartAccountClient<
   Transport,
   Chain,
@@ -71,8 +74,15 @@ export function createIsomorphicClient({
     chain,
     // TODO: we will want to enforce alchemy transport here probably
     feeEstimator: alchemyFeeEstimator(transport as AlchemyTransport),
-    // TODO: we need to use the other middleware that does gas estimation as well here
-    ...(policyId ? alchemyGasManagerMiddleware(policyId) : {}),
+    ...(policyId
+      ? useErc7677middleware
+        ? alchemyGasManagerMiddleware(policyId)
+        : // NOTE: DO NOT USE THIS MIDDLEWARE in the server, currently we require using the erc7677 middleware
+          alchemyGasAndPaymasterAndDataMiddleware({
+            policyId,
+            transport: transport as AlchemyTransport,
+          })
+      : {}),
   }).extend(isomorphicClientActions);
 
   return client;

package/src/local/client.ts

@@ -1,5 +1,11 @@
 import { split } from "@aa-sdk/core";
+import { buildDeferredActionDigest } from "@account-kit/smart-contracts/experimental";
 import { createClient, custom, type Address, type JsonRpcAccount } from "viem";
+import {
+  encodePermissionsContext,
+  prefixSignatureKeyType,
+} from "../capabilities/permissions/mav2";
+import { signSignatureRequest } from "../client/actions/signSignatureRequest";
 import type { PrepareCallsParams } from "../isomorphic/actions/prepareCalls";
 import {
   createIsomorphicClient,
@@ -11,12 +17,6 @@ import type {
   InnerWalletApiClient,
 } from "../types";
 import { assertNever } from "../utils";
-import { signSignatureRequest } from "../client/actions/signSignatureRequest";
-import {
-  encodePermissionsContext,
-  prefixSignatureKeyType,
-} from "../capabilities/permissions/mav2";
-import { buildDeferredActionDigest } from "@account-kit/smart-contracts/experimental";
 
 const localMethods = [
   "wallet_prepareCalls",
@@ -40,6 +40,7 @@ export function createLocalClient(
     transport,
     chain,
     policyId,
+    useErc7677middleware: false,
   });
 
   const clientMap: Record<string, ReturnType<typeof createIsomorphicClient>> = {

package/src/rpc/request.ts

@@ -32,9 +32,15 @@ export const wallet_sendPreparedCalls = Type.Object(
           ]),
           chainId: TypeHex(),
           signature: Type.Object({
-            // ignored, but in the spec can be used when the signature on the UO needs to be formatted differently
-            // potentially useful for deferred actions?
-            type: Type.String(),
+            type: Type.Transform(Type.String())
+              .Decode((value) => {
+                if (value.toLowerCase() !== "ecdsa") {
+                  throw new Error("Invalid signature type, must be 'ecdsa'");
+                }
+
+                return "ecdsa" as const;
+              })
+              .Encode((value) => value),
             signature: TypeHex(),
           }),
           capabilities: Type.Optional(
@@ -180,18 +186,27 @@ export const wallet_listAccounts = Type.Object(
   },
 );
 
-export const wallet_createSession = Type.Object({
-  Request: Type.Object({
-    method: Type.Literal("wallet_createSession"),
-    params: Type.Tuple([
-      Type.Intersect([PermissionsData, Type.Object({ account: TypeAddress })]),
-    ]),
-  }),
-  ReturnType: Type.Object({
-    sessionId: TypeHex(),
-    signatureRequest: TypeSignatureRequest,
-  }),
-});
+export const wallet_createSession = Type.Object(
+  {
+    Request: Type.Object({
+      method: Type.Literal("wallet_createSession"),
+      params: Type.Tuple([
+        Type.Intersect([
+          PermissionsData,
+          Type.Object({ account: TypeAddress }),
+        ]),
+      ]),
+    }),
+    ReturnType: Type.Object({
+      sessionId: TypeHex(),
+      signatureRequest: TypeSignatureRequest,
+    }),
+  },
+  {
+    description:
+      "This method is used to create a session for a given address with specified permissions.",
+  },
+);
 
 export const wallet_getCallsStatus = Type.Object(
   {

package/src/rpc/schema.ts

@@ -1,10 +1,10 @@
-import { type Static } from "@sinclair/typebox";
+import { type Static, type StaticDecode } from "@sinclair/typebox";
 import { RpcSchema } from "ox";
 import * as Requests from "./request";
 
 export const WalletServerRpcSchema = RpcSchema.from<
   | Static<typeof Requests.wallet_prepareCalls>
-  | Static<typeof Requests.wallet_sendPreparedCalls>
+  | StaticDecode<typeof Requests.wallet_sendPreparedCalls>
   | Static<typeof Requests.wallet_createAccount>
   | Static<typeof Requests.wallet_requestAccount>
   | Static<typeof Requests.wallet_listAccounts>