diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 8c8755cd..36812811 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -7,26 +7,18 @@ description: Test your DApp's transactions with the VisualSign parser CLI - Rust development environment - A raw transaction hex from your DApp - -## Install the parser CLI - -```bash -# Clone the repository -git clone https://github.com/anchorageoss/visualsign-parser.git -cd visualsign-parser/src - -# Build the CLI -cargo build --release - -# The binary is at target/release/parser_cli -``` +- Clone the repository and navigate to the proper directory for following commands within the guide: + ```bash + git clone https://github.com/anchorageoss/visualsign-parser.git + cd visualsign-parser/src + ``` ## Parse your first transaction Run the parser with a transaction from your DApp: ```bash -./target/release/parser_cli --chain ethereum -t --output human +cargo run --bin parser_cli -- --chain ethereum -t --output human ``` Replace `ethereum` with your chain (`solana`, `sui`, or `tron`) and `` with your actual transaction data. @@ -34,25 +26,28 @@ Replace `ethereum` with your chain (`solana`, `sui`, or `tron`) and ` --output human --condensed-only +cargo run --bin parser_cli -- --chain ethereum -t --output human --condensed-only ``` This shows only the essential information that fits on small screens. @@ -70,28 +65,19 @@ This shows only the essential information that fits on small screens. For programmatic analysis or integration testing: ```bash -./target/release/parser_cli --chain ethereum -t --output json +cargo run --bin parser_cli -- --chain ethereum -t --output json ``` Use `jq` to extract specific fields: ```bash # Get all field labels -./target/release/parser_cli --chain ethereum -t --output json | jq -r '.Fields[].Label' +cargo run --bin parser_cli -- --chain ethereum -t --output json | jq -r '.Fields[].Label' # Get the transaction title -./target/release/parser_cli --chain ethereum -t --output json | jq -r '.Title' +cargo run --bin parser_cli -- --chain ethereum -t --output json | jq -r '.Title' ``` -## What to check - -When reviewing your transaction's visualization: - -1. **Accuracy** - Do amounts, addresses, and parameters match your transaction? -2. **Clarity** - Can a non-technical user understand what will happen? -3. **Completeness** - Are all important details visible? -4. **Condensed view** - Does the hardware wallet view show critical information? - ## Common issues ### Transaction fails to parse