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

update endpoints, versions, links #73

Merged
merged 3 commits into from
Aug 21, 2024
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
18 changes: 9 additions & 9 deletions docs/astria-evm/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,32 @@

| Property | Value |
|-----|-----|
| Network Name | dusk-8 |
| RPC URL | [https://rpc.evm.dusk-8.devnet.astria.org](https://rpc.evm.dusk-8.devnet.astria.org) |
| Network Name | dusk-10 |
| RPC URL | [https://rpc.evm.dusk-10.devnet.astria.org](https://rpc.evm.dusk-10.devnet.astria.org) |
| Chain ID | 912559 |
| Currency Symbol | RIA |
| Currency Symbol | TIA |
| Dora | [https://www.ondora.xyz/network/astria-devnet](https://www.ondora.xyz/network/astria-devnet) |
| Faucet | [https://faucet.evm.dusk-8.devnet.astria.org](https://faucet.evm.dusk-8.devnet.astria.org) |
| Block Scout | [https://explorer.evm.dusk-8.devnet.astria.org/](https://explorer.evm.dusk-8.devnet.astria.org/) |
| EVM Faucet | [https://faucet.evm.dusk-10.devnet.astria.org](https://faucet.evm.dusk-10.devnet.astria.org) |
| Block Scout | [https://explorer.evm.dusk-10.devnet.astria.org/](https://explorer.evm.dusk-10.devnet.astria.org/) |

## Adding to Metamask

Follow Metamask's official documentation to [manually add a custom network.](https://support.metamask.io/hc/en-us/articles/360043227612-How-to-add-a-custom-network-RPC#h_01G63GGJ83DGDRCS2ZWXM37CV5)

Your settings should be the following:

* Network Name: `dusk-8`
* New RPC URL: `https://rpc.evm.dusk-8.devnet.astria.org`
* Network Name: `dusk-10`
* New RPC URL: `https://rpc.evm.dusk-10.devnet.astria.org`
* Chain ID: `912559`
* Currency symbol: `RIA`
* Currency symbol: `TIA`
* Block Explorer URL: `<empty>`

## Using Cast

Set your `ETH_RPC_URL`:

```bash
export ETH_RPC_URL=https://rpc.evm.dusk-8.devnet.astria.org
export ETH_RPC_URL=https://rpc.evm.dusk-10.devnet.astria.org
```

```bash
Expand Down
8 changes: 8 additions & 0 deletions docs/components/_remote-dawn-endpoints.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
| Name | Endpoint |
|---|---|
| EVM JSON RPC | [https://rpc.evm.dawn-1.devnet.astria.org](https://rpc.evm.dawn-1.devnet.astria.org) |
| EVM Block Explorer | [https://explorer.evm.dawn-1.devnet.astria.org](https://explorer.evm.dawn-1.devnet.astria.org) |
| EVM Faucet | [https://faucet.evm.dawn-1.devnet.astria.org](https://faucet.evm.dawn-1.devnet.astria.org) |
| Sequencer RPC | [https://rpc.sequencer.dawn-1.devnet.astria.org](https://rpc.sequencer.dawn-1.devnet.astria.org) |
| Sequencer gRPC | [https://grpc.sequencer.dawn-1.devnet.astria.org](https://grpc.sequencer.dawn-1.devnet.astria.org) |
| Sequencer Faucet | [https://faucet.sequencer.dawn-1.devnet.astria.org](https://faucet.sequencer.dawn-1.devnet.astria.org) |
8 changes: 8 additions & 0 deletions docs/components/_remote-dusk-endpoints.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
| Name | Endpoint |
|---|---|
| EVM JSON RPC | [https://rpc.evm.dusk-10.devnet.astria.org](https://rpc.evm.dusk-10.devnet.astria.org) |
| EVM Block Explorer | [https://explorer.evm.dusk-10.devnet.astria.org](https://explorer.evm.dusk-10.devnet.astria.org) |
| EVM Faucet | [https://faucet.evm.dusk-10.devnet.astria.org](https://faucet.evm.dusk-10.devnet.astria.org) |
| Sequencer RPC | [https://rpc.sequencer.dusk-10.devnet.astria.org](https://rpc.sequencer.dusk-10.devnet.astria.org) |
| Sequencer gRPC | [https://grpc.sequencer.dusk-10.devnet.astria.org](https://grpc.sequencer.dusk-10.devnet.astria.org) |
| Sequencer Faucet | [https://faucet.sequencer.dusk-10.devnet.astria.org](https://faucet.sequencer.dusk-10.devnet.astria.org) |
8 changes: 0 additions & 8 deletions docs/components/_remote-endpoints.md

This file was deleted.

17 changes: 17 additions & 0 deletions docs/developer/references/astria-go/cli-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,12 @@ astria-go dev purge all [flags]
|---|---|---|---|
| `--instance` | string | `ASTRIA_GO_INSTANCE` | Choose the target instance. (default "default") |

### Flags

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

## `dev purge binaries`

Delete all downloaded binaries for a given instance. `astria-go dev init` must be run before `astria-go dev run`
Expand All @@ -105,6 +111,17 @@ astria-go dev purge binaries [flags]
|---|---|---|---|
| `--instance` | string | `ASTRIA_GO_INSTANCE` | Choose the target instance. (default "default") |

## `dev purge logs`

Delete all logs for a given instance. This deletes all data in the
`~/.astria/logs` directory. Re-initializing is NOT required after using this command.

### Usage

```bash
astria-go dev purge logs [flags]
```

## `dev reset`

The root command for resetting the local development instance data.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ against a different sequencer rpc/grpc.
For example, the default Astria Dusk dev net configuration is as follows:

```toml
[dusk]
sequencer_chain_id = 'astria-dusk-8'
sequencer_grpc = 'https://grpc.sequencer.dusk-8.devnet.astria.org/'
sequencer_rpc = 'https://rpc.sequencer.dusk-8.devnet.astria.org/'
[networks.dusk]
sequencer_chain_id = 'astria-dusk-10'
sequencer_grpc = 'https://grpc.sequencer.dusk-10.devnet.astria.org/'
sequencer_rpc = 'https://rpc.sequencer.dusk-10.devnet.astria.org/'
rollup_name = ''
default_denom = 'nria'
```
Expand Down Expand Up @@ -56,7 +56,7 @@ astria-go dev init \
Your local networks config will look like this:

```toml
[local]
[networks.local]
sequencer_chain_id = 'test-chain'
sequencer_grpc = 'http://127.0.0.1:8080'
sequencer_rpc = 'http://127.0.0.1:26657'
Expand Down
3 changes: 2 additions & 1 deletion docs/developer/references/endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
| Network | Sequencer RPC |
|---|---|
| local | <http://127.0.0.1:26657> |
| Dusk | <https://rpc.sequencer.dusk-8.devnet.astria.org/> |
| Dusk | <https://rpc.sequencer.dusk-10.devnet.astria.org/> |
| Dawn | <https://rpc.sequencer.dawn-1.devnet.astria.org/> |
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,28 @@ Then, open the `geth-genesis-local.json` file and update the `chainId` and
`astriaSequencerInitialHeight` using the block height from the previous command
to choose which sequencer block the first block of your rollup will be in:

Create a new genesis account for your Geth rollup:

```bash
cast w new
```

Also in the `geth-genesis-local.json` file, update the `"alloc"` account with
your new one:

```json
{
"config": {
...
"chainId": <6 digit number>,
"astriaRollupName": "<your rollup name>",
"astriaSequencerInitialHeight": <sequencer block height>,
...
},
"alloc": {
"<your new address>": { "balance": "300000000000000000000" }
}
}
}
```

Keep the `chainId` and `astriaRollupName` you chose on hand, as they will also
Expand All @@ -57,23 +71,9 @@ will work but will cause your rollup to sync potentially millions of blocks that
have no relevant data for your new rollup.
:::

Create a new genesis account for your Geth rollup:
You will use the private key for your new account to send [test
transactions](./test-transactions.md) later on.

```bash
cast w new
```

Also in the `geth-genesis-local.json` file, update the `"alloc"` account with
your new one:

```json
"alloc": {
"<your new address>": { "balance": "300000000000000000000" }
}
```

You will use the private key for your new account with the [test
transactions](./test-transactions.md) later on.

## Start Geth

Expand All @@ -95,7 +95,6 @@ just run
If you need to restart the rollup and want to also clear the state data, you can use:

```bash
# in astria-geth dir
just clean-restart
```

Expand All @@ -118,15 +117,15 @@ Navigate to the `~/.astria` directory. If you have run the commands shown above,
you should find a `default` directory.

Open the `~/.astria/default/networks-config.toml` file and update the
`rollup_name` variable in the `[dusk]` sections using the same
`rollup_name` variable in the `[networks.dusk]` sections using the same
`"astriaRollupName"` you used when [setting up your Geth
rollup](#setup-a-geth-rollup).

```toml
[dusk]
sequencer_chain_id = 'astria-dusk-8'
sequencer_grpc = 'https://grpc.sequencer.dusk-8.devnet.astria.org/'
sequencer_rpc = 'https://rpc.sequencer.dusk-8.devnet.astria.org/'
[networks.dusk]
sequencer_chain_id = 'astria-dusk-10'
sequencer_grpc = 'https://grpc.sequencer.dusk-10.devnet.astria.org/'
sequencer_rpc = 'https://rpc.sequencer.dusk-10.devnet.astria.org/'
rollup_name = '<your rollup name>' # update this value
default_denom = 'nria'
```
Expand All @@ -137,11 +136,11 @@ created.

:::warning
If you skip updating the priv key the Astria services will still start correctly
but your Composer will not be able to write transactions to the sequencer.
but your Composer will not be able to submit transactions to the sequencer.
:::

You can then use the [Sequencer
Faucet](https://faucet.sequencer.dusk-8.devnet.astria.org/) to fund the account
Faucet](https://faucet.sequencer.dusk-10.devnet.astria.org/) to fund the account
you just created using the account address.

## Run the local Astria components against the Remote Sequencer
Expand Down
9 changes: 4 additions & 5 deletions docs/developer/tutorials/run-local-rollup-and-sequencer.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Open the `geth-genesis-local.json` file in your Geth repo and update the
```json
{
"config": {
"chainId": <6 digit number>,
...
"chainId": <6 digit number>,
"astriaRollupName": "<your rollup name>",
...
"alloc": {
Expand All @@ -40,8 +40,8 @@ Open the `geth-genesis-local.json` file in your Geth repo and update the
}
```

You will use the private key for your new account, and the `"chainId"` you chose,
with the [test transactions](./test-transactions.md) later on.
You will use the private key for your new account to send [test
transactions](./test-transactions.md) later on.

## Start Geth

Expand All @@ -63,7 +63,6 @@ just run
If you need to restart the rollup and want to also clear the state data, you can use:

```bash
# in astria-geth dir
just clean-restart
```

Expand All @@ -84,7 +83,7 @@ Open the `~/.astria/default/networks-config.toml` file and update the
rollup](#setup-a-geth-rollup).

```toml
[local]
[networks.local]
sequencer_chain_id = 'sequencer-test-chain-0'
sequencer_grpc = 'http://127.0.0.1:8080'
sequencer_rpc = 'http://127.0.0.1:26657'
Expand Down
31 changes: 21 additions & 10 deletions docs/dusk-faq/faq.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,30 @@
# FAQ and Debugging

## Endpoints
## Dusk-net Endpoints and Service Versions

<!--@include: ./../components/_remote-endpoints.md-->
<!--@include: ./../components/_remote-dusk-endpoints.md-->

## Software Versions
Service Versions:

The latest Devnet (dusk-8) runs the following software versions:
- [Astria Conductor v0.19.0](https://github.com/astriaorg/astria/releases/tag/conductor-v0.19.0)
- [Astria Composer v0.7.0](https://github.com/astriaorg/astria/releases/tag/composer-v0.7.0)
- [Astria Sequencer-relayer v0.14.0](https://github.com/astriaorg/astria/releases/tag/sequencer-relayer-v0.14.0)
- [Astria Sequencer v0.15.0](https://github.com/astriaorg/astria/releases/tag/sequencer-v0.15.0)
- [Astria-Geth EVM v0.12.0](https://github.com/astriaorg/astria-geth/releases/tag/v0.12.0)
- [CometBFT v0.38.8](https://github.com/cometbft/cometbft/releases/tag/v0.38.8)

- [conductor v0.17.0](https://github.com/astriaorg/astria/releases/tag/conductor-v0.17.0)
- [composer v0.7.0](https://github.com/astriaorg/astria/releases/tag/composer-v0.7.0)
- [sequencer-relayer v0.14.0](https://github.com/astriaorg/astria/releases/tag/sequencer-relayer-v0.14.0)
- [sequencer v0.15.0](https://github.com/astriaorg/astria/releases/tag/sequencer-v0.15.0)
- [astria-geth EVM v0.12.0](https://github.com/astriaorg/astria-geth/releases/tag/v0.12.0)
- [CometBFT v0.38.6](https://github.com/cometbft/cometbft/releases/tag/v0.38.6)
## Dawn-net Endpoints and Service Versions

<!--@include: ./../components/_remote-dawn-endpoints.md-->

Service Versions:

- [Astria Conductor v0.19.0](https://github.com/astriaorg/astria/releases/tag/conductor-v0.19.0)
- [Astria Composer v0.7.0](https://github.com/astriaorg/astria/releases/tag/composer-v0.7.0)
- [Astria Sequencer-relayer v0.14.0](https://github.com/astriaorg/astria/releases/tag/sequencer-relayer-v0.14.0)
- [Astria Sequencer v0.15.0](https://github.com/astriaorg/astria/releases/tag/sequencer-v0.15.0)
- [Astria-Geth EVM v0.12.0](https://github.com/astriaorg/astria-geth/releases/tag/v0.12.0)
- [CometBFT v0.38.8](https://github.com/cometbft/cometbft/releases/tag/v0.38.8)

## Install the latest Astria cli

Expand Down
Loading