@lightprotocol/zk-compression-cli 0.20.4 → 0.22.0

package/dist/commands/test-validator/index.d.ts

@@ -1,6 +1,7 @@
 import { Command } from "@oclif/core";
 declare class SetupCommand extends Command {
     static description: string;
+    static examples: string[];
     protected finally(_: Error | undefined): Promise<any>;
     static flags: {
         "skip-indexer": import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
@@ -16,6 +17,8 @@ declare class SetupCommand extends Command {
         "limit-ledger-size": import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
         "gossip-host": import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         stop: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        "geyser-config": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        "validator-args": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     };
     run(): Promise<void>;
 }

package/dist/commands/test-validator/index.js

@@ -1,8 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const initTestEnv_1 = require("../../utils/initTestEnv");
 const index_1 = require("../../utils/index");
+const path_1 = tslib_1.__importDefault(require("path"));
+const fs_1 = tslib_1.__importDefault(require("fs"));
 class SetupCommand extends core_1.Command {
     finally(_) {
         process.exit();
@@ -11,6 +14,12 @@ class SetupCommand extends core_1.Command {
         const { flags } = await this.parse(SetupCommand);
         const loader = new index_1.CustomLoader("Performing setup tasks...\n");
         loader.start();
+        if (flags["geyser-config"]) {
+            const configPath = path_1.default.resolve(flags["geyser-config"]);
+            if (!fs_1.default.existsSync(configPath)) {
+                this.error(`Geyser config file not found: ${configPath}`);
+            }
+        }
         if (flags["stop"] === true) {
             await (0, initTestEnv_1.stopTestEnv)({
                 indexer: !flags["skip-indexer"],
@@ -32,12 +41,20 @@ class SetupCommand extends core_1.Command {
                 skipSystemAccounts: flags["skip-system-accounts"],
                 proverRunMode: flags["prover-run-mode"],
                 circuits: flags["circuit"],
+                geyserConfig: flags["geyser-config"],
+                validatorArgs: flags["validator-args"],
             });
             this.log("\nSetup tasks completed successfully \x1b[32m✔\x1b[0m");
         }
     }
 }
-SetupCommand.description = "Perform setup tasks";
+SetupCommand.description = "Start a local test setup with: Solana test validator, Photon indexer, and Light prover";
+SetupCommand.examples = [
+    "$ light test-validator",
+    "$ light test-validator --skip-indexer",
+    "$ light test-validator --geyser-config ./config.json",
+    '$ light test-validator --validator-args "--limit-ledger-size 50000000"',
+];
 SetupCommand.flags = {
     "skip-indexer": core_1.Flags.boolean({
         description: "Runs a test validator without starting a new indexer.",
@@ -120,5 +137,14 @@ SetupCommand.flags = {
         required: false,
         default: false,
     }),
+    "geyser-config": core_1.Flags.string({
+        description: "Path to Geyser plugin config.",
+        required: false,
+    }),
+    "validator-args": core_1.Flags.string({
+        description: "Additional arguments to pass directly to solana-test-validator. Only use if you know what you are doing.",
+        required: false,
+        exclusive: ["geyser-config"],
+    }),
 };
 exports.default = SetupCommand;

package/dist/utils/initTestEnv.d.ts

@@ -2,7 +2,7 @@ export declare function stopTestEnv(options: {
     indexer: boolean;
     prover: boolean;
 }): Promise<void>;
-export declare function initTestEnv({ additionalPrograms, skipSystemAccounts, indexer, prover, rpcPort, indexerPort, proverPort, gossipHost, checkPhotonVersion, photonDatabaseUrl, limitLedgerSize, proverRunMode, circuits, }: {
+export declare function initTestEnv({ additionalPrograms, skipSystemAccounts, indexer, prover, rpcPort, indexerPort, proverPort, gossipHost, checkPhotonVersion, photonDatabaseUrl, limitLedgerSize, proverRunMode, circuits, geyserConfig, validatorArgs, }: {
     additionalPrograms?: {
         address: string;
         path: string;
@@ -19,8 +19,10 @@ export declare function initTestEnv({ additionalPrograms, skipSystemAccounts, in
     limitLedgerSize?: number;
     proverRunMode?: "inclusion" | "non-inclusion" | "forester" | "forester-test" | "rpc" | "full" | "full-test";
     circuits?: string[];
+    validatorArgs?: string;
+    geyserConfig?: string;
 }): Promise<void>;
-export declare function initTestEnvIfNeeded({ additionalPrograms, skipSystemAccounts, indexer, prover, }?: {
+export declare function initTestEnvIfNeeded({ additionalPrograms, skipSystemAccounts, indexer, prover, geyserConfig, validatorArgs, }?: {
     additionalPrograms?: {
         address: string;
         path: string;
@@ -28,6 +30,8 @@ export declare function initTestEnvIfNeeded({ additionalPrograms, skipSystemAcco
     skipSystemAccounts?: boolean;
     indexer?: boolean;
     prover?: boolean;
+    geyserConfig?: string;
+    validatorArgs?: string;
 }): Promise<void>;
 export declare function programsDirPath(): string;
 export declare function programFilePath(programName: string): string;
@@ -42,7 +46,7 @@ export declare function getSolanaArgs({ additionalPrograms, skipSystemAccounts,
     gossipHost?: string;
     downloadBinaries?: boolean;
 }): Promise<Array<string>>;
-export declare function startTestValidator({ additionalPrograms, skipSystemAccounts, limitLedgerSize, rpcPort, gossipHost, }: {
+export declare function startTestValidator({ additionalPrograms, skipSystemAccounts, limitLedgerSize, rpcPort, gossipHost, validatorArgs, geyserConfig, }: {
     additionalPrograms?: {
         address: string;
         path: string;
@@ -51,5 +55,7 @@ export declare function startTestValidator({ additionalPrograms, skipSystemAccou
     limitLedgerSize?: number;
     rpcPort?: number;
     gossipHost?: string;
+    validatorArgs?: string;
+    geyserConfig?: string;
 }): Promise<void>;
 export declare function killTestValidator(): Promise<void>;

package/dist/utils/initTestEnv.js

@@ -42,7 +42,7 @@ async function stopTestEnv(options) {
     await Promise.all(killPromises);
     console.log("All specified processes and validator stopped.");
 }
-async function initTestEnv({ additionalPrograms, skipSystemAccounts, indexer = true, prover = true, rpcPort = 8899, indexerPort = 8784, proverPort = 3001, gossipHost = "127.0.0.1", checkPhotonVersion = true, photonDatabaseUrl, limitLedgerSize, proverRunMode, circuits, }) {
+async function initTestEnv({ additionalPrograms, skipSystemAccounts, indexer = true, prover = true, rpcPort = 8899, indexerPort = 8784, proverPort = 3001, gossipHost = "127.0.0.1", checkPhotonVersion = true, photonDatabaseUrl, limitLedgerSize, proverRunMode, circuits, geyserConfig, validatorArgs, }) {
     // We cannot await this promise directly because it will hang the process
     startTestValidator({
         additionalPrograms,
@@ -50,6 +50,8 @@ async function initTestEnv({ additionalPrograms, skipSystemAccounts, indexer = t
         limitLedgerSize,
         rpcPort,
         gossipHost,
+        validatorArgs,
+        geyserConfig,
     });
     await (0, process_1.waitForServers)([{ port: rpcPort, path: "/health" }]);
     await (0, process_1.confirmServerStability)(`http://127.0.0.1:${rpcPort}/health`);
@@ -66,7 +68,7 @@ async function initTestEnv({ additionalPrograms, skipSystemAccounts, indexer = t
         await (0, processProverServer_1.startProver)(proverPort, proverRunMode, circuits);
     }
 }
-async function initTestEnvIfNeeded({ additionalPrograms, skipSystemAccounts, indexer = false, prover = false, } = {}) {
+async function initTestEnvIfNeeded({ additionalPrograms, skipSystemAccounts, indexer = false, prover = false, geyserConfig, validatorArgs, } = {}) {
     try {
         const anchorProvider = await (0, utils_1.setAnchorProvider)();
         // this request will fail if there is no local test validator running
@@ -80,6 +82,8 @@ async function initTestEnvIfNeeded({ additionalPrograms, skipSystemAccounts, ind
             skipSystemAccounts,
             indexer,
             prover,
+            geyserConfig,
+            validatorArgs,
         });
     }
 }
@@ -181,7 +185,7 @@ async function getSolanaArgs({ additionalPrograms, skipSystemAccounts, limitLedg
     }
     return solanaArgs;
 }
-async function startTestValidator({ additionalPrograms, skipSystemAccounts, limitLedgerSize, rpcPort, gossipHost, }) {
+async function startTestValidator({ additionalPrograms, skipSystemAccounts, limitLedgerSize, rpcPort, gossipHost, validatorArgs, geyserConfig, }) {
     const command = "solana-test-validator";
     const solanaArgs = await getSolanaArgs({
         additionalPrograms,
@@ -192,6 +196,14 @@ async function startTestValidator({ additionalPrograms, skipSystemAccounts, limi
     });
     await killTestValidator();
     await new Promise((r) => setTimeout(r, 1000));
+    // Add geyser config if provided
+    if (geyserConfig) {
+        solanaArgs.push("--geyser-plugin-config", geyserConfig);
+    }
+    // Add custom validator args last
+    if (validatorArgs) {
+        solanaArgs.push(...validatorArgs.split(" "));
+    }
     console.log("Starting test validator...");
     await (0, process_1.executeCommand)({
         command,

package/oclif.manifest.json

@@ -1,190 +1,206 @@
 {
   "commands": {
-    "approve-and-mint-to": {
+    "balance": {
       "aliases": [],
       "args": {},
       "examples": [
-        "$ light approve-and-mint-to --mint PublicKey --to PublicKey --amount 1000"
+        "$ light balance --mint=<ADDRESS> --owner=<ADDRESS>"
       ],
       "flags": {
-        "mint-authority": {
-          "description": "Specify the filepath of the mint authority keypair. Defaults to your local solana wallet.",
-          "name": "mint-authority",
-          "required": false,
+        "owner": {
+          "description": "Address of the compressed token owner.",
+          "name": "owner",
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "mint": {
-          "description": "Specify the mint address.",
+          "description": "Mint address of the compressed token account.",
           "name": "mint",
           "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
-        },
-        "to": {
-          "description": "Specify the recipient address.",
-          "name": "to",
-          "required": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "amount": {
-          "description": "Amount to mint, in tokens.",
-          "name": "amount",
-          "required": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "approve-and-mint-to",
+      "id": "balance",
       "pluginAlias": "@lightprotocol/zk-compression-cli",
       "pluginName": "@lightprotocol/zk-compression-cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Mint tokens to a compressed account via external mint authority",
+      "summary": "Get balance",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "approve-and-mint-to",
+        "balance",
         "index.js"
       ]
     },
-    "balance": {
+    "approve-and-mint-to": {
       "aliases": [],
       "args": {},
       "examples": [
-        "$ light balance --mint=<ADDRESS> --owner=<ADDRESS>"
+        "$ light approve-and-mint-to --mint PublicKey --to PublicKey --amount 1000"
       ],
       "flags": {
-        "owner": {
-          "description": "Address of the compressed token owner.",
-          "name": "owner",
-          "required": true,
+        "mint-authority": {
+          "description": "Specify the filepath of the mint authority keypair. Defaults to your local solana wallet.",
+          "name": "mint-authority",
+          "required": false,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "mint": {
-          "description": "Mint address of the compressed token account.",
+          "description": "Specify the mint address.",
           "name": "mint",
           "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "to": {
+          "description": "Specify the recipient address.",
+          "name": "to",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "amount": {
+          "description": "Amount to mint, in tokens.",
+          "name": "amount",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "balance",
+      "id": "approve-and-mint-to",
       "pluginAlias": "@lightprotocol/zk-compression-cli",
       "pluginName": "@lightprotocol/zk-compression-cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Get balance",
+      "summary": "Mint tokens to a compressed account via external mint authority",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "balance",
+        "approve-and-mint-to",
         "index.js"
       ]
     },
-    "compress-spl": {
+    "config:config": {
       "aliases": [],
       "args": {},
+      "description": "Initialize or update the configuration values. The default config path is ~/.config/light/config.json you can set up a custom path with an environment variable export LIGHT_PROTOCOL_CONFIG=path/to/config.json",
       "examples": [
-        "$ light compress-spl --mint PublicKey --to PublicKey --amount 10"
+        "$ light config --solanaRpcUrl https://solana-api.example.com"
       ],
       "flags": {
-        "mint": {
-          "description": "Specify the mint address.",
-          "name": "mint",
-          "required": true,
+        "solanaRpcUrl": {
+          "description": "Solana RPC url",
+          "name": "solanaRpcUrl",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "to": {
-          "description": "Specify the recipient address (owner of destination compressed token account).",
-          "name": "to",
-          "required": true,
+        "indexerUrl": {
+          "description": "Indexer url",
+          "name": "indexerUrl",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "amount": {
-          "description": "Amount to compress, in tokens.",
-          "name": "amount",
-          "required": true,
+        "proverUrl": {
+          "description": "Prover url",
+          "name": "proverUrl",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "get": {
+          "description": "Gets the current config values",
+          "name": "get",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "compress-spl",
+      "id": "config:config",
       "pluginAlias": "@lightprotocol/zk-compression-cli",
       "pluginName": "@lightprotocol/zk-compression-cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Compress SPL tokens.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "compress-spl",
+        "config",
         "index.js"
       ]
     },
-    "compress-sol": {
+    "config": {
       "aliases": [],
       "args": {},
+      "description": "Initialize or update the configuration values. The default config path is ~/.config/light/config.json you can set up a custom path with an environment variable export LIGHT_PROTOCOL_CONFIG=path/to/config.json",
       "examples": [
-        "$ light compress-sol --to PublicKey --amount 10"
+        "$ light config --solanaRpcUrl https://solana-api.example.com"
       ],
       "flags": {
-        "to": {
-          "description": "Specify the recipient address.",
-          "name": "to",
-          "required": true,
+        "solanaRpcUrl": {
+          "description": "Solana RPC url",
+          "name": "solanaRpcUrl",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "amount": {
-          "description": "Amount to compress, in lamports.",
-          "name": "amount",
-          "required": true,
+        "indexerUrl": {
+          "description": "Indexer url",
+          "name": "indexerUrl",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "proverUrl": {
+          "description": "Prover url",
+          "name": "proverUrl",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "get": {
+          "description": "Gets the current config values",
+          "name": "get",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "compress-sol",
+      "id": "config",
       "pluginAlias": "@lightprotocol/zk-compression-cli",
       "pluginName": "@lightprotocol/zk-compression-cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Compress SOL.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "compress-sol",
+        "config",
         "index.js"
       ]
     },
@@ -271,109 +287,93 @@
         "index.js"
       ]
     },
-    "config:config": {
+    "compress-sol": {
       "aliases": [],
       "args": {},
-      "description": "Initialize or update the configuration values. The default config path is ~/.config/light/config.json you can set up a custom path with an environment variable export LIGHT_PROTOCOL_CONFIG=path/to/config.json",
       "examples": [
-        "$ light config --solanaRpcUrl https://solana-api.example.com"
+        "$ light compress-sol --to PublicKey --amount 10"
       ],
       "flags": {
-        "solanaRpcUrl": {
-          "description": "Solana RPC url",
-          "name": "solanaRpcUrl",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "indexerUrl": {
-          "description": "Indexer url",
-          "name": "indexerUrl",
+        "to": {
+          "description": "Specify the recipient address.",
+          "name": "to",
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "proverUrl": {
-          "description": "Prover url",
-          "name": "proverUrl",
+        "amount": {
+          "description": "Amount to compress, in lamports.",
+          "name": "amount",
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
-        },
-        "get": {
-          "description": "Gets the current config values",
-          "name": "get",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:config",
+      "id": "compress-sol",
       "pluginAlias": "@lightprotocol/zk-compression-cli",
       "pluginName": "@lightprotocol/zk-compression-cli",
       "pluginType": "core",
       "strict": true,
+      "summary": "Compress SOL.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "config",
+        "compress-sol",
         "index.js"
       ]
     },
-    "config": {
+    "compress-spl": {
       "aliases": [],
       "args": {},
-      "description": "Initialize or update the configuration values. The default config path is ~/.config/light/config.json you can set up a custom path with an environment variable export LIGHT_PROTOCOL_CONFIG=path/to/config.json",
       "examples": [
-        "$ light config --solanaRpcUrl https://solana-api.example.com"
+        "$ light compress-spl --mint PublicKey --to PublicKey --amount 10"
       ],
       "flags": {
-        "solanaRpcUrl": {
-          "description": "Solana RPC url",
-          "name": "solanaRpcUrl",
+        "mint": {
+          "description": "Specify the mint address.",
+          "name": "mint",
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "indexerUrl": {
-          "description": "Indexer url",
-          "name": "indexerUrl",
+        "to": {
+          "description": "Specify the recipient address (owner of destination compressed token account).",
+          "name": "to",
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "proverUrl": {
-          "description": "Prover url",
-          "name": "proverUrl",
+        "amount": {
+          "description": "Amount to compress, in tokens.",
+          "name": "amount",
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
-        },
-        "get": {
-          "description": "Gets the current config values",
-          "name": "get",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config",
+      "id": "compress-spl",
       "pluginAlias": "@lightprotocol/zk-compression-cli",
       "pluginName": "@lightprotocol/zk-compression-cli",
       "pluginType": "core",
       "strict": true,
+      "summary": "Compress SPL tokens.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "config",
+        "compress-spl",
         "index.js"
       ]
     },
@@ -662,7 +662,13 @@
     "test-validator": {
       "aliases": [],
       "args": {},
-      "description": "Perform setup tasks",
+      "description": "Start a local test setup with: Solana test validator, Photon indexer, and Light prover",
+      "examples": [
+        "$ light test-validator",
+        "$ light test-validator --skip-indexer",
+        "$ light test-validator --geyser-config ./config.json",
+        "$ light test-validator --validator-args \"--limit-ledger-size 50000000\""
+      ],
       "flags": {
         "skip-indexer": {
           "description": "Runs a test validator without starting a new indexer.",
@@ -797,6 +803,25 @@
           "required": false,
           "allowNo": false,
           "type": "boolean"
+        },
+        "geyser-config": {
+          "description": "Path to Geyser plugin config.",
+          "name": "geyser-config",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "validator-args": {
+          "description": "Additional arguments to pass directly to solana-test-validator. Only use if you know what you are doing.",
+          "exclusive": [
+            "geyser-config"
+          ],
+          "name": "validator-args",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -873,5 +898,5 @@
       ]
     }
   },
-  "version": "0.20.4"
+  "version": "0.22.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightprotocol/zk-compression-cli",
-  "version": "0.20.4",
+  "version": "0.22.0",
   "description": "ZK Compression: Secure Scaling on Solana",
   "maintainers": [
     {
@@ -41,7 +41,7 @@
     "@oclif/plugin-not-found": "^3.1.2",
     "@oclif/plugin-plugins": "^5.0.7",
     "@solana-developers/helpers": "^1.5.1",
-    "@solana/web3.js": "^1.95.3",
+    "@solana/web3.js": "1.95.3",
     "axios": "^1.6.8",
     "case-anything": "^2.1.13",
     "cli-progress": "^3.12.0",
@@ -55,9 +55,9 @@
     "tweetnacl": "^1.0.3",
     "wait-on": "^7.2.0",
     "which": "^4.0.0",
-    "@lightprotocol/compressed-token": "0.15.4",
+    "@lightprotocol/compressed-token": "0.16.0",
     "@lightprotocol/hasher.rs": "0.2.0",
-    "@lightprotocol/stateless.js": "0.15.4"
+    "@lightprotocol/stateless.js": "0.16.0"
   },
   "devDependencies": {
     "@oclif/test": "2.3.9",