@account-kit/plugingen 4.0.0-alpha.0

package/src/IPlugin.ts

@@ -0,0 +1,396 @@
+export const IPluginAbi = [
+  {
+    type: "function",
+    name: "onInstall",
+    inputs: [{ name: "data", type: "bytes", internalType: "bytes" }],
+    outputs: [],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "function",
+    name: "onUninstall",
+    inputs: [{ name: "data", type: "bytes", internalType: "bytes" }],
+    outputs: [],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "function",
+    name: "pluginManifest",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "tuple",
+        internalType: "struct PluginManifest",
+        components: [
+          { name: "interfaceIds", type: "bytes4[]", internalType: "bytes4[]" },
+          {
+            name: "dependencyInterfaceIds",
+            type: "bytes4[]",
+            internalType: "bytes4[]",
+          },
+          {
+            name: "executionFunctions",
+            type: "bytes4[]",
+            internalType: "bytes4[]",
+          },
+          {
+            name: "permittedExecutionSelectors",
+            type: "bytes4[]",
+            internalType: "bytes4[]",
+          },
+          {
+            name: "permitAnyExternalAddress",
+            type: "bool",
+            internalType: "bool",
+          },
+          { name: "canSpendNativeToken", type: "bool", internalType: "bool" },
+          {
+            name: "permittedExternalCalls",
+            type: "tuple[]",
+            internalType: "struct ManifestExternalCallPermission[]",
+            components: [
+              {
+                name: "externalAddress",
+                type: "address",
+                internalType: "address",
+              },
+              { name: "permitAnySelector", type: "bool", internalType: "bool" },
+              { name: "selectors", type: "bytes4[]", internalType: "bytes4[]" },
+            ],
+          },
+          {
+            name: "userOpValidationFunctions",
+            type: "tuple[]",
+            internalType: "struct ManifestAssociatedFunction[]",
+            components: [
+              {
+                name: "executionSelector",
+                type: "bytes4",
+                internalType: "bytes4",
+              },
+              {
+                name: "associatedFunction",
+                type: "tuple",
+                internalType: "struct ManifestFunction",
+                components: [
+                  {
+                    name: "functionType",
+                    type: "uint8",
+                    internalType: "enum ManifestAssociatedFunctionType",
+                  },
+                  { name: "functionId", type: "uint8", internalType: "uint8" },
+                  {
+                    name: "dependencyIndex",
+                    type: "uint256",
+                    internalType: "uint256",
+                  },
+                ],
+              },
+            ],
+          },
+          {
+            name: "runtimeValidationFunctions",
+            type: "tuple[]",
+            internalType: "struct ManifestAssociatedFunction[]",
+            components: [
+              {
+                name: "executionSelector",
+                type: "bytes4",
+                internalType: "bytes4",
+              },
+              {
+                name: "associatedFunction",
+                type: "tuple",
+                internalType: "struct ManifestFunction",
+                components: [
+                  {
+                    name: "functionType",
+                    type: "uint8",
+                    internalType: "enum ManifestAssociatedFunctionType",
+                  },
+                  { name: "functionId", type: "uint8", internalType: "uint8" },
+                  {
+                    name: "dependencyIndex",
+                    type: "uint256",
+                    internalType: "uint256",
+                  },
+                ],
+              },
+            ],
+          },
+          {
+            name: "preUserOpValidationHooks",
+            type: "tuple[]",
+            internalType: "struct ManifestAssociatedFunction[]",
+            components: [
+              {
+                name: "executionSelector",
+                type: "bytes4",
+                internalType: "bytes4",
+              },
+              {
+                name: "associatedFunction",
+                type: "tuple",
+                internalType: "struct ManifestFunction",
+                components: [
+                  {
+                    name: "functionType",
+                    type: "uint8",
+                    internalType: "enum ManifestAssociatedFunctionType",
+                  },
+                  { name: "functionId", type: "uint8", internalType: "uint8" },
+                  {
+                    name: "dependencyIndex",
+                    type: "uint256",
+                    internalType: "uint256",
+                  },
+                ],
+              },
+            ],
+          },
+          {
+            name: "preRuntimeValidationHooks",
+            type: "tuple[]",
+            internalType: "struct ManifestAssociatedFunction[]",
+            components: [
+              {
+                name: "executionSelector",
+                type: "bytes4",
+                internalType: "bytes4",
+              },
+              {
+                name: "associatedFunction",
+                type: "tuple",
+                internalType: "struct ManifestFunction",
+                components: [
+                  {
+                    name: "functionType",
+                    type: "uint8",
+                    internalType: "enum ManifestAssociatedFunctionType",
+                  },
+                  { name: "functionId", type: "uint8", internalType: "uint8" },
+                  {
+                    name: "dependencyIndex",
+                    type: "uint256",
+                    internalType: "uint256",
+                  },
+                ],
+              },
+            ],
+          },
+          {
+            name: "executionHooks",
+            type: "tuple[]",
+            internalType: "struct ManifestExecutionHook[]",
+            components: [
+              {
+                name: "executionSelector",
+                type: "bytes4",
+                internalType: "bytes4",
+              },
+              {
+                name: "preExecHook",
+                type: "tuple",
+                internalType: "struct ManifestFunction",
+                components: [
+                  {
+                    name: "functionType",
+                    type: "uint8",
+                    internalType: "enum ManifestAssociatedFunctionType",
+                  },
+                  { name: "functionId", type: "uint8", internalType: "uint8" },
+                  {
+                    name: "dependencyIndex",
+                    type: "uint256",
+                    internalType: "uint256",
+                  },
+                ],
+              },
+              {
+                name: "postExecHook",
+                type: "tuple",
+                internalType: "struct ManifestFunction",
+                components: [
+                  {
+                    name: "functionType",
+                    type: "uint8",
+                    internalType: "enum ManifestAssociatedFunctionType",
+                  },
+                  { name: "functionId", type: "uint8", internalType: "uint8" },
+                  {
+                    name: "dependencyIndex",
+                    type: "uint256",
+                    internalType: "uint256",
+                  },
+                ],
+              },
+            ],
+          },
+        ],
+      },
+    ],
+    stateMutability: "pure",
+  },
+  {
+    type: "function",
+    name: "pluginMetadata",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "tuple",
+        internalType: "struct PluginMetadata",
+        components: [
+          { name: "name", type: "string", internalType: "string" },
+          { name: "version", type: "string", internalType: "string" },
+          { name: "author", type: "string", internalType: "string" },
+          {
+            name: "permissionDescriptors",
+            type: "tuple[]",
+            internalType: "struct SelectorPermission[]",
+            components: [
+              {
+                name: "functionSelector",
+                type: "bytes4",
+                internalType: "bytes4",
+              },
+              {
+                name: "permissionDescription",
+                type: "string",
+                internalType: "string",
+              },
+            ],
+          },
+        ],
+      },
+    ],
+    stateMutability: "pure",
+  },
+  {
+    type: "function",
+    name: "postExecutionHook",
+    inputs: [
+      { name: "functionId", type: "uint8", internalType: "uint8" },
+      { name: "preExecHookData", type: "bytes", internalType: "bytes" },
+    ],
+    outputs: [],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "function",
+    name: "preExecutionHook",
+    inputs: [
+      { name: "functionId", type: "uint8", internalType: "uint8" },
+      { name: "sender", type: "address", internalType: "address" },
+      { name: "value", type: "uint256", internalType: "uint256" },
+      { name: "data", type: "bytes", internalType: "bytes" },
+    ],
+    outputs: [{ name: "", type: "bytes", internalType: "bytes" }],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "function",
+    name: "preRuntimeValidationHook",
+    inputs: [
+      { name: "functionId", type: "uint8", internalType: "uint8" },
+      { name: "sender", type: "address", internalType: "address" },
+      { name: "value", type: "uint256", internalType: "uint256" },
+      { name: "data", type: "bytes", internalType: "bytes" },
+    ],
+    outputs: [],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "function",
+    name: "preUserOpValidationHook",
+    inputs: [
+      { name: "functionId", type: "uint8", internalType: "uint8" },
+      {
+        name: "userOp",
+        type: "tuple",
+        internalType: "struct UserOperation",
+        components: [
+          { name: "sender", type: "address", internalType: "address" },
+          { name: "nonce", type: "uint256", internalType: "uint256" },
+          { name: "initCode", type: "bytes", internalType: "bytes" },
+          { name: "callData", type: "bytes", internalType: "bytes" },
+          { name: "callGasLimit", type: "uint256", internalType: "uint256" },
+          {
+            name: "verificationGasLimit",
+            type: "uint256",
+            internalType: "uint256",
+          },
+          {
+            name: "preVerificationGas",
+            type: "uint256",
+            internalType: "uint256",
+          },
+          { name: "maxFeePerGas", type: "uint256", internalType: "uint256" },
+          {
+            name: "maxPriorityFeePerGas",
+            type: "uint256",
+            internalType: "uint256",
+          },
+          { name: "paymasterAndData", type: "bytes", internalType: "bytes" },
+          { name: "signature", type: "bytes", internalType: "bytes" },
+        ],
+      },
+      { name: "userOpHash", type: "bytes32", internalType: "bytes32" },
+    ],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "function",
+    name: "runtimeValidationFunction",
+    inputs: [
+      { name: "functionId", type: "uint8", internalType: "uint8" },
+      { name: "sender", type: "address", internalType: "address" },
+      { name: "value", type: "uint256", internalType: "uint256" },
+      { name: "data", type: "bytes", internalType: "bytes" },
+    ],
+    outputs: [],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "function",
+    name: "userOpValidationFunction",
+    inputs: [
+      { name: "functionId", type: "uint8", internalType: "uint8" },
+      {
+        name: "userOp",
+        type: "tuple",
+        internalType: "struct UserOperation",
+        components: [
+          { name: "sender", type: "address", internalType: "address" },
+          { name: "nonce", type: "uint256", internalType: "uint256" },
+          { name: "initCode", type: "bytes", internalType: "bytes" },
+          { name: "callData", type: "bytes", internalType: "bytes" },
+          { name: "callGasLimit", type: "uint256", internalType: "uint256" },
+          {
+            name: "verificationGasLimit",
+            type: "uint256",
+            internalType: "uint256",
+          },
+          {
+            name: "preVerificationGas",
+            type: "uint256",
+            internalType: "uint256",
+          },
+          { name: "maxFeePerGas", type: "uint256", internalType: "uint256" },
+          {
+            name: "maxPriorityFeePerGas",
+            type: "uint256",
+            internalType: "uint256",
+          },
+          { name: "paymasterAndData", type: "bytes", internalType: "bytes" },
+          { name: "signature", type: "bytes", internalType: "bytes" },
+        ],
+      },
+      { name: "userOpHash", type: "bytes32", internalType: "bytes32" },
+    ],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "nonpayable",
+  },
+] as const;

package/src/cli.ts

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+import { cac } from "cac";
+import { generate, type GenerateOptions } from "./commands/generate/index.js";
+import { init, type InitOptions } from "./commands/init.js";
+import * as logger from "./logger.js";
+import { VERSION } from "./version.js";
+
+const cli = cac("plugingen");
+
+cli
+  .command("init", "Initialize a new plugingen config")
+  .option("-c, --config <path>", "[string] path to config file")
+  .option("-r, --root <path>", "[string] root path to resolve config from")
+  .example((name) => `${name} init`)
+  .action(async (options: InitOptions) => init(options));
+
+cli
+  .command(
+    "generate",
+    "Generate code for all of the plugins configured within the plugingen config"
+  )
+  .option("-c, --config <path>", "[string] path to config file")
+  .option("-r, --root <path>", "[string] root path to resolve config from")
+  .example((name) => `${name} generate`)
+  .action(async (options: GenerateOptions) => generate(options));
+
+cli.help();
+cli.version(VERSION);
+
+void (async () => {
+  try {
+    // Parse CLI args without running command
+    cli.parse(process.argv, { run: false });
+    if (!cli.matchedCommand) {
+      if (cli.args.length === 0) {
+        if (!cli.options.help && !cli.options.version) cli.outputHelp();
+      } else throw new Error(`Unknown command: ${cli.args.join(" ")}`);
+    }
+    await cli.runMatchedCommand();
+  } catch (error) {
+    logger.error(`\n${(error as Error).message}`);
+    process.exit(1);
+  }
+})();