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

Implement diataxis #1742

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
1,551 changes: 788 additions & 763 deletions .vitepress/config.ts

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion community/foundation-delegation-program.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The minimum requirements for participation in the program are as follows:
for at least 1 month before application deadline
* Run a bridge node (on Mainnet Beta if you are already an active Mainnet Beta
validator or on Mocha testnet if not) that is connected and reporting
to the Celestia Labs [OTEL collector](../nodes/celestia-node-metrics.md)
to the Celestia Labs [OTEL collector](../how-to-guides/celestia-node-metrics.md)
(for new applicants - on testnet, so that we can evaluate performance)
* Not jailed or slashed in the 6 months before application deadline
* Not associated with an exchange or custodian
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ RPC endpoints and types of nodes you can run in order to participate in Arabica

| Node type | Endpoint type | Endpoint |
| -------------------------------------------------------------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| **Consensus nodes** ([full](../nodes/full-consensus-node.md)) | Consensus RPC | `https://rpc.celestia-arabica-11.com` |
| **Consensus nodes** ([full](../how-to-guides/consensus-node.md)) | Consensus RPC | `https://rpc.celestia-arabica-11.com` |
| | API | `https://api.celestia-arabica-11.com` |
| | gRPC | `grpc.celestia-arabica-11.com:443` |
| | Direct endpoints with open ports | Open ports: 26656 (p2p), 26657 (RPC), 1317 (API), 9090 (GRPC) |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: A guide on how to bridge in and out of your Arbitrum Orbit rollup.
next:
text: "Intro to OP Stack integration"
link: "/developers/intro-to-op-stack"
link: "/how-to-guides/intro-to-op-stack"
---

# Bridging in and out of your Orbit rollup
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ and [the original deployment guide](https://docs.arbitrum.io/launch-orbit-chain/
- [Docker](https://docs.docker.com/engine/install/ubuntu/)
running on your machine
- [Docker Compose](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-20-04)
- A fully synced and funded Mocha testnet [light node](../nodes/light-node.md)
- A fully synced and funded Mocha testnet [light node](../how-to-guides/light-node.md)
on **v0.13.2**
- [Mocha testnet faucet](../nodes/mocha-testnet.md#mocha-testnet-faucet)
- [Mocha testnet faucet](../how-to-guides/mocha-testnet.md#mocha-testnet-faucet)
- A browser-based Ethereum wallet (like [MetaMask](https://metamask.io))
- At least 1 Arbitrum Sepolia testnet ETH (for custom gas token chains,
0.6 ETH and 0.4 native tokens)
Expand Down Expand Up @@ -412,7 +412,7 @@ Extra resources in Arbitrum documentation:
<!-- markdownlint-disable MD013 -->
| Component | Version | Details |
|-----------|---------|---------|
| Nitro | [v2.3.1-rc.1](https://github.com/celestiaorg/nitro/releases/tag/v2.3.1-rc.1) | Includes the replay binary for the WASM root `0x10c65b27d5031ce2351c719072e58f3153228887f027f9f6d65300d2b5b30152`. [Read the overview for overall changes](../developers/arbitrum-integration.md). |
| Nitro | [v2.3.1-rc.1](https://github.com/celestiaorg/nitro/releases/tag/v2.3.1-rc.1) | Includes the replay binary for the WASM root `0x10c65b27d5031ce2351c719072e58f3153228887f027f9f6d65300d2b5b30152`. [Read the overview for overall changes](../how-to-guides/arbitrum-integration.md). |
| Contracts | [v1.2.1-celestia](https://github.com/celestiaorg/nitro-contracts/releases/tag/v1.2.1-celestia) | Integrates Blobstream X functionality into nitro-contracts v1.2.1 |
| Orbit SDK | [v0.8.2 Orbit SDK for Celestia DA](https://github.com/celestiaorg/arbitrum-orbit-sdk/releases/tag/v0.8.2) | This is not compatible with Orbit SDK v0.8.2 or with the latest changes to nitro-contracts for the Atlas upgrade. The Orbit SDK itself is in Alpha. |
| celestia-node | [v0.13.1](https://github.com/celestiaorg/celestia-node/releases/tag/v0.13.1) | This integration has only been tested with celestia-node 0.13.1 and only works with said version, and with future versions after that. Under the hood, the Nitro node uses [this commit](https://github.com/celestiaorg/celestia-openrpc/commit/64f04840aa97d4deb821b654b1fb59167d242bd1) of celestia-openrpc. |
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,14 @@ settles on Arbitrum One, Ethereum, or other EVM chains.

The integration of Celestia with Arbitrum orbit is possible thanks to 3 key components:

- [DA Provider implementation](#da-provider-implementation)
- [Preimage Oracle implementation](#preimage-oracle-implementation)
- [Blobstream X implementation](#blobstream-x-implementation)
- [Introduction to Arbitrum rollups with Celestia as DA](#introduction-to-arbitrum-rollups-with-celestia-as-da)
- [Overview](#overview)
- [Key components](#key-components)
- [DA provider implementation](#da-provider-implementation)
- [Preimage Oracle Implementation](#preimage-oracle-implementation)
- [Blobstream X implementation](#blobstream-x-implementation)
- [Ethereum fallback mechanism in Nitro](#ethereum-fallback-mechanism-in-nitro)
- [Next steps](#next-steps)

Additionally, the [Ethereum fallback mechanism](#ethereum-fallback-mechanism-in-nitro) is a feature of the integration, which is native in Nitro.

Expand All @@ -42,7 +47,7 @@ Then the `Read` logic takes care of taking the deserialized Blob Pointer struct

The following represents a non-exhaustive list of considerations when running a Batch Poster node for a chain with Celestia underneath:
- You will need to use a consensus node RPC endpoint, you can
[find a list of them for Mocha](../nodes/mocha-testnet#community-rpc-endpoints)
[find a list of them for Mocha](../how-to-guides/mocha-testnet#community-rpc-endpoints)
- The Batch Poster will only post a Celestia batch to the underlying chain if the height for which it posted is in a recent range in BlobstreamX and if the verification succeeds, otherwise it will discard the batch. Since it will wait until a range is relayed, it can take several minutes for a batch to be posted, but one can always make an on-chain request for the BlobstreamX contract to relay a header promptly.

The following represents a non-exhaustive list of considerations when running a Nitro node for a chain with Celestia underneath:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_label: Integrate with Blobstream contracts
description: Learn how to integrate your L2's onchain logic with Blobstream
prev:
text: "Overview of Blobstream"
link: "/developers/blobstream"
link: "/how-to-guides/blobstream"
---

# Integrate with Blobstream contracts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ to Ethereum, this would likely mean running and connecting to a full node.
More information on the RPC that is exposed by a Celestia light node can be found
[in the RPC documentation](https://node-rpc-docs.celestia.org/).
Additionally, if you need more information on how to run a light node, you can
[check out the documentation](../nodes/light-node.md).
[check out the documentation](../how-to-guides/light-node.md).

```go
// CelestiaLightNodeClient summarizes the actions that a rollup that uses
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: Learn how to query the inclusion proofs used in Blobstream

## Prerequisites

- Access to a Celestia [consensus node](../nodes/consensus-node.md)
- Access to a Celestia [consensus node](../how-to-guides/consensus-node.md)
RPC endpoint (or full node). The node doesn't need to be a
validating node in order for the proofs to be queried. A full node is enough.

Expand All @@ -32,8 +32,8 @@ used for the queries. It can be initialized using:
}(trpc)
```

The `<rpc_endpoint>` can be retrieved from [Mainnet Beta](../nodes/mainnet.md#integrations) for
and [Mocha](../nodes/mocha-testnet.md) for the Mocha testnet.
The `<rpc_endpoint>` can be retrieved from [Mainnet Beta](../how-to-guides/mainnet.md#integrations) for
and [Mocha](../how-to-guides/mocha-testnet.md) for the Mocha testnet.

In case the reader wants to interact with an on-chain contract that can be used to verify
that data was posted to Celestia, the bindings of that contract are needed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
description: Learn how to build rollups that use Blobstream.
prev:
text: "Ethereum fallback mechanism"
link: "/developers/ethereum-fallback"
link: "/how-to-guides/ethereum-fallback"
next:
text: "Submitting data blobs to Celestia"
link: "/developers/submit-data"
link: "/how-to-guides/submit-data"
---

# Introduction to Blobstream rollups
Expand Down Expand Up @@ -51,12 +51,12 @@ meaning four merkle proofs:
to prove that the subtree roots belong to a set of rows in the Celestia block
3. [row roots proofs to the data root](https://github.com/celestiaorg/celestia-app/tree/main/pkg/proof#row-root-to-data-root-inclusion-proof):
to prove that those rows belong to the Celestia Block
4. [data root tuple proof to the data root tuple](https://docs.celestia.org/developers/blobstream-proof-queries#the-commitment-scheme):
4. [data root tuple proof to the data root tuple](https://docs.celestia.org/how-to-guides/blobstream-proof-queries#the-commitment-scheme):
to prove that the Celestia block referenced by its height and data root,
was committed to by Blobstream.

More details on the blob share commitment inclusion proof can be found in the
[commitment scheme docs](https://docs.celestia.org/developers/blobstream-proof-queries#the-commitment-scheme)
[commitment scheme docs](https://docs.celestia.org/how-to-guides/blobstream-proof-queries#the-commitment-scheme)
and also the
[data square layout](https://github.com/celestiaorg/celestia-app/blob/main/specs/src/specs/data_square_layout.md#blob-share-commitment-rules).

Expand Down Expand Up @@ -178,7 +178,7 @@ For the data root, we will use a binary Merkle proof to prove its
inclusion in a data root tuple root that was committed to by the
Blobstream smart contract.
More on this in the
[data root inclusion proofs section](https://docs.celestia.org/developers/blobstream-proof-queries#_1-data-root-inclusion-proof).
[data root inclusion proofs section](https://docs.celestia.org/how-to-guides/blobstream-proof-queries#_1-data-root-inclusion-proof).

#### Sequence of spans: Proving inclusion of some data

Expand All @@ -201,7 +201,7 @@ part of the rollup data is done as follows:
root tuple root. This can be created using the
[`data_root_inclusion_proof`](https://github.com/celestiaorg/celestia-core/blob/c3ab251659f6fe0f36d10e0dbd14c29a78a85352/rpc/client/http/http.go#L492-L511)
query. More on this can be found in the
[data root inclusion proofs documentation](https://docs.celestia.org/developers/blobstream-proof-queries#_1-data-root-inclusion-proof).
[data root inclusion proofs documentation](https://docs.celestia.org/how-to-guides/blobstream-proof-queries#_1-data-root-inclusion-proof).

2. Verify inclusion proof of the data to Celestia data root:

Expand All @@ -216,7 +216,7 @@ part of the rollup data is done as follows:
query.

More details on these proofs can be found in the transaction inclusion proof
[documentation](https://docs.celestia.org/developers/blobstream-proof-queries#_2-transaction-inclusion-proof).
[documentation](https://docs.celestia.org/how-to-guides/blobstream-proof-queries#_2-transaction-inclusion-proof).
jcstein marked this conversation as resolved.
Show resolved Hide resolved

3. Prove that the data is in the sequence spans:

Expand Down Expand Up @@ -298,7 +298,7 @@ It portrays the different possible data availability proofs, constructs them and
shows how to verify them.

Also, more details on querying these kinds of proofs can be found in the
[proof queries](https://docs.celestia.org/developers/blobstream-proof-queries) documentation.
[proof queries](https://docs.celestia.org/how-to-guides/blobstream-proof-queries) documentation.

### Optimistic rollups that use blob share commitments

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
next:
text: "Celestia-node key"
link: "/developers/celestia-node-key"
link: "/tutorials/celestia-node-key"
---

# New Blobstream X deployments
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
prev:
text: "Overview of Blobstream X"
link: "/developers/blobstreamx"
link: "/how-to-guides/blobstreamx"
jcstein marked this conversation as resolved.
Show resolved Hide resolved
---

# Requesting data commitment ranges
Expand Down Expand Up @@ -54,7 +54,7 @@ to run the operator script.
Here are example values for the `.env` file:

1. `TENDERMINT_RPC_URL` from
[the public Celestia list](https://docs.celestia.org/nodes/mainnet#integrations).
[the public Celestia list](https://docs.celestia.org/how-to-guides/mainnet#integrations).
2. `SUCCINCT_RPC_URL` = `https://alpha.succinct.xyz/api`
3. Request for `SUCCINCT_API_KEY` from
[the Succinct team](https://alpha.succinct.xyz/partner).
Expand Down
12 changes: 6 additions & 6 deletions developers/blobstream.md → how-to-guides/blobstream.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,9 +153,9 @@ the following chains:

| Contract | EVM network | Contract address | Attested data on Celestia | Link to Celenium |
|----------------| ---------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------- |
| SP1 Blobstream | Ethereum Mainnet | [`0x7Cf3876F681Dbb6EdA8f6FfC45D66B996Df08fAe`](https://etherscan.io/address/0x7Cf3876F681Dbb6EdA8f6FfC45D66B996Df08fAe#events) | [Mainnet Beta](../nodes/mainnet.md) | [Deployment on Celenium](https://celenium.io/blobstream?network=ethereum&page=1) |
| SP1 Blobstream | Arbitrum One | [`0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794`](https://arbiscan.io/address/0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794#events) | [Mainnet Beta](../nodes/mainnet.md) | [Deployment on Celenium](https://celenium.io/blobstream?network=arbitrum&page=1) |
| SP1 Blobstream | Base | [`0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794`](https://basescan.org/address/0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794#events) | [Mainnet Beta](../nodes/mainnet.md) | [Deployment on Celenium](https://celenium.io/blobstream?network=base&page=1) |
| SP1 Blobstream | Sepolia | [`0xf0c6429ebab2e7dc6e05dafb61128be21f13cb1e`](https://sepolia.etherscan.io/address/0xf0c6429ebab2e7dc6e05dafb61128be21f13cb1e#events) | [Mocha testnet](../nodes/mocha-testnet.md) | [Deployment on Celenium](https://mocha-4.celenium.io/blobstream?network=ethereum&page=1) |
| SP1 Blobstream | Arbitrum Sepolia | [`0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2`](https://sepolia.arbiscan.io/address/0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2#events) | [Mocha testnet](../nodes/mocha-testnet.md) | [Deployment on Celenium](https://mocha-4.celenium.io/blobstream?network=arbitrum&page=1) |
| SP1 Blobstream | Base Sepolia | [`0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2`](https://sepolia.basescan.org/address/0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2#events) | [Mocha testnet](../nodes/mocha-testnet.md) | [Deployment on Celenium](https://mocha-4.celenium.io/blobstream?network=base&page=1) |
| SP1 Blobstream | Ethereum Mainnet | [`0x7Cf3876F681Dbb6EdA8f6FfC45D66B996Df08fAe`](https://etherscan.io/address/0x7Cf3876F681Dbb6EdA8f6FfC45D66B996Df08fAe#events) | [Mainnet Beta](../how-to-guides/mainnet.md) | [Deployment on Celenium](https://celenium.io/blobstream?network=ethereum&page=1) |
| SP1 Blobstream | Arbitrum One | [`0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794`](https://arbiscan.io/address/0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794#events) | [Mainnet Beta](../how-to-guides/mainnet.md) | [Deployment on Celenium](https://celenium.io/blobstream?network=arbitrum&page=1) |
| SP1 Blobstream | Base | [`0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794`](https://basescan.org/address/0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794#events) | [Mainnet Beta](../how-to-guides/mainnet.md) | [Deployment on Celenium](https://celenium.io/blobstream?network=base&page=1) |
| SP1 Blobstream | Sepolia | [`0xf0c6429ebab2e7dc6e05dafb61128be21f13cb1e`](https://sepolia.etherscan.io/address/0xf0c6429ebab2e7dc6e05dafb61128be21f13cb1e#events) | [Mocha testnet](../how-to-guides/mocha-testnet.md) | [Deployment on Celenium](https://mocha-4.celenium.io/blobstream?network=ethereum&page=1) |
| SP1 Blobstream | Arbitrum Sepolia | [`0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2`](https://sepolia.arbiscan.io/address/0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2#events) | [Mocha testnet](../how-to-guides/mocha-testnet.md) | [Deployment on Celenium](https://mocha-4.celenium.io/blobstream?network=arbitrum&page=1) |
| SP1 Blobstream | Base Sepolia | [`0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2`](https://sepolia.basescan.org/address/0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2#events) | [Mocha testnet](../how-to-guides/mocha-testnet.md) | [Deployment on Celenium](https://mocha-4.celenium.io/blobstream?network=base&page=1) |
4 changes: 2 additions & 2 deletions developers/blobstreamx.md → how-to-guides/blobstreamx.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
description: What is BlobstreamX
prev:
text: "New SP1 Blobstream deployments"
link: "/developers/sp1-blobstream-deploy"
link: "/how-to-guides/sp1-blobstream-deploy"
jcstein marked this conversation as resolved.
Show resolved Hide resolved
next:
text: "Requesting data commitment ranges"
link: "/developers/blobstream-x-requesting-data-commitment-ranges"
link: "/how-to-guides/blobstream-x-requesting-data-commitment-ranges"
---

# Blobstream X: the previous zk implementation of Blobstream
Expand Down
4 changes: 2 additions & 2 deletions nodes/bridge-node.md → how-to-guides/bridge-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ add the port after the IP address or use the
port if you prefer.

Refer to
[the ports section of the celestia-node troubleshooting page](../nodes/celestia-node-troubleshooting.md#ports)
[the ports section of the celestia-node troubleshooting page](../how-to-guides/celestia-node-troubleshooting.md#ports)
jcstein marked this conversation as resolved.
Show resolved Hide resolved
for information on which ports are required to be open on your machine.

Using an RPC of your own, or one from the
Expand Down Expand Up @@ -136,7 +136,7 @@ celestia bridge start --core.ip validator-1.celestia-arabica-11.com \
--p2p.network arabica
```

You can create your key for your node by [following the `cel-key` instructions](../../developers/celestia-node-key).
You can create your key for your node by [following the `cel-key` instructions](../../tutorials/celestia-node-key).

Once you start the bridge node, a wallet key will be generated for you.
You will need to fund that address with Testnet tokens to pay for
Expand Down
4 changes: 2 additions & 2 deletions developers/bubs-testnet.md → how-to-guides/bubs-testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: The first testnet built with OP Stack and Celestia.
next:
text: "Ethereum fallback mechanism"
link: "/developers/ethereum-fallback"
link: "/how-to-guides/ethereum-fallback"
---

# Bubs testnet
Expand All @@ -23,7 +23,7 @@ layer. This integration can be found in the
The testnet is hosted by [Caldera](https://caldera.xyz),
who makes it easy to launch rollups with no code required.
Bubs' data is posted to Celestia
on the [Mocha testnet](../nodes/mocha-testnet.md).
on the [Mocha testnet](../how-to-guides/mocha-testnet.md).
[View the namespace for Bubs on Celestia's Mocha testnet](https://mocha-4.celenium.io/namespace/000000000000000000000000000000000000ca1de12ad45362e77e87).

[Learn more about the setup of the integration in
Expand Down
Loading
Loading