Skip to content

Commit

Permalink
chore(docs): dusk-2 to dusk-3 updates (#34)
Browse files Browse the repository at this point in the history
## Description
Updated all references to `dusk-2` to `dusk-3`.
Updated referenced software versions.
Updated cli install instructions for new cli version.
  • Loading branch information
sambukowski committed Jan 19, 2024
1 parent d5e83e7 commit 95f8f2b
Show file tree
Hide file tree
Showing 11 changed files with 58 additions and 562 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ npm-debug.log*
yarn-debug.log*
yarn-error.log*

.yarn/install-state.gz

# editor files
.idea/
.vscode/
Expand Down
1 change: 1 addition & 0 deletions .yarnrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
nodeLinker: node-modules
12 changes: 6 additions & 6 deletions docs/astria-evm/1-overview.md → docs/astria-evm/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ sidebar_position: 1

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

## Adding to Metamask

Expand All @@ -29,7 +29,7 @@ Your settings should look like the image below
Set your `ETH_RPC_URL`:

```bash
export ETH_RPC_URL=https://rpc-archive.evm.dusk-2.devnet.astria.org/
export ETH_RPC_URL=https://rpc-archive.evm.dusk-3.devnet.astria.org/
```

```bash
Expand Down
19 changes: 9 additions & 10 deletions docs/cloud-rollup/digital-ocean.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import RemoteEndpoints from '../components/_remote-endpoints.mdx';

This guide assumes you're using Digital Ocean's Kubernetes (K8s) service.

Install and configure `doctl`: <https://docs.digitalocean.com/reference/doctl/how-to/install/>
Install and configure `doctl`: [https://docs.digitalocean.com/reference/doctl/how-to/install/](https://docs.digitalocean.com/reference/doctl/how-to/install/)

Follow the instructions in Digital Ocean's [Quick Start Guide](https://docs.digitalocean.com/products/kubernetes/getting-started/)
to create a new cluster in the region of your choosing.
Expand All @@ -49,8 +49,7 @@ This will create several Kubernetes (k8s) resources and a Digital Ocean loadbala

## Verify Loadbalancer with external IP

You should see a new loadbalancer being created in the Digital Ocean console:
<https://cloud.digitalocean.com/networking/load_balancers>
You should see a new loadbalancer being created in the Digital Ocean console: [https://cloud.digitalocean.com/networking/load_balancers](https://cloud.digitalocean.com/networking/load_balancers)

You can also check that your Digital Ocean load balancer was created with:

Expand Down Expand Up @@ -78,7 +77,7 @@ More info can be found [here](https://kubernetes.io/docs/concepts/services-netwo

How you create an `A` record will depend on where you manage your domain.

An example for Google domains can be seen here: <https://support.google.com/a/answer/2579934?hl=en>
An example for Google domains can be seen here: [https://support.google.com/a/answer/2579934?hl=en](https://support.google.com/a/answer/2579934?hl=en)

Create a wildcard record `*` pointing to the `EXTERNAL-IP` of your `ingress-nginx-controller`:

Expand Down Expand Up @@ -179,8 +178,8 @@ config:
balance: '<BALANCE>'
sequencer:
initialBlockHeight: <INITIAL_SEQUENCER_BLOCK_HEIGHT>
websocket: wss://rpc.sequencer.dusk-2.devnet.astria.org/websocket
rpc: https://rpc.sequencer.dusk-2.devnet.astria.org
websocket: wss://rpc.sequencer.dusk-3.devnet.astria.org/websocket
rpc: https://rpc.sequencer.dusk-3.devnet.astria.org
ingress:
hostname: <YOUR_HOSTNAME>
celestia-node:
Expand Down Expand Up @@ -214,7 +213,7 @@ export SEQUENCER_ACCOUNT_ADDRESS=8a2f...5f68

## Fund your Sequencer Account

Navigate to <https://faucet.sequencer.dusk-2.devnet.astria.org/>
Navigate to [https://faucet.sequencer.dusk-3.devnet.astria.org/](https://faucet.sequencer.dusk-3.devnet.astria.org/)
to view the sequencer faucet.

Enter your `<SEQUENCER_ACCOUNT_ADDRESS>` into the text box
Expand Down Expand Up @@ -262,9 +261,9 @@ several public endpoints using the DNS you configured:

| Utility | URL |
|-----|-----|
| Block Explorer | <http://blockscout>.<YOUR_ROLLUP_NAME>.<YOUR_HOSTNAME>/ |
| Faucet | <http://faucet>.<YOUR_ROLLUP_NAME>.<YOUR_HOSTNAME>/ |
| RPC | <http://executor>.<YOUR_ROLLUP_NAME>.<YOUR_HOSTNAME>/ |
| Block Explorer | `http://blockscout.<YOUR_ROLLUP_NAME>.<YOUR_HOSTNAME>/` |
| Faucet | `http://faucet.<YOUR_ROLLUP_NAME>.<YOUR_HOSTNAME>/` |
| RPC | `http://executor.<YOUR_ROLLUP_NAME>.<YOUR_HOSTNAME>/` |

## Interact with your Rollup

Expand Down
30 changes: 15 additions & 15 deletions docs/components/_astria-cli-install.mdx
Original file line number Diff line number Diff line change
@@ -1,44 +1,44 @@
### Clone the Astria [dev-cluster](https://github.com/astriaorg/dev-cluster/tree/main)

```bash
git clone --branch dusk-2 https://github.com/astriaorg/dev-cluster.git
git clone --branch dusk-3 https://github.com/astriaorg/dev-cluster.git
```

### Install the latest [astria cli](https://github.com/astriaorg/astria/releases/tag/cli-v0.2.0)
### Install the latest [astria cli](https://github.com/astriaorg/astria/releases/tag/cli-v0.2.2)

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
<TabItem value="ARM Mac" label="ARM Mac" default>

curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.0/astria-cli-aarch64-apple-darwin.tar.gz > astria-cli.tar.gz
```bash
curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.2/astria-cli-aarch64-apple-darwin.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz

```
</TabItem>
<TabItem value="X86_64 Mac" label="X86_64 Mac">

curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.0/astria-cli-x86_64-apple-darwin.tar.gz > astria-cli.tar.gz
```bash
curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.2/astria-cli-x86_64-apple-darwin.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz

```
</TabItem>
<TabItem value="x86_64 Linux" label="x86_64 Linux">

curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.0/astria-cli-x86_64-unknown-linux-gnu.tar.gz > astria-cli.tar.gz
```bash
curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.2/astria-cli-x86_64-unknown-linux-gnu.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz

```
</TabItem>
<TabItem value="From Source" label="From Source">

cargo install astria-cli --git=https://github.com/astriaorg/astria --tag=cli-v0.2.0 --locked

```bash
cargo install astria-cli --git=https://github.com/astriaorg/astria --tag=cli-v0.2.2 --locked
```
</TabItem>
</Tabs>

You'll also need to install the following tools:
:::warning
There is a bug in the latest Docker desktop release for MacOS
Please install the following release: <https://docs.docker.com/desktop/release-notes/#4252>
Please install the following release: [https://docs.docker.com/desktop/release-notes/#4252](https://docs.docker.com/desktop/release-notes/#4252)
For more details see [here](https://github.com/docker/for-mac/issues/7100)
:::
4 changes: 2 additions & 2 deletions docs/components/_cli-cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ import CLI from '../components/_astria-cli-install.mdx';

<CLI />

- kubectl - <https://kubernetes.io/docs/tasks/tools/>
- helm - <https://helm.sh/docs/intro/install/>
- kubectl - [https://kubernetes.io/docs/tasks/tools/](https://kubernetes.io/docs/tasks/tools/)
- helm - [https://helm.sh/docs/intro/install/](https://helm.sh/docs/intro/install/)
12 changes: 6 additions & 6 deletions docs/components/_cli-local.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ import CLI from '../components/_astria-cli-install.mdx';

<CLI />

- docker - <https://docs.docker.com/get-docker/>
- kubectl - <https://kubernetes.io/docs/tasks/tools/>
- helm - <https://helm.sh/docs/intro/install/>
- kind - <https://kind.sigs.k8s.io/docs/user/quick-start/#installation>
- just - <https://just.systems/man/en/chapter_4.html>
- docker - [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)
- kubectl - [https://kubernetes.io/docs/tasks/tools/](https://kubernetes.io/docs/tasks/tools/)
- helm - [https://helm.sh/docs/intro/install/](https://helm.sh/docs/intro/install/)
- kind - [https://kind.sigs.k8s.io/docs/user/quick-start/#installation](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
- just - [https://just.systems/man/en/chapter_4.html](https://just.systems/man/en/chapter_4.html)
- Foundry Cast and Forge tools -
<https://book.getfoundry.sh/getting-started/installation>
[https://book.getfoundry.sh/getting-started/installation](https://book.getfoundry.sh/getting-started/installation)
4 changes: 2 additions & 2 deletions docs/components/_remote-endpoints.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ The endpoints for the remote shared sequencer are:

| NAME | HOSTS | ADDRESS |
|-----|-----|-----|
| Sequencer RPC | rpc.sequencer.dusk-2.devnet.astria.org | 34.111.73.187 |
| Sequencer Faucet | faucet.sequencer.dusk-2.devnet.astria.org | 34.36.8.102 |
| Sequencer RPC | rpc.sequencer.dusk-3.devnet.astria.org | 34.111.73.187 |
| Sequencer Faucet | faucet.sequencer.dusk-3.devnet.astria.org | 34.36.8.102 |
21 changes: 11 additions & 10 deletions docs/dusk-faq/1-information.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,20 @@ Endpoints for the remote cluster are the following:

| NAME | HOSTS | ADDRESS |
|-----|-----|-----|
| EVM JSON RPC | rpc.evm.dusk-2.devnet.astria.org | 34.160.214.22 |
| EVM Block Explorer | explorer.evm.dusk-2.devnet.astria.org | 34.111.167.16 |
| EVM Faucet | faucet.evm.dusk-2.devnet.astria.org | 130.211.4.120 |
| Sequencer RPC | rpc.sequencer.dusk-2.devnet.astria.org | 34.111.73.187 |
| Sequencer Faucet | faucet.sequencer.dusk-2.devnet.astria.org | 34.36.8.102 |
| EVM JSON RPC | rpc.evm.dusk-3.devnet.astria.org | 34.160.214.22 |
| EVM Block Explorer | explorer.evm.dusk-3.devnet.astria.org | 34.111.167.16 |
| EVM Faucet | faucet.evm.dusk-3.devnet.astria.org | 130.211.4.120 |
| Sequencer RPC | rpc.sequencer.dusk-3.devnet.astria.org | 34.111.73.187 |
| Sequencer Faucet | faucet.sequencer.dusk-3.devnet.astria.org | 34.36.8.102 |

## Software Versions

The latest Devnet (dusk-2) runs the following software versions:
- [conductor v0.11.0](https://github.com/astriaorg/astria/releases/tag/v0.11.0--conductor)
- [composer v0.3.0](https://github.com/astriaorg/astria/releases/tag/v0.3.0--composer)
- [sequencer-relayer v0.9.0](https://github.com/astriaorg/astria/releases/tag/v0.9.0--sequencer-relayer)
- [sequencer v0.7.0](https://github.com/astriaorg/astria/releases/tag/v0.7.0--sequencer)
The latest Devnet (dusk-3) runs the following software versions:
- [conductor v0.11.1](https://github.com/astriaorg/astria/releases/tag/conductor-v0.11.1)
- [composer v0.3.1](https://github.com/astriaorg/astria/releases/tag/composer-v0.3.1)
- [sequencer-relayer v0.9.1](https://github.com/astriaorg/astria/releases/tag/sequencer-relayer-v0.9.1)
- [sequencer v0.8.0](https://github.com/astriaorg/astria/releases/tag/sequencer-v0.8.0)
- [Geth EVM v0.5.2](https://github.com/astriaorg/go-ethereum/releases/tag/geth1.13-v0.5.2)

## Install the latest Astria cli
import CLI from '../components/_cli-local.mdx';
Expand Down
6 changes: 3 additions & 3 deletions docs/local-rollup/1-introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ config:
balance: '<BALANCE>'
sequencer:
initialBlockHeight: <INITIAL_SEQUENCER_BLOCK_HEIGHT>
websocket: wss://rpc.sequencer.dusk-2.devnet.astria.org/websocket
rpc: https://rpc.sequencer.dusk-2.devnet.astria.org
websocket: wss://rpc.sequencer.dusk-3.devnet.astria.org/websocket
rpc: https://rpc.sequencer.dusk-3.devnet.astria.org
ingress:
hostname: localdev.me
celestia-node:
Expand Down Expand Up @@ -178,7 +178,7 @@ export SEQUENCER_ACCOUNT_ADDRESS=8a2f...5f68

## Fund your Sequencer Account

Navigate to < https://faucet.sequencer.dusk-2.devnet.astria.org/ > to view the
Navigate to < https://faucet.sequencer.dusk-3.devnet.astria.org/ > to view the
sequencer faucet.

Enter your `<SEQUENCER_ACCOUNT_ADDRESS>` into the text box to send
Expand Down
Loading

0 comments on commit 95f8f2b

Please sign in to comment.