@lightprotocol/zk-compression-cli 0.4.1 → 0.4.3

package/README.md

@@ -88,6 +88,35 @@ solana balance
 
 Now you're all set up to run CLI commands :)
 
+#### Using ZK Testnet
+
+By default, the CLI interacts with localnet. You can view the current config by running:
+
+```bash
+light config --get
+```
+
+To switch to ZK Testnet, run:
+
+```bash
+  light config --indexerUrl "https://zk-testnet.helius.dev:8784" \
+    --proverUrl "https://zk-testnet.helius.dev:3001" \
+    --solanaRpcUrl "https://zk-testnet.helius.dev:8899"
+```
+
+Also adjust your solana config:
+
+```bash
+# Set config
+solana config set --url "https://zk-testnet.helius.dev:8899"
+
+# Airdrop 1 SOL
+solana airdrop 1
+
+# Print your address
+solana address
+```
+
 ### Commands
 
 #### Create a compressed token mint

package/dist/utils/processPhotonIndexer.js

@@ -12,7 +12,7 @@ async function startIndexer(rpcUrl, indexerPort, checkPhotonVersion = true, phot
     const resolvedOrNull = which_1.default.sync("photon", { nothrow: true });
     if (resolvedOrNull === null ||
         (checkPhotonVersion && !(await isExpectedPhotonVersion(constants_1.PHOTON_VERSION)))) {
-        const message = `Photon indexer not found. Please install it by running "cargo install photon-indexer --version ${constants_1.PHOTON_VERSION}"`;
+        const message = `Photon indexer not found. Please install it by running "cargo install photon-indexer --version ${constants_1.PHOTON_VERSION} --locked"`;
         console.log(message);
         throw new Error(message);
     }

package/oclif.manifest.json

@@ -98,25 +98,34 @@
         "index.js"
       ]
     },
-    "compress-sol": {
+    "create-mint": {
       "aliases": [],
       "args": {},
       "examples": [
-        "$ light compress-sol --to PublicKey --amount 10"
+        "$ light create-mint --mint-decimals 5"
       ],
       "flags": {
-        "to": {
-          "description": "Specify the recipient address.",
-          "name": "to",
-          "required": true,
+        "mint-keypair": {
+          "description": "Provide a path to a mint keypair file. Defaults to a random keypair",
+          "name": "mint-keypair",
+          "required": false,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "amount": {
-          "description": "Amount to compress, in lamports.",
-          "name": "amount",
-          "required": true,
+        "mint-authority": {
+          "description": "Address of the mint authority. Defaults to the fee payer",
+          "name": "mint-authority",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "mint-decimals": {
+          "description": "Number of base 10 digits to the right of the decimal place [default: 9]",
+          "name": "mint-decimals",
+          "required": false,
+          "default": 9,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -124,117 +133,124 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "compress-sol",
+      "id": "create-mint",
       "pluginAlias": "@lightprotocol/zk-compression-cli",
       "pluginName": "@lightprotocol/zk-compression-cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Compress SOL.",
+      "summary": "Create a new compressed token mint",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "compress-sol",
+        "create-mint",
         "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"
       ]
     },
-    "create-mint": {
+    "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 create-mint --mint-decimals 5"
+        "$ light config --solanaRpcUrl https://solana-api.example.com"
       ],
       "flags": {
-        "mint-keypair": {
-          "description": "Provide a path to a mint keypair file. Defaults to a random keypair",
-          "name": "mint-keypair",
-          "required": false,
+        "solanaRpcUrl": {
+          "description": "Solana RPC url",
+          "name": "solanaRpcUrl",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "mint-authority": {
-          "description": "Address of the mint authority. Defaults to the fee payer",
-          "name": "mint-authority",
-          "required": false,
+        "indexerUrl": {
+          "description": "Indexer url",
+          "name": "indexerUrl",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "mint-decimals": {
-          "description": "Number of base 10 digits to the right of the decimal place [default: 9]",
-          "name": "mint-decimals",
-          "required": false,
-          "default": 9,
+        "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": "create-mint",
+      "id": "config",
       "pluginAlias": "@lightprotocol/zk-compression-cli",
       "pluginName": "@lightprotocol/zk-compression-cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Create a new compressed token mint",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "create-mint",
+        "config",
         "index.js"
       ]
     },
@@ -279,109 +295,93 @@
         "index.js"
       ]
     },
-    "config: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: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"
       ]
     },
-    "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",
+      "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"
       ]
     },
@@ -762,5 +762,5 @@
       ]
     }
   },
-  "version": "0.4.1"
+  "version": "0.4.3"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightprotocol/zk-compression-cli",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "ZK Compression: Secure Scaling on Solana",
   "maintainers": [
     {
@@ -44,9 +44,9 @@
     "tweetnacl": "^1.0.3",
     "wait-on": "^7.2.0",
     "which": "^4.0.0",
-    "@lightprotocol/compressed-token": "0.3.0",
-    "@lightprotocol/stateless.js": "0.4.0",
-    "@lightprotocol/hasher.rs": "0.2.0"
+    "@lightprotocol/compressed-token": "0.3.1",
+    "@lightprotocol/hasher.rs": "0.2.0",
+    "@lightprotocol/stateless.js": "0.4.1"
   },
   "devDependencies": {
     "@oclif/test": "2.3.9",