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

feat(docs): component sections added #33

Merged
merged 3 commits into from
Jan 18, 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
Original file line number Diff line number Diff line change
Expand Up @@ -9,50 +9,16 @@ a Kubernetes cluster on Digital Ocean which uses the Astria shared sequencer net

## Local Dependencies

### Install the latest [astria cli](https://github.com/astriaorg/astria/releases/tag/cli-v0.2.1)
### Install the latest Astria cli
import RemoteCli from '../components/_cli-cloud.mdx';

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.1/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.1/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.1/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.1 --locked

</TabItem>
</Tabs>

### You'll also need to install the following tools

- kubectl - <https://kubernetes.io/docs/tasks/tools/>
- helm - <https://helm.sh/docs/intro/install/>
<RemoteCli />

## Dusknet Endpoints

The endpoints for the remote shared sequencer are:
import RemoteEndpoints from '../components/_remote-endpoints.mdx';

| 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 |
<RemoteEndpoints />

## Create a New Cluster

Expand Down
44 changes: 44 additions & 0 deletions docs/components/_astria-cli-install.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +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
```

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

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
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
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
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

</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>
For more details see [here](https://github.com/docker/for-mac/issues/7100)
:::
6 changes: 6 additions & 0 deletions docs/components/_cli-cloud.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import CLI from '../components/_astria-cli-install.mdx';

<CLI />

- kubectl - <https://kubernetes.io/docs/tasks/tools/>
- helm - <https://helm.sh/docs/intro/install/>
11 changes: 11 additions & 0 deletions docs/components/_cli-local.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
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>
- Foundry Cast and Forge tools -
<https://book.getfoundry.sh/getting-started/installation>
9 changes: 9 additions & 0 deletions docs/components/_deployment-instructions-redirect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:::tip
Want your own rollup? [Deploy it now!](https://deploy.astria.org/)

To deploy your own rollup on the Astria Dusknet on your __local machine__, check out the
[instructions here](/docs/local-rollup/introduction/)!

To deploy your own rollup on the Astria Dusknet __remotely__, check out the
[instructions here](/docs/cloud-rollup/digital-ocean/)!
:::
6 changes: 6 additions & 0 deletions docs/components/_remote-endpoints.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
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 |
38 changes: 8 additions & 30 deletions docs/dusk-faq/1-information.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebar_position: 5

# FAQ and Debugging

import DeploymentsRedirect from '../components/_deployment-instructions-redirect.mdx';

<DeploymentsRedirect />

## Endpoints

Endpoints for the remote cluster are the following:
Expand All @@ -24,38 +28,12 @@ The latest Devnet (dusk-2) runs the following software versions:
- [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)

## Manually Fetch Sequencer Block Height

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

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.1/astria-cli-aarch64-apple-darwin.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz
## Install the latest Astria cli
import CLI from '../components/_cli-local.mdx';

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

curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.1/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.1/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">



</TabItem>
</Tabs>
## Manually Fetch Sequencer Block Height

### Sequencer Block Height

Expand Down
70 changes: 13 additions & 57 deletions docs/local-rollup/1-introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,73 +7,29 @@ sidebar_position: 1
This guide will walk you through deploying a rollup full node on
a local Kubernetes cluster which uses the Astria shared sequencer network.

:::tip
Want your own rollup? [Deploy it now!](https://deploy.astria.org/)

If you would like to deploy a rollup on a remote Kubernetes cluster,
please see the [remote deployment guide](/docs/cloud-rollup/digital-ocean/) here.
:::

## Local Dependencies

:::info
This guide has been tested on MacOS and Linux but not Windows
:::

### 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
```

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

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.1/astria-cli-aarch64-apple-darwin.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz
### Install the latest Astria cli
import LocalCli from '../components/_cli-local.mdx';

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

curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.1/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.1/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.1 --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>
For more details see [here](https://github.com/docker/for-mac/issues/7100)
:::

- 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>
- Foundry Cast and Forge tools - <https://book.getfoundry.sh/getting-started/installation>
<LocalCli />

## Dusknet Endpoints

The endpoints for the remote shared sequencer are:
import RemoteEndpoints from '../components/_remote-endpoints.mdx';

| 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 |
<RemoteEndpoints />

## Setup Local Environment

Expand Down Expand Up @@ -222,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-2.devnet.astria.org/ > to view the
sequencer faucet.

Enter your `<SEQUENCER_ACCOUNT_ADDRESS>` into the text box to send
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ sidebar_position: 1

# Introduction

:::tip
To deploy your own rollup on the Astria Dusknet, check out the
[instructions here](/docs/local-rollup/introduction/)!
:::
import DeploymentsRedirect from '../components/_deployment-instructions-redirect.mdx';

<DeploymentsRedirect />

Astria is a shared sequencing network that allows many rollups to share a single
decentralized network of sequencers. These sequencers are simple and
permissionless to join, completely replacing centralized sequencers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ sidebar_position: 2

# Why Decentralized Sequencers?

:::tip
To deploy your own rollup on the Astria Dusknet, check out the
[instructions here](/docs/local-rollup/introduction/)!
:::
import DeploymentsRedirect from '../components/_deployment-instructions-redirect.mdx';

<DeploymentsRedirect />

Centralization is antithetical to crypto. And yet, today’s rollups almost
universally depend on a single sequencer. Centralized sequencers provide fast
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ sidebar_position: 3

# Cross-Rollup Composability

:::tip
To deploy your own rollup on the Astria Dusknet, check out the
[instructions here](/docs/local-rollup/introduction/)!
:::
import DeploymentsRedirect from '../components/_deployment-instructions-redirect.mdx';

<DeploymentsRedirect />

Because Astria handles the transaction ordering for multiple rollups, it’s able
to provide guarantees that transactions are only included as part of an atomic
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ sidebar_position: 1

# Architecture Overview

:::tip
To deploy your own rollup on the Astria Dusknet, check out the
[instructions here](/docs/local-rollup/introduction/)!
:::
import DeploymentsRedirect from '../../components/_deployment-instructions-redirect.mdx';

<DeploymentsRedirect />

At a high level, Astria breaks out all of the components that are historically
combined together in monolithic blockchains into individual components. This
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ sidebar_position: 2

# Transaction Flow

:::tip
To deploy your own rollup on the Astria Dusknet, check out the
[instructions here](/docs/local-rollup/introduction/)!
:::
import DeploymentsRedirect from '../../components/_deployment-instructions-redirect.mdx';

<DeploymentsRedirect />

The full transaction flow through the Astria stack is as follows:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,16 @@ sidebar_position: 3

# Rollups

:::tip
To deploy your own rollup on the Astria Dusknet, check out the
[instructions here](/docs/local-rollup/introduction/)!
:::
import DeploymentsRedirect from '../../components/_deployment-instructions-redirect.mdx';

<DeploymentsRedirect />

Astria is designed for permissionless rollup integration and takes advantage of [lazy](https://en.wikipedia.org/wiki/Lazy_evaluation?ref=blog.astria.org) shared sequencing. This means that rollup developers have total sovereignty over their own execution state and can swap out sequencing layers without fear of being locked in. You do not need to ask for permission or go through a governance process to gain access. A rollup simply needs to satisfy the following interfaces:

Write Interface (Rollup <-> Composer):
Write Interface (Rollup to Composer):
- For transaction submissions.

Read Interface (Rollup <-> Conductor):
Read Interface (Rollup to Conductor):
- For receiving blocks from the shared sequencer network.

![Single Rollup](../assets/single-rollup.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ sidebar_position: 4

# Composer

:::tip
To deploy your own rollup on the Astria Dusknet, check out the
[instructions here](/docs/local-rollup/introduction/)!
:::
import DeploymentsRedirect from '../../components/_deployment-instructions-redirect.mdx';

<DeploymentsRedirect />

The Composer is an in-house abstraction over the potential actors in Astria's
MEV supply chain. It currently contains a naive implementations of the role a
Expand Down
Loading