Skip to content
Merged
4 changes: 4 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ export default defineConfig({
text: "Edit this page on GitHub",
},

outline: {
level: [1, 3],
},

logo: { src: '/astria-logo-mini.svg', width: 24, height: 24 },

// https://vitepress.dev/reference/default-theme-config
Expand Down
6 changes: 3 additions & 3 deletions docs/components/_astria-go-cli-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@
::: code-group

```bash [ARM Mac]
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.15.2/astria-go-v0.15.2-darwin-arm64.tar.gz > astria-cli.tar.gz
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.16.0/astria-go-v0.16.0-darwin-arm64.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz
mv astria-go /usr/local/bin/
astria-go version
```

```bash [X86_64 Mac]
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.15.2/astria-go-v0.15.2-darwin-amd64.tar.gz > astria-cli.tar.gz
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.16.0/astria-go-v0.16.0-darwin-amd64.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz
mv astria-go /usr/local/bin/
astria-go version
```

```bash [x86_64 Linux]
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.15.2/astria-go-v0.15.2-linux-amd64.tar.gz > astria-cli.tar.gz
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.16.0/astria-go-v0.16.0-linux-amd64.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz
mv astria-go /usr/local/bin/
astria-go version
Expand Down
2 changes: 1 addition & 1 deletion docs/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,6 @@ export const siteConfig = {
},
cli: {
rust: "v0.5.1",
go: "v0.15.0",
go: "v0.16.0",
}
};
3 changes: 3 additions & 0 deletions docs/developer/astria-cli/astria-cli-commands.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
outline: [1,2]
---
<!-- markdownlint-disable MD024 -->
<!-- Disabling MD024 to allow for repeat "Usage" heading -->

Expand Down
156 changes: 156 additions & 0 deletions docs/developer/astria-go/astria-go-commands.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
outline: [1,2]
---
<!-- markdownlint-disable MD024 -->
<!-- Disabling MD024 to allow for repeat "Usage" heading -->

Expand Down Expand Up @@ -212,6 +215,101 @@ astria-go dev run --network dusk [flags]
| `--sequencer-path` | string | `ASTRIA_GO_SEQUENCER_PATH` | Provide an override path to a specific sequencer binary. |
| `--service-log-level` | string | `ASTRIA_GO_SERVICE_LOG_LEVEL` | Set the log level for services (debug, info, error) (default "info") |

## `dev setconfig`

The root command for all config update commands within a development instance.

### Usage

```bash
astria-go dev setconfig [command] [flags]
```

## `dev setconfig feeasset`

Set the sequencer fee asset across all config for the instance.

### Usage

```bash
astria-go dev setconfig feeasset [denom] [flags]
```

### Flags

| Flag | Arg Type | Override Env Var | Description |
|---|---|---|---|
| `--instance` | string | `ASTRIA_GO_INSTANCE` | Choose the target instance. (default "default") |

## `dev setconfig nativeasset`

Set the netive asset for the sequencer across all config for the instance.

### Usage

```bash
astria-go dev setconfig nativeasset [denom] [flags]
```

### Flags

| Flag | Arg Type | Override Env Var | Description |
|---|---|---|---|
| `--instance` | string | `ASTRIA_GO_INSTANCE` | Choose the target instance. (default "default") |
| `--network` | string | `ASTRIA_GO_NETWORK` | Specify the network that the native asset is being updated for. (default "local") |

## `dev setconfig rollupname`

Set the rollup name across all config for the instance.

### Usage

```bash
astria-go dev setconfig rollupname [name] [flags]
```

### Flags

| Flag | Arg Type | Override Env Var | Description |
|---|---|---|---|
| `--instance` | string | `ASTRIA_GO_INSTANCE` | Choose the target instance. (default "default") |
| `--network` | string | `ASTRIA_GO_NETWORK` | Select the network to run the services against. Valid networks are: local, dusk, dawn, mainnet (default "dawn") |
| `--rollup-port` | string | `ASTRIA_GO_ROLLUP_PORT` | Select the localhost port that the rollup will be running on. (default "8546") |

## `dev setconfig sequencerchainid`

Set the default sequencer chain id across all config for the instance.

### Usage

```bash
astria-go dev setconfig sequencerchainid [chain-id] [flags]
```

### Flags

| Flag | Arg Type | Override Env Var | Description |
|---|---|---|---|
| `--instance` | string | `ASTRIA_GO_INSTANCE` | Choose the target instance. (default "default") |
| `--network` | string | `ASTRIA_GO_NETWORK` | Specify the network that the sequencer chain id is being updated for. (default "local") |

## `dev version`

Print the version of the services used by the CLI.

### Usage

```bash
astria-go dev version [flags]
```

### Flags

| Flag | Arg Type | Override Env Var | Description |
|---|---|---|---|
| `--instance` | string | `ASTRIA_GO_INSTANCE` | Choose the target instance. (default "default") |
| `--network` | string | `ASTRIA_GO_NETWORK` | Select the network to run the services against. Valid networks are: local, dusk, dawn, mainnet (default "dawn") |

## `sequencer`

The root command for all sequencer commands.
Expand Down Expand Up @@ -414,6 +512,64 @@ astria-go sequencer nonce [address] [flags]
| `--network` | string | `ASTRIA_GO_NETWORK` | Configure the values to target a specific network. (default "dawn") |
| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer. |

## `sequencer setconfig`

Update the configuration for the sequencer commands config.

### Usage

```bash
astria-go sequencer setconfig [command] [flags]
```

## `sequencer setconfig feeasset`

Sets the fee asset in the sequencer command configs.

### Usage

```bash
astria-go sequencer setconfig feeasset [denom] [flags]
```

### Flags

| Flag | Arg Type | Override Env Var | Description |
|---|---|---|---|
| `--network` | string | `ASTRIA_GO_NETWORK` | Specify the network that the sequencer chain id is being updated for. (default "local") |

## `sequencer setconfig asset`

Sets the asset in the sequencer command configs.

### Usage

```bash
astria-go sequencer setconfig asset [denom] [flags]
```

### Flags

| Flag | Arg Type | Override Env Var | Description |
|---|---|---|---|
| `--network` | string | `ASTRIA_GO_NETWORK` | Specify the network that the sequencer chain id is being updated for. (default "local") |

## `sequencer setconfig sequencerchainid`

Update the configuration for the sequencer commands config.

### Usage

```bash
astria-go sequencer setconfig sequencerchainid [chain-id] [flags]
```

### Flags

| Flag | Arg Type | Override Env Var | Description |
|---|---|---|---|
| `--network` | string | `ASTRIA_GO_NETWORK` | Specify the network that the sequencer chain id is being updated for. (default "local") |

## `sequencer setkey`

Set private key for an address in system keyring.
Expand Down
51 changes: 51 additions & 0 deletions docs/developer/astria-go/astria-go-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,21 @@ Use the new config with:
astria-go sequencer nonce <other args> --network new_network
```

### Sequencer Networks `setconfig` Commands

The cli also has commands for updating the most common configuration settings:

```bash
# Update the asset the sequencer commands will default to
astria-go sequencer setconfig asset

# Update the fee asset the sequencer commands will default to
astria-go sequencer setconfig feeasset

# Update the sequencer chain id the sequencer commands will default to
astria-go sequencer setconfig sequencerchainid
```

## Devrunner Networks Config

The devrunner networks config provides simplified and powerful options for
Expand Down Expand Up @@ -314,6 +329,24 @@ astria-go dev init \

```

### Network `setconfig` Commands

The cli also has commands for updating the most common configuration settings:

```bash
# Update the fee asset used by the local sequencer network
astria-go dev setconfig feeasset

# Update the native asset used by the local sequencer network
astria-go dev setconfig nativeasset

# Update the rollup name used by the local Conductor and Composer services
astria-go dev setconfig rollupname

# Update the sequencer chain id used by the local sequencer network
astria-go dev setconfig sequencerchainid
```

## Service Config

The full configuration for all Astria services can be found in the
Expand Down Expand Up @@ -354,3 +387,21 @@ LOWER_SNAKE_CASE_VAR_NAME=value

> NOTE: The `network-config.toml` overrides the default values in the
> `base-config.toml`.

### Services `setconfig` Commands

The cli also has commands for updating the most common configuration settings:

```bash
# Update the fee asset used by the local sequencer network
astria-go dev setconfig feeasset

# Update the native asset used by the local sequencer network
astria-go dev setconfig nativeasset

# Update the rollup name used by the local Conductor and Composer services
astria-go dev setconfig rollupname

# Update the sequencer chain id used by the local sequencer network
astria-go dev setconfig sequencerchainid
```
Binary file added docs/tutorials/assets/astria-chat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/tutorials/deploy-novm-messenger-with-charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Then open
[http://chat.astria-chat.localdev.me/](http://chat.astria-chat.localdev.me/) in
your browser to use the UI and send messages.

![Astria Chat noVM Frontend](./assets/astria-chat.png)

::: info
The deployment should take less than 5 minutes, but this will depend on the
speed of your machine and/or download times for images.
Expand Down
Loading
Loading