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

package/src/rpc/examples.ts

@@ -0,0 +1,343 @@
+const PrepareCalls = [
+  {
+    name: "wallet_prepareCalls example",
+    params: [
+      {
+        name: "Request",
+        value: [
+          {
+            calls: [
+              {
+                to: "0x1234567890123456789012345678901234567890",
+                data: "0x",
+              },
+            ],
+            from: "0xa363219d7C0b8673df17529D469Db9eFF0f35D2A",
+            chainId: "0x01",
+            capabilities: {
+              paymasterService: {
+                policyId: "11111111-2222-3333-4444-555555555555",
+              },
+            },
+          },
+        ],
+      },
+    ],
+    result: {
+      name: "Response",
+      value: {
+        type: "user-operation-v070",
+        data: {
+          sender: "0xa363219d7C0b8673df17529D469Db9eFF0f35D2A",
+          nonce: "0x10000000000000000",
+          callData:
+            "0x34fcd5be0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000",
+          paymaster: "0x3f222Df6aB18C1E10d0Ec136503c3B0dfd929048",
+          paymasterData:
+            "0x0000000000000000682d7e7c9fa6f71c28c31141a11ac9eb2bdbe898ddbd42a4f7085f8bb3380ba75dd9231a386e24fe5a84777217c907391e983b5b0f78a4a9d0fd1c8631dd22c10e106b461c",
+          paymasterPostOpGasLimit: "0x0",
+          paymasterVerificationGasLimit: "0x74d3",
+          maxPriorityFeePerGas: "0x60e4b0",
+          maxFeePerGas: "0x1bf52290",
+          callGasLimit: "0x2bb8",
+          verificationGasLimit: "0xc845",
+          preVerificationGas: "0x14b74",
+        },
+        chainId: "0x66eee",
+        signatureRequest: {
+          type: "personal_sign",
+          data: {
+            raw: "0xc69e468aa6fafb5c7298c02841e76f976b433018266af39a5807bc29ea9ad392",
+          },
+        },
+      },
+    },
+  },
+] as const;
+
+const SendPreparedCalls = [
+  {
+    name: "wallet_sendPreparedCalls example",
+    params: [
+      {
+        name: "Request",
+        value: [
+          {
+            type: "user-operation-v070",
+            data: {
+              sender: "0xa363219d7C0b8673df17529D469Db9eFF0f35D2A",
+              nonce: "0x10000000000000000",
+              callData:
+                "0x34fcd5be0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000",
+              paymaster: "0x3f222Df6aB18C1E10d0Ec136503c3B0dfd929048",
+              paymasterData:
+                "0x0000000000000000682d7e7c9fa6f71c28c31141a11ac9eb2bdbe898ddbd42a4f7085f8bb3380ba75dd9231a386e24fe5a84777217c907391e983b5b0f78a4a9d0fd1c8631dd22c10e106b461c",
+              paymasterPostOpGasLimit: "0x0",
+              paymasterVerificationGasLimit: "0x74d3",
+              maxPriorityFeePerGas: "0x60e4b0",
+              maxFeePerGas: "0x1bf52290",
+              callGasLimit: "0x2bb8",
+              verificationGasLimit: "0xc845",
+              preVerificationGas: "0x14b74",
+            },
+            chainId: "0x66eee",
+            signature: {
+              type: "ecdsa",
+              signature:
+                "0xb1a055089b1ba8387ed435f2bd0afe7ff69f22b928cdfdea1b5323c64d6af387164de3fa6febf031b544de46a84d6fb7f084b9798ddfaba820950c257139a7321b",
+            },
+          },
+        ],
+      },
+    ],
+    result: {
+      name: "Response",
+      value: {
+        preparedCallIds: [
+          "0x0000000000000000000000000000000000000000000000000000000000066eeec69e468aa6fafb5c7298c02841e76f976b433018266af39a5807bc29ea9ad392",
+        ],
+      },
+    },
+  },
+] as const;
+
+const RequestAccount = [
+  {
+    name: "wallet_requestAccount example",
+    params: [
+      {
+        name: "Request",
+        value: [
+          {
+            signerAddress: "0xa363219d7C0b8673df17529D469Db9eFF0f35D2A",
+          },
+        ],
+      },
+    ],
+    result: {
+      name: "Response",
+      value: {
+        accountAddress: "0xa363219d7C0b8673df17529D469Db9eFF0f35D2A",
+        id: "3061cc5f-1f96-48a9-ab45-41faad2dd23b",
+      },
+    },
+  },
+] as const;
+
+const CreateAccount = [
+  {
+    name: "wallet_createAccount example",
+    params: [
+      {
+        name: "Request",
+        value: [
+          {
+            signerAddress: "0xa363219d7C0b8673df17529D469Db9eFF0f35D2A",
+            creationOption: {
+              salt: "0x10",
+            },
+          },
+        ],
+      },
+    ],
+    result: {
+      name: "Response",
+      value: {
+        accountAddress: "0xa363219d7C0b8673df17529D469Db9eFF0f35D2A",
+        id: "3061cc5f-1f96-48a9-ab45-41faad2dd23b",
+      },
+    },
+  },
+] as const;
+
+const ListAccounts = [
+  {
+    name: "wallet_listAccounts example",
+    params: [
+      {
+        name: "Request",
+        value: [
+          {
+            signerAddress: "0x6275B53E98D07c729108A177207634eA22F5A748",
+          },
+        ],
+      },
+    ],
+    result: {
+      name: "Response",
+      value: {
+        accounts: [
+          {
+            accountAddress: "0xafdABa1E09e82F780721963eba39bA9e6d9FE4d2",
+            id: "3d8b3315-4aa1-4c67-8c82-20221e8dbf16",
+          },
+        ],
+        meta: {
+          totalCount: 1,
+          after: null,
+        },
+      },
+    },
+  },
+] as const;
+
+const CreateSession = [
+  {
+    name: "wallet_createSession example",
+    params: [
+      {
+        name: "Request",
+        value: [
+          {
+            account: "0xafdABa1E09e82F780721963eba39bA9e6d9FE4d2",
+            chainId: "0x01",
+            key: {
+              publicKey: "0x647bbf38CD0E116d1672405aE17a775572a84e03",
+              type: "secp256k1",
+            },
+            permissions: [
+              {
+                type: "root",
+              },
+            ],
+            expiry: 1747969653,
+          },
+        ],
+      },
+    ],
+    result: {
+      name: "Response",
+      value: {
+        sessionId: "0xcd8b2d07a6fa76f1e8a5eaa8f3a7883c",
+        signatureRequest: {
+          type: "eth_signTypedData_v4",
+          data: {
+            domain: {
+              chainId: 1,
+              verifyingContract: "0xafdABa1E09e82F780721963eba39bA9e6d9FE4d2",
+            },
+            types: {
+              DeferredAction: [
+                {
+                  name: "nonce",
+                  type: "uint256",
+                },
+                {
+                  name: "deadline",
+                  type: "uint48",
+                },
+                {
+                  name: "call",
+                  type: "bytes",
+                },
+              ],
+            },
+            primaryType: "DeferredAction",
+            message: {
+              nonce: "0x1030000000000000000",
+              deadline: 1747969653,
+              call: "0x1bbf564c00000000000099DE0BF6fA90dEB851E2A2df7d83000000010500000000000000000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000001000000000000000000000000647bbf38cd0e116d1672405ae17a775572a84e0300000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000007900000000000082B8e2012be914dFA4f62A0573eA0000000101000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000682fe675000000000000000000000000000000000000000000000000000000000000000000000000000000",
+            },
+          },
+        },
+      },
+    },
+  },
+] as const;
+
+const GetCallsStatus = [
+  {
+    name: "wallet_getCallsStatus example",
+    params: [
+      {
+        name: "Request",
+        value: [
+          "0x0000000000000000000000000000000000000000000000000000000000066eee1057eff9529142aa3b74adcaacfce5b99a09d80c9f2e38e35ea1f27535e61477",
+        ],
+      },
+    ],
+    result: {
+      name: "Response",
+      value: {
+        id: "0x0000000000000000000000000000000000000000000000000000000000066eee1057eff9529142aa3b74adcaacfce5b99a09d80c9f2e38e35ea1f27535e61477",
+        chainId: "0x66eee",
+        atomic: true,
+        status: 200,
+        receipts: [
+          {
+            status: "0x1",
+            blockHash:
+              "0x7c6f2f548c0ad4434dfb64f49a810bc795dadcd4cbec948bf8d4ae81a10fed5e",
+            blockNumber: "0x8ba5f79",
+            gasUsed: "0x33c65",
+            transactionHash:
+              "0x8ec28074a461102e4dbe43cb4aa9fed3e8c1274f1f1b0d5f6a0919ce7e20f517",
+            logs: [
+              {
+                address: "0x00000000000017c61b5bee81050ec8efc9c6fecd",
+                data: "0x0000000000000000000000000000000000000000000000000000000000000000",
+                topics: [
+                  "0xd32049610f0cd3babd266cf338d726cc8c34c8ff97356c0f33c13fa59962ac92",
+                  "0x000000000000000000000000f13223cca0ae9786dd91dffe1f4e834c71ccdc2d",
+                  "0x0000000000000000000000003f3503e682bf27330f9e5065043d47207e609e7d",
+                ],
+              },
+              {
+                address: "0x0000000071727de22e5e9d8baf0edac6f37da032",
+                data: "0x00000000000000000000000000000000000017c61b5bee81050ec8efc9c6fecd0000000000000000000000002cc0c7981d846b9f2a16276556f6e8cb52bfb633",
+                topics: [
+                  "0xd51a9c61267aa6196961883ecf5ff2da6619c37dac0fa92122513fb32c032d2d",
+                  "0x1057eff9529142aa3b74adcaacfce5b99a09d80c9f2e38e35ea1f27535e61477",
+                  "0x000000000000000000000000f13223cca0ae9786dd91dffe1f4e834c71ccdc2d",
+                ],
+              },
+              {
+                address: "0x0000000071727de22e5e9d8baf0edac6f37da032",
+                data: "0x",
+                topics: [
+                  "0xbb47ee3e183a558b1a2ff0874b079f3fc5478b7454eacf2bfc5af2ff5878f972",
+                ],
+              },
+              {
+                address: "0x0000000071727de22e5e9d8baf0edac6f37da032",
+                data: "0x00000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000014ba6c2cd4f0000000000000000000000000000000000000000000000000000000000003451d",
+                topics: [
+                  "0x49628fd1471006c1482da88028e9ce4dbb080b815c9b0344d39e5a8e6ec1419f",
+                  "0x1057eff9529142aa3b74adcaacfce5b99a09d80c9f2e38e35ea1f27535e61477",
+                  "0x000000000000000000000000f13223cca0ae9786dd91dffe1f4e834c71ccdc2d",
+                  "0x0000000000000000000000002cc0c7981d846b9f2a16276556f6e8cb52bfb633",
+                ],
+              },
+            ],
+          },
+        ],
+      },
+    },
+  },
+] as const;
+
+type Example = readonly [
+  {
+    name: string;
+    params: readonly [
+      {
+        name: "Request";
+        value: readonly [unknown];
+      },
+    ];
+    result: {
+      name: "Response";
+      value: unknown;
+    };
+  },
+];
+
+export const Examples = {
+  PrepareCalls,
+  SendPreparedCalls,
+  RequestAccount,
+  CreateAccount,
+  ListAccounts,
+  CreateSession,
+  GetCallsStatus,
+} satisfies Record<string, Example>;

package/src/rpc/request.ts

@@ -3,11 +3,13 @@ import { Capabilities } from "../capabilities/index.js";
 import {
   PermissionsContext,
   PermissionsData,
+  RemotePermission,
 } from "../capabilities/permissions/index.js";
 import {
   TypeAddress,
   TypeBase64UrlEncodedString,
   TypeCreationOptions,
+  TypeEip7702AuthExtendedFields,
   TypeHex,
   TypeSerializedInitcode,
   TypeSignatureRequest,
@@ -15,6 +17,7 @@ import {
   TypeUserOperationRequest_v7,
   TypeUuid,
 } from "../schemas.js";
+import { Examples } from "./examples.js";
 
 export const wallet_sendPreparedCalls = Type.Object(
   {
@@ -23,16 +26,24 @@ export const wallet_sendPreparedCalls = Type.Object(
       params: Type.Tuple([
         Type.Object({
           type: Type.Union([
-            Type.Literal("user-operation-v060"),
-            Type.Literal("user-operation-v070"),
+            Type.Literal("user-operation-v060", {
+              title: "User Operation (Entrypoint v0.6.0)",
+            }),
+            Type.Literal("user-operation-v070", {
+              title: "User Operation (Entrypoint v0.7.0)",
+            }),
           ]),
           data: Type.Union([
-            Type.Omit(TypeUserOperationRequest_v6, ["signature"]),
-            Type.Omit(TypeUserOperationRequest_v7, ["signature"]),
+            Type.Omit(TypeUserOperationRequest_v6, ["signature"], {
+              title: "Unsigned User Operation (Entrypoint v0.6.0)",
+            }),
+            Type.Omit(TypeUserOperationRequest_v7, ["signature"], {
+              title: "Unsigned User Operation (Entrypoint v0.7.0)",
+            }),
           ]),
           chainId: TypeHex(),
           signature: Type.Object({
-            type: Type.Transform(Type.String())
+            type: Type.Transform(Type.Literal("ecdsa"))
               .Decode((value) => {
                 if (value.toLowerCase() !== "ecdsa") {
                   throw new Error("Invalid signature type, must be 'ecdsa'");
@@ -43,8 +54,13 @@ export const wallet_sendPreparedCalls = Type.Object(
               .Encode((value) => value),
             signature: TypeHex(),
           }),
+          signedAuthorization: Type.Optional(TypeEip7702AuthExtendedFields),
           capabilities: Type.Optional(
-            Type.Object({ permissions: PermissionsContext }),
+            Type.Object({
+              permissions: Type.Optional(
+                Type.Union([PermissionsContext, RemotePermission]),
+              ),
+            }),
           ),
         }),
       ]),
@@ -56,6 +72,7 @@ export const wallet_sendPreparedCalls = Type.Object(
   {
     description:
       "This method is used after signing the signatureRequest returned from prepareCalls to submit a user operation",
+    examples: Examples.SendPreparedCalls,
   },
 );
 
@@ -80,12 +97,20 @@ export const wallet_prepareCalls = Type.Object(
     }),
     ReturnType: Type.Object({
       type: Type.Union([
-        Type.Literal("user-operation-v060"),
-        Type.Literal("user-operation-v070"),
+        Type.Literal("user-operation-v060", {
+          title: "User Operation (Entrypoint v0.6.0)",
+        }),
+        Type.Literal("user-operation-v070", {
+          title: "User Operation (Entrypoint v0.7.0)",
+        }),
       ]),
       data: Type.Union([
-        Type.Omit(TypeUserOperationRequest_v6, ["signature"]),
-        Type.Omit(TypeUserOperationRequest_v7, ["signature"]),
+        Type.Omit(TypeUserOperationRequest_v6, ["signature"], {
+          title: "Unsigned User Operation (Entrypoint v0.6.0)",
+        }),
+        Type.Omit(TypeUserOperationRequest_v7, ["signature"], {
+          title: "Unsigned User Operation (Entrypoint v0.7.0)",
+        }),
       ]),
       chainId: TypeHex(),
       signatureRequest: TypeSignatureRequest,
@@ -94,6 +119,7 @@ export const wallet_prepareCalls = Type.Object(
   {
     description:
       "This method is used to prepare a user operation for submission. It will return a built user operation and a signature request which needs to be signed by the user before submitting to wallet_sendPreparedCalls",
+    examples: Examples.PrepareCalls,
   },
 );
 
@@ -103,20 +129,30 @@ export const wallet_requestAccount = Type.Object(
       method: Type.Literal("wallet_requestAccount"),
       params: Type.Tuple([
         Type.Union([
-          Type.Object({
-            signerAddress: TypeAddress,
-            id: Type.Optional(TypeUuid),
-            creationHint: TypeCreationOptions,
-            includeCounterfactualInfo: Type.Optional(
-              Type.Boolean({ default: false }),
-            ),
-          }),
-          Type.Object({
-            accountAddress: TypeAddress,
-            includeCounterfactualInfo: Type.Optional(
-              Type.Boolean({ default: false }),
-            ),
-          }),
+          Type.Object(
+            {
+              signerAddress: TypeAddress,
+              id: Type.Optional(TypeUuid),
+              creationHint: TypeCreationOptions,
+              includeCounterfactualInfo: Type.Optional(
+                Type.Boolean({ default: false }),
+              ),
+            },
+            {
+              title: "Using signer address",
+            },
+          ),
+          Type.Object(
+            {
+              accountAddress: TypeAddress,
+              includeCounterfactualInfo: Type.Optional(
+                Type.Boolean({ default: false }),
+              ),
+            },
+            {
+              title: "Using smart contract account address",
+            },
+          ),
         ]),
       ]),
     }),
@@ -124,10 +160,12 @@ export const wallet_requestAccount = Type.Object(
       accountAddress: TypeAddress,
       id: TypeUuid,
       counterfactualInfo: Type.Optional(TypeSerializedInitcode),
+      delegation: Type.Optional(TypeAddress),
     }),
   },
   {
     description: `This method is used to get the smart account address and relevant info for a given signer. If an account does not already exist for a given signer, this method will create one before returning the counterfactual address.`,
+    examples: Examples.RequestAccount,
   },
 );
 
@@ -150,6 +188,7 @@ export const wallet_createAccount = Type.Object(
   },
   {
     description: `This method is used to create a smart account for a given signer. This method is primarly used to import existing accounts. For most cases, you should use wallet_requestAccount instead.`,
+    examples: Examples.CreateAccount,
   },
 );
 
@@ -175,7 +214,7 @@ export const wallet_listAccounts = Type.Object(
         }),
       ),
       meta: Type.Object({
-        totalCount: Type.Number(),
+        totalCount: Type.Integer(),
         after: Type.Union([TypeBase64UrlEncodedString, Type.Null()]),
       }),
     }),
@@ -183,6 +222,7 @@ export const wallet_listAccounts = Type.Object(
   {
     description:
       "This method is used to list all smart accounts for a given signer.",
+    examples: Examples.ListAccounts,
   },
 );
 
@@ -193,7 +233,9 @@ export const wallet_createSession = Type.Object(
       params: Type.Tuple([
         Type.Intersect([
           PermissionsData,
-          Type.Object({ account: TypeAddress }),
+          Type.Object({
+            account: TypeAddress,
+          }),
         ]),
       ]),
     }),
@@ -205,6 +247,7 @@ export const wallet_createSession = Type.Object(
   {
     description:
       "This method is used to create a session for a given address with specified permissions.",
+    examples: Examples.CreateSession,
   },
 );
 
@@ -224,22 +267,27 @@ export const wallet_getCallsStatus = Type.Object(
       atomic: Type.Boolean(),
       status: Type.Union([
         Type.Literal(100, {
+          title: "Pending",
           description:
             "Batch has been received by the wallet but has not completed execution onchain",
         }),
         Type.Literal(200, {
+          title: "Confirmed",
           description:
             "Batch has been included onchain without reverts, receipts array contains info of all calls",
         }),
         Type.Literal(400, {
+          title: "Offchain Failure",
           description:
             "Batch has not been included onchain and wallet will not retry",
         }),
         Type.Literal(500, {
+          title: "Onchain Failure",
           description:
             "Batch reverted *completely* and only changes related to gas charge may have been included onchain",
         }),
         Type.Literal(600, {
+          title: "Partial Onchain Failure",
           description:
             "Batch reverted *partially* and some changes related to batch calls may have been included onchain",
         }),
@@ -269,5 +317,6 @@ export const wallet_getCallsStatus = Type.Object(
   {
     description:
       "This method is used to get the status of calls IDs returned from wallet_sendPreparedCalls.",
+    examples: Examples.GetCallsStatus,
   },
 );