Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add FAQ section #110

Merged
merged 2 commits into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,13 @@ function sidebar() {
{text: 'Run a novm-messenger Rollup', link: '/tutorials/novm-messenger-rollup.md' },
{text: 'Test Transactions', link: '/tutorials/test-transactions.md' }
]
},
{
text: 'FAQ',
collapsed: true,
items: [
{text: 'astria-go CLI', link: '/faq/astria-go-cli' }
]
}
]
}
Expand All @@ -185,5 +192,6 @@ function nav() {
{ text: "Networks", link: "/networks/testnet" },
{ text: "Developers", link: "/developer/astria-go/astria-go-installation" },
{ text: "Tutorials", link: "/tutorials/run-local-rollup-against-remote-sequencer" },
{ text: "FAQ", link: "/faq/astria-go-cli" },
];
}
102 changes: 102 additions & 0 deletions docs/faq/astria-go-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# `astria-go` CLI FAQ

Common issues and solutions when using the `astria-go` cli.

## Resetting State

The `dev reset state` command removes everything in the
`~/.astria/<instance>/data` directory. If you are running a custom rollup
alongside the sequencer using the TUI, a best practice is to point your rollup
data to this same directory so that all state data can be reset together.

```bash
astria-go dev reset state --instance <instance name>
```

## Error: "Did you reset CometBFT without resetting your application's data?"

This error comes from Cometbft when there is a mismatch in data between Cometbft
and the Astria Sequencer. This can be fixed by resetting the state of your
`astria-go` cli instance.

```bash
astria-go dev reset state --instance <instance name>
```

If the error still persists after a restart of the TUI, check if there are any
services running that should not be:

```bash
ps aux | grep -E '[c]omposer|[c]onductor|[s]equencer|[c]ometbft'
```

If the above command returns any output, you can forcibly terminate the running
services with:

```bash
ps aux | grep -E '[c]omposer|[c]onductor|[s]equencer|[c]ometbft' | awk '{print $2}' | xargs kill -9
```

Then you can restart the TUI:

```bash
astria-go dev run --instance <instance name> [flags]
```

## Creating Instances

If you are developing different rollups in parallel, you can create multiple
instances to allow the different configurations you may need to persists.

```bash
astria-go dev init --instance <new instance name>
```

The only limitation on new instance is that they need unique names.

You can then [update the
configurations](../developer/astria-go/astria-go-config.md) for your
instance(s), then run a specific instance using the `--instance` flag when using
the `dev run` command:

```bash
astria-go dev run --instance <you instance name>
```

## Deleting Instances

To remove an instance you can use the following command. This will delete the
entire `~/.astria/<instance name>` directory and all of its contents:

```bash
astria-go dev purge all --instance <instance name>
```

## Redownload Binaries

The `dev init` command will skip downloading new binaries if they are already
present in the `bin/` dir. To delete and redownload them you need to run the
following commands:

```bash
INSTANCE="instance name"
astria-go dev purge binaries --instance $INSTANCE
astria-go dev init --instance $INSTANCE
```

## Filtering Logs

The TUI currently doesn't have a way of natively filtering the service outputs.
To enable this, use the `--export-logs` flag when running the TUI:

```bash
astria-go dev run --instance <instance name> --export-logs
```

This will output the logs of all services to the `~/.astria/<instance
name>/logs` directory. You can then open a new terminal window and filter the
logs of your choosing with:

```bash
tail -f <timestamp>-<service name>.log | grep "your grep filter"
```
6 changes: 5 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ features:
- title: Flame
details: Flame is the EVM for Celestia-Native DeFi, powered by Astria.
link: /flame/flame-mainnet-alpha
icon: <svg width="196" height="196" viewBox="-58 0 300 196" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M186.485 162.553L169.906 133.459C161.191 133.887 127.047 131.435 116.669 116.052C113.471 111.31 111.772 105.926 111.72 100.532C111.601 88.254 120.953 74.7222 133.843 74.4682C142.664 74.2944 152.067 80.969 152.129 90.155C152.148 92.9897 151.184 95.7127 149.788 98.1452L162.413 120.313C171.286 112.953 176.421 101.777 176.466 90.155C176.556 67.1271 155.368 49.4711 133.523 49.8191C127.006 49.923 120.62 51.5138 114.781 54.4912C110.641 31.1499 98.9635 8.88515 93.8893 0L77.3166 29.094C81.066 35.0003 91.2816 55.8828 91.3474 72.6442C91.4058 87.5082 79.7997 100.344 64.6792 100.344C53.4083 100.344 42.3331 92.7478 42.1529 80.4268C42.0575 73.8975 45.1736 67.5856 51.4658 65.2701C53.0783 64.68 55.5098 64.4011 57.1991 64.4011L69.8238 42.2336C51.6618 35.2782 29.9689 43.6587 21.7758 61.8458C13.0386 81.2367 19.6188 104.938 37.1071 116.765C19.1139 132.097 5.83021 153.642 0.749634 162.585H33.895C41.6115 147.382 58.3203 124.882 76.8943 124.48C91.0157 124.175 103.255 134.835 104.594 149.225C105.087 154.387 103.558 159.44 100.294 163.448C96.893 167.619 91.5767 170.482 86.1725 170.475C80.8882 170.469 76.6535 167.019 74.1173 162.579H48.8616C51.8045 180.763 67.8792 195.119 86.1725 195.116C98.788 195.114 111.051 188.954 119.049 179.136C125.038 171.782 128.455 162.819 128.935 153.447C151.081 161.664 176.273 162.566 186.485 162.553Z" fill="white"/><path d="M186.485 162.553L169.906 133.459C161.191 133.887 127.047 131.435 116.669 116.052C113.471 111.31 111.772 105.926 111.72 100.532C111.601 88.254 120.953 74.7222 133.843 74.4682C142.664 74.2944 152.067 80.969 152.129 90.155C152.148 92.9897 151.184 95.7127 149.788 98.1452L162.413 120.313C171.286 112.953 176.421 101.777 176.466 90.155C176.556 67.1271 155.368 49.4711 133.523 49.8191C127.006 49.923 120.62 51.5138 114.781 54.4912C110.641 31.1499 98.9635 8.88515 93.8893 0L77.3166 29.094C81.066 35.0003 91.2816 55.8828 91.3474 72.6442C91.4058 87.5082 79.7997 100.344 64.6792 100.344C53.4083 100.344 42.3331 92.7478 42.1529 80.4268C42.0575 73.8975 45.1736 67.5856 51.4658 65.2701C53.0783 64.68 55.5098 64.4011 57.1991 64.4011L69.8238 42.2336C51.6618 35.2782 29.9689 43.6587 21.7758 61.8458C13.0386 81.2367 19.6188 104.938 37.1071 116.765C19.1139 132.097 5.83021 153.642 0.749634 162.585H33.895C41.6115 147.382 58.3203 124.882 76.8943 124.48C91.0157 124.175 103.255 134.835 104.594 149.225C105.087 154.387 103.558 159.44 100.294 163.448C96.893 167.619 91.5767 170.482 86.1725 170.475C80.8882 170.469 76.6535 167.019 74.1173 162.579H48.8616C51.8045 180.763 67.8792 195.119 86.1725 195.116C98.788 195.114 111.051 188.954 119.049 179.136C125.038 171.782 128.455 162.819 128.935 153.447C151.081 161.664 176.273 162.566 186.485 162.553Z" fill="url(#paint0_linear_133_15)"/><defs><linearGradient id="paint0_linear_133_15" x1="147.373" y1="1.28041e-07" x2="148.961" y2="195.113" gradientUnits="userSpaceOnUse"><stop stop-color="#B99985"/><stop offset="0.259829" stop-color="#D29A50"/>=<stop offset="0.476861" stop-color="#D06E18"/><stop offset="0.766321" stop-color="#CB513F"/><stop offset="0.995979" stop-color="#A42121"/></linearGradient></defs></svg>
icon: <svg width="36" height="36" viewBox="-58 0 300 196" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M186.485 162.553L169.906 133.459C161.191 133.887 127.047 131.435 116.669 116.052C113.471 111.31 111.772 105.926 111.72 100.532C111.601 88.254 120.953 74.7222 133.843 74.4682C142.664 74.2944 152.067 80.969 152.129 90.155C152.148 92.9897 151.184 95.7127 149.788 98.1452L162.413 120.313C171.286 112.953 176.421 101.777 176.466 90.155C176.556 67.1271 155.368 49.4711 133.523 49.8191C127.006 49.923 120.62 51.5138 114.781 54.4912C110.641 31.1499 98.9635 8.88515 93.8893 0L77.3166 29.094C81.066 35.0003 91.2816 55.8828 91.3474 72.6442C91.4058 87.5082 79.7997 100.344 64.6792 100.344C53.4083 100.344 42.3331 92.7478 42.1529 80.4268C42.0575 73.8975 45.1736 67.5856 51.4658 65.2701C53.0783 64.68 55.5098 64.4011 57.1991 64.4011L69.8238 42.2336C51.6618 35.2782 29.9689 43.6587 21.7758 61.8458C13.0386 81.2367 19.6188 104.938 37.1071 116.765C19.1139 132.097 5.83021 153.642 0.749634 162.585H33.895C41.6115 147.382 58.3203 124.882 76.8943 124.48C91.0157 124.175 103.255 134.835 104.594 149.225C105.087 154.387 103.558 159.44 100.294 163.448C96.893 167.619 91.5767 170.482 86.1725 170.475C80.8882 170.469 76.6535 167.019 74.1173 162.579H48.8616C51.8045 180.763 67.8792 195.119 86.1725 195.116C98.788 195.114 111.051 188.954 119.049 179.136C125.038 171.782 128.455 162.819 128.935 153.447C151.081 161.664 176.273 162.566 186.485 162.553Z" fill="white"/><path d="M186.485 162.553L169.906 133.459C161.191 133.887 127.047 131.435 116.669 116.052C113.471 111.31 111.772 105.926 111.72 100.532C111.601 88.254 120.953 74.7222 133.843 74.4682C142.664 74.2944 152.067 80.969 152.129 90.155C152.148 92.9897 151.184 95.7127 149.788 98.1452L162.413 120.313C171.286 112.953 176.421 101.777 176.466 90.155C176.556 67.1271 155.368 49.4711 133.523 49.8191C127.006 49.923 120.62 51.5138 114.781 54.4912C110.641 31.1499 98.9635 8.88515 93.8893 0L77.3166 29.094C81.066 35.0003 91.2816 55.8828 91.3474 72.6442C91.4058 87.5082 79.7997 100.344 64.6792 100.344C53.4083 100.344 42.3331 92.7478 42.1529 80.4268C42.0575 73.8975 45.1736 67.5856 51.4658 65.2701C53.0783 64.68 55.5098 64.4011 57.1991 64.4011L69.8238 42.2336C51.6618 35.2782 29.9689 43.6587 21.7758 61.8458C13.0386 81.2367 19.6188 104.938 37.1071 116.765C19.1139 132.097 5.83021 153.642 0.749634 162.585H33.895C41.6115 147.382 58.3203 124.882 76.8943 124.48C91.0157 124.175 103.255 134.835 104.594 149.225C105.087 154.387 103.558 159.44 100.294 163.448C96.893 167.619 91.5767 170.482 86.1725 170.475C80.8882 170.469 76.6535 167.019 74.1173 162.579H48.8616C51.8045 180.763 67.8792 195.119 86.1725 195.116C98.788 195.114 111.051 188.954 119.049 179.136C125.038 171.782 128.455 162.819 128.935 153.447C151.081 161.664 176.273 162.566 186.485 162.553Z" fill="url(#paint0_linear_133_15)"/><defs><linearGradient id="paint0_linear_133_15" x1="147.373" y1="1.28041e-07" x2="148.961" y2="195.113" gradientUnits="userSpaceOnUse"><stop stop-color="#B99985"/><stop offset="0.259829" stop-color="#D29A50"/>=<stop offset="0.476861" stop-color="#D06E18"/><stop offset="0.766321" stop-color="#CB513F"/><stop offset="0.995979" stop-color="#A42121"/></linearGradient></defs></svg>

- title: Learn
details: Astria is a sequencing layer that allows many rollups to share a single decentralized network of sequencers.
Expand All @@ -31,4 +31,8 @@ features:
details: Use the Astria stack to create, integrate and build your own modular rollups.
link: /developer/astria-go/astria-go-installation
icon: <svg width="36" height="31" viewBox="0 0 36 31" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M17.25 11.9993V12.7493H18.75V11.9993H17.25ZM23.25 8.25002V9.00002H24.75V8.25002H23.25ZM24 5.62502H24.75V5.20938L24.3976 4.98905L24 5.62502ZM18 1.87427L18.3976 1.2383L17.9974 0.98817L17.5987 1.24063L18 1.87427ZM12 5.67377L11.5987 5.04013L11.25 5.26097V5.67377H12ZM11.25 8.25002V9.00002H12.75V8.25002H11.25ZM7.5 22.6875L7.1025 23.3235L8.25 24.0407V22.6875H7.5ZM1.5 18.9375H0.75V19.3532L1.1025 19.5735L1.5 18.9375ZM1.5 12.2363L1.09875 11.6026L0.75 11.8235V12.2363H1.5ZM7.5 8.43677L7.89756 7.8008L7.49742 7.55067L7.09875 7.80313L7.5 8.43677ZM13.5 12.1875L13.8975 12.8235L14.915 12.1876L13.8976 11.5516L13.5 12.1875ZM28.5 22.6875H27.75V24.0407L28.8975 23.3235L28.5 22.6875ZM34.5 18.9375L34.8975 19.5735L35.25 19.3532V18.9375H34.5ZM34.5 12.1875H35.25V11.7719L34.8976 11.5516L34.5 12.1875ZM28.5 8.43677L28.8976 7.8008L28.4974 7.55067L28.0987 7.80313L28.5 8.43677ZM22.5 12.2363L22.0987 11.6026L21.085 12.2446L22.1062 12.8746L22.5 12.2363ZM18 29.25L17.6025 29.886L18 30.1345L18.3975 29.886L18 29.25ZM24 18.75H24.75V18.3344L24.3976 18.1141L24 18.75ZM18 14.9993L18.3976 14.3633L17.9974 14.1132L17.5987 14.3656L18 14.9993ZM12 18.7988L11.5987 18.1651L11.25 18.386V18.7988H12ZM12 25.5H11.25V25.9157L11.6025 26.136L12 25.5ZM24 25.5L24.3975 26.136L24.75 25.9157V25.5H24ZM17.25 9.37502V11.9993H18.75V9.37502H17.25ZM24.75 8.25002V5.62502H23.25V8.25002H24.75ZM24.3976 4.98905L18.3976 1.2383L17.6024 2.51023L23.6024 6.26098L24.3976 4.98905ZM17.5987 1.24063L11.5987 5.04013L12.4013 6.30741L18.4013 2.50791L17.5987 1.24063ZM11.25 5.67377V8.25002H12.75V5.67377H11.25ZM11.6025 6.26102L17.6025 10.011L18.3975 8.73902L12.3975 4.98902L11.6025 6.26102ZM18.3975 10.011L24.3975 6.26102L23.6025 4.98902L17.6025 8.73902L18.3975 10.011ZM6.75 15.9375V22.6875H8.25V15.9375H6.75ZM7.8975 22.0515L1.8975 18.3015L1.1025 19.5735L7.1025 23.3235L7.8975 22.0515ZM2.25 18.9375V12.2363H0.75V18.9375H2.25ZM1.90125 12.8699L7.90125 9.07041L7.09875 7.80313L1.09875 11.6026L1.90125 12.8699ZM7.10244 9.07273L13.1024 12.8235L13.8976 11.5516L7.89756 7.8008L7.10244 9.07273ZM13.1025 11.5515L7.1025 15.3015L7.8975 16.5735L13.8975 12.8235L13.1025 11.5515ZM7.89376 15.2992L1.89376 11.5979L1.10624 12.8746L7.10624 16.5758L7.89376 15.2992ZM27.75 15.9375V22.6875H29.25V15.9375H27.75ZM28.8975 23.3235L34.8975 19.5735L34.1025 18.3015L28.1025 22.0515L28.8975 23.3235ZM35.25 18.9375V12.1875H33.75V18.9375H35.25ZM34.8976 11.5516L28.8976 7.8008L28.1024 9.07273L34.1024 12.8235L34.8976 11.5516ZM28.0987 7.80313L22.0987 11.6026L22.9013 12.8699L28.9013 9.07041L28.0987 7.80313ZM22.1062 12.8746L28.1062 16.5758L28.8938 15.2992L22.8938 11.5979L22.1062 12.8746ZM28.8975 16.5735L34.8975 12.8235L34.1025 11.5515L28.1025 15.3015L28.8975 16.5735ZM17.25 22.5V29.25H18.75V22.5H17.25ZM24.3976 18.1141L18.3976 14.3633L17.6024 15.6352L23.6024 19.386L24.3976 18.1141ZM17.5987 14.3656L11.5987 18.1651L12.4013 19.4324L18.4013 15.6329L17.5987 14.3656ZM11.25 18.7988V25.5H12.75V18.7988H11.25ZM11.6025 26.136L17.6025 29.886L18.3975 28.614L12.3975 24.864L11.6025 26.136ZM18.3975 29.886L24.3975 26.136L23.6025 24.864L17.6025 28.614L18.3975 29.886ZM24.75 25.5V18.75H23.25V25.5H24.75ZM11.6025 19.386L17.6025 23.136L18.3975 21.864L12.3975 18.114L11.6025 19.386ZM18.3975 23.136L24.3975 19.386L23.6025 18.114L17.6025 21.864L18.3975 23.136Z" fill="url(#paint0_linear_3416_238)"/><defs><linearGradient id="paint0_linear_3416_238" x1="1.50001" y1="29.25" x2="37.6934" y2="24.0344" gradientUnits="userSpaceOnUse"><stop stop-color="#EA9B57"/><stop offset="1" stop-color="#CB513F"/></linearGradient></defs></svg>
- title: FAQ
details: Common questions and answers about our software stack and tooling.
link: /faq/astria-go-cli
icon: <svg xmlns="http://www.w3.org/2000/svg" width="60" height="60" viewBox="0 0 36 25"> <path d="M16.5 20v3h3v-3h-3zm.24-3.5h2.52v-2.1c0-2.5 1.56-3.8 3.12-4.8 1.44-.9 2.28-2.2 2.28-4.1 0-3.2-2.76-5.5-6.66-5.5s-6.66 2.3-6.66 5.5h2.52c0-1.8 1.68-3 4.14-3s4.14 1.2 4.14 3c0 1.2-.48 1.9-1.56 2.6-1.8 1.1-3.84 2.6-3.84 6.3v2.1z" fill="url(#paint0_linear_question)"/> <defs> <linearGradient id="paint0_linear_question" x1="1.5" y1="29.25" x2="37.69" y2="24.03" gradientUnits="userSpaceOnUse"> <stop stop-color="#EA9B57"/> <stop offset="1" stop-color="#CB513F"/> </linearGradient> </defs> </svg>
---
Loading