@account-kit/wallet-client 0.1.0-alpha.2 → 0.1.0-alpha.4

package/src/schemas.ts

@@ -14,33 +14,54 @@ const BASE_64_URL_REGEX = /^[A-Za-z0-9_-]+$/; // Matches base64url encoded strin
 FormatRegistry.Set("base64url", (value) => BASE_64_URL_REGEX.test(value));
 
 export const TypeHex = (options?: SchemaOptions) =>
-  Type.TemplateLiteral("0x${string}", options);
-export const TypeAddress = Type.TemplateLiteral("0x${string}");
-export const TypeUuid = Type.String({ format: "uuid" });
+  Type.TemplateLiteral("0x${string}", {
+    ...options,
+  });
+
+export const TypeAddress = Type.TemplateLiteral("0x${string}", {});
+
+export const TypeUuid = Type.String({
+  format: "uuid",
+});
+
 export const TypeBase64UrlEncodedString = Type.String({
   format: "base64url",
 });
 
 // BigInt is not json-serializable, so it must be encoded as a string.
-export const TypeU256 = Type.Transform(Type.String())
+export const TypeU256 = Type.Transform(Type.String({}))
   .Decode((value) => BigInt(value))
   .Encode((value) => toHex(value));
 
-export const TypeU32 = Type.Transform(Type.String())
+export const TypeU32 = Type.Transform(Type.String({}))
   .Decode((value) => Number.parseInt(value, 16))
   .Encode((value) => toHex(value));
 
 export const TypeUserOperationRequest_v6 = Type.Object({
   sender: TypeAddress,
   nonce: TypeHex(),
-  initCode: Type.Union([TypeHex(), Type.Literal("0x")]),
+  initCode: Type.Union([
+    TypeHex({
+      title: "Present",
+    }),
+    Type.Literal("0x", {
+      title: "Absent",
+    }),
+  ]),
   callData: TypeHex(),
   callGasLimit: TypeHex(),
   verificationGasLimit: TypeHex(),
   preVerificationGas: TypeHex(),
   maxFeePerGas: TypeHex(),
   maxPriorityFeePerGas: TypeHex(),
-  paymasterAndData: Type.Union([TypeHex(), Type.Literal("0x")]),
+  paymasterAndData: Type.Union([
+    TypeHex({
+      title: "Present",
+    }),
+    Type.Literal("0x", {
+      title: "Absent",
+    }),
+  ]),
   signature: TypeHex(),
 });
 
@@ -62,6 +83,21 @@ export const TypeUserOperationRequest_v7 = Type.Object({
   signature: TypeHex(),
 });
 
+export const TypeEip7702AuthRequest = Type.Object({
+  chainId: Type.Integer(),
+  address: TypeAddress,
+  nonce: Type.Integer(),
+});
+
+export const TypeEip7702AuthExtendedFields = Type.Object({
+  chainId: TypeHex(),
+  nonce: TypeHex(),
+  address: TypeAddress,
+  r: TypeHex(),
+  s: TypeHex(),
+  yParity: TypeHex(),
+});
+
 export const TypeWebAuthnPublicKey = Type.Object({
   x: TypeU256,
   y: TypeU256,
@@ -70,54 +106,89 @@ export const TypeWebAuthnPublicKey = Type.Object({
 export const TypePersistedInitcode = Type.Object({
   factoryAddress: TypeAddress,
   initcode: Type.Union([
-    Type.Object({
-      factoryType: Type.Literal("unknown"),
-      factoryData: TypeHex(),
-    }),
-    Type.Object({
-      factoryType: Type.Union([
-        Type.Literal("LightAccountV2.0.0"),
-        Type.Literal("LightAccountV1.1.0"),
-        Type.Literal("LightAccountV1.0.2"),
-        Type.Literal("LightAccountV1.0.1"),
-      ]),
-      salt: TypeU256,
-      initialOwner: TypeAddress,
-    }),
-    Type.Object({
-      factoryType: Type.Union([
-        Type.Literal("MAv1.0.0-MultiOwner"),
-        Type.Literal("LightAccountV2.0.0-MultiOwner"),
-      ]),
-      salt: TypeU256,
-      initialOwners: Type.Array(TypeAddress),
-    }),
-    Type.Object({
-      factoryType: Type.Literal("MAv1.0.0-MultiSig"),
-      salt: TypeU256,
-      initialOwners: Type.Array(TypeAddress),
-      threshold: TypeU256,
-    }),
+    Type.Object(
+      {
+        factoryType: Type.Literal("unknown", { title: "Unknown factory type" }),
+        factoryData: TypeHex({}),
+      },
+      {
+        title: "Unknown factory type",
+      },
+    ),
+    Type.Object(
+      {
+        factoryType: Type.Union([
+          Type.Literal("LightAccountV2.0.0"),
+          Type.Literal("LightAccountV1.1.0"),
+          Type.Literal("LightAccountV1.0.2"),
+          Type.Literal("LightAccountV1.0.1"),
+        ]),
+        salt: TypeU256,
+        initialOwner: TypeAddress,
+      },
+      {
+        title: "Light Account",
+      },
+    ),
+    Type.Object(
+      {
+        factoryType: Type.Union([
+          Type.Literal("MAv1.0.0-MultiOwner"),
+          Type.Literal("LightAccountV2.0.0-MultiOwner"),
+        ]),
+        salt: TypeU256,
+        initialOwners: Type.Array(TypeAddress),
+      },
+      {
+        title: "Multi-Owner Modular Account",
+      },
+    ),
+    Type.Object(
+      {
+        factoryType: Type.Literal("MAv1.0.0-MultiSig"),
+        salt: TypeU256,
+        initialOwners: Type.Array(TypeAddress),
+        threshold: TypeU256,
+      },
+      {
+        title: "Multi-Sig Modular Account",
+      },
+    ),
     Type.Intersect([
       Type.Object({
         factoryType: Type.Literal("MAv2.0.0"),
         salt: TypeU256,
       }),
       Type.Union([
-        Type.Object({
-          mav2type: Type.Literal("ma-ssv"),
-          initialOwner: TypeAddress,
-          entityId: TypeU32,
-        }),
-        Type.Object({
-          mav2type: Type.Literal("sma-b"),
-          initialOwner: TypeAddress,
-        }),
-        Type.Object({
-          mav2type: Type.Literal("ma-webauthn"),
-          initialOwner: TypeWebAuthnPublicKey,
-          entityId: TypeU32,
-        }),
+        Type.Object(
+          {
+            mav2type: Type.Literal("ma-ssv"),
+            initialOwner: TypeAddress,
+            entityId: TypeU32,
+          },
+          {
+            title: "Modular Account V2 SSV",
+          },
+        ),
+        Type.Object(
+          {
+            mav2type: Type.Literal("sma-b"),
+            initialOwner: TypeAddress,
+          },
+          {
+            title: "Modular Account V2 SMA-B",
+          },
+        ),
+        Type.Object(
+          {
+            mav2type: Type.Literal("ma-webauthn"),
+            initialOwner: TypeWebAuthnPublicKey,
+            entityId: TypeU32,
+          },
+          {
+            title: "Modular Account V2 WebAuthn",
+          },
+        ),
       ]),
     ]),
   ]),
@@ -125,20 +196,32 @@ export const TypePersistedInitcode = Type.Object({
 
 export const TypeSerializedInitcode = Type.Object({
   factoryType: Type.Union([
-    Type.Literal("LightAccountV1.0.1"),
-    Type.Literal("LightAccountV1.0.2"),
-    Type.Literal("LightAccountV1.1.0"),
-    Type.Literal("LightAccountV2.0.0"),
-    Type.Literal("LightAccountV2.0.0-MultiOwner"),
-    Type.Literal("MAv1.0.0-MultiOwner"),
-    Type.Literal("MAv1.0.0-MultiSig"),
-    Type.Literal("MAv2.0.0-sma-b"),
-    Type.Literal("MAv2.0.0-ma-ssv"),
-    Type.Literal("MAv2.0.0-ma-webauthn"),
-    Type.Literal("unknown"),
+    Type.Literal("LightAccountV1.0.1", { title: "Light Account v1.0.1" }),
+    Type.Literal("LightAccountV1.0.2", { title: "Light Account v1.0.2" }),
+    Type.Literal("LightAccountV1.1.0", { title: "Light Account v1.1.0" }),
+    Type.Literal("LightAccountV2.0.0", { title: "Light Account v2.0.0" }),
+    Type.Literal("LightAccountV2.0.0-MultiOwner", {
+      title: "Light Account v2.0.0 MultiOwner",
+    }),
+    Type.Literal("MAv1.0.0-MultiOwner", {
+      title: "Modular Account v1.0.0 MultiOwner",
+    }),
+    Type.Literal("MAv1.0.0-MultiSig", {
+      title: "Modular Account v1.0.0 MultiSig",
+    }),
+    Type.Literal("MAv2.0.0-sma-b", {
+      title: "Modular Account v2.0.0 SMA-B",
+    }),
+    Type.Literal("MAv2.0.0-ma-ssv", {
+      title: "Modular Account v2.0.0 SSV",
+    }),
+    Type.Literal("MAv2.0.0-ma-webauthn", {
+      title: "Modular Account v2.0.0 WebAuthn",
+    }),
+    Type.Literal("unknown", { title: "Unknown factory type" }),
   ]),
   factoryAddress: TypeAddress,
-  factoryData: TypeHex(),
+  factoryData: TypeHex({}),
 });
 
 export const TypeCounterfactualInfo = Type.Intersect([
@@ -146,27 +229,55 @@ export const TypeCounterfactualInfo = Type.Intersect([
     accountAddress: TypeAddress,
   }),
   Type.Union([
-    Type.Intersect([
-      Type.Object({
-        type: Type.Literal("sca"),
-      }),
-      TypePersistedInitcode,
-    ]),
-    Type.Object({
-      type: Type.Literal("7702"),
-    }),
+    Type.Intersect(
+      [
+        Type.Object({
+          type: Type.Literal("sca"),
+        }),
+        TypePersistedInitcode,
+      ],
+      {
+        title: "Smart Contract Account",
+      },
+    ),
+    Type.Object(
+      {
+        type: Type.Literal("7702"),
+        implementationAddress: TypeAddress,
+      },
+      {
+        title: "7702 Account",
+      },
+    ),
   ]),
 ]);
 export type TypeCounterfactualInfo = Static<typeof TypeCounterfactualInfo>;
 
 export const TypeCreationOptions = Type.Optional(
   Type.Union([
-    Type.Object({
-      // Optional b/c `sma-b` is the default if no accountType is specified.
-      accountType: Type.Optional(Type.Literal("sma-b")),
-      salt: Type.Optional(TypeHex()),
-    }),
-    // TODO: add more options after v0.
+    Type.Object(
+      {
+        // Optional b/c `sma-b` is the default if no accountType is specified.
+        accountType: Type.Optional(Type.Literal("sma-b")),
+        salt: Type.Optional(TypeHex()),
+      },
+      {
+        title: "SMA-B account type",
+      },
+    ),
+    Type.Object(
+      {
+        accountType: Type.Literal("7702"),
+        // TODO: Add support for specifying a delegation address.
+        // Currently we only support delegating to MAv2, and it's important
+        // that wallet applications maintain a strict shortlist of well-known
+        // accounts: https://github.com/ethereum/ERCs/pull/947/files#diff-dab085f963ca621595044bcbc0922705aa38b69f5bf8770dcb3d0496a633efcfR189
+        // delegation: TypeAddress,
+      },
+      {
+        title: "7702 account type",
+      },
+    ),
   ]),
 );
 export type TypeCreationOptions = Static<typeof TypeCreationOptions>;
@@ -177,8 +288,11 @@ export type TypeAccountType = Exclude<
 >["accountType"];
 
 export const KeySigner = Type.Object({
-  type: Type.Union([Type.Literal("secp256k1"), Type.Literal("contract")]),
-  publicKey: TypeHex(),
+  type: Type.Union([
+    Type.Literal("secp256k1", { title: "Secp256k1" }),
+    Type.Literal("contract", { title: "Contract" }),
+  ]),
+  publicKey: TypeHex({}),
 });
 export type KeySigner = Static<typeof KeySigner>;
 
@@ -186,7 +300,7 @@ export const TTypedDataDefinition = Type.Transform(
   Type.Object({
     domain: Type.Optional(
       Type.Object({
-        chainId: Type.Optional(Type.Number()),
+        chainId: Type.Optional(Type.Integer()),
         name: Type.Optional(Type.String()),
         salt: Type.Optional(TypeHex()),
         verifyingContract: Type.Optional(TypeAddress),
@@ -228,19 +342,36 @@ export const TTypedDataDefinition = Type.Transform(
     };
   });
 
-export const TypeSignatureRequest = Type.Union([
-  Type.Object({
+const TypePersonalSignSignatureRequest = Type.Object(
+  {
     type: Type.Literal("personal_sign"),
     data: Type.Union([
-      Type.String({ minLength: 1 }),
-      Type.Object({
-        raw: TypeHex(),
-      }),
+      Type.String({ minLength: 1, title: "Message" }),
+      Type.Object(
+        {
+          raw: TypeHex(),
+        },
+        { title: "Raw message" },
+      ),
     ]),
-  }),
-  Type.Object({
+  },
+  { title: "Personal sign" },
+);
+
+const TypeTypedDataSignatureRequest = Type.Object(
+  {
     type: Type.Literal("eth_signTypedData_v4"),
     data: TTypedDataDefinition,
+  },
+  {
+    title: "Typed data",
+  },
+);
+
+export const TypeSignatureRequest = Type.Intersect([
+  Type.Union([TypePersonalSignSignatureRequest, TypeTypedDataSignatureRequest]),
+  Type.Object({
+    authorizationRequest: Type.Optional(TypeEip7702AuthRequest),
   }),
 ]);