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

docs typos + wording consistency #62

Merged
merged 4 commits into from
Jun 4, 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
4 changes: 2 additions & 2 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const { BASE: base = "/" } = process.env;
// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "Astria",
description: "The Sequencing Layer Network",
description: "The Sequencing Layer",
lastUpdated: true,
cleanUrls: true,
ignoreDeadLinks: true,
Expand Down Expand Up @@ -77,7 +77,7 @@ function sidebar() {
collapsed: true,
items: [
{
text: 'Using the Astria cli',
text: 'Using the Astria CLI',
collapsed: true,
items: [
{text: 'Install the CLI', link: '/developer/tutorials/install-the-cli.md'},
Expand Down
5 changes: 3 additions & 2 deletions docs/community/1-overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Community overview
# Community Overview

This section will highlight all the different resources and activities for the Astria community.
Reach out on [Twitter](https://x.com/AstriaOrg) or
[Discord](https://discord.gg/3qZCbmZxvF) if you would like addition help.
6 changes: 3 additions & 3 deletions docs/overview/bridging.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## Fee payments

With a sequencing layer, transaction data touches three different chains: the
With the Astria Sequencing Layer, transaction data touches three different chains: the
sequencer chain, the data availability chain, and the rollup chain. Each of
these requires a fee payment for DoS prevention. If each chain requires a
different token for fee payment, this causes a poor UX. Many rollups built on
Ethereum allow for bridged ETH to be used to pay fees, alleviating UX concerns,
Ethereum allows for bridged ETH to be used to pay fees, alleviating UX concerns,
as users only need to obtain one, widely-available token (ETH).

We can do something similar with the sequencer network. Assuming the data
Expand All @@ -17,7 +17,7 @@ derivation) method. In our case, this means bridging TIA (Celestia) to Astria
via IBC, and allowing it to be used for fee payments. Then, a rollup can
optionally choose to accept (IBC-)TIA as a token for fee payments as well.

## Rollup bridging
## Rollup Bridging

To bridge tokens to a rollup built on Astria, the rollup needs to add the
ability to derive deposit transactions from the sequencer or DA network. In
Expand Down
8 changes: 4 additions & 4 deletions docs/overview/how-rollups-work.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ over some subset of data contained in another blockchain, the L1. Bridging
to/from the L1 (by enshrining the rollup’s state transition in the L1) is
implemented by non-sovereign rollups.

## Rollup full node architecture
## Rollup Full Node Architecture

A rollup needs to perform the following:

Expand Down Expand Up @@ -37,7 +37,7 @@ However, rollup nodes may still wish to form a p2p network for two reasons: fast
confirmations, which can be received from the sequencer, or for rollup light
nodes.

## Rollup sequencers
## Rollup Sequencers

In the above section, we discussed how a rollup derives its transactions, but
how does the rollup data end up on L1?
Expand Down Expand Up @@ -65,7 +65,7 @@ the potential for transaction censorship. While there is always the “escape
hatch” by which users post their rollup transactions directly to the L1 for
inclusion on the rollup, this is a poor UX alternative.

## Decentralized sequencers
## Decentralized Sequencers

A decentralized sequencer network is an alternative to the centralized service,
where multiple sequencer nodes each have the ability to propose a batch of
Expand All @@ -89,7 +89,7 @@ network. The first is to create a native asset on the sequencer network to be
used for staking, as well as for transaction fees. The second is to use the
asset of an underlying data availability layer for staking and transaction fees.

## Sequencing Layers
## Sequencing Layer

![Rollups with a decentralized sequencing layer](./assets/rollups-with-a-decentralized-sequencer.png)

Expand Down
27 changes: 11 additions & 16 deletions docs/overview/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![Astria Architecture](./assets/astria-architecture.png)

Astria is building a decentralized sequencer network that can be shared by many rollups.
Astria is building a decentralized sequencing layer that can be shared amongst multiple rollups.

At a high level, the Astria stack performs the following functions:

Expand All @@ -11,18 +11,14 @@ At a high level, the Astria stack performs the following functions:
* allows rollup nodes to easily fetch and verify sequenced data
* batches rollup blocks and posts these batches to Celestia

The first two are mandatory, while the last is implemented more for the
developer experience, allowing rollup developers to focus only on the
rollup-specific application logic, as opposed to the other aspects such as
rollup consensus.

The first requirement (sequencing of arbitrary data for rollups) is implemented
by the Astria sequencer network, a PoS network of sequencer nodes that use
CometBFT for consensus. The sequencer network comes to consensus on the ordering
and inclusion of rollup transactions of the form (rollup_id, tx_bytes). The
rollup_id can be any arbitrary string; it’s used only by rollup nodes to
determine which data is for them. The second (making data available to rollup
nodes) is achieved by publishing the sequenced data via Celestia.
by the Astria sequencer network, a decentralized network of sequencer nodes that
use CometBFT for consensus. The sequencer network comes to consensus on the
ordering and inclusion of rollup transactions of the form `(rollup_id,
tx_bytes)`. The `rollup_id` can be any arbitrary string; it’s used only by
rollup nodes to determine which data is for them. The second (making data
available to rollup nodes) is achieved by publishing the sequenced data via
Celestia.

The third (allowing rollup nodes to easily fetch and verify sequenced data) is
achieved by the Astria “Conductor”, which works similarly to existing rollup
Expand All @@ -40,7 +36,7 @@ developers. For example, since the data is executed lazily, a rollup may choose
to have 2 rollup blocks per Astria block, or 1 rollup block per Astria block.
The rollup’s consensus and execution logic is not enshrined in the sequencer.

## What should I read?
## What Should I Read?

Want to learn more about about rollups or the sequencer? Check out the [How
Rollups Work](/overview/how-rollups-work) or [The Astria Sequencer
Expand All @@ -54,9 +50,8 @@ a local Kubernetes cluster [here](../local-rollup/1-introduction.md).

You can find our endpoints and FAQ [here](/astria-evm/overview.md)

## What If I Need More Help?
## Still Need More Help

While this documentation hopefully includes everything you need, if you can't
find what you're looking for, please reach out to us on
[Twitter](https://twitter.com/AstriaOrg) or check the [Astria
find what you're looking for, please reach out on Discord [Discord](https://discord.gg/3qZCbmZxvF) or check the [Astria
repository](https://github.com/astriaorg/astria).
6 changes: 3 additions & 3 deletions docs/overview/the-astria-sequencer-network.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# The Astria Sequencer Network
# The Astria Sequencing Layer

The Astria sequencer network uses CometBFT (formerly Tendermint) as its
consensus algorithm. At a minimum, the sequencer network needs to implement a
The Astria Sequencing Layer uses CometBFT (formerly Tendermint) as its
consensus algorithm. At a minimum, the sequencing layer needs to implement a
decentralized leader selection algorithm which rotates between proposers.
Ideally, it is also able to provide single-slot (“fast”) finality, which
prevents forks from occurring, allowing for simplified chain derivation logic on
Expand Down
Loading