txo_parser 0.0.1 → 0.0.2

package/README.md

@@ -34,6 +34,20 @@ console.log(parsed)
 //   amount: 0.75
 // }
 
+// Parse legacy format
+const legacyUri =
+  'txo:btc:4e9c1ef9ba5fa3b0aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0:0 0.75 Kx9'
+const parsedLegacy = parseTxoUri(legacyUri)
+console.log(parsedLegacy)
+// Output:
+// {
+//   network: 'btc',
+//   txid: '4e9c1ef9ba5fa3b0aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0',
+//   output: 0,
+//   amount: 0.75,
+//   privkey: 'Kx9'
+// }
+
 // Check if a URI is valid
 console.log(isValidTxoUri(uri)) // true
 
@@ -58,6 +72,9 @@ The package includes a command-line tool that allows you to parse TXO URIs direc
 # Parse a TXO URI and output the full JSON
 txo-parser "txo:btc:4e9c1ef9ba5fa3b0aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0:0?amount=0.75"
 
+# Parse legacy format
+txo-parser "txo:btc:4e9c1ef9ba5fa3b0aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0:0 0.75 Kx9"
+
 # Extract just the txid
 txo-parser "txo:btc:4e9c1ef9ba5fa3b0aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0:0" --txid
 
@@ -74,6 +91,21 @@ If you haven't installed the package globally, you can use `npx`:
 npx txo-parser "txo:btc:4e9c1ef9ba5fa3b0aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0:0"
 ```
 
+## Supported Formats
+
+The parser supports two formats:
+
+1. **Standard Format** (as per specification):  
+   `txo:<network>:<txid>:<output>?key=value&key=value...`
+
+2. **Legacy Format**:  
+   `txo:<network>:<txid>:<output> [amount] [privkey]`
+
+The legacy format supports up to two space-separated parameters after the basic structure:
+
+- First parameter is interpreted as the amount
+- Second parameter is interpreted as the private key
+
 ## API
 
 ### `parseTxoUri(uri)`
@@ -99,7 +131,7 @@ Formats a JSON object into a TXO URI string.
 
 - **Parameters:**
   - `data` (object): The data to format (must include network, txid, and output)
-- **Returns:** Formatted TXO URI string
+- **Returns:** Formatted TXO URI string (always in standard format)
 - **Throws:** Error if required fields are missing or invalid
 
 ## Testing

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;
@@ -80,6 +95,22 @@ export function parseTxoUri (uri) {
     });
   }
 
+  // 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,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "txo_parser",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Parser for TXO URI Specification (v0.1)",
   "type": "module",
   "main": "index.js",