txo_parser 0.0.1 → 0.0.3

package/demo/voucher-data.jsonld

@@ -0,0 +1,31 @@
+{
+  "@context": {
+    "schema": "https://schema.org/",
+    "bt": "https://blocktrails.org/ns/"
+  },
+  "@id": "#this",
+  "@type": "VoucherPool",
+  "schema:name": "Voucher Pool",
+  "schema:description": "Testnet4 voucher management and faucet",
+  "schema:hasPart": [
+    {
+      "@id": "blocktrail.jsonld#this"
+    },
+    {
+      "@id": "webledger.jsonld#this"
+    },
+    {
+      "@id": "ledger-history.jsonld#this"
+    }
+  ],
+  "schema:itemListElement": [
+    {
+      "@type": "schema:ListItem",
+      "@id": "mn05mqrf",
+      "schema:identifier": "txo:btc:d3a54de54a9df9e89b02dfda4274bbb12180c2ac75cb523917a66f515d01b977:0?amount=416366&key=b8f86cd4e9a6f5db705ebfbcbe3093745b10b2781a7ead82647dc770bd60fb02",
+      "schema:address": "tb1pgl8m440er9gmhvxepwuscduanw4xf6p2ccfaetqq48pcxfnhfazsqa22kz",
+      "schema:status": "unspent",
+      "schema:dateCreated": "2026-03-21T09:57:43.035Z"
+    }
+  ]
+}

package/demo/webledger.jsonld

@@ -0,0 +1,9 @@
+{
+  "@context": "https://w3id.org/webledgers",
+  "@id": "#this",
+  "type": "WebLedger",
+  "name": "Voucher Pool Ledger",
+  "description": "Testnet4 voucher balances",
+  "defaultCurrency": "satoshi",
+  "entries": []
+}

package/index.js

@@ -3,6 +3,7 @@
  * Implementation of the TXO URI Specification (v0.1)
  * 
  * Format: txo:<network>:<txid>:<output>?key=value&key=value...
+ * Legacy Format: txo:<network>:<txid>:<output> [amount] [privkey]
  */
 
 /**
@@ -16,8 +17,22 @@ export function parseTxoUri (uri) {
     throw new Error('Invalid URI: URI must be a non-empty string');
   }
 
-  // Split the URI into its components
-  const [scheme, network, txid, outputAndRest] = uri.split(':');
+  // Check if this is using the legacy space-separated format
+  const isLegacyFormat = !uri.includes('?') && uri.split(' ').length > 1;
+
+  // Parse the basic structure first
+  let basicParts;
+  let extraParts = [];
+
+  if (isLegacyFormat) {
+    const allParts = uri.split(' ');
+    basicParts = allParts[0].split(':');
+    extraParts = allParts.slice(1);
+  } else {
+    basicParts = uri.split(':');
+  }
+
+  const [scheme, network, txid, outputAndRest] = basicParts;
 
   // Validate scheme
   if (scheme !== 'txo') {
@@ -41,7 +56,7 @@ export function parseTxoUri (uri) {
 
   // Split the output and query string
   let output, queryString;
-  if (outputAndRest.includes('?')) {
+  if (!isLegacyFormat && outputAndRest.includes('?')) {
     [output, queryString] = outputAndRest.split('?');
   } else {
     output = outputAndRest;
@@ -64,22 +79,41 @@ export function parseTxoUri (uri) {
         // Convert key to lowercase for case-insensitivity
         const normalizedKey = key.toLowerCase();
 
+        // Normalize aliases to canonical names
+        const canonicalKey = normalizedKey === 'key' ? 'privkey' : normalizedKey;
+
         // Process specific key types
-        if (normalizedKey === 'amount') {
+        if (canonicalKey === 'amount') {
           // Parse amount as a number
           const amount = parseFloat(value);
           if (!isNaN(amount)) {
-            queryParams[normalizedKey] = amount;
+            queryParams[canonicalKey] = amount;
           } else {
-            queryParams[normalizedKey] = value;
+            queryParams[canonicalKey] = value;
           }
         } else {
-          queryParams[normalizedKey] = value;
+          queryParams[canonicalKey] = decodeURIComponent(value);
         }
       }
     });
   }
 
+  // Handle legacy format with space-separated parameters
+  if (isLegacyFormat && extraParts.length > 0) {
+    // First extra part is amount
+    if (extraParts[0]) {
+      const amount = parseFloat(extraParts[0]);
+      if (!isNaN(amount)) {
+        queryParams.amount = amount;
+      }
+    }
+
+    // Second extra part is privkey
+    if (extraParts.length > 1 && extraParts[1]) {
+      queryParams.privkey = extraParts[1];
+    }
+  }
+
   // Build the result object
   const result = {
     network,
@@ -136,12 +170,30 @@ export function formatTxoUri (data) {
   // Build the base URI
   let uri = `txo:${data.network}:${data.txid}:${output}`;
 
-  // Add query parameters
+  // Add query parameters (canonical key names, stable order: amount first, then privkey, then rest)
+  const reserved = ['network', 'txid', 'output'];
+  const entries = Object.entries(data).filter(([k]) => !reserved.includes(k) && data[k] !== undefined);
+
+  // Normalize 'key' alias to 'privkey'
   const queryParams = [];
-  Object.entries(data).forEach(([key, value]) => {
-    if (!['network', 'txid', 'output'].includes(key) && value !== undefined) {
-      queryParams.push(`${key.toLowerCase()}=${encodeURIComponent(value)}`);
+  const seen = new Set();
+  for (const [k, v] of entries) {
+    const canonical = k.toLowerCase() === 'key' ? 'privkey' : k.toLowerCase();
+    if (!seen.has(canonical)) {
+      seen.add(canonical);
+      queryParams.push(`${canonical}=${encodeURIComponent(v)}`);
     }
+  }
+
+  // Stable order: amount first, privkey second, rest alphabetical
+  queryParams.sort((a, b) => {
+    const keyA = a.split('=')[0];
+    const keyB = b.split('=')[0];
+    if (keyA === 'amount') return -1;
+    if (keyB === 'amount') return 1;
+    if (keyA === 'privkey') return -1;
+    if (keyB === 'privkey') return 1;
+    return keyA.localeCompare(keyB);
   });
 
   if (queryParams.length > 0) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "txo_parser",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Parser for TXO URI Specification (v0.1)",
   "type": "module",
   "main": "index.js",
@@ -23,7 +23,7 @@
     "cli"
   ],
   "author": "Melvin Carvalho",
-  "license": "MIT",
+  "license": "AGPL-3.0-or-later",
   "bugs": {
     "url": "https://github.com/sandy-mount/txo_parser/issues"
   },