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

Refactor for testnet #76

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
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: 4 additions & 4 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"default": true,
"MD001": false,
"MD013": {
"code_block_line_length": 120,
"MD013": {
"code_blocks": false,
"line_length": 80,
"tables": false
},
"MD024": {
"allow_different_nesting": true
},
"MD032": false
}
}
52 changes: 35 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,65 @@
# Astria Docs

The Astria Docs website built with [VitePress](https://vitepress.dev/)
The [Astria Docs website](https://docs.astria.org/) built with [VitePress](https://vitepress.dev/)

### Installation
## Installation

To get started, clone the repository and run the following:

```
```bash
npm add -D vitepress
```

### Local Development
## Local Development

To run a local development site:

```
```bash
npm run docs:dev
```

This command starts a local development server. Most changes are reflected live without having to restart the server.
This command starts a local development server. Most changes are reflected live
without having to restart the server.

### Build
## Build

```
```bash
npm run docs:build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
This command generates static content into the `build` directory and can be
served using any static contents hosting service.

### Deployment
## Deployment

```
```bash
npm run docs:preview
```

This command starts a local server from the static content generated above for preview before deployment.
This command starts a local server from the static content generated above for
preview before deployment.

The main [Astria docs website](https://docs.astria.org/) is deployed using the
[github deploy action](.github/workflows/deploy.yml).

## Linting

Linting commands:

```bash
just lint-md
```

The main astria docs website is deployed using the [github deploy action](.github/workflows/deploy.yml).
Linting follows [these
rules](https://github.com/DavidAnson/markdownlint/tree/main?tab=readme-ov-file#rules--aliases).

### Contribution Guidelines
## Contribution Guidelines

* Fork & Clone: Fork this repository and clone it to your local machine.
* Branch: Always create a new branch for your changes. Naming it relevantly.
* Commit Changes: Make your changes and commit them with a clear and concise commit message.
* Push & Create PR: Push your changes to your fork and create a pull request to the main branch of this repository.
* Please ensure to review the detailed Contribution Guidelines above before making a pull request.
* Commit Changes: Make your changes and commit them with a clear and concise
commit message.
* Push & Create PR: Push your changes to your fork and create a pull request to
the main branch of this repository.
* Please ensure to review the detailed Contribution Guidelines above before
making a pull request.
104 changes: 52 additions & 52 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -41,86 +41,86 @@ export default defineConfig({
function sidebar() {
return [
{

text: 'Learn',
collapsed: true,
items: [
{ text: 'Astria Overview', link: '/overview/introduction.md' },
{ text: 'How Rollups Work', link: '/overview/how-rollups-work.md'},
{ text: 'The Astria Sequencer Network', link: '/overview/the-astria-sequencer-network.md' },
{ text: 'Bridging', link: '/overview/bridging.md' },
{ text: 'Transaction Flow', link: '/overview/transaction-flow.md' },
{
text: 'What is Astria?',
text: 'Components',
collapsed: true,
items: [
{ text: 'Overview', link: '/overview/introduction' },
{ text: 'How Rollups Work', link: '/overview/how-rollups-work'},
{ text: 'The Astria Sequencer Network', link: '/overview/the-astria-sequencer-network' },
{ text: 'Bridging', link: '/overview/bridging' },
{ text: 'Transaction Flow', link: '/overview/transaction-flow' },
{
text: 'Components',
collapsed: true,
items: [
{ text: 'Composer', link: '/overview/components/composer' },
{ text: 'The Astria Sequencer', link: '/overview/components/the-astria-sequencer' },
{ text: 'Relayer', link: '/overview/components/relayer' },
{ text: 'Data Availability Layer', link: '/overview/components/data-availability-layer' },
{ text: 'Conductor', link: '/overview/components/conductor' },
{ text: 'Composer', link: '/overview/components/composer.md' },
{ text: 'The Astria Sequencer', link: '/overview/components/the-astria-sequencer.md' },
{ text: 'Relayer', link: '/overview/components/relayer.md' },
{ text: 'Data Availability Layer', link: '/overview/components/data-availability-layer.md' },
{ text: 'Conductor', link: '/overview/components/conductor.md' },

]
},
]
}
],
},
]
},
{
text: 'Flame EVM',
collapsed: true,
items: [
{ text: 'Flame EVM', link: '/flame-evm/flame.md' },
]
},
{
text: 'Networks',
collapsed: true,
items: [
{ text: 'Astria Dawn Testnet', link: '/networks/testnet.md' },
{ text: 'Astria Dusk Devnet', link: '/networks/devnet.md' },
{ text: 'Local Network', link: '/networks/local.md' },
]
},
{
text: 'Developers',
collapsed: true,
items: [
{
text: 'Tutorials',
text: 'astria-go CLI',
collapsed: true,
items: [
{
text: 'Using the Astria CLI',
collapsed: true,
items: [
{text: 'Install the CLI', link: '/developer/tutorials/install-the-cli.md'},
{text: 'Run a Local Rollup and Sequencer', link: '/developer/tutorials/run-local-rollup-and-sequencer.md' },
{text: 'Run a Local Rollup against a Remote Sequencer', link: '/developer/tutorials/run-local-rollup-against-remote-sequencer.md' },
{text: 'Test Transactions', link: '/developer/tutorials/test-transactions.md' },
]
}
{text: 'Installation', link: '/developer/astria-go/astria-go-installation.md'},
{text: 'Commands', link: '/developer/astria-go/astria-go-commands.md'},
{text: 'CLI Configuration', link: '/developer/astria-go/astria-go-config.md'},
]
},
{
text: 'References',
text: 'astria-cli CLI',
collapsed: true,
items: [
{text: 'Astria Endpoints', link: '/developer/references/endpoints.md'},
{
text: 'astria-go cli',
collapsed: true,
items: [
{text: 'Installation', link: '/developer/references/astria-go/cli-installation.md'},
{text: 'Commands', link: '/developer/references/astria-go/cli-commands.md'},
{text: 'CLI Configuration', link: '/developer/references/astria-go/cli-config.md'},
]
}
{text: 'Installation', link: '/developer/astria-cli/astria-cli-installation.md'},
{text: 'Commands', link: '/developer/astria-cli/astria-cli-commands.md'},
]
},
{
text: 'The Astria EVM', link: '/astria-evm/overview'
text: 'Deployment Charts',
link: '/developer/deployment-charts.md',
},
{
text: 'spamooor',
link: '/developer/spamooor.md',
},
{
text: 'APIs',
link: '/developer/apis.md',
},
]
},
{
text: 'Resources',
text: 'Tutorials',
collapsed: true,
items: [
{
text: 'Community',
collapsed: true,
items: [
{ text: 'Overview', link: '/community/1-overview' }
]
},
{ text: 'Astria Devnet FAQ', link: '/dusk-faq/faq' }
{text: 'Run a Local Rollup and Sequencer', link: '/tutorials/run-local-rollup-and-sequencer.md' },
{text: 'Run a Local Rollup against a Remote Sequencer', link: '/tutorials/run-local-rollup-against-remote-sequencer.md' },
{text: 'Test Transactions', link: '/tutorials/test-transactions.md' }
]
}
]
Expand Down
56 changes: 13 additions & 43 deletions docs/astria-evm/overview.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,19 @@
# Astria EVM
# EVM

## Network Information
The Astria EVM is a rollup running on top of the Astria
Sequencer Network. It is a fork of
[Geth](https://github.com/ethereum/go-ethereum).

| Property | Value |
|-----|-----|
| 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 | TIA |
| Dora | [https://www.ondora.xyz/network/astria-devnet](https://www.ondora.xyz/network/astria-devnet) |
| 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/) |
## RPC Endpoints

## Adding to Metamask
Below are the RPC endpoint for the different Flame EVMs running on different networks.

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)
| Network | EVM RPC |
|---|---|
| Dawn | [https://rpc.evm.dawn-0.astria.org](https://rpc.flame.dawn-0.astria.org) |
| Dusk | [https://rpc.evm.dusk-10.devnet.astria.org](https://rpc.evm.dusk-10.devnet.astria.org) |
| Local | [http://127.0.0.1:26657](http://127.0.0.1:26657) |

Your settings should be the following:
## Bridging

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

## Using Cast

Set your `ETH_RPC_URL`:

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

```bash
export REC_ADDR=<SOME_ADDRESS>
```

```bash
cast balance $REC_ADDR
```

```bash
cast send $REC_ADDR --value 10000000000000000000 --private-key <PRIVATE-KEY>
```

```bash
cast balance $REC_ADDR
```
TODO add info on bridging flow.
4 changes: 0 additions & 4 deletions docs/community/1-overview.md

This file was deleted.

2 changes: 2 additions & 0 deletions docs/components/_astria-go-cli-build-from-source.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@

<!-- markdownlint-disable MD041 -->

::: code-group

```bash [SSH]
Expand Down
39 changes: 21 additions & 18 deletions docs/components/_astria-go-cli-install.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,28 @@
<!-- markdownlint-disable MD041 -->
<!-- markdownlint-disable MD013 -->

::: code-group

```bash [ARM Mac]
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.15.0/astria-go-v0.15.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 [ARM Mac]
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.15.0/astria-go-v0.15.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.0/astria-go-v0.15.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 Mac]
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.15.0/astria-go-v0.15.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.0/astria-go-v0.15.0-linux-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.0/astria-go-v0.15.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
3 changes: 3 additions & 0 deletions docs/components/_astria-rust-cli-install.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<!-- markdownlint-disable MD041 -->
<!-- markdownlint-disable MD013 -->

::: code-group

```bash [ARM Mac]
Expand Down
20 changes: 20 additions & 0 deletions docs/components/_clone-and-run-charts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- markdownlint-disable MD041 -->

::: code-group

```bash [SSH]
git git@github.com:astriaorg/charts.git
cd charts/
```

```bash [HTTPS]
git clone https://github.com/astriaorg/charts.git
cd charts/
```

:::

<!-- <Tabs>
<TabItem value="SSH" label="SSH" default> </TabItem>
<TabItem value="HTTPS" label="HTTPS> </TabItem>
</Tabs> -->
1 change: 1 addition & 0 deletions docs/components/_clone-geth.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- markdownlint-disable MD041 -->

::: code-group

Expand Down
Loading
Loading