Skip to content

Commit

Permalink
docs: add quicknode, xtoken guide, and update for v0.21.5+ core.port (#…
Browse files Browse the repository at this point in the history
…1890)

* docs: add quicknode

* docs: add core.port for all instances of core.ip

* chore: final changes

* docs: fix link

* style: resize blobspace.png from 30MB to 4MB

* fix: lol hide secret

* docs: add note about quickstart being self contained, link out to context

* chore: match style guide for links

* docs: coderabbit suggestions
  • Loading branch information
jcstein authored Feb 12, 2025
1 parent e5c748c commit 54e6e18
Show file tree
Hide file tree
Showing 59 changed files with 362 additions and 468 deletions.
6 changes: 3 additions & 3 deletions 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](../how-to-guides/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 All @@ -83,7 +83,7 @@ compliance screen
* Dedicated email address so that the Foundation can reach you in the event
of emergency upgrades and fixes
* Maintain a fully archival (non-pruned) bridge node for both Mainnet Beta and Mocha if selected for the program
* Not running your infrastructure in Hetzner or OVH
* Not running your infrastructure in Hetzner or OVH

Not adhering to any of the criteria above will automatically disqualify your
application, and violating any of the criteria after you have received
Expand All @@ -109,7 +109,7 @@ dashboards
* Getting jailed more than once during the cohort’s applicable delegation
period
* Violating the
[Celestia.org Community Code of Conduct](../community/coc.md)
[Celestia.org Community Code of Conduct](/community/coc.md)
or engaging in harmful activities towards the network
* Failing to upgrade your node in a timely manner (24 hours or less)
* If necessary to protect or secure Mainnet Beta or to comply with applicable
Expand Down
2 changes: 1 addition & 1 deletion community/modular-meetup-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ an exceptional Celestia Modular Meetup.
rollups, data availability, or other topics relevant to the
Modular ecosystem. This will help you find speakers with
expertise in the chosen subject.
2. Utilize the [Speaker List](./speaker-list.md) provided by the Modular Meetup program
2. Utilize the [Speaker List](/community/speaker-list.md) provided by the Modular Meetup program
- As a meetup organizer, you have access to a curated
list of talented speakers from Celestia Labs and the
broader Modular ecosystem. This valuable resource can
Expand Down
8 changes: 4 additions & 4 deletions community/modular-meetup-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Code of Conduct. Organizers will respectfully enforce this code
throughout the event. We genuinely appreciate the cooperation of all
participants in maintaining a safe and empowering space for everyone.

- [Celestia.org Community Code of Conduct](./coc.md)
- [Celestia.org Community Code of Conduct](/community/coc.md)

### Signup form

Expand Down Expand Up @@ -81,6 +81,6 @@ companion in organizing events. Drawing upon the wisdom of seasoned event
organizers, this resource is available for you and your co-organizers
to explore and learn.

- [Meetup Guide](./modular-meetup-guide.md)
- [Modular Meetup Toolkit](./modular-meetup-toolkit.md)
- [Speaker List](./speaker-list.md)
- [Meetup Guide](/community/modular-meetup-guide.md)
- [Modular Meetup Toolkit](/community/modular-meetup-toolkit.md)
- [Speaker List](/community/speaker-list.md)
21 changes: 9 additions & 12 deletions how-to-guides/arabica-devnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ the latest upgrades for testing their rollups and applications.
Arabica does not focus on validator or consensus-level testing, rather,
that is what Mocha testnet is used for. If you are a validator, we
recommend testing your validator operations on the
[Mocha testnet](./mocha-testnet.md).
[Mocha testnet](/how-to/mocha-testnet.md).

## Network stability and upgrades

Expand All @@ -28,12 +28,7 @@ undergoes network upgrades in coordination with validators.

## Network details

<!-- markdownlint-disable MD033 -->
<script setup>
import ArabicaVersionTags from '../.vitepress/components/ArabicaVersionTags.vue'
import ArabicaDevnetDetails from '../.vitepress/components/ArabicaDevnetDetails.vue'
import constants from "/.vitepress/constants/constants.js";
</script>


<ArabicaDevnetDetails />

Expand Down Expand Up @@ -74,6 +69,7 @@ your own node.

RPC endpoints and types of nodes you can run in order to participate in Arabica devnet:


<!-- markdownlint-disable MD013 -->

| Node type | Endpoint type | Endpoint |
Expand All @@ -88,7 +84,7 @@ RPC endpoints and types of nodes you can run in order to participate in Arabica
| | | `validator-4.celestia-arabica-11.com` |
| | | |
| **Data availability nodes** | DA Bridge Node Endpoints | `/dns4/da-bridge-1.celestia-arabica-11.com/tcp/2121/p2p/12D3KooWGqwzdEqM54Dce6LXzfFr97Bnhvm6rN7KM7MFwdomfm4S` |
| ([light](./light-node.md), [bridge](./bridge-node.md), [full](./full-storage-node.md)) | | `/dns4/da-bridge-2.celestia-arabica-11.com/tcp/2121/p2p/12D3KooWCMGM5eZWVfCN9ZLAViGfLUWAfXP5pCm78NFKb9jpBtua` |
| ([light](/how-to-guides/light-node.md), [bridge](/how-to-guides/bridge-node.md), [full](/how-to-guides/full-storage-node.md)) | | `/dns4/da-bridge-2.celestia-arabica-11.com/tcp/2121/p2p/12D3KooWCMGM5eZWVfCN9ZLAViGfLUWAfXP5pCm78NFKb9jpBtua` |
| | | `/dns4/da-bridge-3.celestia-arabica-11.com/tcp/2121/p2p/12D3KooWEWuqrjULANpukDFGVoHW3RoeUU53Ec9t9v5cwW3MkVdQ` |
| | | `/dns4/da-bridge-4.celestia-arabica-11.com/tcp/2121/p2p/12D3KooWLT1ysSrD7XWSBjh7tU1HQanF5M64dHV6AuM6cYEJxMPk` |
| | `--core.ip string` endpoints | Refer to "Direct endpoints with open ports" above |
Expand Down Expand Up @@ -117,7 +113,7 @@ to their respective DA node.
:::tip EXAMPLE

```bash
celestia <da_type> start --core.ip <url> --core.grpc.port <port>
celestia <da_type> start --core.ip <url> --core.port <port>
```

:::
Expand All @@ -131,7 +127,8 @@ state access, using default ports:

```bash
celestia light start --p2p.network arabica \
--core.ip validator-1.celestia-arabica-11.com
--core.ip validator-1.celestia-arabica-11.com \
--core.port 9090
```

:::tip Bridge node runners
Expand Down Expand Up @@ -180,5 +177,5 @@ There are multiple explorers you can use for Arabica:
Join our [Telegram announcement channel](https://t.me/+smSFIA7XXLU4MjJh)
for network upgrades.

See the [network upgrade process page](./network-upgrade-process.md) to learn more
about specific upgrades like the [Ginger network upgrade](./network-upgrade-process.md#ginger-network-upgrade).
See the [network upgrade process page](/how-to-guides/network-upgrade-process.md) to learn more
about specific upgrades like the [Ginger network upgrade](/how-to-guides/network-upgrade-process.md#ginger-network-upgrade).
23 changes: 12 additions & 11 deletions how-to-guides/arbitrum-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Celestia's Mocha testnet.


If you're looking to learn more about the integration of Celestia and Orbit,
read the [Arbitrum Orbit integration overview](./arbitrum-integration.md). If you're
read the [Arbitrum Orbit integration overview](/how-to-guides/arbitrum-integration.md). If you're
looking to learn more about Orbit, read
[A gentle introduction: Orbit chains](https://docs.arbitrum.io/launch-orbit-chain/orbit-gentle-introduction).

Expand All @@ -30,13 +30,13 @@ and [the original deployment guide](https://docs.arbitrum.io/launch-orbit-chain/

- Familiarity with Ethereum, Ethereum's testnets, Arbitrum, and Celestia
- [A gentle introduction: Orbit chains](https://docs.arbitrum.io/launch-orbit-chain/orbit-gentle-introduction)
- [Arbitrum Orbit integration overview](./arbitrum-integration.md)
- [Arbitrum Orbit integration overview](/how-to-guides/arbitrum-integration.md)
- [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](../how-to-guides/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](../how-to-guides/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 @@ -189,13 +189,13 @@ connection, since an HTTP one will not support subscriptions. This RPC URL is di
from the `parent-chain.connection.url` object used in the node config, and is
not necessary when running a full node. WebSocket (WSS) URLs which are
essential for real-time data fetching and interaction with the
Arbitrum Sepolia network.
Arbitrum Sepolia network.

To establish a WebSocket connection for your rollup to Arbitrum Sepolia, it's
recommended to
[find an RPC provider with WSS connections from Arbitrum's docs](https://docs.arbitrum.io/build-decentralized-apps/reference/node-providers).

For this example, we will make an account on Alchemy. Follow these steps to set up your account and obtain a WSS URL using Alchemy:
For this example, we will make an account on Alchemy. Follow these steps to set up your account and obtain a WSS URL using Alchemy:

1. Visit [Alchemy's website](https://www.alchemy.com/) and sign up for an account.
2. Once logged in, create a new app by selecting the Arbitrum network, specifically
Expand All @@ -205,7 +205,7 @@ targeting the Arbitrum Sepolia testnet.
4. In the next step, use this WSS URL in your `nodeConfig.json` under the
`celestia-cfg.eth-rpc` object to ensure your node can establish a
WebSocket connection to the Arbitrum Sepolia network
and successfully subscribe to Blobstream events.
and successfully subscribe to Blobstream events.

Without a WSS connection, the Batch Poster won't be able to subscribe to Blobstream
events, and thus will fall back to posting data to parent chain.
Expand All @@ -229,7 +229,8 @@ extra_hosts:
:::
```bash
celestia light start --p2p.network mocha --core.ip <RPC_URL>
celestia light start --p2p.network mocha --core.ip <RPC_URL> \
--core.port 9090
```

To set your light node's auth token, you will use the auth
Expand Down Expand Up @@ -398,8 +399,8 @@ about your chain,
including the addresses of your chain's base contracts.

In the next guides, learn how to
[run a full and validating full node](./arbitrum-full-node.md)
or [bridge in and out of your rollup](./arbitrum-bridge.md).
[run a full and validating full node](/how-to-guides/arbitrum-full-node.md)
or [bridge in and out of your rollup](/how-to-guides/arbitrum-bridge.md).

## Appendix

Expand All @@ -412,7 +413,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](../how-to-guides/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](https://github.com/celestiaorg/nitro-contracts/releases/tag/v1.2.1) | 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
4 changes: 2 additions & 2 deletions how-to-guides/arbitrum-full-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ description: A guide on how to run a full node or validate a full node on your O

- Familiarity with Ethereum, Ethereum's testnets, Arbitrum, and Celestia
- [A gentle introduction: Orbit chains](https://docs.arbitrum.io/launch-orbit-chain/orbit-gentle-introduction)
- [Arbitrum Orbit integration overview](./arbitrum-integration.md)
- [Quickstart: Deploy an Arbitrum Orbit rollup](./arbitrum-deploy.md)
- [Arbitrum Orbit integration overview](/how-to-guides/arbitrum-integration.md)
- [Quickstart: Deploy an Arbitrum Orbit rollup](/how-to-guides/arbitrum-deploy.md)

## Running a full node

Expand Down
8 changes: 4 additions & 4 deletions how-to-guides/arbitrum-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,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](../how-to-guides/mocha-testnet.md#community-rpc-endpoints)
[find a list of them for Mocha](/how-to-guides/mocha-testnet.md#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 All @@ -73,7 +73,7 @@ Finally, the integration only accepts batches with information that can be confi
You can see how BlobstreamX is integrated into the `SequencerInbox.sol` contract [here](https://github.com/celestiaorg/nitro-contracts/blob/celestia-v1.2.1/src/bridge/SequencerInbox.sol#L584-L630), which allows us to discard batches with otherwise faulty data roots, thus giving us a high degree of confidence that the data root can be safely unpacked in case of a challenge.

The Celestia and Arbitrum integration also
[includes Blobstream](./blobstream.md),
[includes Blobstream](/how-to-guides/blobstream.md),
which relays commitments to Celestia’s data root to an onchain light client
on Ethereum. This allows L2 solutions that settle on Ethereum to benefit
from the scalability Celestia’s data availability layer can provide.
Expand All @@ -89,7 +89,7 @@ fails.
The [@celestiaorg/nitro](https://github.com/celestiaorg/nitro) integration
[uses the same fallback mechanism](https://github.com/celestiaorg/nitro/blob/f01968eb3d4e19329e9c92b050e98a8e5772f1f2/arbnode/batch_poster.go#L845-L857).

[More information can be found on the Ethereum fallback mechanisms for Celestia](./ethereum-fallback.md),
[More information can be found on the Ethereum fallback mechanisms for Celestia](/how-to-guides/ethereum-fallback.md),
which enables Ethereum L2s (or L3s) to “fall back” to using Ethereum
calldata for data availability in the event of downtime on Celestia Mainnet
Beta.
Expand All @@ -104,4 +104,4 @@ chain.
## Next steps

In the next page,
[learn how to deploy an Arbitrum rollup devnet using Celestia as DA](./arbitrum-deploy.md).
[learn how to deploy an Arbitrum rollup devnet using Celestia as DA](/how-to-guides/arbitrum-deploy.md).
8 changes: 4 additions & 4 deletions how-to-guides/blobstream-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Make sure to have the following installed:
### Installing Blobstream contracts

We will be using the [`IDAOracle`](https://github.com/celestiaorg/blobstream-contracts/blob/master/src/IDAOracle.sol)
interface to verify inclusion.
interface to verify inclusion.
So, we will install the Blobstream contracts repo as a dependency:

```sh
Expand All @@ -28,7 +28,7 @@ forge install celestiaorg/blobstream-contracts --no-commit

Make sure that the directory you're running this command
from is an initialized git repository. If not, just
initialize the repo using:
initialize the repo using:

```sh
git init
Expand Down Expand Up @@ -115,7 +115,7 @@ header is included in the Celestia chain.
## Querying the proof

To prove that the data was published to Celestia, check out the
[proof queries documentation](./blobstream-proof-queries.md)
[proof queries documentation](/how-to-guides/blobstream-proof-queries.md)
to understand how to query the proofs from Celestia consensus
nodes and make them usable in the Blobstream X verifier contract.

Expand Down Expand Up @@ -168,4 +168,4 @@ take a closer look at these functions:
`verifySharesToDataRootTupleRoot()` method.

For an overview of a demo rollup implementation, head to
[the next section](./blobstream-offchain.md).
[the next section](/how-to-guides/blobstream-offchain.md).
2 changes: 1 addition & 1 deletion how-to-guides/blobstream-offchain.md
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](../how-to-guides/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
Loading

0 comments on commit 54e6e18

Please sign in to comment.