polkadot-cli 0.8.0 → 0.9.0

package/README.md

@@ -94,19 +94,37 @@ dot query System.Account 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY
 # All map entries (default limit: 100)
 dot query System.Account --limit 10
 
-# Pipe to jq (colors disabled automatically)
+# Pipe to jq — stdout is clean JSON, no extra text
 dot query System.Account --limit 5 | jq '.[0].value.data.free'
+dot query System.Number --output json | jq '.+1'
 
 # Query a specific chain using chain prefix
 dot query kusama.System.Account 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY
 ```
 
+#### Output formatting
+
+Query results automatically convert on-chain types for readability:
+
+- **BigInt** values (e.g. balances) render as decimal strings
+- **Binary** fields (e.g. token `name`, `symbol`) render as text when valid UTF-8, or as `0x`-prefixed hex otherwise
+- **Uint8Array** values render as `0x`-prefixed hex
+
+```bash
+# Token metadata — symbol and name display as text, not {}
+dot query assethub-paseo.Assets.Metadata 50000413
+# { "deposit": "6693666000", "name": "Paseo Token", "symbol": "PAS", ... }
+```
+
 ### Look up constants
 
 ```bash
 dot const Balances.ExistentialDeposit
 dot const System.SS58Prefix --chain kusama
 dot const kusama.Balances.ExistentialDeposit
+
+# Pipe to jq — stdout is clean JSON, no extra text
+dot const Balances.ExistentialDeposit --output json | jq
 ```
 
 ### Inspect metadata
@@ -149,6 +167,27 @@ dot tx 0x0503008eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48
 dot tx Utility.batchAll '[{"type":"Balances","value":{"type":"transfer_keep_alive","value":{"dest":"5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty","value":1000000000000}}},{"type":"Balances","value":{"type":"transfer_keep_alive","value":{"dest":"5FLSigC9HGRKVhB9FiEo4Y3koPsNmBmLJbpXg2mp1hXcS59Y","value":2000000000000}}}]' --from alice
 ```
 
+#### Enum shorthand
+
+Enum arguments accept a concise `Variant(value)` syntax instead of verbose JSON:
+
+```bash
+# Instead of: '{"type":"system","value":{"type":"Authorized"}}'
+dot tx Utility.dispatch_as 'system(Authorized)' $(dot tx System.remark 0xcafe --encode) --from alice
+
+# Nested enums work too
+dot tx Utility.dispatch_as 'system(Signed(5FHneW46...))' <call> --from alice
+
+# Void variants — empty parens or just the name
+dot tx ... 'Root()' ...
+dot tx ... 'Root' ...
+
+# JSON inside parens for struct values
+dot tx ... 'AccountId32({"id":"0xd435..."})' ...
+```
+
+Variant matching is case-insensitive (`system` resolves to `system`, `authorized` to `Authorized`). All existing formats (JSON objects, hex, SS58 addresses) continue to work unchanged.
+
 #### Encode call data
 
 Encode a call to hex without signing or submitting. Useful for preparing calls to pass to `Sudo.sudo`, multisig proposals, or governance. Works offline from cached metadata and does not require `--from`.

package/dist/cli.mjs

@@ -5,7 +5,7 @@ var __require = /* @__PURE__ */ createRequire(import.meta.url);
 // src/cli.ts
 import cac from "cac";
 // package.json
-var version = "0.8.0";
+var version = "0.9.0";
 
 // src/config/accounts-store.ts
 import { access as access2, mkdir as mkdir2, readFile as readFile2, writeFile as writeFile2 } from "node:fs/promises";
@@ -212,6 +212,7 @@ async function resolveAccountSigner(name) {
 }
 
 // src/core/output.ts
+import { Binary } from "polkadot-api";
 var isTTY = process.stdout.isTTY ?? false;
 var RESET = isTTY ? "\x1B[0m" : "";
 var CYAN = isTTY ? "\x1B[36m" : "";
@@ -224,6 +225,10 @@ var BOLD = isTTY ? "\x1B[1m" : "";
 function replacer(_key, value) {
   if (typeof value === "bigint")
     return value.toString();
+  if (value instanceof Binary) {
+    const text = value.asText();
+    return text.includes("�") ? value.asHex() : text;
+  }
   if (value instanceof Uint8Array)
     return `0x${Buffer.from(value).toString("hex")}`;
   return value;
@@ -932,12 +937,6 @@ function registerConstCommand(cli) {
       const runtimeToken = await unsafeApi.runtimeToken;
       const result = unsafeApi.constants[palletInfo.name][constantItem.name](runtimeToken);
       const format = opts.output ?? "pretty";
-      if (format === "json") {
-        console.error(`chain: ${chainName}`);
-      } else {
-        console.log(`${DIM}chain: ${chainName}${RESET}
-`);
-      }
       printResult(result, format);
     } finally {
       clientHandle.destroy();
@@ -1207,7 +1206,7 @@ function parseValue(arg) {
 
 // src/commands/tx.ts
 import { getViewBuilder } from "@polkadot-api/view-builder";
-import { Binary } from "polkadot-api";
+import { Binary as Binary2 } from "polkadot-api";
 
 // src/core/explorers.ts
 var pjsAppsLink = (rpc, hash) => `https://polkadot.js.org/apps/?rpc=${encodeURIComponent(rpc)}#/explorer/query/${hash}`;
@@ -1279,8 +1278,8 @@ function normalizeValue(lookup, entry, value) {
       }
       if (innerResolved.type === "primitive" && innerResolved.value === "u8" && typeof value === "string") {
         if (/^0x[0-9a-fA-F]*$/.test(value))
-          return Binary.fromHex(value);
-        return Binary.fromText(value);
+          return Binary2.fromHex(value);
+        return Binary2.fromText(value);
       }
       if (Array.isArray(value)) {
         const innerEntry = resolved.value;
@@ -1335,7 +1334,20 @@ function normalizeValue(lookup, entry, value) {
       return value;
   }
 }
+function parseEnumShorthand(arg) {
+  if (arg.startsWith("{") || arg.startsWith("[") || arg.startsWith("0x"))
+    return null;
+  const firstParen = arg.indexOf("(");
+  if (firstParen === -1 || !arg.endsWith(")"))
+    return null;
+  const variant = arg.slice(0, firstParen);
+  if (!/^[a-zA-Z_]\w*$/.test(variant))
+    return null;
+  return { variant, inner: arg.slice(firstParen + 1, -1) };
+}
 function parseTypedArg(meta, entry, arg) {
+  if (entry.type === "lookupEntry")
+    return parseTypedArg(meta, entry.value, arg);
   switch (entry.type) {
     case "primitive":
       return parsePrimitive(entry.value, arg);
@@ -1353,7 +1365,7 @@ function parseTypedArg(meta, entry, arg) {
     case "enum": {
       if (/^0x[0-9a-fA-F]+$/.test(arg) && meta.lookup.call != null && entry.id === meta.lookup.call) {
         const callCodec = meta.builder.buildDefinition(meta.lookup.call);
-        return callCodec.dec(Binary.fromHex(arg).asBytes());
+        return callCodec.dec(Binary2.fromHex(arg).asBytes());
       }
       if (arg.startsWith("{")) {
         try {
@@ -1361,6 +1373,19 @@ function parseTypedArg(meta, entry, arg) {
         } catch {}
       }
       const variants = Object.keys(entry.value);
+      const shorthand = parseEnumShorthand(arg);
+      if (shorthand) {
+        const matched2 = variants.find((v) => v.toLowerCase() === shorthand.variant.toLowerCase());
+        if (matched2) {
+          const variantDef = entry.value[matched2];
+          const resolvedDef = variantDef.type === "lookupEntry" ? variantDef.value : variantDef;
+          if (resolvedDef.type === "void" || shorthand.inner === "") {
+            return { type: matched2 };
+          }
+          const innerValue = parseTypedArg(meta, variantDef, shorthand.inner);
+          return normalizeValue(meta.lookup, entry, { type: matched2, value: innerValue });
+        }
+      }
       if (variants.includes("Id")) {
         const idVariant = entry.value.Id;
         const innerType = idVariant.type === "lookupEntry" ? idVariant.value : idVariant;
@@ -1382,8 +1407,8 @@ function parseTypedArg(meta, entry, arg) {
       const inner = entry.value;
       if (inner.type === "primitive" && inner.value === "u8") {
         if (/^0x[0-9a-fA-F]*$/.test(arg))
-          return Binary.fromHex(arg);
-        return Binary.fromText(arg);
+          return Binary2.fromHex(arg);
+        return Binary2.fromText(arg);
       }
       if (arg.startsWith("[")) {
         try {
@@ -1391,7 +1416,7 @@ function parseTypedArg(meta, entry, arg) {
         } catch {}
       }
       if (/^0x[0-9a-fA-F]*$/.test(arg))
-        return Binary.fromHex(arg);
+        return Binary2.fromHex(arg);
       return parseValue(arg);
     }
     case "struct":
@@ -1496,12 +1521,6 @@ function registerQueryCommand(cli) {
       const storageApi = unsafeApi.query[palletInfo.name][storageItem.name];
       const parsedKeys = parseStorageKeys(meta, palletInfo.name, storageItem, keys);
       const format = opts.output ?? "pretty";
-      if (format === "json") {
-        console.error(`chain: ${chainName}`);
-      } else {
-        console.log(`${DIM}chain: ${chainName}${RESET}
-`);
-      }
       if (storageItem.type === "map" && parsedKeys.length === 0) {
         const entries = await storageApi.getEntries();
         const limit = Number(opts.limit);
@@ -1563,7 +1582,7 @@ function parseStorageKeys(meta, palletName, storageItem, args) {
 
 // src/commands/tx.ts
 import { getViewBuilder as getViewBuilder2 } from "@polkadot-api/view-builder";
-import { Binary as Binary2 } from "polkadot-api";
+import { Binary as Binary3 } from "polkadot-api";
 function registerTxCommand(cli) {
   cli.command("tx [target] [...args]", "Submit an extrinsic (e.g. Balances.transferKeepAlive <dest> <amount>)").option("--from <name>", "Account to sign with (required)").option("--dry-run", "Estimate fees without submitting").option("--encode", "Encode call to hex without signing or submitting").option("--ext <json>", `Custom signed extension values as JSON, e.g. '{"ExtName":{"value":...}}'`).action(async (target, args, opts) => {
     if (!target) {
@@ -1628,7 +1647,7 @@ function registerTxCommand(cli) {
           throw new Error(`Extra arguments are not allowed when submitting a raw call hex.
 ` + "Usage: dot tx 0x<call_hex> --from <account>");
         }
-        const callBinary = Binary2.fromHex(target);
+        const callBinary = Binary3.fromHex(target);
         tx = await unsafeApi.txFromCallData(callBinary);
         callHex = target;
       } else {
@@ -1649,7 +1668,7 @@ function registerTxCommand(cli) {
           const { codec, location } = meta.builder.buildCall(palletInfo.name, callInfo.name);
           const encodedArgs = codec.enc(callData);
           const fullCall = new Uint8Array([location[0], location[1], ...encodedArgs]);
-          console.log(Binary2.fromBytes(fullCall).asHex());
+          console.log(Binary3.fromBytes(fullCall).asHex());
           return;
         }
         tx = unsafeApi.tx[palletInfo.name][callInfo.name](callData);
@@ -1832,6 +1851,10 @@ function formatEventValue(v) {
     return v.toString();
   if (v === null || v === undefined)
     return "null";
+  if (v instanceof Binary3) {
+    const text = v.asText();
+    return text.includes("�") ? v.asHex() : text;
+  }
   return JSON.stringify(v, (_k, val) => typeof val === "bigint" ? val.toString() : val);
 }
 function parseCallArgs(meta, palletName, callName, args) {
@@ -1939,8 +1962,8 @@ function normalizeValue2(lookup, entry, value) {
       }
       if (innerResolved.type === "primitive" && innerResolved.value === "u8" && typeof value === "string") {
         if (/^0x[0-9a-fA-F]*$/.test(value))
-          return Binary2.fromHex(value);
-        return Binary2.fromText(value);
+          return Binary3.fromHex(value);
+        return Binary3.fromText(value);
       }
       if (Array.isArray(value)) {
         const innerEntry = resolved.value;
@@ -1995,7 +2018,20 @@ function normalizeValue2(lookup, entry, value) {
       return value;
   }
 }
+function parseEnumShorthand2(arg) {
+  if (arg.startsWith("{") || arg.startsWith("[") || arg.startsWith("0x"))
+    return null;
+  const firstParen = arg.indexOf("(");
+  if (firstParen === -1 || !arg.endsWith(")"))
+    return null;
+  const variant = arg.slice(0, firstParen);
+  if (!/^[a-zA-Z_]\w*$/.test(variant))
+    return null;
+  return { variant, inner: arg.slice(firstParen + 1, -1) };
+}
 function parseTypedArg2(meta, entry, arg) {
+  if (entry.type === "lookupEntry")
+    return parseTypedArg2(meta, entry.value, arg);
   switch (entry.type) {
     case "primitive":
       return parsePrimitive2(entry.value, arg);
@@ -2013,7 +2049,7 @@ function parseTypedArg2(meta, entry, arg) {
     case "enum": {
       if (/^0x[0-9a-fA-F]+$/.test(arg) && meta.lookup.call != null && entry.id === meta.lookup.call) {
         const callCodec = meta.builder.buildDefinition(meta.lookup.call);
-        return callCodec.dec(Binary2.fromHex(arg).asBytes());
+        return callCodec.dec(Binary3.fromHex(arg).asBytes());
       }
       if (arg.startsWith("{")) {
         try {
@@ -2021,6 +2057,19 @@ function parseTypedArg2(meta, entry, arg) {
         } catch {}
       }
       const variants = Object.keys(entry.value);
+      const shorthand = parseEnumShorthand2(arg);
+      if (shorthand) {
+        const matched2 = variants.find((v) => v.toLowerCase() === shorthand.variant.toLowerCase());
+        if (matched2) {
+          const variantDef = entry.value[matched2];
+          const resolvedDef = variantDef.type === "lookupEntry" ? variantDef.value : variantDef;
+          if (resolvedDef.type === "void" || shorthand.inner === "") {
+            return { type: matched2 };
+          }
+          const innerValue = parseTypedArg2(meta, variantDef, shorthand.inner);
+          return normalizeValue2(meta.lookup, entry, { type: matched2, value: innerValue });
+        }
+      }
       if (variants.includes("Id")) {
         const idVariant = entry.value.Id;
         const innerType = idVariant.type === "lookupEntry" ? idVariant.value : idVariant;
@@ -2042,8 +2091,8 @@ function parseTypedArg2(meta, entry, arg) {
       const inner = entry.value;
       if (inner.type === "primitive" && inner.value === "u8") {
         if (/^0x[0-9a-fA-F]*$/.test(arg))
-          return Binary2.fromHex(arg);
-        return Binary2.fromText(arg);
+          return Binary3.fromHex(arg);
+        return Binary3.fromText(arg);
       }
       if (arg.startsWith("[")) {
         try {
@@ -2051,7 +2100,7 @@ function parseTypedArg2(meta, entry, arg) {
         } catch {}
       }
       if (/^0x[0-9a-fA-F]*$/.test(arg))
-        return Binary2.fromHex(arg);
+        return Binary3.fromHex(arg);
       return parseValue(arg);
     }
     case "struct":

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polkadot-cli",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "CLI tool for querying Polkadot-ecosystem on-chain state",
   "type": "module",
   "bin": {
@@ -17,8 +17,8 @@
     "typecheck": "tsc --noEmit",
     "lint": "biome check .",
     "lint:fix": "biome check --write .",
-    "test": "bun test",
-    "test:coverage": "bun test --coverage --coverage-reporter=lcov --coverage-dir=coverage",
+    "test": "bun test --concurrent",
+    "test:coverage": "bun test --concurrent --coverage --coverage-reporter=lcov --coverage-dir=coverage",
     "prepare": "husky",
     "changeset": "changeset",
     "version": "changeset version",