Skip to content

Commit

Permalink
Merge branch 'main' into pr/1603
Browse files Browse the repository at this point in the history
  • Loading branch information
jcstein committed Nov 28, 2024
2 parents 398d9a2 + ad43f02 commit fde8c1e
Show file tree
Hide file tree
Showing 35 changed files with 617 additions and 218 deletions.
138 changes: 64 additions & 74 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,38 +25,9 @@ export default {
head: [
[
"link",
{
rel: "icon",
href: "/favicons/favicon.svg",
type: "image/svg+xml",
},
{ rel: "icon", href: "/favicons/favicon.svg", type: "image/svg+xml" },
],
// [
// "link",
// {
// rel: "icon",
// type: "image/svg+xml",
// href: "/favicons/favicon-dark.svg",
// media: "(prefers-color-scheme: dark)",
// },
// ],
[
"link",
{
rel: "icon",
href: "/favicons/favicon.png",
type: "image/png",
},
],
// [
// "link",
// {
// rel: "icon",
// type: "image/png",
// href: "/favicons/favicon-dark.png",
// media: "(prefers-color-scheme: dark)",
// },
// ],
["link", { rel: "icon", href: "/favicons/favicon.png", type: "image/png" }],
[
"link",
{
Expand All @@ -65,15 +36,6 @@ export default {
type: "image/x-icon",
},
],
// [
// "link",
// {
// rel: "icon",
// type: "image/x-icon",
// href: "/favicons/favicon-dark.ico",
// media: "(prefers-color-scheme: dark)",
// },
// ],
["meta", { name: "msapplication-TileColor", content: "#fff" }],
["meta", { name: "theme-color", content: "#fff" }],
[
Expand All @@ -84,8 +46,6 @@ export default {
"width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no",
},
],
// ['meta', { property: 'og:title', content: 'Celestia' }],
// ['meta', { property: 'og:description', content: 'The first modular blockchain network.' }],
[
"meta",
{
Expand All @@ -94,23 +54,34 @@ export default {
},
],
["meta", { httpEquiv: "Content-Language", content: "en" }],

["meta", { name: "twitter:card", content: "summary_large_image" }],
["meta", { name: "twitter:image", content: "/Celestia-og.png" }],
["meta", { name: "twitter:site", content: "@CelestiaOrg" }],
["meta", { name: "twitter:site:domain", content: "docs.celestia.org" }],
["meta", { name: "twitter:url", content: "https://docs.celestia.org" }],
[
"meta",
{
name: "twitter:site:domain",
content: "docs.celestia.org",
name: "twitter:image",
content: "https://docs.celestia.org/Celestia-og.png",
},
],
["meta", { name: "twitter:image:alt", content: "Celestia Documentation" }],

["meta", { property: "og:type", content: "website" }],
["meta", { property: "og:site_name", content: "Celestia Docs" }],
["meta", { property: "og:url", content: "https://docs.celestia.org" }],
[
"meta",
{
name: "twitter:url",
content: "https://docs.celestia.org",
property: "og:image",
content: "https://docs.celestia.org/Celestia-og.png",
},
],
["meta", { name: "og:image", content: "/Celestia-og.png" }],
["meta", { property: "og:image:width", content: "1200" }],
["meta", { property: "og:image:height", content: "630" }],
["meta", { property: "og:image:type", content: "image/png" }],

["meta", { name: "apple-mobile-web-app-title", content: "Celestia" }],
[
"script",
Expand Down Expand Up @@ -232,20 +203,26 @@ export default {
},
transformPageData(pageData) {
pageData.frontmatter.head ??= [];
pageData.frontmatter.head.push([
"meta",
{
name: "og:title",
content:
pageData.frontmatter.layout === "home"
? `Celestia Docs`
: `${pageData.title} | Celestia Docs`,
},
{
name: "og:description",
content: pageData.frontmatter.layout === `${pageData.description}`,
},
]);
pageData.frontmatter.head.push(
[
"meta",
{
property: "og:title",
content:
pageData.frontmatter.layout === "home"
? "Celestia Docs"
: `${pageData.title} | Celestia Docs`,
},
],
[
"meta",
{
property: "og:description",
content:
pageData.description || "The first modular blockchain network.",
},
],
);
},
};

Expand All @@ -255,14 +232,15 @@ function nav() {
text: "Join the network",
items: [
{ text: "Learn", link: "/learn/how-celestia-works/overview" },
{ text: "Build whatever", link: "/how-to-guides/build-whatever" },
{ text: "Node API", link: "/tutorials/node-api" },
{ text: "Discord", link: "https://discord.gg/celestiacommunity" },
{ text: "Quick start", link: "/how-to-guides/quick-start" },
{ text: "Rollup stacks", link: "/how-to-guides/rollup-stacks" },
{
text: "Quick start",
text: "Resources",
items: [
{ text: "Run a node", link: "/how-to-guides/nodes-overview" },
{ text: "Blob tutorial", link: "/tutorials/node-tutorial" },
{
text: "Celestia Improvement Proposals (CIPs)",
link: "https://cips.celestia.org/",
},
{
text: "celestia-app specs",
link: "https://celestiaorg.github.io/celestia-app/",
Expand Down Expand Up @@ -380,14 +358,20 @@ function sidebarHome() {
items: [
{
text: "Run a node",
link: "/how-to-guides/nodes-overview",
collapsed: true,
items: [
{
text: "Quick start",
link: "/how-to-guides/quick-start",
text: "Overview",
link: "/how-to-guides/nodes-overview",
},
{
text: "Getting started",
collapsed: true,
items: [
{
text: "Quick start",
link: "/how-to-guides/quick-start",
},
{
text: "Deciding which node to run",
link: "/how-to-guides/decide-node",
Expand Down Expand Up @@ -555,10 +539,13 @@ function sidebarHome() {
],
},
{
text: "Build whatever",
link: "/how-to-guides/build-whatever",
text: "Rollup stacks",
collapsed: true,
items: [
{
text: "Overview",
link: "/how-to-guides/rollup-stacks",
},
{
text: "EVM",
collapsed: true,
Expand Down Expand Up @@ -811,9 +798,12 @@ function sidebarHome() {
items: [
{
text: "Node API Tutorials",
link: "/tutorials/node-api",
collapsed: true,
items: [
{
text: "Overview",
link: "/tutorials/node-api",
},
{
text: "CLI tutorial",
link: "/tutorials/node-tutorial",
Expand Down
12 changes: 6 additions & 6 deletions .vitepress/constants/arabica_versions.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
const arabicaVersions = Object.freeze({
"app-latest-tag": "v3.0.0-arabica",
"app-latest-sha": "2507aafc20b6f405ede3def2f7439580ed092731",
"core-latest-tag": "v1.43.0-tm-v0.34.35",
"core-latest-sha": "c2c6463a79697d511650d5113738acf5861ba7d7",
"node-latest-tag": "v0.19.0-arabica",
"node-latest-sha": "cfb363cc44c81eb7964839b70d77ec2bcd5a51bd",
"app-latest-tag": "v3.0.1-arabica",
"app-latest-sha": "dbd27087fadd80171e65c30aef776bc5895cb8da",
"core-latest-tag": "v1.44.0-tm-v0.34.35",
"core-latest-sha": "a1268f7ae3e688144a613c8a439dd31818aae07d",
"node-latest-tag": "v0.20.4-arabica",
"node-latest-sha": "51b79431533576a5cddf1235bdf3751e4c014212",
});
export default arabicaVersions;
12 changes: 6 additions & 6 deletions .vitepress/constants/mainnet_versions.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
const mainnetVersions = Object.freeze({
"app-latest-tag": "v2.1.2",
"app-latest-sha": "48173df3dc78f9348eedb3796f29ef9e9e5dc584",
"core-latest-tag": "v1.41.0-tm-v0.34.29",
"core-latest-sha": "aef322775c75783488b439cdf7ca33f38da08426",
"node-latest-tag": "v0.16.0",
"node-latest-sha": "6744f648649ebb5fee1b27faf7aca96ecf4519b2",
"app-latest-tag": "v2.3.1",
"app-latest-sha": "06f24f5dbe48c29964e1d8cfb030cffd90797ded",
"core-latest-tag": "v1.44.0-tm-v0.34.35",
"core-latest-sha": "a1268f7ae3e688144a613c8a439dd31818aae07d",
"node-latest-tag": "v0.20.4",
"node-latest-sha": "51b79431533576a5cddf1235bdf3751e4c014212",
});
export default mainnetVersions;
12 changes: 6 additions & 6 deletions .vitepress/constants/mocha_versions.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
const mochaVersions = Object.freeze({
"app-latest-tag": "v2.3.0-mocha",
"app-latest-sha": "17a756a20c5b96cc9c5e72fa09a7c0c33cb19f7b",
"core-latest-tag": "v1.40.1-tm-v0.34.29-rc0",
"core-latest-sha": "0d2b63836d0f4587e162bfded58f53fba238e69c",
"node-latest-tag": "v0.18.3-mocha",
"node-latest-sha": "395ba5fbfd1cd7f35ae3c13cf78902612b22c64f",
"app-latest-tag": "v3.0.1-mocha",
"app-latest-sha": "dbd27087fadd80171e65c30aef776bc5895cb8da",
"core-latest-tag": "v1.43.0-tm-v0.34.35",
"core-latest-sha": "c2c6463a79697d511650d5113738acf5861ba7d7",
"node-latest-tag": "v0.20.4-mocha",
"node-latest-sha": "51b79431533576a5cddf1235bdf3751e4c014212",
});
export default mochaVersions;
2 changes: 1 addition & 1 deletion community/foundation-delegation-program.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ process will work for Cohort 1 and what that means for future cohorts.

* Initial Cohort (Cohort 1): 50 applicants will be accepted
* Grading System: Applicants in Cohort 1 are divided into first, second,
and third place based eligibility criteria outlined in this document.
and third place based on eligibility criteria outlined in this document.
* Delegation Duration: This varies based on the applicant’s placement in
Cohort 1. First place receives 12 months of delegation, second place receives
8 months, third place receives 4 months.
Expand Down
2 changes: 1 addition & 1 deletion how-to-guides/arabica-devnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ it is a useful way to keep testing the latest changes in the software.

Developers can still deploy on Mocha testnet their sovereign rollups if they
chose to do so, it just will always lag behind Arabica devnet until Mocha
undergoes network upgrades upgrades in coordination with validators.
undergoes network upgrades in coordination with validators.

## Network details

Expand Down
4 changes: 2 additions & 2 deletions how-to-guides/arbitrum-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,14 @@ The following represents a non-exhaustive list of considerations when running a

### Preimage Oracle Implementation

In order to support fraud proofs, this integration has the necessary code for a Nitro validator to populate its preimage mapping with Celestia hashes that then get "unpealed" in order to reveal the full data for a Blob. You can
In order to support fraud proofs, this integration has the necessary code for a Nitro validator to populate its preimage mapping with Celestia hashes that then get "unpeeled" in order to reveal the full data for a Blob. You can
[read more about the "Hash Oracle Trick"](https://docs.arbitrum.io/inside-arbitrum-nitro/#readpreimage-and-the-hash-oracle-trick).

The data structures and hashing functions for this can be found in the [`nitro/das/celestia/tree` folder](https://github.com/celestiaorg/nitro/tree/v2.3.1-rc.1/das/celestia/tree)

You can see where the preimage oracle gets used in the fraud proof replay binary [here](https://github.com/celestiaorg/nitro/blob/966e631f1a03b49d49f25bea67a92b275d3bacb9/cmd/replay/main.go#L153-L294)

Something important to note is that the preimage oracle only keeps track of hashes for the rows in the Celestia data square in which a blob resides in, this way each Orbit chain with Celestia underneath does not need validators to recompute an entire Celestia Data Square, but instead, only have to compute the row roots for the rows in which it's data lives in, and the header data root, which is the binary merkle tree hash built using the row roots and column roots fetched from a Celestia node. Because only data roots that can be confirmed on Blobstream get accepted into the sequencer inbox, one can have a high degree of certainty that the canonical data root being unpealed as well as the row roots are in fact correct.
Something important to note is that the preimage oracle only keeps track of hashes for the rows in the Celestia data square in which a blob resides in, this way each Orbit chain with Celestia underneath does not need validators to recompute an entire Celestia Data Square, but instead, only have to compute the row roots for the rows in which it's data lives in, and the header data root, which is the binary merkle tree hash built using the row roots and column roots fetched from a Celestia node. Because only data roots that can be confirmed on Blobstream get accepted into the sequencer inbox, one can have a high degree of certainty that the canonical data root being unpeeled as well as the row roots are in fact correct.

### Blobstream X implementation

Expand Down
2 changes: 1 addition & 1 deletion how-to-guides/blobstream-offchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ func (s *Sequencer) ProduceBlock(txs []json.RawMessage) (Block, error) {
header := Header{
Height: uint64(len(s.Blocks) + 1),
PreviousHash: lastBlock.Header.Hash(),
Namespce: s.Namespace,
Namespace: s.Namespace,
Span: span,
}

Expand Down
4 changes: 2 additions & 2 deletions how-to-guides/blobstream-x-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Assume we're deploying to a chain which chainID is 12345. The `.env` should look
CREATE2_SALT=
# The 'owner' of the contracts, recommended to be an EOA
GUARDIAN=
# The default prover to fullfill requests for Functions that have not opted for a different prover
# The default prover to fulfill requests for Functions that have not opted for a different prover
PROVER=
# RPC URLs for each chain you want to deploy to
RPC_12345=
Expand Down Expand Up @@ -162,7 +162,7 @@ which will return the address of the function verifier that was deployed in the

Now that the function verifier's contract is deployed and registered in the succinct gateway, we can define whitelisting rules for the proof submission.

by default, the whitelist status is set to `Default`. This means that only the default verifier, which was setup when [deploying the SuccinctGateway](#deploy-a-new-succinctgateway). And if you want to restrict the list of provers that can submit proofs to your registered function verifier, you can set the whitelisting status of the function verifier and then add a custom prover. Or even allow for permissionlss submission.
by default, the whitelist status is set to `Default`. This means that only the default verifier, which was setup when [deploying the SuccinctGateway](#deploy-a-new-succinctgateway). And if you want to restrict the list of provers that can submit proofs to your registered function verifier, you can set the whitelisting status of the function verifier and then add a custom prover. Or even allow for permissionless submission.

#### Set Whitelist Status

Expand Down
2 changes: 1 addition & 1 deletion how-to-guides/celestia-app-vesting.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Home directory: /var/folders/_8/ljj6hspn0kn09qf9fy8kdyh40000gn/T/celestia_app_XX
--> Updating go.mod
```

And set the location as the `CElESTIA_APP_HOME` variable. We will use this
And set the location as the `CELESTIA_APP_HOME` variable. We will use this
for the remainder of the devnet section.

```bash
Expand Down
3 changes: 3 additions & 0 deletions how-to-guides/celestia-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ This tutorial will guide you through installing celestia-app, both
[from source](#building-binary-from-source) and with
[a pre-built binary](#installing-a-pre-built-binary)

Celestia-app is the software that allows you to run
validator nodes and provide RPC endpoints.

## Building binary from source

This section of the tutorial presumes you completed the steps in
Expand Down
14 changes: 12 additions & 2 deletions how-to-guides/celestia-node-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ availability instance. This tutorial will focus on running metrics for a light n

This tutorial assumes you have already setup your light node
by following the tutorial in the
[celestia-node API tutorial](./tutorials/node-tutorial.md).
[celestia-node API tutorial](../tutorials/node-tutorial.md).

## Running metrics flags

Expand Down Expand Up @@ -48,10 +48,20 @@ Here is an example for Mocha testnet:

```sh
celestia <node-type> start --metrics.tls=true \
--metrics --metrics.endpoint otel.celestia-mocha.com \
--metrics --metrics.endpoint otel.mocha.celestia.observer \
--core.ip <URI> --p2p.network mocha
```

### Arabica devnet

Here is an example for Arabica devnet:

```sh
celestia <node-type> start --metrics.tls=true \
--metrics --metrics.endpoint otel.arabica.celestia.observer \
--core.ip <URI> --p2p.network arabica
```

### TLS connections

The `--metrics.tls` flag enables or disables a TLS connection to the
Expand Down
Loading

0 comments on commit fde8c1e

Please sign in to comment.