From f4fe4292f401b3a1896ff3148b848bc474e5e735 Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Wed, 27 Sep 2023 14:51:23 -0400 Subject: [PATCH 01/14] chore: change links on calendar.md --- docs/community/calendar.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/community/calendar.md b/docs/community/calendar.md index 740306a34a5..ded15414f97 100644 --- a/docs/community/calendar.md +++ b/docs/community/calendar.md @@ -8,6 +8,8 @@ description: Find all the different community call events happening in Celestia' The Celestia community calendar is available for finding all the different community call events happening in Celestia's community. -You can add the community calendar to your personal calendar [here](https://calendar.google.com/calendar/u/0?cid=Y19za2JzbjIzNWszYmlzdHNoZ3RvNmw5ODYyNEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t). +[Add the community calendar to your personal calendar](https://calendar.google.com/calendar/u/0?cid=Y19za2JzbjIzNWszYmlzdHNoZ3RvNmw5ODYyNEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t) +to stay updated with all the events. -You can see past community call agendas, notes, and recordings [here](https://github.com/celestiaorg/community-calls/blob/main/README.md). +Explore [past community call agendas, notes, and recordings](https://github.com/celestiaorg/community-calls/blob/main/README.md) +for more insights. From fe089005ee5d6e24d60de0ebf81220aa7a69bb4f Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Wed, 27 Sep 2023 15:35:55 -0400 Subject: [PATCH 02/14] chore: edit modular meetup links --- docs/community/modular-meetup-guide.md | 4 ++-- docs/community/modular-meetup-intro.md | 4 ++-- docs/community/modular-meetup-toolkit.md | 13 +++++++------ 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/community/modular-meetup-guide.md b/docs/community/modular-meetup-guide.md index 384852c35e2..9d7d358b70f 100644 --- a/docs/community/modular-meetup-guide.md +++ b/docs/community/modular-meetup-guide.md @@ -343,7 +343,7 @@ those who cannot attend in person and expand the reach of your event. after the event. This helps attendees revisit the content and allows those who couldn't attend to learn from the talks. -### Utilizing [Meetup.com](http://Meetup.com) platform +### Utilizing Meetup.com platform Celestia Labs is committed to supporting your meetup efforts by helping you with meetup.com, from setting up the group to covering organizer dues. @@ -357,7 +357,7 @@ Below is a detailed overview of how Celestia Labs can assist you. - If you already have a meetup.com group but need Celestia Labs' assistance with organizing or covering dues, email [meetups@celestia.org](mailto:meetups@celestia.org) to add one of their employees as the Organizer. -3. Setting up groups on Meetup.com +3. Setting up groups on [Meetup.com](https://meetup.com) - Celestia Labs will help you set up your meetup group, including logos, naming, custom URLs, group description, and other essential details. They provide a unique logo for Celestia Modular Meetups, diff --git a/docs/community/modular-meetup-intro.md b/docs/community/modular-meetup-intro.md index 40ddfe25924..4ff5dd9fd61 100644 --- a/docs/community/modular-meetup-intro.md +++ b/docs/community/modular-meetup-intro.md @@ -41,7 +41,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](https://docs.celestia.org/community/coc/) +- [Celestia.org Community Code of Conduct](../../community/coc/) ### Emails @@ -58,7 +58,7 @@ Your active participation is key to unlocking the full potential of this vibrant community. Our primary communication tool is Discord, providing an engaging platform to connect with fellow organizers: -- [Discord link](https://discord.com/invite/je7UVpDuDu) +- [Discord](https://discord.com/invite/je7UVpDuDu) Make sure to join the channel #meetups where we will be also giving you the relevant role as a Meetup Organizer. diff --git a/docs/community/modular-meetup-toolkit.md b/docs/community/modular-meetup-toolkit.md index 8f7b48a5edc..ae47ea94bfc 100644 --- a/docs/community/modular-meetup-toolkit.md +++ b/docs/community/modular-meetup-toolkit.md @@ -13,12 +13,12 @@ help you plan and execute your meetups effectively. ## Celestia branding guidelines -- [BrandKit](https://company-223625.frontify.com/d/JoSwaZS4Mjpj/guidelines) +- [Brand kit](https://company-223625.frontify.com/d/JoSwaZS4Mjpj/guidelines) 1. Includes logo files, color schemes, typography, icons and illustrations ## Sample “Introduction to Modularity” workshop presentation -- [Link](https://docs.google.com/presentation/d/1R4bkWgU2nql1chwVwND4seREHbKzugl0-Xr88w3QdIQ/edit#slide=id.g1b629412475_0_0) +- [Sample presentation - introduction to modularity](https://docs.google.com/presentation/d/1R4bkWgU2nql1chwVwND4seREHbKzugl0-Xr88w3QdIQ/edit#slide=id.g1b629412475_0_0) - Summary: This is an overview presentation on Modular blockchains and dives deep into Celestia core technologies. - The sample presentation covers: @@ -31,7 +31,7 @@ help you plan and execute your meetups effectively. ## Sample “Run a Celestia light node” workshop presentation -- [Link](https://docs.google.com/presentation/d/1fV7OYUdW4kafkZcgHwFenFWDbSIwkk0R6BnSKrAV-Hc/edit#slide=id.g20713cce7c2_1_0) +- [Sample presentation - run a light node](https://docs.google.com/presentation/d/1fV7OYUdW4kafkZcgHwFenFWDbSIwkk0R6BnSKrAV-Hc/edit#slide=id.g20713cce7c2_1_0) - Summary: This is an overview presentation goes over running a Celestia light node. You can find existing video presentations for this here: @@ -46,7 +46,7 @@ help you plan and execute your meetups effectively. ## Sample “Deploy a Sovereign Rollup” workshop presentation -- [Link](https://docs.google.com/presentation/d/163yP8lQ28k-xfL3jcdX2cfO-3zg8e63AOuHeHxde3vk/edit#slide=id.g20713cce7c2_1_596) +- [Sample presentation - deploy a sovereign rollup](https://docs.google.com/presentation/d/163yP8lQ28k-xfL3jcdX2cfO-3zg8e63AOuHeHxde3vk/edit#slide=id.g20713cce7c2_1_596) - Summary: This is an overview presentation on deploying a sovereign rollup with Rollkit on Celestia. You can find existing video presentations for this here: @@ -59,7 +59,7 @@ help you plan and execute your meetups effectively. ## Sample “Modular Meetup Introduction” workshop presentation -- [Link to the Presentation](https://docs.google.com/presentation/d/1HIOKwnCRylofo4sp5I93hsfY3DKWbmXxfvMdoiIk-3I/edit?usp=sharing) +- [Sample presentation - modular meetup introduction](https://docs.google.com/presentation/d/1HIOKwnCRylofo4sp5I93hsfY3DKWbmXxfvMdoiIk-3I/edit?usp=sharing) - The sample presentation covers: 1. Introduction to Celestia and modular blockchains 2. Introduction to the Modular Meetup Program @@ -71,7 +71,8 @@ help you plan and execute your meetups effectively. ## Swag logistics - Merchandise support - 1. For merchandise support for your meetup, please email natnet@celestia.org + 1. For merchandise support for your meetup, please email + [natnet@celestia.org](mailto:natnet@celestia.org) With this Modular Meetups Organizer Kit, you’ll have everything you need to plan and execute engaging, informative, and successful From 0df19e91b2a54f755cf5350aef3dc4465a2c14f2 Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Wed, 27 Sep 2023 15:54:09 -0400 Subject: [PATCH 03/14] chore: change link text in translations.md --- docs/community/translations.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/community/translations.md b/docs/community/translations.md index 72fd278643f..695c2bb7b0e 100644 --- a/docs/community/translations.md +++ b/docs/community/translations.md @@ -10,14 +10,14 @@ to translating the documentation page, then this is the guide for you. ## Visit our Crowdin project -To get started, go to the Crowdin -project [here](https://crowdin.com/project/celestia-docs). +To get started, visit the +[Celestia Docs Crowdin project](https://crowdin.com/project/celestia-docs). You will have to create an account and then you will be able to join the project in order to begin your translation journey. -If you don't see your language, feel free to ask for it on -the `#translations` channel on Discord [here](https://discord.gg/celestiacommunity). +If your language isn't listed, request it on the +[`#translations` channel on our Discord server](https://discord.gg/celestiacommunity). On Crowdin you can translate, comment on translations, and also give upvotes and downvotes to existing translations. @@ -30,7 +30,9 @@ Here are few tips to help you during your translation. ### Crowdin documentation -Official Crowdin's documentation is available [here](https://support.crowdin.com/online-editor). +You can reference the +[official Crowdin documentation](https://support.crowdin.com/online-editor) +for more detailed guidance. ### Guide From a13a25154856d39dabdeffc5f98c846554abc696 Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Wed, 27 Sep 2023 16:27:40 -0400 Subject: [PATCH 04/14] chore: update bubs-testnet.md --- docs/developers/bubs-testnet.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/developers/bubs-testnet.md b/docs/developers/bubs-testnet.md index ca0777c718f..3e106d0f0a3 100644 --- a/docs/developers/bubs-testnet.md +++ b/docs/developers/bubs-testnet.md @@ -16,10 +16,10 @@ an EVM-compatible execution layer to deploy their EVM applications on. The Bubs Testnet is a testnet rollup, a modified version of `optimism-bedrock` that uses Celestia as a data availability (DA) -layer. This integration can be found in this -[repository](https://github.com/celestiaorg/optimism). The testnet -is hosted by [Caldera](https://caldera.xyz), who makes it easy to launch -rollups with no code required. +layer. This integration can be found in the +[@celestiaorg/optimism repository](https://github.com/celestiaorg/optimism). +The testnet is hosted by [Caldera](https://caldera.xyz), +who makes it easy to launch rollups with no code required. In this setup, data handling is accomplished in two ways. Firstly, data is written to the DA layer, in this case, Celestia From 40a483910a2173d98fd10bce755543fd6d1a1ee2 Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Wed, 27 Sep 2023 16:30:27 -0400 Subject: [PATCH 05/14] chore: update link on build-modular.md --- docs/developers/build-modular.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developers/build-modular.md b/docs/developers/build-modular.md index 9439fb1cdb6..2db6f1161a5 100644 --- a/docs/developers/build-modular.md +++ b/docs/developers/build-modular.md @@ -11,7 +11,7 @@ are for me!” You’ve come to the right place. This page will give you the rundown on modular blockchains and their benefits for developers like you. -If you already know all this, [skip to the end](https://docs.celestia.org/developers/build-modular/#building-on-celestia) +If you already know all this, [skip to the end](#building-on-celestia) to get straight into building. ## What is a modular blockchain? From 9497f6aff49752f18a7a771e9d2f42ac6b278110 Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Wed, 27 Sep 2023 16:48:15 -0400 Subject: [PATCH 06/14] chore: no click here in celestia-app-vesting.md --- docs/developers/celestia-app-vesting.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/developers/celestia-app-vesting.md b/docs/developers/celestia-app-vesting.md index cab79121ee6..8850e25ba24 100644 --- a/docs/developers/celestia-app-vesting.md +++ b/docs/developers/celestia-app-vesting.md @@ -18,7 +18,7 @@ flag to your vesting transaction. ## Local devnet -First, download and [install Celestia App](../../nodes/celestia-app), +First, [download and install Celestia App](../../nodes/celestia-app), selecting the [network and corresponding version](../../nodes/participate) that you would like to use. @@ -312,8 +312,8 @@ account on a local devnet. In this portion of the tutorial, we'll cover how to set up a consensus full node and set up a vesting account on [Mocha Testnet](../../nodes/mocha-testnet). -First, be sure that you have installed Celestia App for the latest -version for Mocha Testnet on this [page](../../nodes/celestia-app). +First, be sure that you have +[installed Celestia App for the latest version for Mocha Testnet](../../nodes/celestia-app). ### Create a wallet @@ -344,13 +344,14 @@ export TO_ADDRESS=address_of_vesting_account ### Fund your account -Head to the [faucet](../../nodes/mocha-testnet/#mocha-testnet-faucet), +Head to [the faucet](../../nodes/mocha-testnet/#mocha-testnet-faucet), and fund your `origin` address. ### Create a vesting account on Mocha To create a vesting account on Mocha, you will need an RPC URL to send -the transaction to. You can find an RPC [here](../../nodes/mocha-testnet/#rpc-endpoints). +the transaction to. You can find the +[RPC endpoints on the Mocha testnet page](../../nodes/mocha-testnet/#rpc-endpoints). Set your RPC URL: @@ -381,7 +382,7 @@ celestia-appd tx vesting create-vesting-account $TO_ADDRESS 100000utia 168674805 Running a consensus full node or validator will prevent you from needing to use an RPC. -You can set up a [validator](../../nodes/full-consensus-node) or [full node](../../nodes/validator-node) for the previous portion +You can [set up a validator](../../nodes/full-consensus-node) or [full node](../../nodes/validator-node) for the previous portion of the tutorial. Note: this may take some time depending on how you choose to sync the @@ -416,8 +417,8 @@ broadcast-mode = "sync" ## Notes Not all vesting accounts can be created with a message, some need to be -set at genesis. Learn more -[here](https://docs.cosmos.network/v0.46/modules/auth/05_vesting.html#note). +set at genesis. You can +[learn more in the Cosmos Network documentation](https://docs.cosmos.network/v0.46/modules/auth/05_vesting.html#note). ## Conclusion From 2f6b66a4f713f2b6cb59dcc5b066bf69095266f6 Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Wed, 27 Sep 2023 17:13:38 -0400 Subject: [PATCH 07/14] chore: update ports section link to troubleshooting page also removes "please" --- docs/developers/celestia-app-wallet.md | 8 ++-- docs/developers/celestia-node-key.mdx | 5 ++- docs/developers/node-tutorial.mdx | 45 ++++++++++++-------- docs/developers/prompt-scavenger.mdx | 5 ++- docs/nodes/bridge-node.mdx | 30 +++++++------ docs/nodes/celestia-node-metrics.md | 5 ++- docs/nodes/celestia-node-troubleshooting.mdx | 20 ++++----- docs/nodes/celestia-node.mdx | 2 +- docs/nodes/docker-images.mdx | 45 ++++++++++++-------- docs/nodes/full-consensus-node.mdx | 10 +++-- docs/nodes/full-storage-node.mdx | 18 ++++---- docs/nodes/instantiate-testnet.md | 6 +-- docs/nodes/light-node.mdx | 18 ++++---- docs/nodes/validator-node.mdx | 12 +++--- src/pages/arabica-9.mdx | 2 +- 15 files changed, 130 insertions(+), 101 deletions(-) diff --git a/docs/developers/celestia-app-wallet.md b/docs/developers/celestia-app-wallet.md index 0ff2ee26eb7..d647987d6ff 100644 --- a/docs/developers/celestia-app-wallet.md +++ b/docs/developers/celestia-app-wallet.md @@ -10,7 +10,7 @@ wallet using `celestia-app`. ## Prerequisites -- [Gone through Quick Start and Installed `celestia-app`](../nodes/quick-start.md) +- Gone through [Quick Start and Installed `celestia-app`](../nodes/quick-start.md) Note, you do not need to install `celestia-node` for this tutorial. @@ -60,7 +60,7 @@ celestia-appd query bank balances celestia1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ``` :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for -information on which ports are required -to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: diff --git a/docs/developers/celestia-node-key.mdx b/docs/developers/celestia-node-key.mdx index 1177be713ba..483385f4808 100644 --- a/docs/developers/celestia-node-key.mdx +++ b/docs/developers/celestia-node-key.mdx @@ -225,8 +225,9 @@ ghcr.io/celestiaorg/celestia-node:sha-747c9e5 celestia light start \ ``` :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: List active containers in another window with: diff --git a/docs/developers/node-tutorial.mdx b/docs/developers/node-tutorial.mdx index 776fc6c731e..4e4098d4e5f 100644 --- a/docs/developers/node-tutorial.mdx +++ b/docs/developers/node-tutorial.mdx @@ -990,8 +990,9 @@ add the port after the IP address or use the `--core.grpc.port` flag to specify another port if you prefer. -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: @@ -1016,8 +1017,9 @@ add the port after the IP address or use the `--core.grpc.port` flag to specify another port if you prefer. -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: @@ -1042,8 +1044,9 @@ add the port after the IP address or use the `--core.grpc.port` flag to specify another port if you prefer. -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: @@ -1059,8 +1062,9 @@ celestia light start --core.ip --p2p.network blockspacerace ``` :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: @@ -1071,8 +1075,9 @@ celestia light start --core.ip rpc-mocha.pops.one --p2p.network mocha ``` :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: @@ -1083,8 +1088,9 @@ celestia light start --core.ip consensus-full.celestia-arabica-10.com --p2p.netw ``` :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: @@ -1109,8 +1115,9 @@ celestia light start --core.ip --keyring.accname ``` :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: @@ -1121,8 +1128,9 @@ celestia light start --core.ip --keyring.accname --p2p.n ``` :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: @@ -1133,8 +1141,9 @@ celestia light start --core.ip --keyring.accname --p2p.n ``` :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: diff --git a/docs/developers/prompt-scavenger.mdx b/docs/developers/prompt-scavenger.mdx index 243a8a7b731..4dac6ff1f94 100644 --- a/docs/developers/prompt-scavenger.mdx +++ b/docs/developers/prompt-scavenger.mdx @@ -141,8 +141,9 @@ add the port after the IP address or use the `--core.grpc.port` flag to specify another port if you prefer. -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: You should now have a running light node on your machine. diff --git a/docs/nodes/bridge-node.mdx b/docs/nodes/bridge-node.mdx index 93c360cea74..b4e0eb494f2 100644 --- a/docs/nodes/bridge-node.mdx +++ b/docs/nodes/bridge-node.mdx @@ -95,8 +95,9 @@ add the port after the IP address or use the `--core.grpc.port` flag to specify another port if you prefer. -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: If you need a list of RPC endpoints to connect to, you can check from the list [here](../blockspace-race) @@ -124,8 +125,9 @@ add the port after the IP address or use the `--core.grpc.port` flag to specify another port if you prefer. -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: If you need a list of RPC endpoints to connect to, you can check from the list [here](../mocha-testnet#rpc-endpoints) @@ -153,8 +155,9 @@ add the port after the IP address or use the `--core.grpc.port` flag to specify another port if you prefer. -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: If you need a list of RPC endpoints to connect to, you can check from the list [here](../arabica-devnet#rpc-endpoints) @@ -188,8 +191,9 @@ add the port after the IP address or use the `--core.grpc.port` flag to specify another port if you prefer. -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: If you need a list of RPC endpoints to connect to, you can check from the list [here](../blockspace-race) @@ -233,8 +237,9 @@ add the port after the IP address or use the `--core.grpc.port` flag to specify another port if you prefer. -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: If you need a list of RPC endpoints to connect to, you can check from the list [here](../mocha-testnet#rpc-endpoints) @@ -282,8 +287,9 @@ add the port after the IP address or use the `--core.grpc.port` flag to specify another port if you prefer. -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: If you need a list of RPC endpoints to connect to, you can check from the list [here](../mocha-testnet#rpc-endpoints) diff --git a/docs/nodes/celestia-node-metrics.md b/docs/nodes/celestia-node-metrics.md index 189e0ecce28..751fd13faa0 100644 --- a/docs/nodes/celestia-node-metrics.md +++ b/docs/nodes/celestia-node-metrics.md @@ -32,8 +32,9 @@ add the port after the IP address or use the `--core.grpc.port` flag to specify another port if you prefer. -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: diff --git a/docs/nodes/celestia-node-troubleshooting.mdx b/docs/nodes/celestia-node-troubleshooting.mdx index ec9e53f4f37..4ca59fe4a7e 100644 --- a/docs/nodes/celestia-node-troubleshooting.mdx +++ b/docs/nodes/celestia-node-troubleshooting.mdx @@ -82,8 +82,8 @@ celestia start --p2p.network --core.ip
``` :::tip -Please refer to the [ports](#ports) section for information on -which ports are required to be open on your machine. +Refer to [the ports section of this page](#ports) +for information on which ports are required to be open on your machine. ::: > NOTE: It is advised before switching networks to reinitialize @@ -161,8 +161,8 @@ celestia start --p2p.network ``` :::tip -Please refer to the [ports](#ports) section for information on -which ports are required to be open on your machine. +Refer to [the ports section of this page](#ports) +for information on which ports are required to be open on your machine. ::: @@ -220,8 +220,8 @@ celestia start --p2p.network ``` :::tip -Please refer to the [ports](#ports) section for information on -which ports are required to be open on your machine. +Refer to [the ports section of this page](#ports) +for information on which ports are required to be open on your machine. ::: ### Light nodes v0.8.2 and earlier @@ -250,8 +250,8 @@ celestia light start --p2p.network ``` :::tip -Please refer to the [ports](#ports) section for information on -which ports are required to be open on your machine. +Refer to [the ports section of this page](#ports) +for information on which ports are required to be open on your machine. ::: #### Example for Blockspace Race on v0.8.2 and earlier @@ -287,8 +287,8 @@ celestia light start --p2p.network mocha --core.ip
:::tip -Please refer to the [ports](#ports) section for information on -which ports are required to be open on your machine. +Refer to [the ports section of this page](#ports) +for information on which ports are required to be open on your machine. ::: ## FATAL headers given to the heightSub are in the wrong order diff --git a/docs/nodes/celestia-node.mdx b/docs/nodes/celestia-node.mdx index 943469aca67..2962cdb5b5d 100644 --- a/docs/nodes/celestia-node.mdx +++ b/docs/nodes/celestia-node.mdx @@ -430,4 +430,4 @@ we recommend the [node RPC CLI tutorial](../../developers/node-tutorial). To upgrade your binary, you can install the latest version from the instructions above and restart your node. If you run into any issues, -please refer to the [troubleshooting](../celestia-node-troubleshooting) section. +Refer to the [troubleshooting](../celestia-node-troubleshooting) section. diff --git a/docs/nodes/docker-images.mdx b/docs/nodes/docker-images.mdx index e17e6a45796..da8945160f2 100644 --- a/docs/nodes/docker-images.mdx +++ b/docs/nodes/docker-images.mdx @@ -54,8 +54,9 @@ docker run -e NODE_TYPE=light -e P2P_NETWORK=blockspacerace ghcr.io/celestiaorg/ :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: Congratulations! You now have a Celestia light node running on the Blockspace Race testnet. @@ -76,8 +77,9 @@ docker run -e NODE_TYPE=light -e P2P_NETWORK=mocha ghcr.io/celestiaorg/celestia- :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: Congratulations! You now have a Celestia light node running on the Mocha testnet. @@ -98,8 +100,9 @@ docker run -e NODE_TYPE=light -e P2P_NETWORK=arabica ghcr.io/celestiaorg/celesti :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: Congratulations! You now have a Celestia light node running on the Arabica devnet. @@ -125,8 +128,9 @@ docker run -e NODE_TYPE=bridge -e P2P_NETWORK=blockspacerace ghcr.io/celestiaorg :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: Congratulations! You now have a Celestia bridge node running on the Blockspace Race testnet. @@ -147,8 +151,9 @@ docker run -e NODE_TYPE=bridge -e P2P_NETWORK=mocha ghcr.io/celestiaorg/celestia :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: Congratulations! You now have a Celestia bridge node running on the Mocha network. @@ -169,8 +174,9 @@ docker run -e NODE_TYPE=bridge -e P2P_NETWORK=arabica ghcr.io/celestiaorg/celest :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: Congratulations! You now have a Celestia bridge node running on the Arabica network. @@ -196,8 +202,9 @@ docker run -e NODE_TYPE=full -e P2P_NETWORK=blockspacerace ghcr.io/celestiaorg/c :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: Congratulations! You now have a Celestia full node running on the Blockspace Race testnet. @@ -218,8 +225,9 @@ docker run -e NODE_TYPE=full -e P2P_NETWORK=mocha ghcr.io/celestiaorg/celestia-n :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: Congratulations! You now have a Celestia full storage node running on the Mocha network. @@ -240,8 +248,9 @@ docker run -e NODE_TYPE=full -e P2P_NETWORK=arabica ghcr.io/celestiaorg/celestia :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: Congratulations! You now have a Celestia full storage node running on the Arabica network. diff --git a/docs/nodes/full-consensus-node.mdx b/docs/nodes/full-consensus-node.mdx index 3eb21af6735..0b84f4377f1 100644 --- a/docs/nodes/full-consensus-node.mdx +++ b/docs/nodes/full-consensus-node.mdx @@ -146,8 +146,9 @@ celestia-appd tendermint unsafe-reset-all --home $HOME/.celestia-app ``` :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: ### Syncing @@ -235,8 +236,9 @@ Follow the tutorial on setting up Celestia App as a background process with SystemD [here](./systemd.md). :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) section for information on -which ports are required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: ### Optional: configure for RPC endpoint diff --git a/docs/nodes/full-storage-node.mdx b/docs/nodes/full-storage-node.mdx index 5441733fe30..e9ba55120ad 100644 --- a/docs/nodes/full-storage-node.mdx +++ b/docs/nodes/full-storage-node.mdx @@ -95,9 +95,9 @@ submit `PayForBlob` transactions, or query for the node's account balance, a gRPC endpoint of a validator (core) node must be passed as directed below. -Please refer to the [ports](../../nodes/celestia-node/#ports) -section for information on which ports are -required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: ```sh @@ -141,9 +141,9 @@ submit `PayForBlob` transactions, or query for the node's account balance, a gRPC endpoint of a validator (core) node must be passed as directed below. -Please refer to the [ports](../../nodes/celestia-node/#ports) -section for information on which ports are -required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: ```sh @@ -187,9 +187,9 @@ submit `PayForBlob` transactions, or query for the node's account balance, a gRPC endpoint of a validator (core) node must be passed as directed below. -Please refer to the [ports](../../nodes/celestia-node/#ports) -section for information on which ports are -required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: ```sh diff --git a/docs/nodes/instantiate-testnet.md b/docs/nodes/instantiate-testnet.md index 016d3957002..8102e6c5f47 100644 --- a/docs/nodes/instantiate-testnet.md +++ b/docs/nodes/instantiate-testnet.md @@ -166,9 +166,9 @@ celestia-appd start ``` :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) -section for information on which ports are -required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: Now you have a new Celestia Testnet to play around with! diff --git a/docs/nodes/light-node.mdx b/docs/nodes/light-node.mdx index 2c467f6e6e1..0530c4a808b 100644 --- a/docs/nodes/light-node.mdx +++ b/docs/nodes/light-node.mdx @@ -981,9 +981,9 @@ submit `PayForBlob` transactions, or query for the node's account balance, a gRPC endpoint of a validator (core) node must be passed as directed below. -Please refer to the [ports](../../nodes/celestia-node/#ports) -section for information on which ports are -required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: ```sh @@ -1003,9 +1003,9 @@ submit `PayForBlob` transactions, or query for the node's account balance, a gRPC endpoint of a validator (core) node must be passed as directed below. -Please refer to the [ports](../../nodes/celestia-node/#ports) -section for information on which ports are -required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: ```sh @@ -1025,9 +1025,9 @@ submit `PayForBlob` transactions, or query for the node's account balance, a gRPC endpoint of a validator (core) node must be passed as directed below. -Please refer to the [ports](../../nodes/celestia-node/#ports) -section for information on which ports are -required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: ```sh diff --git a/docs/nodes/validator-node.mdx b/docs/nodes/validator-node.mdx index 861d76d673a..ecf6e5ce187 100644 --- a/docs/nodes/validator-node.mdx +++ b/docs/nodes/validator-node.mdx @@ -172,9 +172,9 @@ wget -O - https://snaps.qubelabs.io/celestia/${SNAP_NAME} | tar xf - \ In order to start your validator node, run the following: :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) -section for information on which ports are -required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: ```bash @@ -270,9 +270,9 @@ celestia bridge init --core.ip ``` :::tip -Please refer to the [ports](../../nodes/celestia-node/#ports) -section for information on which ports are -required to be open on your machine. +Refer to +[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +for information on which ports are required to be open on your machine. ::: If you need a list of RPC endpoints to connect to, you can check from the list [here](../mocha-testnet#rpc-endpoints) diff --git a/src/pages/arabica-9.mdx b/src/pages/arabica-9.mdx index cc33e43d5e4..d7826510e73 100644 --- a/src/pages/arabica-9.mdx +++ b/src/pages/arabica-9.mdx @@ -10,7 +10,7 @@ description: A guide to Arabica-9 devnet. :::caution This page is maintained for developers still using the `arabica-9` devnet. -Please refer to the [Arabica devnet](../nodes/arabica-devnet) page for the latest +Refer to the [Arabica devnet](../nodes/arabica-devnet) page for the latest updates on the Arabica devnet. ::: From b74740c1633695ee5eaa1aeb51eb16d9334cdd0e Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Wed, 27 Sep 2023 17:24:21 -0400 Subject: [PATCH 08/14] chore: add edits from celestia-node-key.mdx and cosmostation.mdx --- docs/developers/celestia-node-key.mdx | 6 +++--- docs/developers/cosmostation.mdx | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/developers/celestia-node-key.mdx b/docs/developers/celestia-node-key.mdx index 483385f4808..58ef5da75b9 100644 --- a/docs/developers/celestia-node-key.mdx +++ b/docs/developers/celestia-node-key.mdx @@ -12,7 +12,7 @@ While this tutorial will go over installation process of `cel-key`, it is recommended that you complete the following prerequisites first: -- [Setting Up Your Environment](../nodes/environment.mdx) +- [Setting up your environment](../nodes/environment.mdx) Once you completed the prerequisite, you can proceed with this tutorial. @@ -211,8 +211,8 @@ Example: ### Prerequisites - Docker installed on your machine -- Understanding of the [guide](../nodes/docker-images.mdx) - on how to run `celestia-node` with Docker. +- Understanding of the +[guide on how to run `celestia-node` with Docker](../nodes/docker-images.mdx). ### Running your node diff --git a/docs/developers/cosmostation.mdx b/docs/developers/cosmostation.mdx index 1b3f9ff9aac..1f5607a134f 100644 --- a/docs/developers/cosmostation.mdx +++ b/docs/developers/cosmostation.mdx @@ -19,11 +19,11 @@ The example in this guide is for Date: Thu, 28 Sep 2023 13:26:15 -0400 Subject: [PATCH 09/14] chore: no "click here" in remainder of developers category --- docs/developers/demos.md | 2 +- docs/developers/deploy-on-bubs.md | 8 ++--- .../full-stack-modular-development-guide.md | 12 +++---- docs/developers/ibc-relayer.md | 4 +-- docs/developers/integrate-celestia.md | 3 +- docs/developers/intro-to-op-stack.md | 14 ++++----- docs/developers/keplr.mdx | 10 +++--- docs/developers/leap.mdx | 8 ++--- docs/developers/node-api.md | 11 ++++--- docs/developers/node-tutorial.mdx | 31 ++++++++++++------- docs/developers/optimism-devnet.mdx | 4 +-- docs/developers/optimism.mdx | 11 ++++--- docs/developers/prompt-scavenger.mdx | 5 +-- docs/developers/wallets.md | 4 ++- 14 files changed, 71 insertions(+), 56 deletions(-) diff --git a/docs/developers/demos.md b/docs/developers/demos.md index 7fd17330377..8eb5076ec7e 100644 --- a/docs/developers/demos.md +++ b/docs/developers/demos.md @@ -13,7 +13,7 @@ and make a pull request to do so! ## Celestia -- macOS light node client - [quasarapp.xyz](https://quasarapp.xyz) +- macOS light node client - [quazarapp.xyz](https://quazarapp.xyz) - RPC CLI tutorial with an on-chain SVG - [based64.xyz](https://based64.xyz) ## OP Stack testnet diff --git a/docs/developers/deploy-on-bubs.md b/docs/developers/deploy-on-bubs.md index d8d821c9c00..90665f594e4 100644 --- a/docs/developers/deploy-on-bubs.md +++ b/docs/developers/deploy-on-bubs.md @@ -56,8 +56,8 @@ allows anyone to set a new value for the "number" variable, while the `increment` function increases the value of "number" by one each time it's called. -You can learn more about Solidity and smart contract programming -[here](https://ethereum.org/en/developers/learning-tools/). +You can +[learn more about Solidity and smart contract programming](https://ethereum.org/en/developers/learning-tools/). To compile the contract, run the following forge command from the `$HOME/counter-project/counter_contract/` directory: @@ -177,8 +177,8 @@ src/Counter.sol:Counter ### Using Bubs First, set a private key from your funded Ethereum wallet and -set the `BUBS_RPC_URL` variable with an [RPC](../bubs-testnet/#rpc-urls) -of your choosing: +set the `BUBS_RPC_URL` variable with an +[RPC of your choosing](../bubs-testnet/#rpc-urls): ```bash export BUBS_PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 diff --git a/docs/developers/full-stack-modular-development-guide.md b/docs/developers/full-stack-modular-development-guide.md index 9dea3f187f3..941ea2f2862 100644 --- a/docs/developers/full-stack-modular-development-guide.md +++ b/docs/developers/full-stack-modular-development-guide.md @@ -20,7 +20,7 @@ cover how to build dapps on these newer, shared platforms. If you're interested in learning more about modular blockchains, or are new to the Celestia ecosystem, we recommend you read the -[Build Modular](./build-modular.md) page first. +[Build Modular page](./build-modular.md) first. ## Getting started @@ -206,8 +206,8 @@ Foundry uses [Dappsys Test](https://book.getfoundry.sh/reference/ds-test.html) to provide basic logging and assertion functionality. It's included in the Forge Standard Library. -Here, we are using `assertEq` to assert equality. You can view all of the -assertion functions available [here](https://book.getfoundry.sh/reference/ds-test.html?highlight=log_int#asserting). +Here, we are using `assertEq` to assert equality. You can +[view all of the assertion functions available](https://book.getfoundry.sh/reference/ds-test.html?highlight=log_int#asserting). #### Running the test @@ -764,7 +764,7 @@ Now we’re ready to run the app. Right now, the app is configured to be using `localhost:8545` using the Ethermint rollup we're running with Rollkit. -First, you'll need to install [MetaMask](https://metamask.io). +First, you'll need to [install MetaMask](https://metamask.io). To use the test account, you will need to import the private key from Ethermint to MetaMask. First, run the following command: @@ -804,5 +804,5 @@ balance. Now that you have your dapp running, go ahead and test out a new post on your Ethermint sovereign rollup. If you enjoyed this tutorial, be -sure to share your example in our -[Discord](https://discord.com/invite/je7UVpDuDu)! +sure to share your example +[in our Discord](https://discord.com/invite/je7UVpDuDu)! diff --git a/docs/developers/ibc-relayer.md b/docs/developers/ibc-relayer.md index c3018a766a9..535254c0b74 100644 --- a/docs/developers/ibc-relayer.md +++ b/docs/developers/ibc-relayer.md @@ -46,8 +46,8 @@ sudo apt install librust-openssl-dev build-essential git ### Build Hermes Create a new directory and clone the Hermes repository. -For the latest available release see Hermes -[GitHub](https://github.com/informalsystems/hermes/tags). +For the latest available release see +[Hermes GitHub](https://github.com/informalsystems/hermes/tags). ```bash mkdir -p $HOME/hermes diff --git a/docs/developers/integrate-celestia.md b/docs/developers/integrate-celestia.md index 94b44afd19b..181ec3cad7f 100644 --- a/docs/developers/integrate-celestia.md +++ b/docs/developers/integrate-celestia.md @@ -40,6 +40,7 @@ minimal as possible. Celestia supports many already existing key management systems, as we rely on the Cosmos-SDK and Tendermint libraries for signing and verifying transactions. +Learn more in the [Cosmos-SDK documentation](https://docs.cosmos.network/main/basics/accounts.html#keys-accounts-addresses-and-signatures) ### RPC and querying @@ -51,7 +52,7 @@ data from the chain. In `celestia-node`, the Data Availability node client, there is a JSON-RPC API that allows you to interact directly with Celestia's Data Availability layer. -The guide for it can be found [here](https://docs.celestia.org/developers/node-tutorial). +Learn [how to use the API in this tutorial](../../developers/node-tutorial). ### Compatibility diff --git a/docs/developers/intro-to-op-stack.md b/docs/developers/intro-to-op-stack.md index 628d837e112..dde1974a4ed 100644 --- a/docs/developers/intro-to-op-stack.md +++ b/docs/developers/intro-to-op-stack.md @@ -23,10 +23,10 @@ Ubuntu 22.10, and a 4 core AMD CPU. ::: :::caution -This is a **beta integration** and we are working on resolving open -[issues](https://github.com/celestiaorg/optimism/issues). +This is a **beta integration** and we are working on resolving +[open issues](https://github.com/celestiaorg/optimism/issues). The current testnet this setup is compatible with is the -[Arabica](../../nodes/arabica-devnet) devnet. +[Arabica devnet](../../nodes/arabica-devnet). ::: [Optimism](https://www.optimism.io/) uses Ethereum as @@ -44,9 +44,9 @@ rollup blocks and posts to Ethereum. ## Celestia and OP Stack repository -Find the repository for this integration -[here](https://github.com/celestiaorg/optimism/) or at -`https://github.com/celestiaorg/optimism`. +Find the +[repository for this integration](https://github.com/celestiaorg/optimism/) +at `https://github.com/celestiaorg/optimism`. ### What are Optimism and the OP Stack? @@ -66,7 +66,7 @@ blockchain infrastructure to governance systems. This software suite aims to simplify L2 blockchain creation and support the Optimism ecosystem's growth and development. -Learn more about Optimism [here](https://www.optimism.io/). +Learn [more about Optimism](https://www.optimism.io/). ### What is Celestia? diff --git a/docs/developers/keplr.mdx b/docs/developers/keplr.mdx index d02d79f6dfe..3b2b7fe4824 100644 --- a/docs/developers/keplr.mdx +++ b/docs/developers/keplr.mdx @@ -33,8 +33,8 @@ to connect to Tendermint chains from their browser. In this tutorial, we will have an interactive demo that goes over how you can add Celestia network parameters to Keplr. -Most of the overview of this integration are found on Keplr's website -[here](https://docs.keplr.app/api). +Most of the overview of this integration are found on +[Keplr's website](https://docs.keplr.app/api). For our demonstration, we converted the Keplr code on their docs to React components in order to demonstrate how you can add a Celestia @@ -42,11 +42,13 @@ network to Keplr from inside the docs. ## Install Keplr -You can learn more about installing Keplr [here](https://www.keplr.app/download). +You can +[install Keplr from the Keplr downloads page](https://www.keplr.app/download). ## Create an account -To learn how to create an account on Keplr, you can follow this [guide](https://www.keplr.app/onboarding/how-to-create). +Then, +[create an account on Keplr](https://www.keplr.app/onboarding/how-to-create). For all wallet types, follow steps 1-2 in the guide linked above to set up Keplr. diff --git a/docs/developers/leap.mdx b/docs/developers/leap.mdx index 9939fd1de82..1a3c5776951 100644 --- a/docs/developers/leap.mdx +++ b/docs/developers/leap.mdx @@ -19,11 +19,11 @@ The example in this guide is for Note: You are also encouraged to find a community-run API endpoint and there are several in the Discord. This one is used for demonstration - purposes. You can find a list of RPC endpoints [here](../../nodes/blockspace-race). + purposes. Check out the + [list of RPC endpoints on the Blockspace Race page](../../nodes/blockspace-race). ```sh celestia light start --core.ip --p2p.network blockspacerace @@ -1003,7 +1008,8 @@ an example public core endpoint. > Note: You are also encouraged to find a community-run API endpoint and there are several in the Discord. This one is used for demonstration - purposes. You can find a list of RPC endpoints [here](../../nodes/mocha-testnet#rpc-endpoints). + purposes. Check out the + [list of RPC endpoints on the Mocha testnet page](../../nodes/mocha-testnet). ```sh celestia light start --core.ip --p2p.network mocha @@ -1030,7 +1036,8 @@ an example public core endpoint. > Note: You are also encouraged to find a community-run API endpoint and there are several in the Discord. This one is used for demonstration - purposes. You can find a list of RPC endpoints [here](../../nodes/arabica-devnet#rpc-endpoints). + purposes. Check out the + [list of RPC endpoints on the Arabica devnet page](../../nodes/arabica-devnet). ```sh celestia light start --core.ip --p2p.network arabica @@ -1163,7 +1170,7 @@ the `celestia-node` directory: If you would like to fund your wallet with testnet tokens, head over to either the `#mocha-faucet` or `#arabica-faucet` channels on the -Celestia [Discord](https://discord.gg/celestiacommunity). +[Celestia Discord](https://discord.gg/celestiacommunity). You can request funds to your wallet address using the following command in Discord: @@ -1302,7 +1309,7 @@ We use the following `namespace_id` of `0x42690c204d39600fddd3` and the `data` value of `0xf1f20ca8007e910a3bf8b2e61da0f26bca07ef78717a6ea54165f5`. You can generate your own `namespace_id` and data values using this -useful Golang Playground we created [here](https://go.dev/play/p/7ltvaj8lhRl). +useful [Golang Playground we created](https://go.dev/play/p/7ltvaj8lhRl). Here is an example of the format of the `PayForBlob` transaction: @@ -1478,7 +1485,7 @@ higher. They are also **optional** to use with `blob.submit`. To set the gas fee and limit, you can use the `--fee` and `--gas.limit` flags respectively when submitting data using the RPC CLI. -Learn more about gas fees and limits [here](../../developers/submit-data). +Learn [more about gas fees and limits](../../developers/submit-data). To set the fee of 10000 utia, use the `--fee 10000` flag: diff --git a/docs/developers/optimism-devnet.mdx b/docs/developers/optimism-devnet.mdx index 5550d5f415a..44b70f2eee8 100644 --- a/docs/developers/optimism-devnet.mdx +++ b/docs/developers/optimism-devnet.mdx @@ -11,7 +11,7 @@ This guide will show you how to run your own OP Stack devnet. ### Environment setup and Golang installation -Install dependencies [here](../nodes/environment.mdx). +First, [install dependencies](../nodes/environment.mdx). ### Clone repository @@ -222,7 +222,7 @@ make devnet-logs #### lazydocker You can install [lazydocker](https://github.com/jesseduffield/lazydocker) -to view all of the components of your stack in one GUI by running: +to view all of the components of your stack in one TUI by running: ```bash asdf plugin add lazydocker https://github.com/comdotlinux/asdf-lazydocker.git diff --git a/docs/developers/optimism.mdx b/docs/developers/optimism.mdx index 83c60ae3314..1e00a3a6483 100644 --- a/docs/developers/optimism.mdx +++ b/docs/developers/optimism.mdx @@ -13,8 +13,8 @@ version of `optimism-bedrock`. ## Install dependencies -You can find the steps to install dependencies -and the modified version [here](../optimism-devnet/). +You can find the +[steps to install dependencies and the modified version](../optimism-devnet/). ## Pick your deployment type @@ -31,8 +31,8 @@ to the [previous page](../optimism-devnet/) to get started. ### Using a light node :::caution -This is a **beta integration** and we are working on resolving open -[issues](https://github.com/celestiaorg/optimism/issues/). +This is a **beta integration** and we are working on resolving +[open issues](https://github.com/celestiaorg/optimism/issues/). The current testnet this setup is compatible with is the [Arabica](../../nodes/arabica-devnet/) devnet. @@ -48,7 +48,8 @@ If you choose to use your own node store, the light node must be **fully synced** and **funded** for you to be able to submit and retrieve `PayForBlobs` to a Celestia network. -If it is not synced, you will run into [errors](https://github.com/celestiaorg/celestia-node/issues/2151/). +If it is not synced, you will run into +[errors similar to this](https://github.com/celestiaorg/celestia-node/issues/2151/). Visit the [Arabica page](../../nodes/arabica-devnet/) to visit the faucet. diff --git a/docs/developers/prompt-scavenger.mdx b/docs/developers/prompt-scavenger.mdx index 4dac6ff1f94..205d2e2ba56 100644 --- a/docs/developers/prompt-scavenger.mdx +++ b/docs/developers/prompt-scavenger.mdx @@ -94,7 +94,8 @@ Golang version: go{constants.golangNodeBSR}
Let’s run the following commands to get our env vars setup (NOTE: For `CORE_IP` you can select -from list of available RPC endpoints [here](https://docs.celestia.org/nodes/blockspace-race/#rpc-endpoints): +from the +[list of available RPC endpoints on the Blockspace Race page](../../nodes/blockspace-race/#rpc-endpoints): ```sh KEYNAME="scavenger_key" @@ -168,7 +169,7 @@ This will be used for the env var file we setup later. ### OpenAI key -Make sure to go over to [OpenAI](https://openai.com/) in +Make sure to [go over to OpenAI](https://openai.com/) in order to sign up to an account and generate an OpenAI API key. The key will be needed to communicate with OpenAI. diff --git a/docs/developers/wallets.md b/docs/developers/wallets.md index c59c84eceab..ce9c969edce 100644 --- a/docs/developers/wallets.md +++ b/docs/developers/wallets.md @@ -19,7 +19,9 @@ through the offerings in the Celestia wallet space. 1. [Ledger](../keplr) the Keplr guide will also show you how to use your Ledger device to securely manage your account. -2. [Cosmostation wallet](../cosmostation) +2. [Leap wallet](../leap) + +3. [Cosmostation wallet](../cosmostation) ## For developers From c8287246df18b3be00dd72befe21570dc382c8f0 Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Thu, 28 Sep 2023 13:41:36 -0400 Subject: [PATCH 10/14] fix: linting/formatting --- docs/developers/celestia-node-key.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developers/celestia-node-key.mdx b/docs/developers/celestia-node-key.mdx index 58ef5da75b9..44ec39f9783 100644 --- a/docs/developers/celestia-node-key.mdx +++ b/docs/developers/celestia-node-key.mdx @@ -212,7 +212,7 @@ Example: - Docker installed on your machine - Understanding of the -[guide on how to run `celestia-node` with Docker](../nodes/docker-images.mdx). + [guide on how to run `celestia-node` with Docker](../nodes/docker-images.mdx). ### Running your node From a275df86cef414395dd310ce87e1db19bd97fc72 Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Thu, 28 Sep 2023 13:48:37 -0400 Subject: [PATCH 11/14] chore: no "click here" on /learn section --- docs/learn/data-availability-faq.md | 2 +- docs/learn/how-celestia-works/transaction-lifecycle.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/learn/data-availability-faq.md b/docs/learn/data-availability-faq.md index 95e3732c0cc..0fed7f6c6ee 100644 --- a/docs/learn/data-availability-faq.md +++ b/docs/learn/data-availability-faq.md @@ -58,7 +58,7 @@ rounds of sampling for block data, it increases its confidence that data is available. Once the light node successfully reaches a predetermined confidence level (e.g. 99%) it will consider the block data as available. -Want a simpler explanation? Check out [this thread](https://twitter.com/nickwh8te/status/1559977957195751424) +Want a simpler explanation? [Check out this thread](https://twitter.com/nickwh8te/status/1559977957195751424) on how data availability sampling is like flipping a coin. diff --git a/docs/learn/how-celestia-works/transaction-lifecycle.md b/docs/learn/how-celestia-works/transaction-lifecycle.md index ba343e6a855..dd0fa3e7c5f 100644 --- a/docs/learn/how-celestia-works/transaction-lifecycle.md +++ b/docs/learn/how-celestia-works/transaction-lifecycle.md @@ -27,7 +27,8 @@ executed by the Celestia state machine once the block is committed. ![Lifecycle of a `celestia-app` Transaction](../../img/learn/tx-lifecycle.png) Next, the block producer adds to the block header a commitment -of the block data. As described [here](../data-availability-layer), +of the block data. As +[described in the "Celestia's data availability layer" page](../data-availability-layer), the commitment is the Merkle root of the 4k intermediate Merkle roots (i.e., one for each row and column of the extended matrix). To compute this commitment, the block producer performs the following operations: From db67fc97aab48e446d4bc1467f75e8891016b0a7 Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Thu, 28 Sep 2023 14:19:39 -0400 Subject: [PATCH 12/14] chore: no "click here" on 1/2 of node section --- docs/nodes/arabica-devnet.mdx | 7 +++--- docs/nodes/blockspace-race.mdx | 22 +++++++++-------- docs/nodes/bridge-node.mdx | 26 ++++++++++---------- docs/nodes/celestia-app-commands.md | 6 ++--- docs/nodes/celestia-app.mdx | 4 +-- docs/nodes/celestia-node-metrics.md | 2 +- docs/nodes/celestia-node-troubleshooting.mdx | 4 ++- docs/nodes/celestia-node.mdx | 8 +++--- docs/nodes/decide-node.md | 10 ++++---- docs/nodes/docker-images.mdx | 6 ++--- 10 files changed, 50 insertions(+), 45 deletions(-) diff --git a/docs/nodes/arabica-devnet.mdx b/docs/nodes/arabica-devnet.mdx index f0075a1dd1d..fd6bb3a6390 100644 --- a/docs/nodes/arabica-devnet.mdx +++ b/docs/nodes/arabica-devnet.mdx @@ -16,15 +16,16 @@ exclusively on providing developers with enhanced performance and 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 just testing your validator operations on Mocha [here](./mocha-testnet.mdx). +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.mdx). With Arabica having the latest updates from all Celestia's products deployed on it, it can be subject to many changes. Therefore, as a fair warning, Arabica can break unexpectedly but given it will be continuously updated, 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 +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 Hardfork Upgrades in coordination with Validators. diff --git a/docs/nodes/blockspace-race.mdx b/docs/nodes/blockspace-race.mdx index ecff33d1a41..a6d39d08134 100644 --- a/docs/nodes/blockspace-race.mdx +++ b/docs/nodes/blockspace-race.mdx @@ -21,8 +21,8 @@ do data sampling for transactions they need. The Blockspace Race will help put the Celestia network through its paces to harden features and prepare node operators for mainnet launch. -Learn more about the design of the program and its importance for the -Celestia community at our announcement post [here](https://blog.celestia.org/the-blockspace-race/). +You can read more about the design of the program and its importance for the +Celestia community in our [announcement post](https://blog.celestia.org/the-blockspace-race/). Since Celestia is made up of two networks (consensus and data availability), the incentivized testnet consists of multiple node types. @@ -78,7 +78,7 @@ govern participation in the program. ### Security policy In the interest of reporting security issues and vulnerabilities, please -refer to our Security Policy found [here](https://blog.celestia.org/the-blockspace-race/). +refer to our [Security Policy](https://blog.celestia.org/the-blockspace-race/). ### Points and rewards @@ -135,8 +135,8 @@ querying the node's state and broadcasting transactions on the Celestia network. The default port is 26657. We will be listing RPC endpoints -provided by the community here and their status provided by Brightly Stake -[here](https://celestia-tools.brightlystake.com/). +provided by the community here and their status provided by +[Brightly Stake](https://celestia-tools.brightlystake.com/).
View all RPC endpoints @@ -595,18 +595,20 @@ Note: Faucet has a limit of 50 tokens per week per address/Discord ID ## Terms of Service -A link to Celestia’s Incentivized Testnet Supplemental Terms can be found -[here](https://docs.celestia.org/community/itn-tos/). Those incorporate -our website [Terms of Service](https://celestia.org/tos/) by reference. +You can find the +[Celestia’s Incentivized Testnet Supplemental Terms](https://docs.celestia.org/community/itn-tos/) +on our website. Those incorporate our +[Terms of Service](https://celestia.org/tos/) by reference. We encourage you to review and familiarise yourself with all relevant terms. ## Community Code of Conduct -A link to our Community Code of Conduct can be found [here](https://docs.celestia.org/community/coc/). +You can find our [Community Code of Conduct](https://docs.celestia.org/community/coc/) +on our website. ## Privacy Policy -A link to our Privacy Policy can be found [here](https://celestia.org/privacy/). +You can read our [Privacy Policy](https://celestia.org/privacy/) on our website. ## Network upgrades diff --git a/docs/nodes/bridge-node.mdx b/docs/nodes/bridge-node.mdx index b4e0eb494f2..dc94adfe1e6 100644 --- a/docs/nodes/bridge-node.mdx +++ b/docs/nodes/bridge-node.mdx @@ -62,7 +62,7 @@ The following tutorial is done on an Ubuntu Linux 20.04 (LTS) x64 instance machi ### Setup the dependencies -Follow the tutorial here installing the dependencies [here](./environment.mdx). +Follow the tutorial for [installing the dependencies](./environment.mdx). ## Deploy the Celestia bridge node @@ -70,7 +70,7 @@ Follow the tutorial here installing the dependencies [here](./environment.mdx). Install the `celestia-node` binary, which will be used to run the bridge node. -Follow the tutorial for installing `celestia-node` [here](./celestia-node.mdx). +Follow the tutorial for [installing `celestia-node`](./celestia-node.mdx). ### Initialize the bridge node @@ -100,7 +100,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can check from the list [here](../blockspace-race) +If you need a list of RPC endpoints to connect to, you can check the [list on the Blockspace Race page](../blockspace-race). Here is an example of initializing the bridge node: @@ -130,7 +130,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can check from the list [here](../mocha-testnet#rpc-endpoints) +If you need a list of RPC endpoints to connect to, you can check the [list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). Here is an example of initializing the bridge node: @@ -160,7 +160,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can check from the list [here](../arabica-devnet#rpc-endpoints) +If you need a list of RPC endpoints to connect to, you can check the [list on the Arabica Devnet page](../arabica-devnet#rpc-endpoints). Here is an example of initializing the bridge node: @@ -196,7 +196,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can check from the list [here](../blockspace-race) +If you need a list of RPC endpoints to connect to, you can check the [list on the Blockspace Race page](../blockspace-race). Here is an example of starting the bridge node: @@ -204,7 +204,7 @@ Here is an example of starting the bridge node: celestia bridge start --core.ip --p2p.network blockspacerace ``` -You can create your key for your node by following the `cel-key` instructions [here](../../developers/celestia-node-key) +You can create your key for your node by [following the `cel-key` instructions](../../developers/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 @@ -242,7 +242,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can check from the list [here](../mocha-testnet#rpc-endpoints) +If you need a list of RPC endpoints to connect to, you can check the [list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). Here is an example of starting the bridge node: @@ -250,7 +250,7 @@ Here is an example of starting the bridge node: celestia bridge start --core.ip rpc-mocha.pops.one:26657 ``` -You can create your key for your node by following the `cel-key` instructions [here](../../developers/celestia-node-key) +You can create your key for your node by [following the `cel-key` instructions](../../developers/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 @@ -292,7 +292,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can check from the list [here](../mocha-testnet#rpc-endpoints) +If you need a list of RPC endpoints to connect to, you can check the [list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). Here is an example of starting the bridge node: @@ -300,7 +300,7 @@ Here is an example of starting the bridge node: celestia bridge start --core.ip consensus-validator.celestia-arabica-10.com --p2p.network arabica ``` -You can create your key for your node by following the `cel-key` instructions [here](../../developers/celestia-node-key) +You can create your key for your node by [following the `cel-key` instructions](../../developers/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 @@ -355,7 +355,7 @@ celestia bridge start --core.ip --keyring.accname --p2 ### Optional: start the bridge node with SystemD -Follow the tutorial on setting up the bridge node as a background process with -SystemD [here](./systemd.md). +Follow the +[tutorial on setting up the bridge node as a background process with SystemD](./systemd.md). You have successfully set up a bridge node that is syncing with the network. diff --git a/docs/nodes/celestia-app-commands.md b/docs/nodes/celestia-app-commands.md index da699773bd0..95cf154c18e 100644 --- a/docs/nodes/celestia-app-commands.md +++ b/docs/nodes/celestia-app-commands.md @@ -360,6 +360,6 @@ celestia-appd gentx $KEY_NAME $STAKING_AMOUNT --chain-id $CHAIN_ID \ --evm-address=$EVM_ADDRESS \ ``` -You can then share your gentx JSON file on the networks -repo [here](https://github.com/celestiaorg/networks) in the respective -network directory you are participating in. +You can then share your gentx JSON file on +[the networks repo](https://github.com/celestiaorg/networks) +in the respective network directory you are participating in. diff --git a/docs/nodes/celestia-app.mdx b/docs/nodes/celestia-app.mdx index 313815e627a..85939661c27 100644 --- a/docs/nodes/celestia-app.mdx +++ b/docs/nodes/celestia-app.mdx @@ -10,8 +10,8 @@ import blockspaceraceVersions from "../constants/blockspacerace_versions.js"; # Celestia App This tutorial will guide you through installing `celestia-app`. This -tutorial presumes you completed the steps in setting up your -own environment [here](./environment.mdx). +tutorial presumes you completed the steps in +[setting up your own environment](./environment.mdx). ## Install celestia-app diff --git a/docs/nodes/celestia-node-metrics.md b/docs/nodes/celestia-node-metrics.md index 751fd13faa0..db7e766034a 100644 --- a/docs/nodes/celestia-node-metrics.md +++ b/docs/nodes/celestia-node-metrics.md @@ -53,7 +53,7 @@ Essentially, the design considerations here will necessitate running an OpenTelemetry (OTEL) collector that connects to Celestia light node. -For an overview of OTEL, check out the guide [here](https://opentelemetry.io/docs/collector). +For an overview of OTEL, check out [the guide](https://opentelemetry.io/docs/collector). The ADR and the OTEL docs will help you run your collector on the metrics endpoint. This will then allow you to process the data in the collector on a diff --git a/docs/nodes/celestia-node-troubleshooting.mdx b/docs/nodes/celestia-node-troubleshooting.mdx index 4ca59fe4a7e..dbdcfe57157 100644 --- a/docs/nodes/celestia-node-troubleshooting.mdx +++ b/docs/nodes/celestia-node-troubleshooting.mdx @@ -35,7 +35,9 @@ The following ports are used by Celestia nodes: | 26659 | HTTP | localhost | REST Gateway | false | `--gateway.port string` | :::caution -The gateway endpoints have been deprecated and will be removed in the future. If you would like to use them anyway, you can find more details [here](https://github.com/celestiaorg/celestia-node/pull/2360). +The gateway endpoints have been deprecated and will be removed in the future. +If you would like to use them anyway, you can +[find more details on GitHub](https://github.com/celestiaorg/celestia-node/pull/2360). ::: ## Changing the location of your node store diff --git a/docs/nodes/celestia-node.mdx b/docs/nodes/celestia-node.mdx index 2962cdb5b5d..4560315e8bc 100644 --- a/docs/nodes/celestia-node.mdx +++ b/docs/nodes/celestia-node.mdx @@ -16,8 +16,8 @@ import TabItem from '@theme/TabItem'; ``` This tutorial goes over building and installing `celestia-node`. This -tutorial assumes you completed the steps in setting up your development -environment [here](./environment.mdx). +tutorial assumes you completed the steps in +[setting up your development environment](./environment.mdx). ## Install celestia-node @@ -418,7 +418,7 @@ Golang version: go{constants.golangNodeArabica}
## Next steps -First, we recommend reading the [overview](../overview/) +First, we recommend [reading the overview](../overview/) of our node types, if you haven't yet. Now that you've installed Celestia Node, it's time to [pick your node type](../decide-node/) and run your node! @@ -430,4 +430,4 @@ we recommend the [node RPC CLI tutorial](../../developers/node-tutorial). To upgrade your binary, you can install the latest version from the instructions above and restart your node. If you run into any issues, -Refer to the [troubleshooting](../celestia-node-troubleshooting) section. +Refer to the [troubleshooting section](../celestia-node-troubleshooting). diff --git a/docs/nodes/decide-node.md b/docs/nodes/decide-node.md index 56d6c0d564c..92db31bbd37 100644 --- a/docs/nodes/decide-node.md +++ b/docs/nodes/decide-node.md @@ -14,15 +14,15 @@ It is highly recommended if you are a beginner to get started with running a Data-Availability light node. In order to get started, you can proceed to the -light node section [here](./light-node.mdx). +[light node section](./light-node.mdx). You can also play around with the Data Availability API -in this tutorial for the light node [here](../developers/node-tutorial.mdx). +in [this tutorial for the light node](../developers/node-tutorial.mdx). ## Advanced -If you are looking to run a validator, please follow the tutorial -for running a validator [here](./validator-node.mdx). +If you are looking to run a validator, please follow the +[tutorial for running a validator](./validator-node.mdx). Note that running a validator means you must also run a bridge node, -which is covered [here](./bridge-node.mdx). +which is covered in [this section](./bridge-node.mdx). diff --git a/docs/nodes/docker-images.mdx b/docs/nodes/docker-images.mdx index da8945160f2..2b6750d521f 100644 --- a/docs/nodes/docker-images.mdx +++ b/docs/nodes/docker-images.mdx @@ -11,7 +11,7 @@ import blockspaceraceVersions from "../constants/blockspacerace_versions.js"; This page has instructions to run `celestia-node` using Docker. If you are looking for instructions to run `celestia-node` using a binary, please -refer to the [celestia-node](./celestia-node.mdx) page. +refer to the [celestia-node page](./celestia-node.mdx). Using Docker is the easiest way to run `celestia-node` for most users. Docker is a containerization platform that allows you to run `celestia-node` @@ -26,8 +26,8 @@ key management in Docker, visit the [Docker and `cel-key` section](../../developers/celestia-node-key/#docker-and-cel-key). The easiest way to install Docker is to use the Docker Desktop installer or -Ubuntu. You can find the instructions for your operating system -[here](https://docs.docker.com/engine/install). +Ubuntu. You can +[follow the instructions for your operating system](https://docs.docker.com/engine/install). ## Prerequisites From 464f06d9327ae9898de62d5cb5768496c527bf61 Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Fri, 29 Sep 2023 20:01:43 -0400 Subject: [PATCH 13/14] chore: finish node section --- docs/nodes/bridge-node.mdx | 12 +++++----- docs/nodes/full-consensus-node.mdx | 12 +++++----- docs/nodes/full-storage-node.mdx | 31 +++++++++++++----------- docs/nodes/hardfork-process.md | 7 +++--- docs/nodes/ibc-relayer.md | 12 ++++++---- docs/nodes/instantiate-testnet.md | 9 ++++--- docs/nodes/light-node.mdx | 38 +++++++++++++++++------------- docs/nodes/mocha-testnet.mdx | 2 +- docs/nodes/qgb-binary.mdx | 6 ++--- docs/nodes/qgb-intro.md | 34 +++++++++++++------------- docs/nodes/quick-start.md | 4 ++-- docs/nodes/validator-node.mdx | 28 ++++++++++++---------- 12 files changed, 107 insertions(+), 88 deletions(-) diff --git a/docs/nodes/bridge-node.mdx b/docs/nodes/bridge-node.mdx index dc94adfe1e6..9ec30e4a7f7 100644 --- a/docs/nodes/bridge-node.mdx +++ b/docs/nodes/bridge-node.mdx @@ -100,7 +100,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can check the [list on the Blockspace Race page](../blockspace-race). +If you need a list of RPC endpoints to connect to, you can find the [list on the Blockspace Race page](../blockspace-race). Here is an example of initializing the bridge node: @@ -130,7 +130,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can check the [list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). +If you need a list of RPC endpoints to connect to, you can find the [list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). Here is an example of initializing the bridge node: @@ -160,7 +160,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can check the [list on the Arabica Devnet page](../arabica-devnet#rpc-endpoints). +If you need a list of RPC endpoints to connect to, you can find the [list on the Arabica Devnet page](../arabica-devnet#rpc-endpoints). Here is an example of initializing the bridge node: @@ -196,7 +196,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can check the [list on the Blockspace Race page](../blockspace-race). +If you need a list of RPC endpoints to connect to, you can find the [list on the Blockspace Race page](../blockspace-race). Here is an example of starting the bridge node: @@ -242,7 +242,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can check the [list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). +If you need a list of RPC endpoints to connect to, you can find the [list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). Here is an example of starting the bridge node: @@ -292,7 +292,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can check the [list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). +If you need a list of RPC endpoints to connect to, you can find the [list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). Here is an example of starting the bridge node: diff --git a/docs/nodes/full-consensus-node.mdx b/docs/nodes/full-consensus-node.mdx index 0b84f4377f1..59e1b087ed7 100644 --- a/docs/nodes/full-consensus-node.mdx +++ b/docs/nodes/full-consensus-node.mdx @@ -31,11 +31,11 @@ instance machine. ### Setup the dependencies -Follow the instructions on installing the dependencies [here](./environment.mdx). +Follow the instructions on [installing the dependencies](./environment.mdx). ### Install celestia-app -Follow the tutorial on installing `celestia-app` [here](./celestia-app.mdx). +Follow the tutorial on [installing `celestia-app`](./celestia-app.mdx). ### Setup the P2P networks @@ -166,7 +166,7 @@ and then apply them. State sync relies on weak subjectivity; a trusted header (specifically the hash and height) must be provided. This can be found by querying a trusted RPC endpoint (/block). RPC endpoints are also required for retrieving light blocks. These can be found in the docs here under the respective networks or -from the [chain-registry](https://github.com/cosmos/chain-registry). +from [the chain-registry](https://github.com/cosmos/chain-registry). In `$HOME/.celestia-app/config/config.toml`, set @@ -232,8 +232,8 @@ In order to start your full consensus node, run the following: celestia-appd start ``` -Follow the tutorial on setting up Celestia App as a background process -with SystemD [here](./systemd.md). +Follow the tutorial on +[setting up Celestia App as a background process with SystemD](./systemd.md). :::tip Refer to @@ -245,7 +245,7 @@ for information on which ports are required to be open on your machine. You can configure your full consensus node to be a public RPC endpoint and listen to any connections from Data Availability Nodes in order to -serve requests for the Data Availability API [here](../developers/node-tutorial.mdx). +serve requests for the Data Availability API. Run the following commands: diff --git a/docs/nodes/full-storage-node.mdx b/docs/nodes/full-storage-node.mdx index e9ba55120ad..4ab85279891 100644 --- a/docs/nodes/full-storage-node.mdx +++ b/docs/nodes/full-storage-node.mdx @@ -38,14 +38,14 @@ The following tutorial is done on an Ubuntu Linux 20.04 (LTS) x64 instance machi ### Setup the dependencies -You can follow the tutorial for setting up your dependencies [here](./environment.mdx) +You can follow [the tutorial for setting up your dependencies](./environment.mdx) ## Install celestia-node > Note: Make sure that you have at least 250+ Gb of free space for > Celestia full storage node -You can follow the tutorial for installing `celestia-node` [here](./celestia-node.mdx) +You can follow [the tutorial for installing `celestia-node`](./celestia-node.mdx) ### Run the full storage node @@ -104,10 +104,11 @@ for information on which ports are required to be open on your machine. celestia full start --core.ip http:// --p2p.network blockspacerace ``` -If you would like to find example RPC endpoints, check out the list of -resources [here](../blockspace-race). +If you need a list of RPC endpoints to connect to, you can find the +[list on the Blockspace Race page](../blockspace-race#rpc-endpoints). -You can create your key for your node by following the `cel-key` instructions [here](../../developers/celestia-node-key) +You can create your key for your node by following +[the `cel-key` instructions](../../developers/celestia-node-key) Once you start the Full Node, a wallet key will be generated for you. You will need to fund that address with testnet tokens to pay for @@ -120,7 +121,7 @@ You can find the address by running the following command: You can get testnet tokens from: -* [Blockspace Race](../blockspace-race) +* [Blockspace Race testnet](../blockspace-race) > NOTE: If you are running a full-storage node for your sovereign rollup, it is highly recommended to request Arabica devnet tokens @@ -150,10 +151,11 @@ for information on which ports are required to be open on your machine. celestia full start --core.ip : ``` -If you would like to find example RPC endpoints, check out the list of -resources [here](../mocha-testnet#rpc-endpoints). +If you need a list of RPC endpoints to connect to, you can find the +[list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). -You can create your key for your node by following the `cel-key` instructions [here](../../developers/celestia-node-key) +You can create your key for your node by following +[the `cel-key` instructions](../../developers/celestia-node-key) Once you start the Full Node, a wallet key will be generated for you. You will need to fund that address with testnet tokens to pay for @@ -166,7 +168,7 @@ You can find the address by running the following command: You can get testnet tokens from: -* [Mocha](../mocha-testnet) +* [Mocha testnet](../mocha-testnet) > NOTE: If you are running a full-storage node for your sovereign rollup, it is highly recommended to request Arabica devnet tokens @@ -196,10 +198,11 @@ for information on which ports are required to be open on your machine. celestia full start --core.ip http:// --p2p.network arabica ``` -If you would like to find example RPC endpoints, check out the list of -resources [here](../arabica-devnet#rpc-endpoints). +If you need a list of RPC endpoints to connect to, you can find the +[list on the Arabica devnet page](../arabica-devnet#rpc-endpoints). -You can create your key for your node by following the `cel-key` instructions [here](../../developers/celestia-node-key) +You can create your key for your node by following +[the `cel-key` instructions](../../developers/celestia-node-key) Once you start the Full Node, a wallet key will be generated for you. You will need to fund that address with testnet tokens to pay for @@ -212,7 +215,7 @@ You can find the address by running the following command: You can get testnet tokens from: -* [Arabica](../arabica-devnet) +* [Arabica devnet](../arabica-devnet) > NOTE: If you are running a full-storage node for your sovereign rollup, it is highly recommended to request Arabica devnet tokens diff --git a/docs/nodes/hardfork-process.md b/docs/nodes/hardfork-process.md index 24dc0fce50e..790e09529b8 100644 --- a/docs/nodes/hardfork-process.md +++ b/docs/nodes/hardfork-process.md @@ -34,8 +34,8 @@ The general process can be broken down into several components: The two testnets were hardforks are deployed on are: -- [Arabica](./arabica-devnet.mdx) -- [Mocha](./mocha-testnet.mdx) +- [Arabica devnet](./arabica-devnet.mdx) +- [Mocha testnet](./mocha-testnet.mdx) ### Mocha hardfork @@ -45,7 +45,8 @@ while maintaining the existing state and also will rename Mamaki to Mocha. The new chain-id will be `mocha`. -The release logs for `mocha` can be found [here](https://github.com/celestiaorg/celestia-app/releases). +You can find the +[release logs for consensus nodes on the celestia-app releases page](https://github.com/celestiaorg/celestia-app/releases). The most exciting feature included is setting the stage for QGB on Mocha. diff --git a/docs/nodes/ibc-relayer.md b/docs/nodes/ibc-relayer.md index 142f2bae4be..b2bcd213509 100644 --- a/docs/nodes/ibc-relayer.md +++ b/docs/nodes/ibc-relayer.md @@ -23,7 +23,8 @@ For this guide, we will look just at Hermes. ### Install -1. Download the latest version of the binary from [Releases](https://github.com/informalsystems/hermes/releases). +1. Download the latest version of the binary from +[@informalsystems/hermes releases](https://github.com/informalsystems/hermes/releases). 2. Create the directory for the binary: `mkdir -p $HOME/.hermes/bin` 3. Extract the binary: `tar -C $HOME/.hermes/bin/ -vxzf $ARCHIVE_NAME` 4. Update `PATH` to point to the binary, either in `.bashrc` or `.zshrc` @@ -46,10 +47,10 @@ You can try to do this automatically by typing the command: hermes config auto --chains cosmoshub testnets/celestiatestnet --output $HOME/.hermes/config.toml ``` -This takes information from the [chain-registry](https://github.com/cosmos/chain-registry). +This takes information from [the chain-registry](https://github.com/cosmos/chain-registry). If the information is not there, you will have to enter it -manually by opening the `config.toml`. You can read the -self-documented example [here](https://github.com/informalsystems/hermes/blob/v1.3.0/config.toml). +manually by opening the `config.toml`. You can +[read the self-documented example](https://github.com/informalsystems/hermes/blob/v1.3.0/config.toml). You will be required to find RPC and gRPC endpoints. ### Keys @@ -96,7 +97,8 @@ hermes start As with other processes, you can use `systemd` to manage hermes in the background. For more information on setting up `clients`, `connections` and `channels`, use the `help` -command within the cli or refer to [Hermes website](https://hermes.informal.systems). +command within the cli or refer to +[the Hermes website](https://hermes.informal.systems). ## Transfer diff --git a/docs/nodes/instantiate-testnet.md b/docs/nodes/instantiate-testnet.md index 8102e6c5f47..d321a5f8d2d 100644 --- a/docs/nodes/instantiate-testnet.md +++ b/docs/nodes/instantiate-testnet.md @@ -12,15 +12,18 @@ to test out new features to build as a core developer. ## Hardware requirements -You can follow hardware requirements [here](../nodes/validator-node.mdx#hardware-requirements). +You wil need to +[follow hardware requirements](../nodes/validator-node.mdx#hardware-requirements). ## Setup dependencies -You can setup dependencies by following the guide [here](./environment.mdx). +You wil need to +[setup dependencies by following the guide](./environment.mdx). ## celestia-app installation -You can install `celestia-app` by following the guide [here](./celestia-app.mdx). +You wil need to +[install `celestia-app` by following the guide](./celestia-app.mdx). ## Spin up a Celestia testnet diff --git a/docs/nodes/light-node.mdx b/docs/nodes/light-node.mdx index 0530c4a808b..29da5fe4dab 100644 --- a/docs/nodes/light-node.mdx +++ b/docs/nodes/light-node.mdx @@ -19,7 +19,8 @@ This tutorial will guide you through setting up a Celestia light node, which will allow you to perform data availability sampling on the data availability (DA) network. -> To view a video tutorial for setting up a Celestia light node, click [here](../developers/light-node-video.md) +View +[a video tutorial for setting up a Celestia light node](../developers/light-node-video.md). ## Overview of light nodes @@ -1040,7 +1041,8 @@ celestia light start --core.ip --p2p.network {/* -If you need a list of RPC endpoints to connect to, you can check from the list [here](../blockspace-race) +If you need a list of RPC endpoints to connect to, you can find the +[list on the Blockspace Race page](../blockspace-race#rpc-endpoints). For example, your command might look something like this: @@ -1051,7 +1053,8 @@ celestia light start --core.ip rpc-blockspacerace.pops.one --p2p.network blocksp */} -If you need a list of RPC endpoints to connect to, you can check from the list [here](../mocha-testnet#rpc-endpoints) +If you need a list of RPC endpoints to connect to, you can find the +[list on the Mocha testnet page](../mocha-testnet#rpc-endpoints). For example, your command might look something like this: @@ -1062,7 +1065,8 @@ celestia light start --core.ip rpc-mocha.pops.one --p2p.network mocha -If you need a list of RPC endpoints to connect to, you can check from the list [here](../arabica-devnet#rpc-endpoints) +If you need a list of RPC endpoints to connect to, you can find the +[list on the Arabica devnet page](../arabica-devnet#rpc-endpoints). For example, your command might look something like this: @@ -1075,7 +1079,8 @@ celestia light start --core.ip consensus-validator.celestia-arabica-10.com --p2p ### Keys and wallets -You can create your key for your node by running the following command with the [`cel-key`](../../developers/celestia-node-key) utility: +You can create your key for your node by running the following command with the +[`cel-key` utility](../../developers/celestia-node-key): ```sh ./cel-key add --keyring-backend test --node.type light --p2p.network @@ -1131,9 +1136,9 @@ You can find the address by running the following command in the You have three networks to get testnet tokens from: -* [Arabica](../arabica-devnet#arabica-devnet-faucet) -* [Mocha](../mocha-testnet#mocha-testnet-faucet) -* [Blockspace race](../blockspace-race) +* [Arabica devnet](../arabica-devnet#arabica-devnet-faucet) +* [Mocha testnet](../mocha-testnet#mocha-testnet-faucet) +* [Blockspace Race testnet](../blockspace-race) > NOTE: If you are running a light node for your sovereign rollup, it is highly recommended to request Arabica devnet tokens @@ -1185,8 +1190,9 @@ celestia light start --core.ip --keyring.accname {/* -With your light node running, you can check out this tutorial on -submitting `PayForBlob` transactions [here](../../developers/node-tutorial). +With your light node running, you can check out +[this tutorial on submitting `PayForBlob` transactions](../../developers/node-tutorial). */} -With your light node running, you can check out this tutorial on -submitting `PayForBlob` transactions [here](../../developers/node-tutorial). +With your light node running, you can check out +[this tutorial on submitting `PayForBlob` transactions](../../developers/node-tutorial). -With your light node running, you can check out this tutorial on -submitting `PayForBlob` transactions [here](../../developers/node-tutorial). +With your light node running, you can check out +[this tutorial on submitting `PayForBlob` transactions](../../developers/node-tutorial). diff --git a/docs/nodes/mocha-testnet.mdx b/docs/nodes/mocha-testnet.mdx index 08c9b408d5d..91f52c5a18a 100644 --- a/docs/nodes/mocha-testnet.mdx +++ b/docs/nodes/mocha-testnet.mdx @@ -19,7 +19,7 @@ sovereign rollups on Mocha, but we also recommend [Arabica devnet](./arabica-dev for that as it is designed for development purposes. Mocha is a milestone in Celestia, allowing everyone to test out -core functionalities on the network. Read the announcement [here](https://blog.celestia.org/celestia-testnet-introduces-alpha-data-availability-api). +core functionalities on the network. Read [the announcement](https://blog.celestia.org/celestia-testnet-introduces-alpha-data-availability-api). Your best approach to participating is to first determine which node you would like to run. Each node guides will link to the relevant network in order to show you how to connect to them. diff --git a/docs/nodes/qgb-binary.mdx b/docs/nodes/qgb-binary.mdx index 39922c1a33d..54917f42235 100644 --- a/docs/nodes/qgb-binary.mdx +++ b/docs/nodes/qgb-binary.mdx @@ -41,11 +41,11 @@ qgb --help ## How to run If you are a Celestia-app validator, all you need to do is run the -orchestrator. Check [here](../qgb-orchestrator) for more details. +orchestrator. Check out [the QGB orchestrator page](../qgb-orchestrator) for more details. If you want to post commitments on an EVM chain, you will need to deploy -a new QGB contract and run a relayer. Check [here](../qgb-relayer) for -relayer docs and [here](../qgb-deploy) for how to deploy a new QGB +a new QGB contract and run a relayer. Check out [the QGB relayer page](../qgb-relayer) for +relayer docs and [the QGB deployment page](../qgb-deploy) for how to deploy a new QGB contract. Note: the QGB P2P network is a separate network than the consensus or diff --git a/docs/nodes/qgb-intro.md b/docs/nodes/qgb-intro.md index cf8ca76df1a..b6f84d87785 100644 --- a/docs/nodes/qgb-intro.md +++ b/docs/nodes/qgb-intro.md @@ -5,19 +5,19 @@ description: An overview of the Quantum Gravity Bridge. # Quantum Gravity Bridge -The Quantum Gravity Bridge, covered previously in the Celestia blog post -found [here](https://blog.celestia.org/celestiums/), introduces the concept -of a Celestium, which is an EVM L2 rollup that uses Celestia for data availability +The Quantum Gravity Bridge, covered previously in +[the Celestia blog post](https://blog.celestia.org/celestiums/), +introduces the concept of a Celestium, which is an EVM L2 +rollup that uses Celestia for data availability but settles on Ethereum (or any other EVM L1 chain). This page and following tutorials will go over the Quantum Gravity Bridge and how Validators on Celestia can run it. -If you're looking to learn more, you can view the -`orchestrator-relayer` repository -[here](https://github.com/celestiaorg/orchestrator-relayer), and -read more about the QGB -[here](https://github.com/celestiaorg/quantum-gravity-bridge#how-it-works). +If you're looking to learn more, you can view +[the `orchestrator-relayer` repository](https://github.com/celestiaorg/orchestrator-relayer) +, and +[read more about the QGB](https://github.com/celestiaorg/quantum-gravity-bridge#how-it-works). ## Overview @@ -30,18 +30,18 @@ Celestia. This will later be attested to by the Celestia validator set, and eventually posted to the target EVM chain (in this case, Ethereum). Then, the celestium, or any party, will be able to verify the attestations, i.e. valsets and data commitments, directly on the EVM chain on the QGB smart contract. You can -reference the QGB smart contract -[here](https://github.com/celestiaorg/quantum-gravity-bridge/blob/master/src/QuantumGravityBridge.sol). +reference +[the QGB smart contract](https://github.com/celestiaorg/quantum-gravity-bridge/blob/master/src/QuantumGravityBridge.sol). ![QGB-Architecture](../img/qgb/qgb-diagram.png) The specification of the QGB `Valset`s, which track the Celestia validator set -changes, can be found in this [ADR](https://github.com/celestiaorg/celestia-app/blob/main/docs/architecture/adr-002-qgb-valset.md). +changes, can be found in [ADR 002](https://github.com/celestiaorg/celestia-app/blob/main/docs/architecture/adr-002-qgb-valset.md). The QGB data commitments, which represent commitments over sets of blocks defined by a data commitment window, are -discussed more in-depth in the following -[ADR](https://github.com/celestiaorg/celestia-app/blob/main/docs/architecture/adr-003-qgb-data-commitments.md). +discussed more in-depth in +[ADR 003](https://github.com/celestiaorg/celestia-app/blob/main/docs/architecture/adr-003-qgb-data-commitments.md). The Orchestrator is part of the validator setup and works as follows: @@ -62,15 +62,15 @@ The diagram below goes over this process. ![QGB-Relayer](../img/qgb/qgb-relayer.png) -You can learn more about the mechanics behind the Relayer in this -[ADR](https://github.com/celestiaorg/celestia-app/blob/main/docs/architecture/adr-004-qgb-relayer-security.md). +You can learn more about the mechanics behind the Relayer in +[ADR 004](https://github.com/celestiaorg/celestia-app/blob/main/docs/architecture/adr-004-qgb-relayer-security.md). ## Setting up the QGB The following sections in this category presume you have the following setup: -- A Celestia App [validator](../validator-node) running -- A Celestia Node - [bridge node](../bridge-node) running +- A Celestia App [validator node](../validator-node) running +- A Celestia Node [bridge node](../bridge-node) running ## Next steps diff --git a/docs/nodes/quick-start.md b/docs/nodes/quick-start.md index 840ed3ea4ce..2919a9ac0e7 100644 --- a/docs/nodes/quick-start.md +++ b/docs/nodes/quick-start.md @@ -32,8 +32,8 @@ covers the Data Availability layer. ## Getting started As covered in the previous section, Celestia offers -two different test networks, [Arabica](./arabica-devnet.mdx) -and [Mocha](./mocha-testnet.mdx). +two different test networks, [Arabica devnet](./arabica-devnet.mdx) +and [Mocha testnet](./mocha-testnet.mdx). If you are planning to run a light node, it is recommended to use Arabica, which you will find options to connecting to diff --git a/docs/nodes/validator-node.mdx b/docs/nodes/validator-node.mdx index ecf6e5ce187..b68b1c18187 100644 --- a/docs/nodes/validator-node.mdx +++ b/docs/nodes/validator-node.mdx @@ -30,11 +30,11 @@ instance machine. ### Setup the dependencies -Follow the instructions on installing the dependencies [here](./environment.mdx). +Follow [the instructions on installing the dependencies](./environment.mdx). ### Install celestia-app -Follow the tutorial on installing `celestia-app` [here](./celestia-app.mdx). +Follow [the tutorial on installing `celestia-app`](./celestia-app.mdx). ### Setup the P2P networks @@ -181,12 +181,13 @@ for information on which ports are required to be open on your machine. celestia-appd start ``` -Follow the tutorial on setting up `celestia-app` as a background process -with SystemD [here](../systemd). +Follow +[the tutorial on setting up `celestia-app` as a background process +with SystemD](../systemd). ### Wallet -Follow the tutorial on creating a wallet [here](../developers/celestia-app-wallet.md). +Follow [the tutorial on creating a wallet](../developers/celestia-app-wallet.md). ### Delegate stake to a validator @@ -259,7 +260,7 @@ Celestia bridge node daemon. ### Install Celestia Node -You can follow the tutorial for installing `celestia-node` [here](./celestia-node.mdx) +You can [follow the tutorial for installing `celestia-node`](./celestia-node.mdx) ### Initialize the bridge node @@ -275,7 +276,8 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can check from the list [here](../mocha-testnet#rpc-endpoints) +If you need a list of RPC endpoints to connect to, you can find the +[list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). ### Run the bridge node @@ -287,8 +289,8 @@ celestia bridge start ### Optional: start the bridge node with SystemD -Follow the tutorial on setting up the bridge node as a background process with -SystemD [here](../systemd). +Follow +[the tutorial on setting up the bridge node as a background process with SystemD](../systemd). You have successfully set up a bridge node that is syncing with the network. @@ -303,7 +305,7 @@ is enabled. First, prepare an EVM address with a private key that you have access to. We will use it to register your validator's EVM address -[later](#register-your-validators-evm-address) in this page. +[later in this page](#register-your-validators-evm-address). @@ -479,10 +481,12 @@ txhash: ```` -You should now be able to see your validator from a block explorer like [here](https://celestia.explorers.guru) +You should now be able to see your validator from +[a block explorer](../mocha-testnet#explorers) ## Run the QGB Orchestrator Now that the QGB will be enabled for Blockspace Race (BSR), all validators will need to run the QGB orchestrator to be able to sign attestations. -To run it, please check the docs [here](https://docs.celestia.org/nodes/qgb-orchestrator/#how-to-run). +To run it, please +[refer to the documentation](https://docs.celestia.org/nodes/qgb-orchestrator/#how-to-run). From f9944ac47023f8e6ed365ab9283697ea9b49abc9 Mon Sep 17 00:00:00 2001 From: "joshcs.eth" <46639943+jcstein@users.noreply.github.com> Date: Fri, 29 Sep 2023 20:03:40 -0400 Subject: [PATCH 14/14] chore: change instances of "Devnet" and "Testnet" to "devnet" and "testnet" --- docs/developers/celestia-app-vesting.md | 8 ++++---- docs/developers/cosmostation.mdx | 4 ++-- docs/developers/keplr.mdx | 12 ++++++------ docs/developers/leap.mdx | 2 +- docs/developers/node-tutorial.mdx | 18 +++++++++--------- docs/developers/optimism-devnet.mdx | 4 ++-- docs/nodes/arabica-devnet.mdx | 10 +++++----- docs/nodes/bridge-node.mdx | 8 ++++---- docs/nodes/celestia-node.mdx | 16 ++++++++-------- docs/nodes/full-storage-node.mdx | 8 ++++---- docs/nodes/light-node.mdx | 18 +++++++++--------- docs/nodes/mocha-testnet.mdx | 2 +- docs/nodes/validator-node.mdx | 2 +- 13 files changed, 56 insertions(+), 56 deletions(-) diff --git a/docs/developers/celestia-app-vesting.md b/docs/developers/celestia-app-vesting.md index 8850e25ba24..fc11986a047 100644 --- a/docs/developers/celestia-app-vesting.md +++ b/docs/developers/celestia-app-vesting.md @@ -303,17 +303,17 @@ pagination: ``` Congratulations! You've now made your own vesting account on a local devnet. -Next, you can learn how to create a vesting account on Mocha Testnet. +Next, you can learn how to create a vesting account on Mocha testnet. ## Mocha In the previous section of this tutorial, we learned how to create a vesting account on a local devnet. In this portion of the tutorial, we'll cover how to set up a consensus full node and set up a vesting account on -[Mocha Testnet](../../nodes/mocha-testnet). +[Mocha testnet](../../nodes/mocha-testnet). First, be sure that you have -[installed Celestia App for the latest version for Mocha Testnet](../../nodes/celestia-app). +[installed Celestia App for the latest version for Mocha testnet](../../nodes/celestia-app). ### Create a wallet @@ -423,4 +423,4 @@ set at genesis. You can ## Conclusion Congratulations! You've learned how to create a local devnet, create a -vesting account on it, and how to make a vesting account on the Mocha Testnet! +vesting account on it, and how to make a vesting account on the Mocha testnet! diff --git a/docs/developers/cosmostation.mdx b/docs/developers/cosmostation.mdx index 1f5607a134f..281e144947f 100644 --- a/docs/developers/cosmostation.mdx +++ b/docs/developers/cosmostation.mdx @@ -35,7 +35,7 @@ click "Add Custom Chain" You can then add the following parameters: -- Custom Chain name: `Mocha Testnet` +- Custom Chain name: `Mocha testnet` - Rest URL: `https://api-mocha.pops.one` - New RPC URL: `https://rpc-mocha.pops.one` - Currency symbol: `TIA` @@ -52,6 +52,6 @@ then add the following parameters: Now, click `Add a custom chain` and you will be able to view your Celestia account balance and transactions in Cosmostation wallet. -Switch chains to "Mocha Testnet" and you'll see that you're connected to Celestia's Mocha Testnet! +Switch chains to "Mocha testnet" and you'll see that you're connected to Celestia's Mocha testnet! ![cosmostation](../img/cosmostation/cosmostation.png) diff --git a/docs/developers/keplr.mdx b/docs/developers/keplr.mdx index 3b2b7fe4824..c15470d78d2 100644 --- a/docs/developers/keplr.mdx +++ b/docs/developers/keplr.mdx @@ -14,14 +14,14 @@ import TabItem from '@theme/TabItem'; export const ARABICA_PARAMS = { chainId: `${constants.arabicaChainId}`, - chainName: 'Arabica Devnet', + chainName: 'Arabica devnet', rpc: 'https://consensus-full.celestia-arabica-10.com/', rest: 'https://api.consensus.celestia-arabica-10.com/' } export const MOCHA_PARAMS = { chainId: `${constants.mochaChainId}`, - chainName: 'Mocha Testnet', + chainName: 'Mocha testnet', rpc: 'https://rpc-mocha.pops.one', rest: 'https://api-mocha.pops.one' } @@ -192,7 +192,7 @@ export const BLOCKSPACERACE_PARAMS = { Here is a demo button that allows you to -add Mocha Testnet to Keplr. +add Mocha testnet to Keplr. Try it out: @@ -206,7 +206,7 @@ import '@site/src/components/AddNetworkKeplr'

export const MOCHA_PARAMS = {`{ chainId: '${constants.mochaChainId}', - chainName: 'Mocha Testnet', + chainName: 'Mocha testnet', rpc: 'https://rpc-mocha.pops.one', rest: 'https://api-mocha.pops.one/' }`}
@@ -219,7 +219,7 @@ export const MOCHA_PARAMS = {`{ Here is a demo button that allows you to -add Arabica Devnet to Keplr. +add Arabica devnet to Keplr. Try it out: @@ -233,7 +233,7 @@ import '@site/src/components/AddNetworkKeplr'

export const ARABICA_PARAMS = {`{ chainId: '${constants.arabicaChainId}', - chainName: 'Arabica Devnet', + chainName: 'Arabica devnet', rpc: 'https://consensus-full.celestia-arabica-10.com/', rest: 'https://api.consensus.celestia-arabica-10.com/' }`}
diff --git a/docs/developers/leap.mdx b/docs/developers/leap.mdx index 1a3c5776951..3c70ace4f0e 100644 --- a/docs/developers/leap.mdx +++ b/docs/developers/leap.mdx @@ -36,7 +36,7 @@ You can then add the following parameters: - Chain Id: -- Chain Name: `Mocha Testnet` +- Chain Name: `Mocha testnet` - New RPC URL: `https://rpc-mocha.pops.one` - New REST URL: `https://api-mocha.pops.one` - Address Prefix: `celestia` diff --git a/docs/developers/node-tutorial.mdx b/docs/developers/node-tutorial.mdx index 10e1b1e3942..866581a0296 100644 --- a/docs/developers/node-tutorial.mdx +++ b/docs/developers/node-tutorial.mdx @@ -678,7 +678,7 @@ Golang version: go{constants.golangNodeBSR}
-Installing `celestia-node` for Mocha Testnet means installing a specific version +Installing `celestia-node` for Mocha testnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -709,7 +709,7 @@ Golang version: go{constants.golangNodeMocha}
 -Installing `celestia-node` for Mocha Testnet means installing a specific version +Installing `celestia-node` for Mocha testnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -740,7 +740,7 @@ Golang version: go{constants.golangNodeMocha}
 -Installing `celestia-node` for Mocha Testnet means installing a specific version +Installing `celestia-node` for Mocha testnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -771,7 +771,7 @@ Golang version: go{constants.golangNodeMocha}
 -Installing `celestia-node` for Mocha Testnet means installing a specific version +Installing `celestia-node` for Mocha testnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -808,7 +808,7 @@ Golang version: go{constants.golangNodeMocha}
-Installing `celestia-node` for Arabica Devnet means installing a specific version +Installing `celestia-node` for Arabica devnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -839,7 +839,7 @@ Golang version: go{constants.golangNodeArabica}
 -Installing `celestia-node` for Arabica Devnet means installing a specific version +Installing `celestia-node` for Arabica devnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -870,7 +870,7 @@ Golang version: go{constants.golangNodeArabica}
 -Installing `celestia-node` for Arabica Devnet means installing a specific version +Installing `celestia-node` for Arabica devnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -901,7 +901,7 @@ Golang version: go{constants.golangNodeArabica}
 -Installing `celestia-node` for Arabica Devnet means installing a specific version +Installing `celestia-node` for Arabica devnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -1158,7 +1158,7 @@ for information on which ports are required to be open on your machine. ```` Once you start the Light Node, a wallet key will be generated for you. -You will need to fund that address with Mocha Testnet or Arabica Devnet +You will need to fund that address with Mocha testnet or Arabica devnet tokens to pay for `PayForBlob` transactions or `PayForBlob transactions`, respectively. You can find the address by running the following command in diff --git a/docs/developers/optimism-devnet.mdx b/docs/developers/optimism-devnet.mdx index 44b70f2eee8..bcc7fb0745f 100644 --- a/docs/developers/optimism-devnet.mdx +++ b/docs/developers/optimism-devnet.mdx @@ -34,9 +34,9 @@ git checkout v0.1.3-OP_v1.0.6-CN_v0.11.0-rc8 ``` - + -If you are using **Arabica Devnet** and deploying using the +If you are using **Arabica devnet** and deploying using the [**testnet deployment guide**](../optimism/) use the following version: diff --git a/docs/nodes/arabica-devnet.mdx b/docs/nodes/arabica-devnet.mdx index fd6bb3a6390..0b622cb17ed 100644 --- a/docs/nodes/arabica-devnet.mdx +++ b/docs/nodes/arabica-devnet.mdx @@ -11,14 +11,14 @@ import constants from "../constants/constants.js"; ![arabica-devnet](../img/arabica-devnet.png) -Arabica Devnet is a new testnet from Celestia Labs that is focused +Arabica devnet is a new testnet from Celestia Labs that is focused exclusively on providing developers with enhanced performance and 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.mdx). +[Mocha testnet](./mocha-testnet.mdx). With Arabica having the latest updates from all Celestia's products deployed on it, it can be subject to many changes. Therefore, as a fair warning, @@ -26,7 +26,7 @@ Arabica can break unexpectedly but given it will be continuously updated, 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 +chose to do so, it just will always lag behind Arabica devnet until Mocha undergoes Hardfork Upgrades in coordination with Validators. ## Software version numbers @@ -62,7 +62,7 @@ The RPC endpoint is to allow users to interact with Celestia's nodes by querying the node's state and broadcasting transactions on the Celestia network. The default port is 26657. -Below is a list of RPC endpoints you can use to connect to Arabica Devnet: +Below is a list of RPC endpoints you can use to connect to Arabica devnet: :::tip Pay attention @@ -116,7 +116,7 @@ broadcast transactions. ### Discord -You can request from Arabica Devnet Faucet on the #arabica-faucet channel on +You can request from Arabica devnet Faucet on the #arabica-faucet channel on Celestia's Discord server with the following command: ```text diff --git a/docs/nodes/bridge-node.mdx b/docs/nodes/bridge-node.mdx index 9ec30e4a7f7..1f1813b7d3b 100644 --- a/docs/nodes/bridge-node.mdx +++ b/docs/nodes/bridge-node.mdx @@ -130,7 +130,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can find the [list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). +If you need a list of RPC endpoints to connect to, you can find the [list on the Mocha testnet page](../mocha-testnet#rpc-endpoints). Here is an example of initializing the bridge node: @@ -160,7 +160,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can find the [list on the Arabica Devnet page](../arabica-devnet#rpc-endpoints). +If you need a list of RPC endpoints to connect to, you can find the [list on the Arabica devnet page](../arabica-devnet#rpc-endpoints). Here is an example of initializing the bridge node: @@ -242,7 +242,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can find the [list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). +If you need a list of RPC endpoints to connect to, you can find the [list on the Mocha testnet page](../mocha-testnet#rpc-endpoints). Here is an example of starting the bridge node: @@ -292,7 +292,7 @@ Refer to for information on which ports are required to be open on your machine. ::: -If you need a list of RPC endpoints to connect to, you can find the [list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). +If you need a list of RPC endpoints to connect to, you can find the [list on the Mocha testnet page](../mocha-testnet#rpc-endpoints). Here is an example of starting the bridge node: diff --git a/docs/nodes/celestia-node.mdx b/docs/nodes/celestia-node.mdx index 4560315e8bc..7c54db2214a 100644 --- a/docs/nodes/celestia-node.mdx +++ b/docs/nodes/celestia-node.mdx @@ -158,7 +158,7 @@ Golang version: go{constants.golangNodeBSR}
-Installing `celestia-node` for Mocha Testnet means installing a specific version +Installing `celestia-node` for Mocha testnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -189,7 +189,7 @@ Golang version: go{constants.golangNodeMocha}
 -Installing `celestia-node` for Mocha Testnet means installing a specific version +Installing `celestia-node` for Mocha testnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -220,7 +220,7 @@ Golang version: go{constants.golangNodeMocha}
 -Installing `celestia-node` for Mocha Testnet means installing a specific version +Installing `celestia-node` for Mocha testnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -251,7 +251,7 @@ Golang version: go{constants.golangNodeMocha}
 -Installing `celestia-node` for Mocha Testnet means installing a specific version +Installing `celestia-node` for Mocha testnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -288,7 +288,7 @@ Golang version: go{constants.golangNodeMocha}
-Installing `celestia-node` for Arabica Devnet means installing a specific version +Installing `celestia-node` for Arabica devnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -319,7 +319,7 @@ Golang version: go{constants.golangNodeArabica}
 -Installing `celestia-node` for Arabica Devnet means installing a specific version +Installing `celestia-node` for Arabica devnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -350,7 +350,7 @@ Golang version: go{constants.golangNodeArabica}
 -Installing `celestia-node` for Arabica Devnet means installing a specific version +Installing `celestia-node` for Arabica devnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -381,7 +381,7 @@ Golang version: go{constants.golangNodeArabica}
 -Installing `celestia-node` for Arabica Devnet means installing a specific version +Installing `celestia-node` for Arabica devnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: diff --git a/docs/nodes/full-storage-node.mdx b/docs/nodes/full-storage-node.mdx index 4ab85279891..a052892847d 100644 --- a/docs/nodes/full-storage-node.mdx +++ b/docs/nodes/full-storage-node.mdx @@ -127,7 +127,7 @@ You can get testnet tokens from: rollup, it is highly recommended to request Arabica devnet tokens as Arabica has the latest changes that can be used to test for developing your sovereign rollup. You can still use - Mocha Testnet as well, it is just mostly used for validator operations. + Mocha testnet as well, it is just mostly used for validator operations. */} @@ -152,7 +152,7 @@ celestia full start --core.ip : ``` If you need a list of RPC endpoints to connect to, you can find the -[list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). +[list on the Mocha testnet page](../mocha-testnet#rpc-endpoints). You can create your key for your node by following [the `cel-key` instructions](../../developers/celestia-node-key) @@ -174,7 +174,7 @@ You can get testnet tokens from: rollup, it is highly recommended to request Arabica devnet tokens as Arabica has the latest changes that can be used to test for developing your sovereign rollup. You can still use - Mocha Testnet as well, it is just mostly used for validator operations. + Mocha testnet as well, it is just mostly used for validator operations. @@ -221,7 +221,7 @@ You can get testnet tokens from: rollup, it is highly recommended to request Arabica devnet tokens as Arabica has the latest changes that can be used to test for developing your sovereign rollup. You can still use - Mocha Testnet as well, it is just mostly used for validator operations. + Mocha testnet as well, it is just mostly used for validator operations. diff --git a/docs/nodes/light-node.mdx b/docs/nodes/light-node.mdx index 29da5fe4dab..b488e84dab4 100644 --- a/docs/nodes/light-node.mdx +++ b/docs/nodes/light-node.mdx @@ -652,7 +652,7 @@ Golang version: go{constants.golangNodeBSR}
-Installing `celestia-node` for Mocha Testnet means installing a specific version +Installing `celestia-node` for Mocha testnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -683,7 +683,7 @@ Golang version: go{constants.golangNodeMocha}
 -Installing `celestia-node` for Mocha Testnet means installing a specific version +Installing `celestia-node` for Mocha testnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -714,7 +714,7 @@ Golang version: go{constants.golangNodeMocha}
 -Installing `celestia-node` for Mocha Testnet means installing a specific version +Installing `celestia-node` for Mocha testnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -745,7 +745,7 @@ Golang version: go{constants.golangNodeMocha}
 -Installing `celestia-node` for Mocha Testnet means installing a specific version +Installing `celestia-node` for Mocha testnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -782,7 +782,7 @@ Golang version: go{constants.golangNodeMocha}
-Installing `celestia-node` for Arabica Devnet means installing a specific version +Installing `celestia-node` for Arabica devnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -813,7 +813,7 @@ Golang version: go{constants.golangNodeArabica}
 -Installing `celestia-node` for Arabica Devnet means installing a specific version +Installing `celestia-node` for Arabica devnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -844,7 +844,7 @@ Golang version: go{constants.golangNodeArabica}
 -Installing `celestia-node` for Arabica Devnet means installing a specific version +Installing `celestia-node` for Arabica devnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -875,7 +875,7 @@ Golang version: go{constants.golangNodeArabica}
 -Installing `celestia-node` for Arabica Devnet means installing a specific version +Installing `celestia-node` for Arabica devnet means installing a specific version to be compatible with the network. Install the `celestia-node` binary by running the following commands: @@ -1144,7 +1144,7 @@ You have three networks to get testnet tokens from: rollup, it is highly recommended to request Arabica devnet tokens as Arabica has the latest changes that can be used to test for developing your sovereign rollup. You can still use - Mocha Testnet as well, it is just used for validator operations. + Mocha testnet as well, it is just used for validator operations. You can request funds to your wallet address using the following command in Discord: diff --git a/docs/nodes/mocha-testnet.mdx b/docs/nodes/mocha-testnet.mdx index 91f52c5a18a..fd675f26e54 100644 --- a/docs/nodes/mocha-testnet.mdx +++ b/docs/nodes/mocha-testnet.mdx @@ -141,7 +141,7 @@ Full node 2: > DO NOT CURRENTLY EXIST AND THERE ARE NO PUBLIC SALES OR OTHER PUBLIC > DISTRIBUTIONS OF ANY MAINNET CELESTIA TOKENS. -You can request from Mocha Testnet Faucet on the #mocha-faucet channel on +You can request from Mocha testnet Faucet on the #mocha-faucet channel on Celestia's Discord server with the following command: ```text diff --git a/docs/nodes/validator-node.mdx b/docs/nodes/validator-node.mdx index b68b1c18187..3f90cdfbefd 100644 --- a/docs/nodes/validator-node.mdx +++ b/docs/nodes/validator-node.mdx @@ -277,7 +277,7 @@ for information on which ports are required to be open on your machine. ::: If you need a list of RPC endpoints to connect to, you can find the -[list on the Mocha Testnet page](../mocha-testnet#rpc-endpoints). +[list on the Mocha testnet page](../mocha-testnet#rpc-endpoints). ### Run the bridge node