Skip to content

Commit 43fd4cd

Browse files
Copilotjcstein
andauthored
docs: passthrough command (#2074)
* Initial plan for issue * docs: add passthrough command documentation for consensus nodes Add comprehensive documentation for the passthrough command introduced in celestia-app v4.0.0. This command allows users to invoke queries on historical app versions, which is useful for querying data from before major version upgrades. Co-authored-by: jcstein <[email protected]> * fix: configure CodeQL to scan only JavaScript/TypeScript languages Co-authored-by: jcstein <[email protected]> * fix: update CodeQL configuration to include Go language scanning Co-authored-by: jcstein <[email protected]> * Remove unrelated CodeQL configuration files Co-authored-by: jcstein <[email protected]> * Apply suggestions from code review * Apply suggestions from code review --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: jcstein <[email protected]>
1 parent 85dc244 commit 43fd4cd

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

how-to-guides/consensus-node.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -529,3 +529,67 @@ To reduce the log level, you can modify the `log_level` field in your `config.to
529529
-log_level = "info"
530530
+log_level = "*:error,p2p:info,state:info"
531531
```
532+
533+
### Passthrough command for historical queries
534+
535+
Starting with celestia-app v4 the `passthrough` command allows you to invoke queries on historical app versions. This is particularly useful when you need to query data from before a major version upgrade occurred.
536+
537+
#### When to use the passthrough command
538+
539+
The passthrough command is useful in scenarios where:
540+
541+
- You need to query state or transactions that existed before a major app version upgrade
542+
- You're running a post-upgrade node but need to access data using the query format from a previous version
543+
- You're debugging issues related to version compatibility after an upgrade
544+
545+
#### Basic usage
546+
547+
```sh
548+
celestia-appd passthrough [app-version] [command] [flags]
549+
```
550+
551+
Where:
552+
553+
- `[app-version]` is the historical app version you want to query against (e.g., `v1`, `v2`, `v3`)
554+
- `[command]` is the command you want to execute using that app version's format
555+
556+
#### Examples
557+
558+
Query account balance using app version 1 format:
559+
560+
```sh
561+
celestia-appd passthrough v1 query bank balances [address]
562+
```
563+
564+
Query validator information using app version 2 format:
565+
566+
```sh
567+
celestia-appd passthrough v2 query staking validator [validator-address]
568+
```
569+
570+
Query transaction using app version 3 format:
571+
572+
```sh
573+
celestia-appd passthrough v3 query tx [transaction-hash]
574+
```
575+
576+
#### Important considerations
577+
578+
- The passthrough command requires that your node has the historical data for the version you're querying
579+
- Not all query types may be available for all historical versions
580+
- This command is most useful immediately after major version upgrades when you need backward compatibility
581+
- Ensure your node is fully synced before using passthrough queries for accurate results
582+
583+
#### Getting help
584+
585+
To see all available options for the passthrough command:
586+
587+
```sh
588+
celestia-appd passthrough --help
589+
```
590+
591+
To see available commands for a specific app version:
592+
593+
```sh
594+
celestia-appd passthrough [app-version] --help
595+
```

0 commit comments

Comments
 (0)