diff --git a/.vitepress/config.ts b/.vitepress/config.ts index a9116f11037..fecacc6c331 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -8,827 +8,852 @@ const { BASE: base = "/" } = process.env; // https://vitepress.dev/concepts/site-config export default { - lang: "en-US", - title: "Celestia Docs", - description: "The first modular blockchain network.", - lastUpdated: true, - cleanUrls: true, - ignoreDeadLinks: true, - base: base, - markdown: { - math: true, - }, - sitemap: { - hostname: "https://docs.celestia.org", - }, + lang: "en-US", + title: "Celestia Docs", + description: "The first modular blockchain network.", + lastUpdated: true, + cleanUrls: true, + ignoreDeadLinks: true, + base: base, + markdown: { + math: true, + }, + sitemap: { + hostname: "https://docs.celestia.org", + }, - head: [ - [ - "link", - { - rel: "icon", - href: "/favicons/favicon.svg", - type: "image/svg+xml", - }, - ], - // [ - // "link", - // { - // rel: "icon", - // type: "image/svg+xml", - // href: "/favicons/favicon-dark.svg", - // media: "(prefers-color-scheme: dark)", - // }, - // ], - [ - "link", - { - rel: "icon", - href: "/favicons/favicon.png", - type: "image/png", - }, - ], - // [ - // "link", - // { - // rel: "icon", - // type: "image/png", - // href: "/favicons/favicon-dark.png", - // media: "(prefers-color-scheme: dark)", - // }, - // ], - [ - "link", - { - rel: "shortcut icon", - href: "/favicons/favicon.ico", - type: "image/x-icon", - }, - ], - // [ - // "link", - // { - // rel: "icon", - // type: "image/x-icon", - // href: "/favicons/favicon-dark.ico", - // media: "(prefers-color-scheme: dark)", - // }, - // ], - ["meta", { name: "msapplication-TileColor", content: "#fff" }], - ["meta", { name: "theme-color", content: "#fff" }], - [ - "meta", - { - name: "viewport", - content: - "width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no", - }, - ], - // ['meta', { property: 'og:title', content: 'Celestia' }], - // ['meta', { property: 'og:description', content: 'The first modular blockchain network.' }], - [ - "meta", - { - property: "description", - content: "The first modular blockchain network.", - }, - ], - ["meta", { httpEquiv: "Content-Language", content: "en" }], - ["meta", { name: "twitter:card", content: "summary_large_image" }], - ["meta", { name: "twitter:image", content: "/Celestia-og.png" }], - [ - "meta", - { - name: "twitter:site:domain", - content: "docs.celestia.org", - }, - ], - [ - "meta", - { - name: "twitter:url", - content: "https://docs.celestia.org", - }, - ], - ["meta", { name: "og:image", content: "/Celestia-og.png" }], - ["meta", { name: "apple-mobile-web-app-title", content: "Celestia" }], - [ - "script", - {}, - ` + head: [ + [ + "link", + { + rel: "icon", + href: "/favicons/favicon.svg", + type: "image/svg+xml", + }, + ], + // [ + // "link", + // { + // rel: "icon", + // type: "image/svg+xml", + // href: "/favicons/favicon-dark.svg", + // media: "(prefers-color-scheme: dark)", + // }, + // ], + [ + "link", + { + rel: "icon", + href: "/favicons/favicon.png", + type: "image/png", + }, + ], + // [ + // "link", + // { + // rel: "icon", + // type: "image/png", + // href: "/favicons/favicon-dark.png", + // media: "(prefers-color-scheme: dark)", + // }, + // ], + [ + "link", + { + rel: "shortcut icon", + href: "/favicons/favicon.ico", + type: "image/x-icon", + }, + ], + // [ + // "link", + // { + // rel: "icon", + // type: "image/x-icon", + // href: "/favicons/favicon-dark.ico", + // media: "(prefers-color-scheme: dark)", + // }, + // ], + ["meta", { name: "msapplication-TileColor", content: "#fff" }], + ["meta", { name: "theme-color", content: "#fff" }], + [ + "meta", + { + name: "viewport", + content: + "width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no", + }, + ], + // ['meta', { property: 'og:title', content: 'Celestia' }], + // ['meta', { property: 'og:description', content: 'The first modular blockchain network.' }], + [ + "meta", + { + property: "description", + content: "The first modular blockchain network.", + }, + ], + ["meta", { httpEquiv: "Content-Language", content: "en" }], + ["meta", { name: "twitter:card", content: "summary_large_image" }], + ["meta", { name: "twitter:image", content: "/Celestia-og.png" }], + [ + "meta", + { + name: "twitter:site:domain", + content: "docs.celestia.org", + }, + ], + [ + "meta", + { + name: "twitter:url", + content: "https://docs.celestia.org", + }, + ], + ["meta", { name: "og:image", content: "/Celestia-og.png" }], + ["meta", { name: "apple-mobile-web-app-title", content: "Celestia" }], + [ + "script", + {}, + ` window.chatbaseConfig = { chatbotId: "oeduJpy4UAtpDuOQcCuVM", } `, + ], + [ + "script", + { + src: "https://www.chatbase.co/embed.min.js", + id: "oeduJpy4UAtpDuOQcCuVM", + defer: true, + }, + ], + [ + "script", + { + src: "https://plausible.celestia.org/js/plausible.js", + "data-domain": "docs.celestia.org", + defer: "true", + }, + ], ], - [ - "script", - { - src: "https://www.chatbase.co/embed.min.js", - id: "oeduJpy4UAtpDuOQcCuVM", - defer: true, - }, - ], - [ - "script", - { - src: "https://plausible.celestia.org/js/plausible.js", - "data-domain": "docs.celestia.org", - defer: "true", - }, - ], - ], - themeConfig: { - // https://vitepress.dev/concepts/default-theme-config - nav: nav(), - outline: { - level: "deep", - }, + themeConfig: { + // https://vitepress.dev/concepts/default-theme-config + nav: nav(), + outline: { + level: "deep", + }, - search: { - provider: "local", - options: { - detailedView: true, - }, - }, + search: { + provider: "local", + options: { + detailedView: true, + }, + }, - sidebar: { - "/": sidebarHome(), - }, + sidebar: { + "/": sidebarHome(), + }, - editLink: { - pattern: "https://github.com/celestiaorg/docs/edit/main/:path", - text: "Edit this page on GitHub", - }, + editLink: { + pattern: "https://github.com/celestiaorg/docs/edit/main/:path", + text: "Edit this page on GitHub", + }, - logo: { - alt: "Celestia Logo", - light: "/logo-light.svg", - dark: "/logo-dark.svg", - }, + logo: { + alt: "Celestia Logo", + light: "/logo-light.svg", + dark: "/logo-dark.svg", + }, - siteTitle: false, + siteTitle: false, - socialLinks: [ - { icon: "github", link: "https://github.com/celestiaorg/docs" }, - { icon: "twitter", link: "https://twitter.com/CelestiaOrg" }, - { icon: "youtube", link: "https://www.youtube.com/@CelestiaNetwork" }, - { icon: "discord", link: "https://discord.gg/celestiacommunity" }, - { icon: { svg: telegramSVG }, link: "https://t.me/CelestiaCommunity" }, - ], + socialLinks: [ + { icon: "github", link: "https://github.com/celestiaorg/docs" }, + { icon: "twitter", link: "https://twitter.com/CelestiaOrg" }, + { icon: "youtube", link: "https://www.youtube.com/@CelestiaNetwork" }, + { icon: "discord", link: "https://discord.gg/celestiacommunity" }, + { icon: { svg: telegramSVG }, link: "https://t.me/CelestiaCommunity" }, + ], - transformHead(assets: string[]): HeadConfig[] { - const ruberoidLightFont = assets.find( - (file) => /Ruberoid-Light\.\w+\.otf/, - ); - const ruberoidRegularFont = assets.find( - (file) => /Ruberoid-Regular\.\w+\.otf/, - ); - const ruberoidBoldFont = assets.find((file) => /Ruberoid-Bold\.\w+\.otf/); + transformHead(assets: string[]): HeadConfig[] { + const ruberoidLightFont = assets.find( + (file) => /Ruberoid-Light\.\w+\.otf/, + ); + const ruberoidRegularFont = assets.find( + (file) => /Ruberoid-Regular\.\w+\.otf/, + ); + const ruberoidBoldFont = assets.find((file) => /Ruberoid-Bold\.\w+\.otf/); - const headConfig: HeadConfig[] = []; + const headConfig: HeadConfig[] = []; - if (ruberoidLightFont) { - headConfig.push([ - "link", - { - rel: "preload", - href: ruberoidLightFont, - as: "font", - type: "font/opentype", - crossorigin: "", - }, - ]); - } + if (ruberoidLightFont) { + headConfig.push([ + "link", + { + rel: "preload", + href: ruberoidLightFont, + as: "font", + type: "font/opentype", + crossorigin: "", + }, + ]); + } - if (ruberoidRegularFont) { - headConfig.push([ - "link", - { - rel: "preload", - href: ruberoidRegularFont, - as: "font", - type: "font/opentype", - crossorigin: "", - }, - ]); - } + if (ruberoidRegularFont) { + headConfig.push([ + "link", + { + rel: "preload", + href: ruberoidRegularFont, + as: "font", + type: "font/opentype", + crossorigin: "", + }, + ]); + } - if (ruberoidBoldFont) { - headConfig.push([ - "link", - { - rel: "preload", - href: ruberoidBoldFont, - as: "font", - type: "font/opentype", - crossorigin: "", - }, - ]); - } - return headConfig; + if (ruberoidBoldFont) { + headConfig.push([ + "link", + { + rel: "preload", + href: ruberoidBoldFont, + as: "font", + type: "font/opentype", + crossorigin: "", + }, + ]); + } + return headConfig; + }, }, - }, - transformPageData(pageData) { - pageData.frontmatter.head ??= []; - pageData.frontmatter.head.push([ - "meta", - { - name: "og:title", - content: - pageData.frontmatter.layout === "home" - ? `Celestia Docs` - : `${pageData.title} | Celestia Docs`, - }, - { - name: "og:description", - content: pageData.frontmatter.layout === `${pageData.description}`, - }, - ]); - }, -}; - -function nav() { - return [ - { - text: "Join the network", - items: [ - { text: "Learn", link: "/learn/how-celestia-works/overview" }, - { text: "Networks", link: "/nodes/participate" }, - { text: "Nodes", link: "/nodes/overview" }, - { text: "Developers", link: "/developers/build-whatever" }, - { text: "Discord", link: "https://discord.gg/celestiacommunity" }, - { - text: "Quick start", - items: [ - { text: "Blob tutorial", link: "/developers/node-tutorial" }, + transformPageData(pageData) { + pageData.frontmatter.head ??= []; + pageData.frontmatter.head.push([ + "meta", { - text: "celestia-app specs", - link: "https://celestiaorg.github.io/celestia-app/", + name: "og:title", + content: + pageData.frontmatter.layout === "home" + ? `Celestia Docs` + : `${pageData.title} | Celestia Docs`, }, { - text: "celestia-node API", - link: "https://node-rpc-docs.celestia.org/", + name: "og:description", + content: pageData.frontmatter.layout === `${pageData.description}`, }, - ], - }, - ], + ]); }, - ]; -} +}; -function sidebarHome() { - return [ - { - text: "Learn", - collapsed: true, - items: [ +function nav() { + return [ { - text: "Overview of Celestia", - collapsed: true, - items: [ - { - text: "Introduction", - link: "/learn/how-celestia-works/overview", - }, - { - text: "Monolithic vs. modular blockchains", - link: "/learn/how-celestia-works/monolithic-vs-modular", - }, - { - text: "Data availability layer", - collapsed: true, - items: [ - { - text: "Celestia's data availability layer", - link: "/learn/how-celestia-works/data-availability-layer", - }, - { - text: "The lifecycle of a celestia-app transaction", - link: "/learn/how-celestia-works/transaction-lifecycle", - }, - { - text: "Data retrievability and pruning", - link: "/learn/retrievability", - }, - { - text: "Data availability FAQ", - link: "/learn/how-celestia-works/data-availability-faq", - }, - ], - }, - { - text: "Extra resources", - collapsed: true, - items: [ - { - text: "Learn modular", - link: "https://celestia.org/learn/", - }, - { - text: "celestia-app specifications", - link: "https://celestiaorg.github.io/celestia-app/", - }, - { - text: "celestia-node API documentation", - link: "https://node-rpc-docs.celestia.org/", - }, - { - text: "Celestia glossary", - link: "https://celestia.org/glossary/", - }, - { - text: "Awesome Celestia resources", - link: "https://github.com/celestiaorg/awesome-celestia/", + text: "Join the network", + items: [ + { text: "Learn", link: "/learn/how-celestia-works/overview" }, + { text: "Build whatever", link: "/how-to-guides/build-whatever" }, + { text: "Node API", link: "/tutorials/node-api" }, + { text: "Discord", link: "https://discord.gg/celestiacommunity" }, + { + text: "Quick start", + items: [ + { text: "Run a node", link: "/how-to-guides/nodes-overview" }, + { text: "Blob tutorial", link: "/tutorials/node-tutorial" }, + { + text: "celestia-app specs", + link: "https://celestiaorg.github.io/celestia-app/", + }, + { + text: "celestia-node API docs", + link: "https://node-rpc-docs.celestia.org/", + }, + ], }, - ], - }, - ], - }, - { - text: "TIA", - collapsed: true, - items: [ - { - text: "Overview of TIA", - link: "/learn/tia", - }, - { - text: "Paying for blobspace", - link: "/learn/paying-for-blobspace", - }, - { - text: "Staking, governance, & supply", - link: "/learn/staking-governance-supply", - }, - { - text: "How to stake TIA", - link: "/learn/how-to-stake-tia", - }, - { - text: "Staking dashboards", - link: "/learn/staking", - }, - ], - }, - ], - }, - { - text: "Run a node", - collapsed: true, - items: [ - { text: "Overview", link: "/nodes/overview" }, - { - text: "Quick start", - link: "/nodes/quick-start", - collapsed: true, - items: [ - { text: "Deciding which node to run", link: "/nodes/decide-node" }, - { text: "Setting up environment ", link: "/nodes/environment" }, - { text: "Install celestia-node", link: "/nodes/celestia-node" }, - { text: "Install celestia-app", link: "/nodes/celestia-app" }, - { text: "Docker images", link: "/nodes/docker-images" }, - ], - }, - { - text: "Networks", - collapsed: true, - items: [ - { text: "Networks overview", link: "/nodes/participate"}, - { text: "Mainnet Beta", link: "/nodes/mainnet" }, - { text: "Mocha testnet", link: "/nodes/mocha-testnet" }, - { text: "Arabica devnet", link: "/nodes/arabica-devnet" }, - ], + ], }, + ]; +} + +function sidebarHome() { + return [ { - text: "Types of nodes", - collapsed: true, - items: [ - { - text: "Data availability", - collapsed: true, - items: [ - { text: "Light node", link: "/nodes/light-node" }, - { text: "Full node", link: "/nodes/full-storage-node" }, - { text: "Bridge node", link: "/nodes/bridge-node" }, - ], - }, - { - text: "Consensus", - collapsed: true, - items: [ - { text: "Consensus node", link: "/nodes/consensus-node" }, - { text: "Validator node", link: "/nodes/validator-node" }, - ], - }, - { - text: "IBC relayers", - collapsed: true, - items: [ + text: "Learn", + collapsed: true, + items: [ { - text: "IBC relaying guide", - link: "/nodes/ibc-relayer", + text: "Overview of Celestia", + collapsed: true, + items: [ + { + text: "Introduction", + link: "/learn/how-celestia-works/overview", + }, + { + text: "Monolithic vs. modular blockchains", + link: "/learn/how-celestia-works/monolithic-vs-modular", + }, + { + text: "Data availability layer", + collapsed: true, + items: [ + { + text: "Celestia's data availability layer", + link: "/learn/how-celestia-works/data-availability-layer", + }, + { + text: "The lifecycle of a celestia-app transaction", + link: "/learn/how-celestia-works/transaction-lifecycle", + }, + { + text: "Data retrievability and pruning", + link: "/learn/retrievability", + }, + { + text: "Data availability FAQ", + link: "/learn/how-celestia-works/data-availability-faq", + }, + ], + }, + { + text: "Extra resources", + collapsed: true, + items: [ + { + text: "Learn modular", + link: "https://celestia.org/learn/", + }, + { + text: "celestia-app specifications", + link: "https://celestiaorg.github.io/celestia-app/", + }, + { + text: "celestia-node API documentation", + link: "https://node-rpc-docs.celestia.org/", + }, + { + text: "Celestia glossary", + link: "https://celestia.org/glossary/", + }, + { + text: "Awesome Celestia resources", + link: "https://github.com/celestiaorg/awesome-celestia/", + }, + ], + }, + ], }, { - text: "IBC relayers", - link: "https://www.mintscan.io/celestia/relayers", + text: "TIA", + collapsed: true, + items: [ + { + text: "Overview of TIA", + link: "/learn/tia", + }, + { + text: "Paying for blobspace", + link: "/learn/paying-for-blobspace", + }, + { + text: "Staking, governance, & supply", + link: "/learn/staking-governance-supply", + }, + { + text: "How to stake TIA", + link: "/learn/how-to-stake-tia", + }, + { + text: "Staking dashboards", + link: "/learn/staking", + }, + ], }, - ], - }, - ], + ], }, { - text: "Resources", - collapsed: true, - items: [ - { - text: "celestia-node", - collapsed: true, - items: [ - { text: "Metrics", link: "/nodes/celestia-node-metrics" }, - { text: "config.toml guide", link: "/nodes/config-toml" }, - { - text: "Custom networks and values", - link: "/nodes/celestia-node-custom-networks", - }, - { - text: "Syncing a light node from a trusted hash", - link: "/nodes/celestia-node-trusted-hash", - }, - { - text: "Troubleshooting", - link: "/nodes/celestia-node-troubleshooting", - }, - ], - }, - { - text: "celestia-app", - collapsed: true, - items: [ - { - text: "Specifications", - link: "https://celestiaorg.github.io/celestia-app/", - }, - { - text: "Metrics, visualization, and alerts", - link: "/nodes/celestia-app-metrics", - }, - { - text: "Jailing and slashing mechanics", - link: "/nodes/celestia-app-slashing", - }, - { - text: "Create a Celestia testnet", - link: "/nodes/instantiate-testnet", - }, - { - text: "Helpful CLI commands", - link: "/nodes/celestia-app-commands", - }, - { - text: "Upgrade Monitor", - link: "/nodes/celestia-app-upgrade-monitor", - }, - { - text: "Wallets in celestia-app", - link: "/nodes/celestia-app-wallet", - }, - { - text: "Multisig", - link: "/nodes/celestia-app-multisig", - }, - { - text: "Create a vesting account", - link: "/nodes/celestia-app-vesting", - }, - ], - }, - { text: "SystemD", link: "/nodes/systemd" }, - { text: "Network upgrade process", link: "/nodes/network-upgrade-process" }, - ], - }, - ], - }, - { - text: "Developers", - collapsed: true, - items: [ - { - text: "Build whatever", - link: "/developers/build-whatever", - collapsed: true, - items: [ - { - text: "EVM", - collapsed: true, - items: [ - { - text: "Arbitrum", - collapsed: true, - items: [ - { - text: "Introduction to Arbitrum rollups with Celestia as DA", - link: "/developers/arbitrum-integration", - }, - { - text: "Quickstart: Deploy an Arbitrum Orbit rollup", - link: "/developers/arbitrum-deploy", - }, - { - text: "How to run a full Orbit rollup node and validator", - link: "/developers/arbitrum-full-node", - }, - { - text: "Bridging in and out of your Orbit rollup", - link: "/developers/arbitrum-bridge", - }, - { - text: "How to customize your Orbit chain's deployment configuration", - link: "https://docs.arbitrum.io/launch-orbit-chain/how-tos/customize-deployment-configuration", - }, - { - text: "Audit", - link: "https://github.com/celestiaorg/nitro/blob/celestia-v2.3.3/audits/celestia/arbitrum_nitro_celestia_audit_report.pdf", - } - ], - }, - { - text: "Astria", - collapsed: true, - items: [ - { text: "Documentation", link: "https://docs.astria.org" }, - { - text: "Just deploy", - link: "https://docs.astria.org/developer/tutorials/install-the-cli", - }, - ], + text: "How-to guides", + collapsed: true, + items: [ + { + text: "Run a node", + link: "/how-to-guides/nodes-overview", + collapsed: true, + items: [ + { + text: "Quick start", + link: "/how-to-guides/quick-start", + collapsed: true, + items: [ + { text: "Deciding which node to run", link: "/how-to-guides/decide-node" }, + { text: "Setting up environment ", link: "/how-to-guides/environment" }, + { text: "Install celestia-node", link: "/how-to-guides/celestia-node" }, + { text: "Install celestia-app", link: "/how-to-guides/celestia-app" }, + { text: "Docker images", link: "/how-to-guides/docker-images" }, + ], + }, + { + text: "Networks", + collapsed: true, + items: [ + { text: "Networks overview", link: "/how-to-guides/participate" }, + { text: "Mainnet Beta", link: "/how-to-guides/mainnet" }, + { text: "Mocha testnet", link: "/how-to-guides/mocha-testnet" }, + { text: "Arabica devnet", link: "/how-to-guides/arabica-devnet" }, + ], + }, + { + text: "Types of nodes", + collapsed: true, + items: [ + { + text: "Data availability", + collapsed: true, + items: [ + { text: "Light node", link: "/how-to-guides/light-node" }, + { text: "Full node", link: "/how-to-guides/full-storage-node" }, + { text: "Bridge node", link: "/how-to-guides/bridge-node" }, + ], + }, + { + text: "Consensus", + collapsed: true, + items: [ + { text: "Consensus node", link: "/how-to-guides/consensus-node" }, + { text: "Validator node", link: "/how-to-guides/validator-node" }, + ], + }, + { + text: "IBC relayers", + collapsed: true, + items: [ + { + text: "IBC relaying guide", + link: "/how-to-guides/ibc-relayer", + }, + { + text: "IBC relayers", + link: "https://www.mintscan.io/celestia/relayers", + }, + ], + }, + ], + }, + { + text: "Resources", + collapsed: true, + items: [ + { + text: "celestia-node", + collapsed: true, + items: [ + { text: "Metrics", link: "/how-to-guides/celestia-node-metrics" }, + { text: "config.toml guide", link: "/how-to-guides/config-toml" }, + { + text: "Custom networks and values", + link: "/how-to-guides/celestia-node-custom-networks", + }, + { + text: "Syncing a light node from a trusted hash", + link: "/how-to-guides/celestia-node-trusted-hash", + }, + { + text: "Troubleshooting", + link: "/how-to-guides/celestia-node-troubleshooting", + }, + ], + }, + { + text: "celestia-app", + collapsed: true, + items: [ + { + text: "Specifications", + link: "https://celestiaorg.github.io/celestia-app/", + }, + { + text: "Metrics, visualization, and alerts", + link: "/how-to-guides/celestia-app-metrics", + }, + { + text: "Jailing and slashing mechanics", + link: "/how-to-guides/celestia-app-slashing", + }, + { + text: "Create a Celestia testnet", + link: "/how-to-guides/instantiate-testnet", + }, + { + text: "Helpful CLI commands", + link: "/how-to-guides/celestia-app-commands", + }, + { + text: "Upgrade Monitor", + link: "/how-to-guides/celestia-app-upgrade-monitor", + }, + { + text: "Wallets in celestia-app", + link: "/how-to-guides/celestia-app-wallet", + }, + { + text: "Multisig", + link: "/how-to-guides/celestia-app-multisig", + }, + { + text: "Create a vesting account", + link: "/how-to-guides/celestia-app-vesting", + }, + ], + }, + { text: "SystemD", link: "/how-to-guides/systemd" }, + { text: "Network upgrade process", link: "/how-to-guides/network-upgrade-process" }, + ], + }, + ], }, { - text: "Optimism", - collapsed: true, - items: [ - { - text: "Intro to OP Stack integration", - link: "/developers/intro-to-op-stack", - }, - { - text: "Run an OP Stack devnet posting Celestia", - link: "/developers/optimism", - }, - { - text: "OP Stack testnets", - collapsed: true, - items: [ + text: "Build whatever", + link: "/how-to-guides/build-whatever", + collapsed: true, + items: [ { - text: "Bubs testnet", - link: "/developers/bubs-testnet", + text: "EVM", + collapsed: true, + items: [ + { + text: "Arbitrum", + collapsed: true, + items: [ + { + text: "Introduction to Arbitrum rollups with Celestia as DA", + link: "/how-to-guides/arbitrum-integration", + }, + { + text: "Quickstart: Deploy an Arbitrum Orbit rollup", + link: "/how-to-guides/arbitrum-deploy", + }, + { + text: "How to run a full Orbit rollup node and validator", + link: "/how-to-guides/arbitrum-full-node", + }, + { + text: "Bridging in and out of your Orbit rollup", + link: "/how-to-guides/arbitrum-bridge", + }, + { + text: "How to customize your Orbit chain's deployment configuration", + link: "https://docs.arbitrum.io/launch-orbit-chain/how-tos/customize-deployment-configuration", + }, + { + text: "Audit", + link: "https://github.com/celestiaorg/nitro/blob/celestia-v2.3.3/audits/celestia/arbitrum_nitro_celestia_audit_report.pdf", + } + ], + }, + { + text: "Astria", + collapsed: true, + items: [ + { text: "Documentation", link: "https://docs.astria.org" }, + { + text: "Just deploy", + link: "https://docs.astria.org/developer/tutorials/install-the-cli", + }, + ], + }, + { + text: "Optimism", + collapsed: true, + items: [ + { + text: "Intro to OP Stack integration", + link: "/how-to-guides/intro-to-op-stack", + }, + { + text: "Run an OP Stack devnet posting Celestia", + link: "/how-to-guides/optimism", + }, + { + text: "OP Stack testnets", + collapsed: true, + items: [ + { + text: "Bubs testnet", + link: "/how-to-guides/bubs-testnet", + }, + { + text: "Raspberry testnet", + link: "https://raas.gelato.network/rollups/details/public/opcelestia-raspberry", + }, + ] + }, + { + text: "Audit", + link: "https://docs.celestia.org/audits/Celestia_OP_Stack_Audit.pdf", + }, + { + text: "Rollups as a Service", + collapsed: true, + items: [ + { + text: "Caldera", + link: "https://caldera.xyz/", + }, + { + text: "Conduit", + link: "https://conduit.xyz/", + } + ], + }, + + ], + }, + { + text: "Ethereum fallback mechanism", + link: "/how-to-guides/ethereum-fallback", + }, + ], }, { - text: "Raspberry testnet", - link: "https://raas.gelato.network/rollups/details/public/opcelestia-raspberry", + text: "Sovereign", + collapsed: true, + items: [ + { text: "Rollkit", link: "https://rollkit.dev" }, + { + text: "Sovereign SDK", + link: "https://github.com/Sovereign-Labs/sovereign-sdk/tree/stable/examples/demo-rollup#demo-rollup", + }, + ], }, - ] - }, - { - text: "Audit", - link: "https://docs.celestia.org/audits/Celestia_OP_Stack_Audit.pdf", - }, - { - text: "Rollups as a Service", - collapsed: true, - items: [ { - text: "Caldera", - link: "https://caldera.xyz/", + text: "Blobstream rollups", + link: "/how-to-guides/blobstream-rollups", }, { - text: "Conduit", - link: "https://conduit.xyz/", + text: "Other", + collapsed: true, + items: [ + { + text: "Dymension", + link: "https://docs.dymension.xyz/", + }, + ] } - ], - }, - - ], + ], }, { - text: "Ethereum fallback mechanism", - link: "/developers/ethereum-fallback", - }, - ], - }, - { - text: "Sovereign", - collapsed: true, - items: [ - { text: "Rollkit", link: "https://rollkit.dev" }, - { - text: "Sovereign SDK", - link: "https://github.com/Sovereign-Labs/sovereign-sdk/tree/stable/examples/demo-rollup#demo-rollup", - }, - ], - }, - { - text: "Blobstream rollups", - link: "/developers/blobstream-rollups", - }, - { - text: "Other", - collapsed: true, - items: [ + text: "Post data to Celestia", + collapsed: true, + items: [ + { + text: "Submitting data blobs to Celestia", + link: "/how-to-guides/submit-data", + }, + { + text: "FeeGrant module for blobs submission", + link: "/how-to-guides/feegrant-for-blobs", + }, + { + text: "MultiAccounts feature for blobs submission", + link: "/how-to-guides/multiaccounts", + }, + { + text: "Transaction resubmission guidelines", + link: "/how-to-guides/transaction-resubmission", + }, + ] + }, { - text: "Dymension", - link: "https://docs.dymension.xyz/", + text: "Integrate with Blobstream", + collapsed: true, + items: [ + { + text: "Overview of Blobstream", + link: "/how-to-guides/blobstream", + }, + { + text: "Integrate with Blobstream contracts", + link: "/how-to-guides/blobstream-contracts", + }, + { + text: "Integrate with Blobstream client", + link: "/how-to-guides/blobstream-offchain", + }, + { + text: "Querying the Blobstream proofs", + link: "/how-to-guides/blobstream-proof-queries", + }, + { + text: "SP1 Blobstream", + collapsed: true, + items: [ + { + text: "Local SP1 Blobstream operators", + collapsed: true, + items: [ + { + text: "New SP1 Blobstream deployments", + link: "/how-to-guides/sp1-blobstream-deploy", + }, + ], + }, + { + text: "SP1 Blobstream audits", + collapsed: true, + items: [ + { + text: "Ottersec", + link: "https://docs.celestia.org/audits/SP1_Blobstream_Ottersec_Audit.pdf", + }, + { + text: "SP1 Audits", + link: "https://github.com/succinctlabs/sp1/tree/dev/audits" + } + ] + }, + ] + }, + { + text: "Blobstream X", + collapsed: true, + items: [ + { + text: "Overview of BlobstreamX", + link: "/how-to-guides/blobstreamx", + }, + { + text: "Example implementation of Blobstream proofs by CryptoKass", + link: "https://github.com/CryptoKass/blobstreamx-example", + }, + { + text: "Local Blobstream X operators", + collapsed: true, + items: [ + { + text: "Requesting data commitment ranges", + link: "/how-to-guides/blobstream-x-requesting-data-commitment-ranges", + }, + { + text: "New Blobstream X deployments", + link: "/how-to-guides/blobstream-x-deploy", + } + ] + }, + { + text: "Blobstream X audits", + collapsed: true, + items: [ + { + text: "Informal Systems", + link: "https://docs.celestia.org/audits/Blobstream_X-Informal_Systems_Audit.pdf", + }, + { + text: "OtterSec", + link: "https://docs.celestia.org/audits/Blobstream_X-OtterSec_Audit.pdf", + }, + { + text: "Veridise", + link: "https://docs.celestia.org/audits/Blobstream_X-Veridise_Audit.pdf", + }, + { + text: "Zellic", + link: "https://docs.celestia.org/audits/Blobstream_X-Zellic_Audit.pdf", + } + ], + } + ] + }, + ], }, - ] - } - ], - }, - { - text: "Posting data to Celestia", - collapsed: true, - items: [ - { - text: "Submitting data blobs to Celestia", - link: "/developers/submit-data", - }, - { - text: "FeeGrant module for blobs submission", - link: "/developers/feegrant-for-blobs", - }, - { - text: "MultiAccounts feature for blobs submission", - link: "/developers/multiaccounts", - }, - { - text: "Transaction resubmission guidelines", - link: "/developers/transaction-resubmission", - }, - ] - }, - { - text: "Node API", - link: "/developers/node-api", - collapsed: true, - items: [ - { - text: "CLI tutorial", - link: "/developers/node-tutorial", - }, - { - text: "Golang client tutorial", - link: "/developers/golang-client-tutorial", - }, - { - text: "Rust client tutorial", - link: "/developers/rust-client-tutorial", - }, - { - text: "RPC documentation & playground", - link: "https://node-rpc-docs.celestia.org/", - }, - { text: "Prompt Scavenger", link: "/developers/prompt-scavenger" }, - ], - }, + ], + }, { - text: "Integrate with Blobstream", - collapsed: true, - items: [ - { - text: "Overview of Blobstream", - link: "/developers/blobstream", - }, - { - text: "Integrate with Blobstream contracts", - link: "/developers/blobstream-contracts", - }, - { - text: "Integrate with Blobstream client", - link: "/developers/blobstream-offchain", - }, - { - text: "Querying the Blobstream proofs", - link: "/developers/blobstream-proof-queries", - }, - { - text: "SP1 Blobstream", - collapsed: true, - items: [ - { - text: "Local SP1 Blobstream operators", - collapsed: true, - items: [ - { - text: "New SP1 Blobstream deployments", - link: "/developers/sp1-blobstream-deploy", - }, - ], - }, - { - text: "SP1 Blobstream audits", - collapsed: true, - items: [ - { - text: "Ottersec", - link: "https://docs.celestia.org/audits/SP1_Blobstream_Ottersec_Audit.pdf", - }, - { - text: "SP1 Audits", - link: "https://github.com/succinctlabs/sp1/tree/dev/audits" - } - ] + text: "Tutorials", + collapsed: true, + items: [ + { + text: "Node API Tutorials", + link: "/tutorials/node-api", + collapsed: true, + items: [ + { + text: "CLI tutorial", + link: "/tutorials/node-tutorial", + }, + { + text: "Golang client tutorial", + link: "/tutorials/golang-client-tutorial", + }, + { + text: "Rust client tutorial", + link: "/tutorials/rust-client-tutorial", + }, + { + text: "RPC documentation & playground", + link: "https://node-rpc-docs.celestia.org/", + }, + { text: "Prompt Scavenger", link: "/tutorials/prompt-scavenger" }, + ], + }, + { + text: "Wallets", + collapsed: true, + items: [ + { + text: "Celestia-node", + link: "/tutorials/celestia-node-key" + }, + { + text: "Integrating Wallets for developers", + link: "/tutorials/wallets", + }, + ], }, - ] - }, - { - text: "Blobstream X", - collapsed: true, - items: [ { - text: "Overview of BlobstreamX", - link: "/developers/blobstreamx", + text: "Integrate Celestia for service providers", + link: "/tutorials/integrate-celestia", }, + + ] + }, + { + text: "References", + collapsed: true, + items: [ { - text: "Example implementation of Blobstream proofs by CryptoKass", - link: "https://github.com/CryptoKass/blobstreamx-example", + text: "celestia-node api documentation", + link: "https://node-rpc-docs.celestia.org/", }, { - text: "Local Blobstream X operators", - collapsed: true, - items: [ - { - text: "Requesting data commitment ranges", - link: "/developers/blobstream-x-requesting-data-commitment-ranges", - }, - { - text: "New Blobstream X deployments", - link: "/developers/blobstream-x-deploy", - } - ] + text: "celestia-app specifications", + link: "https://celestiaorg.github.io/celestia-app/", }, - { - text: "Blobstream X audits", - collapsed: true, - items: [ - { - text: "Informal Systems", - link: "https://docs.celestia.org/audits/Blobstream_X-Informal_Systems_Audit.pdf", - }, - { - text: "OtterSec", - link: "https://docs.celestia.org/audits/Blobstream_X-OtterSec_Audit.pdf", - }, - { - text: "Veridise", - link: "https://docs.celestia.org/audits/Blobstream_X-Veridise_Audit.pdf", - }, - { - text: "Zellic", - link: "https://docs.celestia.org/audits/Blobstream_X-Zellic_Audit.pdf", - } - ], - } - ] - }, - ], + ], }, { - text: "Wallets", - collapsed: true, - items: [ - { text: "Celestia-node", link: "/developers/celestia-node-key" }, - { - text: "Integrating Wallets for developers", - link: "/developers/wallets", - }, - ], + text: "Community", + collapsed: true, + items: [ + { text: "Discord", link: "https://discord.gg/celestiacommunity" }, + { text: "Code of Conduct", link: "/community/coc" }, + { + text: "Celestia Foundation Delegation Program", + link: "/community/foundation-delegation-program" + }, + { + text: "Modular Meetups", + collapsed: true, + items: [ + { text: "Overview", link: "/community/modular-meetup-intro" }, + { text: "Guide", link: "/community/modular-meetup-guide" }, + { text: "Toolkit", link: "/community/modular-meetup-toolkit" }, + { text: "Speaker list", link: "/community/speaker-list" }, + ], + }, + ], }, - { - text: "Integrate Celestia for service providers", - link: "/developers/integrate-celestia", - }, - ], - }, - { - text: "Community", - collapsed: true, - items: [ - { text: "Discord", link: "https://discord.gg/celestiacommunity"}, - { text: "Code of Conduct", link: "/community/coc" }, - { text: "Celestia Foundation Delegation Program", - link: "/community/foundation-delegation-program" - }, - { - text: "Modular Meetups", - collapsed: true, - items: [ - { text: "Overview", link: "/community/modular-meetup-intro" }, - { text: "Guide", link: "/community/modular-meetup-guide" }, - { text: "Toolkit", link: "/community/modular-meetup-toolkit" }, - { text: "Speaker list", link: "/community/speaker-list" }, - ], - }, - ], - }, - ]; + ] } diff --git a/community/foundation-delegation-program.md b/community/foundation-delegation-program.md index b7afe157204..6a8b524d1c0 100644 --- a/community/foundation-delegation-program.md +++ b/community/foundation-delegation-program.md @@ -70,7 +70,7 @@ The minimum requirements for participation in the program are as follows: for at least 1 month before application deadline * Run a bridge node (on Mainnet Beta if you are already an active Mainnet Beta validator or on Mocha testnet if not) that is connected and reporting -to the Celestia Labs [OTEL collector](../nodes/celestia-node-metrics.md) +to the Celestia Labs [OTEL collector](../how-to-guides/celestia-node-metrics.md) (for new applicants - on testnet, so that we can evaluate performance) * Not jailed or slashed in the 6 months before application deadline * Not associated with an exchange or custodian diff --git a/nodes/arabica-devnet.md b/how-to-guides/arabica-devnet.md similarity index 97% rename from nodes/arabica-devnet.md rename to how-to-guides/arabica-devnet.md index 7052c41147e..367960a32f8 100644 --- a/nodes/arabica-devnet.md +++ b/how-to-guides/arabica-devnet.md @@ -79,7 +79,7 @@ RPC endpoints and types of nodes you can run in order to participate in Arabica | Node type | Endpoint type | Endpoint | | -------------------------------------------------------------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| **Consensus nodes** ([full](../nodes/full-consensus-node.md)) | Consensus RPC | `https://rpc.celestia-arabica-11.com` | +| **Consensus nodes** ([full](../how-to-guides/consensus-node.md)) | Consensus RPC | `https://rpc.celestia-arabica-11.com` | | | API | `https://api.celestia-arabica-11.com` | | | gRPC | `grpc.celestia-arabica-11.com:443` | | | Direct endpoints with open ports | Open ports: 26656 (p2p), 26657 (RPC), 1317 (API), 9090 (GRPC) | diff --git a/developers/arbitrum-bridge.md b/how-to-guides/arbitrum-bridge.md similarity index 99% rename from developers/arbitrum-bridge.md rename to how-to-guides/arbitrum-bridge.md index bb7ffde6687..25a183fcfd5 100644 --- a/developers/arbitrum-bridge.md +++ b/how-to-guides/arbitrum-bridge.md @@ -2,7 +2,7 @@ description: A guide on how to bridge in and out of your Arbitrum Orbit rollup. next: text: "Intro to OP Stack integration" - link: "/developers/intro-to-op-stack" + link: "/how-to-guides/intro-to-op-stack" --- # Bridging in and out of your Orbit rollup diff --git a/developers/arbitrum-deploy.md b/how-to-guides/arbitrum-deploy.md similarity index 99% rename from developers/arbitrum-deploy.md rename to how-to-guides/arbitrum-deploy.md index b331a49e3cd..2978940ed25 100644 --- a/developers/arbitrum-deploy.md +++ b/how-to-guides/arbitrum-deploy.md @@ -34,9 +34,9 @@ and [the original deployment guide](https://docs.arbitrum.io/launch-orbit-chain/ - [Docker](https://docs.docker.com/engine/install/ubuntu/) running on your machine - [Docker Compose](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-20-04) -- A fully synced and funded Mocha testnet [light node](../nodes/light-node.md) +- A fully synced and funded Mocha testnet [light node](../how-to-guides/light-node.md) on **v0.13.2** - - [Mocha testnet faucet](../nodes/mocha-testnet.md#mocha-testnet-faucet) + - [Mocha testnet faucet](../how-to-guides/mocha-testnet.md#mocha-testnet-faucet) - A browser-based Ethereum wallet (like [MetaMask](https://metamask.io)) - At least 1 Arbitrum Sepolia testnet ETH (for custom gas token chains, 0.6 ETH and 0.4 native tokens) @@ -412,7 +412,7 @@ Extra resources in Arbitrum documentation: | Component | Version | Details | |-----------|---------|---------| -| Nitro | [v2.3.1-rc.1](https://github.com/celestiaorg/nitro/releases/tag/v2.3.1-rc.1) | Includes the replay binary for the WASM root `0x10c65b27d5031ce2351c719072e58f3153228887f027f9f6d65300d2b5b30152`. [Read the overview for overall changes](../developers/arbitrum-integration.md). | +| Nitro | [v2.3.1-rc.1](https://github.com/celestiaorg/nitro/releases/tag/v2.3.1-rc.1) | Includes the replay binary for the WASM root `0x10c65b27d5031ce2351c719072e58f3153228887f027f9f6d65300d2b5b30152`. [Read the overview for overall changes](../how-to-guides/arbitrum-integration.md). | | Contracts | [v1.2.1-celestia](https://github.com/celestiaorg/nitro-contracts/releases/tag/v1.2.1-celestia) | Integrates Blobstream X functionality into nitro-contracts v1.2.1 | | Orbit SDK | [v0.8.2 Orbit SDK for Celestia DA](https://github.com/celestiaorg/arbitrum-orbit-sdk/releases/tag/v0.8.2) | This is not compatible with Orbit SDK v0.8.2 or with the latest changes to nitro-contracts for the Atlas upgrade. The Orbit SDK itself is in Alpha. | | celestia-node | [v0.13.1](https://github.com/celestiaorg/celestia-node/releases/tag/v0.13.1) | This integration has only been tested with celestia-node 0.13.1 and only works with said version, and with future versions after that. Under the hood, the Nitro node uses [this commit](https://github.com/celestiaorg/celestia-openrpc/commit/64f04840aa97d4deb821b654b1fb59167d242bd1) of celestia-openrpc. | diff --git a/developers/arbitrum-full-node.md b/how-to-guides/arbitrum-full-node.md similarity index 100% rename from developers/arbitrum-full-node.md rename to how-to-guides/arbitrum-full-node.md diff --git a/developers/arbitrum-integration.md b/how-to-guides/arbitrum-integration.md similarity index 92% rename from developers/arbitrum-integration.md rename to how-to-guides/arbitrum-integration.md index d4f9cd1e565..2da9ea99f7e 100644 --- a/developers/arbitrum-integration.md +++ b/how-to-guides/arbitrum-integration.md @@ -22,9 +22,14 @@ settles on Arbitrum One, Ethereum, or other EVM chains. The integration of Celestia with Arbitrum orbit is possible thanks to 3 key components: -- [DA Provider implementation](#da-provider-implementation) -- [Preimage Oracle implementation](#preimage-oracle-implementation) -- [Blobstream X implementation](#blobstream-x-implementation) +- [Introduction to Arbitrum rollups with Celestia as DA](#introduction-to-arbitrum-rollups-with-celestia-as-da) + - [Overview](#overview) + - [Key components](#key-components) + - [DA provider implementation](#da-provider-implementation) + - [Preimage Oracle Implementation](#preimage-oracle-implementation) + - [Blobstream X implementation](#blobstream-x-implementation) + - [Ethereum fallback mechanism in Nitro](#ethereum-fallback-mechanism-in-nitro) + - [Next steps](#next-steps) Additionally, the [Ethereum fallback mechanism](#ethereum-fallback-mechanism-in-nitro) is a feature of the integration, which is native in Nitro. @@ -42,7 +47,7 @@ Then the `Read` logic takes care of taking the deserialized Blob Pointer struct The following represents a non-exhaustive list of considerations when running a Batch Poster node for a chain with Celestia underneath: - You will need to use a consensus node RPC endpoint, you can -[find a list of them for Mocha](../nodes/mocha-testnet#community-rpc-endpoints) +[find a list of them for Mocha](../how-to-guides/mocha-testnet#community-rpc-endpoints) - The Batch Poster will only post a Celestia batch to the underlying chain if the height for which it posted is in a recent range in BlobstreamX and if the verification succeeds, otherwise it will discard the batch. Since it will wait until a range is relayed, it can take several minutes for a batch to be posted, but one can always make an on-chain request for the BlobstreamX contract to relay a header promptly. The following represents a non-exhaustive list of considerations when running a Nitro node for a chain with Celestia underneath: diff --git a/developers/blobstream-contracts.md b/how-to-guides/blobstream-contracts.md similarity index 99% rename from developers/blobstream-contracts.md rename to how-to-guides/blobstream-contracts.md index 0352b54990b..924a0dc07be 100644 --- a/developers/blobstream-contracts.md +++ b/how-to-guides/blobstream-contracts.md @@ -3,7 +3,7 @@ sidebar_label: Integrate with Blobstream contracts description: Learn how to integrate your L2's onchain logic with Blobstream prev: text: "Overview of Blobstream" - link: "/developers/blobstream" + link: "/how-to-guides/blobstream" --- # Integrate with Blobstream contracts diff --git a/developers/blobstream-offchain.md b/how-to-guides/blobstream-offchain.md similarity index 99% rename from developers/blobstream-offchain.md rename to how-to-guides/blobstream-offchain.md index 35acd0ea87d..e355497b38e 100644 --- a/developers/blobstream-offchain.md +++ b/how-to-guides/blobstream-offchain.md @@ -106,7 +106,7 @@ to Ethereum, this would likely mean running and connecting to a full node. More information on the RPC that is exposed by a Celestia light node can be found [in the RPC documentation](https://node-rpc-docs.celestia.org/). Additionally, if you need more information on how to run a light node, you can -[check out the documentation](../nodes/light-node.md). +[check out the documentation](../how-to-guides/light-node.md). ```go // CelestiaLightNodeClient summarizes the actions that a rollup that uses diff --git a/developers/blobstream-proof-queries.md b/how-to-guides/blobstream-proof-queries.md similarity index 99% rename from developers/blobstream-proof-queries.md rename to how-to-guides/blobstream-proof-queries.md index ab4914ad56b..e13948b4463 100644 --- a/developers/blobstream-proof-queries.md +++ b/how-to-guides/blobstream-proof-queries.md @@ -8,7 +8,7 @@ description: Learn how to query the inclusion proofs used in Blobstream ## Prerequisites -- Access to a Celestia [consensus node](../nodes/consensus-node.md) +- Access to a Celestia [consensus node](../how-to-guides/consensus-node.md) RPC endpoint (or full node). The node doesn't need to be a validating node in order for the proofs to be queried. A full node is enough. @@ -32,8 +32,8 @@ used for the queries. It can be initialized using: }(trpc) ``` -The `` can be retrieved from [Mainnet Beta](../nodes/mainnet.md#integrations) for -and [Mocha](../nodes/mocha-testnet.md) for the Mocha testnet. +The `` can be retrieved from [Mainnet Beta](../how-to-guides/mainnet.md#integrations) for +and [Mocha](../how-to-guides/mocha-testnet.md) for the Mocha testnet. In case the reader wants to interact with an on-chain contract that can be used to verify that data was posted to Celestia, the bindings of that contract are needed. diff --git a/developers/blobstream-rollups.md b/how-to-guides/blobstream-rollups.md similarity index 97% rename from developers/blobstream-rollups.md rename to how-to-guides/blobstream-rollups.md index 5e0766944d9..2b37b39e91e 100644 --- a/developers/blobstream-rollups.md +++ b/how-to-guides/blobstream-rollups.md @@ -2,10 +2,10 @@ description: Learn how to build rollups that use Blobstream. prev: text: "Ethereum fallback mechanism" - link: "/developers/ethereum-fallback" + link: "/how-to-guides/ethereum-fallback" next: text: "Submitting data blobs to Celestia" - link: "/developers/submit-data" + link: "/how-to-guides/submit-data" --- # Introduction to Blobstream rollups @@ -51,12 +51,12 @@ meaning four merkle proofs: to prove that the subtree roots belong to a set of rows in the Celestia block 3. [row roots proofs to the data root](https://github.com/celestiaorg/celestia-app/tree/main/pkg/proof#row-root-to-data-root-inclusion-proof): to prove that those rows belong to the Celestia Block - 4. [data root tuple proof to the data root tuple](https://docs.celestia.org/developers/blobstream-proof-queries#the-commitment-scheme): + 4. [data root tuple proof to the data root tuple](https://docs.celestia.org/how-to-guides/blobstream-proof-queries#the-commitment-scheme): to prove that the Celestia block referenced by its height and data root, was committed to by Blobstream. More details on the blob share commitment inclusion proof can be found in the -[commitment scheme docs](https://docs.celestia.org/developers/blobstream-proof-queries#the-commitment-scheme) +[commitment scheme docs](https://docs.celestia.org/how-to-guides/blobstream-proof-queries#the-commitment-scheme) and also the [data square layout](https://github.com/celestiaorg/celestia-app/blob/main/specs/src/specs/data_square_layout.md#blob-share-commitment-rules). @@ -178,7 +178,7 @@ For the data root, we will use a binary Merkle proof to prove its inclusion in a data root tuple root that was committed to by the Blobstream smart contract. More on this in the -[data root inclusion proofs section](https://docs.celestia.org/developers/blobstream-proof-queries#_1-data-root-inclusion-proof). +[data root inclusion proofs section](https://docs.celestia.org/how-to-guides/blobstream-proof-queries#_1-data-root-inclusion-proof). #### Sequence of spans: Proving inclusion of some data @@ -201,7 +201,7 @@ part of the rollup data is done as follows: root tuple root. This can be created using the [`data_root_inclusion_proof`](https://github.com/celestiaorg/celestia-core/blob/c3ab251659f6fe0f36d10e0dbd14c29a78a85352/rpc/client/http/http.go#L492-L511) query. More on this can be found in the - [data root inclusion proofs documentation](https://docs.celestia.org/developers/blobstream-proof-queries#_1-data-root-inclusion-proof). + [data root inclusion proofs documentation](https://docs.celestia.org/how-to-guides/blobstream-proof-queries#_1-data-root-inclusion-proof). 2. Verify inclusion proof of the data to Celestia data root: @@ -216,7 +216,7 @@ part of the rollup data is done as follows: query. More details on these proofs can be found in the transaction inclusion proof - [documentation](https://docs.celestia.org/developers/blobstream-proof-queries#_2-transaction-inclusion-proof). + [documentation](https://docs.celestia.org/how-to-guides/blobstream-proof-queries#_2-transaction-inclusion-proof). 3. Prove that the data is in the sequence spans: @@ -298,7 +298,7 @@ It portrays the different possible data availability proofs, constructs them and shows how to verify them. Also, more details on querying these kinds of proofs can be found in the -[proof queries](https://docs.celestia.org/developers/blobstream-proof-queries) documentation. +[proof queries](https://docs.celestia.org/how-to-guides/blobstream-proof-queries) documentation. ### Optimistic rollups that use blob share commitments diff --git a/developers/blobstream-x-deploy.md b/how-to-guides/blobstream-x-deploy.md similarity index 99% rename from developers/blobstream-x-deploy.md rename to how-to-guides/blobstream-x-deploy.md index 99a1cc9d6e7..8547be78259 100644 --- a/developers/blobstream-x-deploy.md +++ b/how-to-guides/blobstream-x-deploy.md @@ -1,7 +1,7 @@ --- next: text: "Celestia-node key" - link: "/developers/celestia-node-key" + link: "/tutorials/celestia-node-key" --- # New Blobstream X deployments diff --git a/developers/blobstream-x-requesting-data-commitment-ranges.md b/how-to-guides/blobstream-x-requesting-data-commitment-ranges.md similarity index 96% rename from developers/blobstream-x-requesting-data-commitment-ranges.md rename to how-to-guides/blobstream-x-requesting-data-commitment-ranges.md index 300afacb95c..62cfee7d8a7 100644 --- a/developers/blobstream-x-requesting-data-commitment-ranges.md +++ b/how-to-guides/blobstream-x-requesting-data-commitment-ranges.md @@ -1,7 +1,7 @@ --- prev: text: "Overview of Blobstream X" - link: "/developers/blobstreamx" + link: "/how-to-guides/blobstreamx" --- # Requesting data commitment ranges @@ -54,7 +54,7 @@ to run the operator script. Here are example values for the `.env` file: 1. `TENDERMINT_RPC_URL` from - [the public Celestia list](https://docs.celestia.org/nodes/mainnet#integrations). + [the public Celestia list](https://docs.celestia.org/how-to-guides/mainnet#integrations). 2. `SUCCINCT_RPC_URL` = `https://alpha.succinct.xyz/api` 3. Request for `SUCCINCT_API_KEY` from [the Succinct team](https://alpha.succinct.xyz/partner). diff --git a/developers/blobstream.md b/how-to-guides/blobstream.md similarity index 90% rename from developers/blobstream.md rename to how-to-guides/blobstream.md index 4e5b0fbbc0d..b964501b860 100644 --- a/developers/blobstream.md +++ b/how-to-guides/blobstream.md @@ -153,9 +153,9 @@ the following chains: | Contract | EVM network | Contract address | Attested data on Celestia | Link to Celenium | |----------------| ---------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------- | -| SP1 Blobstream | Ethereum Mainnet | [`0x7Cf3876F681Dbb6EdA8f6FfC45D66B996Df08fAe`](https://etherscan.io/address/0x7Cf3876F681Dbb6EdA8f6FfC45D66B996Df08fAe#events) | [Mainnet Beta](../nodes/mainnet.md) | [Deployment on Celenium](https://celenium.io/blobstream?network=ethereum&page=1) | -| SP1 Blobstream | Arbitrum One | [`0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794`](https://arbiscan.io/address/0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794#events) | [Mainnet Beta](../nodes/mainnet.md) | [Deployment on Celenium](https://celenium.io/blobstream?network=arbitrum&page=1) | -| SP1 Blobstream | Base | [`0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794`](https://basescan.org/address/0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794#events) | [Mainnet Beta](../nodes/mainnet.md) | [Deployment on Celenium](https://celenium.io/blobstream?network=base&page=1) | -| SP1 Blobstream | Sepolia | [`0xf0c6429ebab2e7dc6e05dafb61128be21f13cb1e`](https://sepolia.etherscan.io/address/0xf0c6429ebab2e7dc6e05dafb61128be21f13cb1e#events) | [Mocha testnet](../nodes/mocha-testnet.md) | [Deployment on Celenium](https://mocha-4.celenium.io/blobstream?network=ethereum&page=1) | -| SP1 Blobstream | Arbitrum Sepolia | [`0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2`](https://sepolia.arbiscan.io/address/0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2#events) | [Mocha testnet](../nodes/mocha-testnet.md) | [Deployment on Celenium](https://mocha-4.celenium.io/blobstream?network=arbitrum&page=1) | -| SP1 Blobstream | Base Sepolia | [`0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2`](https://sepolia.basescan.org/address/0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2#events) | [Mocha testnet](../nodes/mocha-testnet.md) | [Deployment on Celenium](https://mocha-4.celenium.io/blobstream?network=base&page=1) | +| SP1 Blobstream | Ethereum Mainnet | [`0x7Cf3876F681Dbb6EdA8f6FfC45D66B996Df08fAe`](https://etherscan.io/address/0x7Cf3876F681Dbb6EdA8f6FfC45D66B996Df08fAe#events) | [Mainnet Beta](../how-to-guides/mainnet.md) | [Deployment on Celenium](https://celenium.io/blobstream?network=ethereum&page=1) | +| SP1 Blobstream | Arbitrum One | [`0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794`](https://arbiscan.io/address/0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794#events) | [Mainnet Beta](../how-to-guides/mainnet.md) | [Deployment on Celenium](https://celenium.io/blobstream?network=arbitrum&page=1) | +| SP1 Blobstream | Base | [`0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794`](https://basescan.org/address/0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794#events) | [Mainnet Beta](../how-to-guides/mainnet.md) | [Deployment on Celenium](https://celenium.io/blobstream?network=base&page=1) | +| SP1 Blobstream | Sepolia | [`0xf0c6429ebab2e7dc6e05dafb61128be21f13cb1e`](https://sepolia.etherscan.io/address/0xf0c6429ebab2e7dc6e05dafb61128be21f13cb1e#events) | [Mocha testnet](../how-to-guides/mocha-testnet.md) | [Deployment on Celenium](https://mocha-4.celenium.io/blobstream?network=ethereum&page=1) | +| SP1 Blobstream | Arbitrum Sepolia | [`0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2`](https://sepolia.arbiscan.io/address/0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2#events) | [Mocha testnet](../how-to-guides/mocha-testnet.md) | [Deployment on Celenium](https://mocha-4.celenium.io/blobstream?network=arbitrum&page=1) | +| SP1 Blobstream | Base Sepolia | [`0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2`](https://sepolia.basescan.org/address/0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2#events) | [Mocha testnet](../how-to-guides/mocha-testnet.md) | [Deployment on Celenium](https://mocha-4.celenium.io/blobstream?network=base&page=1) | diff --git a/developers/blobstreamx.md b/how-to-guides/blobstreamx.md similarity index 96% rename from developers/blobstreamx.md rename to how-to-guides/blobstreamx.md index 83c56819001..bb9c1e8cd17 100644 --- a/developers/blobstreamx.md +++ b/how-to-guides/blobstreamx.md @@ -2,10 +2,10 @@ description: What is BlobstreamX prev: text: "New SP1 Blobstream deployments" - link: "/developers/sp1-blobstream-deploy" + link: "/how-to-guides/sp1-blobstream-deploy" next: text: "Requesting data commitment ranges" - link: "/developers/blobstream-x-requesting-data-commitment-ranges" + link: "/how-to-guides/blobstream-x-requesting-data-commitment-ranges" --- # Blobstream X: the previous zk implementation of Blobstream diff --git a/nodes/bridge-node.md b/how-to-guides/bridge-node.md similarity index 98% rename from nodes/bridge-node.md rename to how-to-guides/bridge-node.md index 1b040932e0f..06891fe147e 100644 --- a/nodes/bridge-node.md +++ b/how-to-guides/bridge-node.md @@ -84,7 +84,7 @@ add the port after the IP address or use the port if you prefer. Refer to -[the ports section of the celestia-node troubleshooting page](../nodes/celestia-node-troubleshooting.md#ports) +[the ports section of the celestia-node troubleshooting page](../how-to-guides/celestia-node-troubleshooting.md#ports) for information on which ports are required to be open on your machine. Using an RPC of your own, or one from the @@ -136,7 +136,7 @@ celestia bridge start --core.ip validator-1.celestia-arabica-11.com \ --p2p.network arabica ``` -You can create your key for your node by [following the `cel-key` instructions](../../developers/celestia-node-key). +You can create your key for your node by [following the `cel-key` instructions](../../tutorials/celestia-node-key). Once you start the bridge node, a wallet key will be generated for you. You will need to fund that address with Testnet tokens to pay for diff --git a/developers/bubs-testnet.md b/how-to-guides/bubs-testnet.md similarity index 96% rename from developers/bubs-testnet.md rename to how-to-guides/bubs-testnet.md index 509fdd4760a..41e9cd8c6f7 100644 --- a/developers/bubs-testnet.md +++ b/how-to-guides/bubs-testnet.md @@ -2,7 +2,7 @@ description: The first testnet built with OP Stack and Celestia. next: text: "Ethereum fallback mechanism" - link: "/developers/ethereum-fallback" + link: "/how-to-guides/ethereum-fallback" --- # Bubs testnet @@ -23,7 +23,7 @@ layer. This integration can be found in the The testnet is hosted by [Caldera](https://caldera.xyz), who makes it easy to launch rollups with no code required. Bubs' data is posted to Celestia -on the [Mocha testnet](../nodes/mocha-testnet.md). +on the [Mocha testnet](../how-to-guides/mocha-testnet.md). [View the namespace for Bubs on Celestia's Mocha testnet](https://mocha-4.celenium.io/namespace/000000000000000000000000000000000000ca1de12ad45362e77e87). [Learn more about the setup of the integration in diff --git a/developers/build-whatever.md b/how-to-guides/build-whatever.md similarity index 94% rename from developers/build-whatever.md rename to how-to-guides/build-whatever.md index aa283d54506..e9e8ac971a3 100644 --- a/developers/build-whatever.md +++ b/how-to-guides/build-whatever.md @@ -24,9 +24,9 @@ So, you’re ready to start experimenting and building on Celestia? Here are a few options that are currently available for developers.
- - - + + + diff --git a/nodes/celestia-app-commands.md b/how-to-guides/celestia-app-commands.md similarity index 100% rename from nodes/celestia-app-commands.md rename to how-to-guides/celestia-app-commands.md diff --git a/nodes/celestia-app-metrics.md b/how-to-guides/celestia-app-metrics.md similarity index 98% rename from nodes/celestia-app-metrics.md rename to how-to-guides/celestia-app-metrics.md index ee1064f1416..6f6ceb88989 100644 --- a/nodes/celestia-app-metrics.md +++ b/how-to-guides/celestia-app-metrics.md @@ -2,7 +2,7 @@ description: A guide on how to monitor the health and performance of your system. prev: text: "Troubleshooting" - link: "/nodes/celestia-node-troubleshooting" + link: "/how-to-guides/celestia-node-troubleshooting" --- # Metrics diff --git a/nodes/celestia-app-multisig.md b/how-to-guides/celestia-app-multisig.md similarity index 100% rename from nodes/celestia-app-multisig.md rename to how-to-guides/celestia-app-multisig.md diff --git a/nodes/celestia-app-slashing.md b/how-to-guides/celestia-app-slashing.md similarity index 100% rename from nodes/celestia-app-slashing.md rename to how-to-guides/celestia-app-slashing.md diff --git a/nodes/celestia-app-upgrade-monitor.md b/how-to-guides/celestia-app-upgrade-monitor.md similarity index 100% rename from nodes/celestia-app-upgrade-monitor.md rename to how-to-guides/celestia-app-upgrade-monitor.md diff --git a/nodes/celestia-app-vesting.md b/how-to-guides/celestia-app-vesting.md similarity index 95% rename from nodes/celestia-app-vesting.md rename to how-to-guides/celestia-app-vesting.md index f8e27bee256..55c1a2d044f 100644 --- a/nodes/celestia-app-vesting.md +++ b/how-to-guides/celestia-app-vesting.md @@ -17,9 +17,9 @@ flag to your vesting transaction. ## Local devnet -First, [download and install celestia-app](../nodes/celestia-app.md), +First, [download and install celestia-app](../how-to-guides/celestia-app.md), selecting the -[network and corresponding version](../nodes/participate.md) +[network and corresponding version](../how-to-guides/participate.md) that you would like to use. ### Setting up the local devnet @@ -309,10 +309,10 @@ Next, you can learn how to create a vesting account on Mocha testnet. 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 node and set up a vesting account on -[Mocha testnet](../nodes/mocha-testnet.md). +[Mocha testnet](../how-to-guides/mocha-testnet.md). First, be sure that you have -[installed celestia-app for the latest version for Mocha testnet](../nodes/celestia-app.md). +[installed celestia-app for the latest version for Mocha testnet](../how-to-guides/celestia-app.md). ### Create a wallet @@ -343,14 +343,14 @@ export TO_ADDRESS=address_of_vesting_account ### Fund your account -Head to [the faucet](../nodes/mocha-testnet.md#mocha-testnet-faucet), +Head to [the faucet](../how-to-guides/mocha-testnet.md#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 the -[RPC endpoints on the Mocha testnet page](../nodes/mocha-testnet.md#integrations). +[RPC endpoints on the Mocha testnet page](../how-to-guides/mocha-testnet.md#integrations). If you are running a production application, use a production endpoint. @@ -383,8 +383,8 @@ celestia-appd tx vesting create-vesting-account $TO_ADDRESS 100000utia 168674805 Running a consensus node or validator will prevent you from needing to use an RPC. -You can set up a [validator](../nodes/validator-node.md) -or [consensus node](../nodes/consensus-node.md) +You can set up a [validator](../how-to-guides/validator-node.md) +or [consensus node](../how-to-guides/consensus-node.md) for the previous portion of the tutorial. Note: this may take some time depending on how you choose to sync the diff --git a/nodes/celestia-app-wallet.md b/how-to-guides/celestia-app-wallet.md similarity index 91% rename from nodes/celestia-app-wallet.md rename to how-to-guides/celestia-app-wallet.md index 839a9e89ca0..b8596f287b6 100644 --- a/nodes/celestia-app-wallet.md +++ b/how-to-guides/celestia-app-wallet.md @@ -9,7 +9,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](../how-to-guides/quick-start.md) Note, you do not need to install celestia-node for this tutorial. @@ -60,6 +60,6 @@ celestia-appd query bank balances celestia1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx :::tip Refer to -[the ports section of the celestia-node troubleshooting page](../nodes/celestia-node-troubleshooting.md#ports) +[the ports section of the celestia-node troubleshooting page](../how-to-guides/celestia-node-troubleshooting.md#ports) for information on which ports are required to be open on your machine. ::: diff --git a/nodes/celestia-app.md b/how-to-guides/celestia-app.md similarity index 100% rename from nodes/celestia-app.md rename to how-to-guides/celestia-app.md diff --git a/nodes/celestia-node-custom-networks.md b/how-to-guides/celestia-node-custom-networks.md similarity index 91% rename from nodes/celestia-node-custom-networks.md rename to how-to-guides/celestia-node-custom-networks.md index a94f82af831..5142c6ada51 100644 --- a/nodes/celestia-node-custom-networks.md +++ b/how-to-guides/celestia-node-custom-networks.md @@ -18,7 +18,7 @@ export NETWORK= export CELESTIA_CUSTOM="${NETWORK}:${GENESIS_HASH}:${BRIDGE}" ``` -Query your node ID [using the RPC CLI](../developers/node-tutorial.md#get-your-node-id). +Query your node ID [using the RPC CLI](../tutorials/node-tutorial.md#get-your-node-id). These values with examples would look like: ```bash diff --git a/nodes/celestia-node-metrics.md b/how-to-guides/celestia-node-metrics.md similarity index 98% rename from nodes/celestia-node-metrics.md rename to how-to-guides/celestia-node-metrics.md index 98cf46c48b2..19a380b828e 100644 --- a/nodes/celestia-node-metrics.md +++ b/how-to-guides/celestia-node-metrics.md @@ -9,7 +9,7 @@ availability instance. This tutorial will focus on running metrics for a light n This tutorial assumes you have already setup your light node by following the tutorial in the -[celestia-node API tutorial](./developers/node-tutorial.md). +[celestia-node API tutorial](./tutorials/node-tutorial.md). ## Running metrics flags diff --git a/nodes/celestia-node-troubleshooting.md b/how-to-guides/celestia-node-troubleshooting.md similarity index 99% rename from nodes/celestia-node-troubleshooting.md rename to how-to-guides/celestia-node-troubleshooting.md index 2884ad3b1ec..78e132fdab2 100644 --- a/nodes/celestia-node-troubleshooting.md +++ b/how-to-guides/celestia-node-troubleshooting.md @@ -2,7 +2,7 @@ description: A guide to troubleshooting common issues with Celestia Node. next: text: "Metrics, visualization, and alerts" - link: "nodes/celestia-app-metrics" + link: "how-to-guides/celestia-app-metrics" --- # Troubleshooting diff --git a/nodes/celestia-node-trusted-hash.md b/how-to-guides/celestia-node-trusted-hash.md similarity index 100% rename from nodes/celestia-node-trusted-hash.md rename to how-to-guides/celestia-node-trusted-hash.md diff --git a/nodes/celestia-node.md b/how-to-guides/celestia-node.md similarity index 98% rename from nodes/celestia-node.md rename to how-to-guides/celestia-node.md index e1ec58dc4eb..e9b3b066fc7 100644 --- a/nodes/celestia-node.md +++ b/how-to-guides/celestia-node.md @@ -136,7 +136,7 @@ Now that you've installed Celestia Node, it's time to [pick your node type](./decide-node.md) and run your node! If you're planning to run a light node, -we recommend the [node RPC CLI tutorial](../developers/node-tutorial.md). +we recommend the [node RPC CLI tutorial](../tutorials/node-tutorial.md). ## Upgrading your binary diff --git a/nodes/config-toml.md b/how-to-guides/config-toml.md similarity index 100% rename from nodes/config-toml.md rename to how-to-guides/config-toml.md diff --git a/nodes/consensus-node.md b/how-to-guides/consensus-node.md similarity index 100% rename from nodes/consensus-node.md rename to how-to-guides/consensus-node.md diff --git a/nodes/decide-node.md b/how-to-guides/decide-node.md similarity index 96% rename from nodes/decide-node.md rename to how-to-guides/decide-node.md index fe153952e49..38e69716144 100644 --- a/nodes/decide-node.md +++ b/how-to-guides/decide-node.md @@ -13,7 +13,7 @@ It is highly recommended to get started with running a data availability [light node](./light-node.md). You can also play around with the Data Availability API in -[this tutorial for posting and retrieving data with a light node](../developers/node-tutorial.md). +[this tutorial for posting and retrieving data with a light node](../tutorials/node-tutorial.md). ### Other DA nodes diff --git a/nodes/docker-images.md b/how-to-guides/docker-images.md similarity index 97% rename from nodes/docker-images.md rename to how-to-guides/docker-images.md index 4da8d764abf..22eb5449881 100644 --- a/nodes/docker-images.md +++ b/how-to-guides/docker-images.md @@ -28,7 +28,7 @@ to run the node. If you would like to learn more about key management in Docker, visit the -[Docker and `cel-key` section](../developers/celestia-node-key.md#docker-and-cel-key). +[Docker and `cel-key` section](../tutorials/celestia-node-key.md#docker-and-cel-key). The easiest way to install Docker is to use the Docker Desktop installer or Ubuntu. You can @@ -116,7 +116,7 @@ Congratulations! You now have a celestia-node running! If you would like to run the node with custom flags, you can refer to the -[celestia-node tutorial](../developers/node-tutorial.md#connect-to-a-core-endpoint) page. Refer to +[celestia-node tutorial](../tutorials/node-tutorial.md#connect-to-a-core-endpoint) page. Refer to [the ports section of the celestia-node troubleshooting page](./celestia-node-troubleshooting.md#ports) for information on which ports are required to be open on your machine. diff --git a/nodes/environment.md b/how-to-guides/environment.md similarity index 100% rename from nodes/environment.md rename to how-to-guides/environment.md diff --git a/developers/ethereum-fallback.md b/how-to-guides/ethereum-fallback.md similarity index 94% rename from developers/ethereum-fallback.md rename to how-to-guides/ethereum-fallback.md index 99511602c03..67238a01019 100644 --- a/developers/ethereum-fallback.md +++ b/how-to-guides/ethereum-fallback.md @@ -2,10 +2,10 @@ description: The DA fallback mechanism to Ethereum for rollups. next: text: "Blobstream rollups" - link: "/developers/blobstream-rollups" + link: "/how-to-guides/blobstream-rollups" prev: text: "Run an OP Stack devnet posting Celestia" - link: "/developers/optimism" + link: "/how-to-guides/optimism" --- # Ethereum fallback diff --git a/developers/feegrant-for-blobs.md b/how-to-guides/feegrant-for-blobs.md similarity index 98% rename from developers/feegrant-for-blobs.md rename to how-to-guides/feegrant-for-blobs.md index e4ba39be0f0..960e11944ed 100644 --- a/developers/feegrant-for-blobs.md +++ b/how-to-guides/feegrant-for-blobs.md @@ -9,7 +9,7 @@ funding it, enabling a third-party account to cover the transaction fees. ## Pre-requisites -- celestia-node binary (`celestia`) [installed](../nodes/celestia-node.md) +- celestia-node binary (`celestia`) [installed](../how-to-guides/celestia-node.md) - Access to a Mocha node (e.g., `https://rpc.celestia-mocha.com:443`) - Running DA Light node on Mocha testnet - One account with sufficient funds, the "granter" diff --git a/nodes/full-storage-node.md b/how-to-guides/full-storage-node.md similarity index 97% rename from nodes/full-storage-node.md rename to how-to-guides/full-storage-node.md index a76dc2ca63f..261b7d3e529 100644 --- a/nodes/full-storage-node.md +++ b/how-to-guides/full-storage-node.md @@ -73,7 +73,7 @@ node's account balance, a gRPC endpoint of a validator (core) node must be passed as directed below. Refer to -[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +[the ports section of the celestia-node troubleshooting page](../../how-to-guides/celestia-node-troubleshooting/#ports) for information on which ports are required to be open on your machine. ```sh @@ -91,7 +91,7 @@ provides the light node with access to state queries (reading balances, submitti transactions, and other state-related queries). You can create your key for your node by following -[the `cel-key` instructions](../../developers/celestia-node-key) +[the `cel-key` instructions](../../tutorials/celestia-node-key) Once you start the full storage node, a wallet key will be generated for you. You will need to fund that address with testnet tokens to pay for diff --git a/nodes/ibc-relayer.md b/how-to-guides/ibc-relayer.md similarity index 98% rename from nodes/ibc-relayer.md rename to how-to-guides/ibc-relayer.md index 7c762e3bcf8..974df3aead0 100644 --- a/nodes/ibc-relayer.md +++ b/how-to-guides/ibc-relayer.md @@ -2,7 +2,7 @@ description: Learn how to establish IBC connections and relay packets. next: text: "Metrics" - link: "/nodes/celestia-node-metrics" + link: "/how-to-guides/celestia-node-metrics" --- # IBC relaying guide @@ -21,7 +21,7 @@ are two standard implementations: - [Go Relayer](https://pkg.go.dev/github.com/cosmos/relayer) built in Go The following guide explains how to establish IBC connections and relay -packets between [Mocha testnet](../nodes/mocha-testnet.md) and +packets between [Mocha testnet](../how-to-guides/mocha-testnet.md) and [Cosmos hub testnet](https://hub.cosmos.network/main/hub-tutorials/join-testnet.html) networks by using the Hermes relayer. diff --git a/nodes/instantiate-testnet.md b/how-to-guides/instantiate-testnet.md similarity index 99% rename from nodes/instantiate-testnet.md rename to how-to-guides/instantiate-testnet.md index 3485adba047..1e52952a220 100644 --- a/nodes/instantiate-testnet.md +++ b/how-to-guides/instantiate-testnet.md @@ -188,7 +188,7 @@ celestia-appd start :::tip Refer to -[the ports section of the celestia-node troubleshooting page](../nodes/celestia-node-troubleshooting.md#ports) +[the ports section of the celestia-node troubleshooting page](../how-to-guides/celestia-node-troubleshooting.md#ports) for information on which ports are required to be open on your machine. ::: diff --git a/developers/intro-to-op-stack.md b/how-to-guides/intro-to-op-stack.md similarity index 98% rename from developers/intro-to-op-stack.md rename to how-to-guides/intro-to-op-stack.md index 1589f33e5b4..e4677402a2a 100644 --- a/developers/intro-to-op-stack.md +++ b/how-to-guides/intro-to-op-stack.md @@ -2,7 +2,7 @@ description: Learn about the integration of OP Stack with Celestia. prev: text: "Bridging in and out of your Orbit rollup" - link: "/developers/arbitrum-bridge" + link: "/how-to-guides/arbitrum-bridge" --- # Introduction to OP Stack integration diff --git a/nodes/light-node.md b/how-to-guides/light-node.md similarity index 95% rename from nodes/light-node.md rename to how-to-guides/light-node.md index 636aa18cd87..b6b9b930ed3 100644 --- a/nodes/light-node.md +++ b/how-to-guides/light-node.md @@ -90,7 +90,7 @@ node's account balance, a gRPC endpoint of a validator (core) node must be passed as directed below. Refer to -[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +[the ports section of the celestia-node troubleshooting page](../../how-to-guides/celestia-node-troubleshooting/#ports) for information on which ports are required to be open on your machine. ::: code-group @@ -114,7 +114,7 @@ Tip: you can replace the core.ip with a consensus node RPC endpoint from [Mainne ### Keys and wallets You can create your key for your node by running the following command with the -[`cel-key` utility](../../developers/celestia-node-key) in the +[`cel-key` utility](../../tutorials/celestia-node-key) in the `celestia-node` directory: ```sh @@ -149,7 +149,7 @@ Once you start the light node, a wallet key will be generated for you. You will need to fund that address with testnet tokens to pay for `PayForBlob` transactions. -You can [find the address using the RPC CLI](../developers/node-tutorial.md#get-your-account-address) +You can [find the address using the RPC CLI](../tutorials/node-tutorial.md#get-your-account-address) or by running the following command in the `celestia-node` directory: @@ -218,4 +218,4 @@ Follow ## Data availability sampling With your light node running, you can check out -[this tutorial on submitting `PayForBlob` transactions](../developers/node-tutorial.md). +[this tutorial on submitting `PayForBlob` transactions](../tutorials/node-tutorial.md). diff --git a/nodes/mainnet.md b/how-to-guides/mainnet.md similarity index 97% rename from nodes/mainnet.md rename to how-to-guides/mainnet.md index 6ac69292453..7b111d759a0 100644 --- a/nodes/mainnet.md +++ b/how-to-guides/mainnet.md @@ -148,7 +148,6 @@ on [service providers with SLAs](#production-rpc-endpoints). - `celestia-rpc.0xcryptovestor.com` - `rpc-celestia-mainnet.trusted-point.com` - `celestia-rpc.chainode.tech:33373` -- `celestia-rpc.noders.services` - `celestia-mainnet-rpc.itrocket.net:443` #### Community API endpoints @@ -169,7 +168,6 @@ on [service providers with SLAs](#production-rpc-endpoints). - `celestia.api.kjnodes.com` - `api-celestia-mainnet.trusted-point.com` - `celestia-api.chainode.tech` -- `celestia-api.noders.services` - `celestia-mainnet-api.itrocket.net:443` #### Community gRPC endpoints @@ -189,14 +187,12 @@ on [service providers with SLAs](#production-rpc-endpoints). - `celestia.grpc.kjnodes.com:443` - `grpc-celestia-mainnet.trusted-point.com:9095` - `celestia-grpc.chainode.tech:443` -- `celestia-grpc.noders.services:11090` - `celestia-mainnet-grpc.itrocket.net:443` #### Community WebSocket endpoints - `wss://celestia-ws.chainode.tech:33373/websocket` - `wss://celestia-mainnet-ws.itrocket.net:443/websocket` -- `wss://rpc.celestia.mainnet.dteam.tech:443/websocket` - `wss://celestia.cumulo.org.es:443/websocket` ### Data availability nodes @@ -251,9 +247,6 @@ RPCs for DA nodes to initialise or start your celestia-node to Mainnet Beta with - `celestia-mainnet-consensus.itrocket.net` - gRPC: port 9090 - RPC: port 26657 -- `celestia-consensus-mainnet.noders.services` - - gRPC: port 9080 - - RPC: port 26657 DA full and light nodes might have troubles connecting to the networks, so you can check out this @@ -291,7 +284,6 @@ There are multiple explorers you can use for Mainnet Beta: - [https://stakeflow.io/celestia](https://stakeflow.io/celestia) - [https://celestia.exploreme.pro/](https://celestia.exploreme.pro/) - [https://mainnet.itrocket.net/celestia/](https://mainnet.itrocket.net/celestia/) -- [https://explorer.mainnet.dteam.tech/celestia](https://explorer.mainnet.dteam.tech/celestia) ## Analytics diff --git a/nodes/mocha-testnet.md b/how-to-guides/mocha-testnet.md similarity index 96% rename from nodes/mocha-testnet.md rename to how-to-guides/mocha-testnet.md index 523f37c0462..06246247195 100644 --- a/nodes/mocha-testnet.md +++ b/how-to-guides/mocha-testnet.md @@ -107,9 +107,6 @@ full blocks from it. - gRPC port: 9090 - `rpc-celestia-testnet.cryptech.com.ua` - gRPC: grpc-celestia-testnet.cryptech.com.ua:443 -- `celestia-consensus-testnet.noders.services` - - RPC port: 26357 - - gRPC port: 9070 ## Community RPC endpoints @@ -125,7 +122,6 @@ Celestia network. The default port is 26657. - `rpc-celestia-testnet-01.stakeflow.io` - `mocha.celestia.rpc.cumulo.me` - `rpc-mocha-full.avril14th.org` -- `celestia-t-rpc.noders.services/` - `rpc-1.testnet.celestia.nodes.guru` - `rpc-2.testnet.celestia.nodes.guru` - `celestia-testnet-rpc.itrocket.net:443` @@ -146,7 +142,6 @@ The default port is 1317. - [https://api-celestia-testnet-01.stakeflow.io/](https://api-celestia-testnet-01.stakeflow.io/) - [https://mocha.api.cumulo.me/](https://mocha.api.cumulo.me/) - [https://api-mocha-full.avril14th.org](https://api-mocha-full.avril14th.org) -- [https://celestia-t-api.noders.services](https://celestia-t-api.noders.services) - [https://api-1.testnet.celestia.nodes.guru](https://api-1.testnet.celestia.nodes.guru) - [https://api-2.testnet.celestia.nodes.guru](https://api-2.testnet.celestia.nodes.guru) - [https://celestia-testnet-api.itrocket.net](https://celestia-testnet-api.itrocket.net) @@ -170,7 +165,6 @@ broadcast transactions. - `grpc-celestia-testnet-01.stakeflow.io:16002` - `mocha.grpc.cumulo.me:443` - `grpc-mocha-full.avril14th.org` -- `celestia-grpc.noders.services:21090` - `grpc-1.testnet.celestia.nodes.guru:10790` - `grpc-2.testnet.celestia.nodes.guru:10790` - `celestia-testnet-grpc.itrocket.net:443` @@ -240,7 +234,6 @@ There are several explorers you can use for Mocha: - [https://testnet.celestia.explorers.guru](https://testnet.celestia.explorers.guru) - [https://testnet.itrocket.net/celestia](https://testnet.itrocket.net/celestia) - [https://explorers.cryptech.com.ua/Celestia-Testnet](https://explorers.cryptech.com.ua/Celestia-Testnet) -- [https://explorer.testnet.dteam.tech/celestia](https://explorer.testnet.dteam.tech/celestia) ## Network upgrades diff --git a/developers/multiaccounts.md b/how-to-guides/multiaccounts.md similarity index 100% rename from developers/multiaccounts.md rename to how-to-guides/multiaccounts.md diff --git a/nodes/network-upgrade-process.md b/how-to-guides/network-upgrade-process.md similarity index 100% rename from nodes/network-upgrade-process.md rename to how-to-guides/network-upgrade-process.md diff --git a/nodes/overview.md b/how-to-guides/nodes-overview.md similarity index 100% rename from nodes/overview.md rename to how-to-guides/nodes-overview.md diff --git a/developers/optimism-devnet.md b/how-to-guides/optimism-devnet.md similarity index 100% rename from developers/optimism-devnet.md rename to how-to-guides/optimism-devnet.md diff --git a/developers/optimism.md b/how-to-guides/optimism.md similarity index 98% rename from developers/optimism.md rename to how-to-guides/optimism.md index 59efc67ef14..befd0de9674 100644 --- a/developers/optimism.md +++ b/how-to-guides/optimism.md @@ -15,7 +15,7 @@ If you don't have devops experience and would like to use a Rollups as a Service ## Dependency setup -- [celestia-node](../nodes/celestia-node.md) +- [celestia-node](../how-to-guides/celestia-node.md) ### Setting up your light node diff --git a/nodes/participate.md b/how-to-guides/participate.md similarity index 100% rename from nodes/participate.md rename to how-to-guides/participate.md diff --git a/nodes/quick-start.md b/how-to-guides/quick-start.md similarity index 100% rename from nodes/quick-start.md rename to how-to-guides/quick-start.md diff --git a/developers/sp1-blobstream-deploy.md b/how-to-guides/sp1-blobstream-deploy.md similarity index 97% rename from developers/sp1-blobstream-deploy.md rename to how-to-guides/sp1-blobstream-deploy.md index b007611bec6..780a68ee2cf 100644 --- a/developers/sp1-blobstream-deploy.md +++ b/how-to-guides/sp1-blobstream-deploy.md @@ -1,7 +1,7 @@ --- next: text: "Overview of Blobstream X" - link: "/developers/blobstreamx" + link: "/how-to-guides/blobstreamx" --- # New SP1 Blobstream deployments diff --git a/developers/submit-data.md b/how-to-guides/submit-data.md similarity index 99% rename from developers/submit-data.md rename to how-to-guides/submit-data.md index fa77b6d9610..588f8bd1141 100644 --- a/developers/submit-data.md +++ b/how-to-guides/submit-data.md @@ -1,7 +1,7 @@ --- prev: text: "Blobstream rollups" - link: "/developers/blobstream-rollups" + link: "/how-to-guides/blobstream-rollups" --- # Submitting data blobs to Celestia @@ -20,7 +20,7 @@ With one share for the PFB transaction, 4095 shares remain: 1 at 478 bytes and 4094 at 482 bytes each. This is subject to change based on governance parameters. -Learn more on [the Mainnet Beta page under "Maximum bytes"](../nodes/mainnet.md#maximum-bytes). +Learn more on [the Mainnet Beta page under "Maximum bytes"](../how-to-guides/mainnet.md#maximum-bytes). It is advisable to submit transactions where the total blob size is significantly smaller than 1.8 MiB (e.g. 500 KiB) in order for your transaction to get included diff --git a/nodes/systemd.md b/how-to-guides/systemd.md similarity index 100% rename from nodes/systemd.md rename to how-to-guides/systemd.md diff --git a/developers/transaction-resubmission.md b/how-to-guides/transaction-resubmission.md similarity index 84% rename from developers/transaction-resubmission.md rename to how-to-guides/transaction-resubmission.md index 11e1b94f1b6..941d894bf55 100644 --- a/developers/transaction-resubmission.md +++ b/how-to-guides/transaction-resubmission.md @@ -14,8 +14,8 @@ transactions will not be re-gossiped, except in the presence of a new peer. If you are running a production application on Celestia, it is recommended to use a high-availability, production -RPC provider for [Mainnet Beta](../nodes/mainnet.md#production-rpc-endpoints),[Mocha](../nodes/mocha-testnet.md#production-rpc-endpoints), -or [Arabica](../nodes/arabica-devnet.md#production-rpc-endpoints). +RPC provider for [Mainnet Beta](../how-to-guides/mainnet.md#production-rpc-endpoints),[Mocha](../how-to-guides/mocha-testnet.md#production-rpc-endpoints), +or [Arabica](../how-to-guides/arabica-devnet.md#production-rpc-endpoints). ## Monitoring and resubmission diff --git a/nodes/validator-node.md b/how-to-guides/validator-node.md similarity index 96% rename from nodes/validator-node.md rename to how-to-guides/validator-node.md index 51f71fa6731..c559d8a0f41 100644 --- a/nodes/validator-node.md +++ b/how-to-guides/validator-node.md @@ -30,11 +30,11 @@ The following tutorial is done on an Ubuntu Linux 20.04 (LTS) x64 instance machine. First, follow the instructions on -[setting up a consensus node](/nodes/consensus-node#set-up-a-consensus-node). +[setting up a consensus node](/how-to-guides/consensus-node#set-up-a-consensus-node). ### Wallet -Follow [the tutorial on creating a wallet](../nodes/celestia-app-wallet.md). +Follow [the tutorial on creating a wallet](../how-to-guides/celestia-app-wallet.md). ### Delegate stake to a validator @@ -117,7 +117,7 @@ celestia bridge init --core.ip :::tip Refer to -[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports) +[the ports section of the celestia-node troubleshooting page](../../how-to-guides/celestia-node-troubleshooting/#ports) for information on which ports are required to be open on your machine. ::: @@ -237,7 +237,7 @@ After starting your node, please submit your node as a seed and peer to the ## Optional: Transaction indexer configuration options Follow the instructions under -[transaction indexer configuration options](/nodes/full-consensus-node#optional-transaction-indexer-configuration-options) +[transaction indexer configuration options](/how-to-guides/consensus-node#optional-transaction-indexer-configuration-options) to configure your `config.toml` file to select which transactions to index. ## Additional resources diff --git a/index.md b/index.md index f9a935d2a1a..63c55c20fe2 100644 --- a/index.md +++ b/index.md @@ -13,7 +13,7 @@ hero: actions: - theme: brand text: Build whatever - link: /developers/build-whatever + link: /how-to-guides/build-whatever - theme: alt text: Introduction link: /learn/how-celestia-works/overview @@ -23,13 +23,13 @@ features: details: Celestia allows you to deploy your own blockchain in minutes, as easily as a smart contract. link: /learn/how-celestia-works/overview icon: 🏗️ - - title: Run a node - details: Access the dynamic scaling unlocked by data availability sampling, where scale increases with the number of users. - link: /nodes/overview + - title: How-to guides + details: Explore step-by-step guides for running a node, posting data blobs, building applications and sovereign rollups on Celestia. + link: /how-to-guides/nodes-overview icon: 📈 - - title: Developers - details: Create applications using your favorite VM or define your own. Build sovereign rollups, a new type of self-governing blockchain with minimal platform risk. - link: /developers/build-whatever + - title: Tutorials + details: Access tutorials for interacting with Celestia, starting with celestia-node through the node API. + link: /tutorials/node-api icon: ⚙️ - title: Community details: Join the Celestia discord to connect, collaborate, and contribute to the future of modular blockchains. diff --git a/learn/paying-for-blobspace.md b/learn/paying-for-blobspace.md index eac42cafeed..db1b77dedf8 100644 --- a/learn/paying-for-blobspace.md +++ b/learn/paying-for-blobspace.md @@ -20,7 +20,7 @@ See [the detailed life cycle of a Celestia transaction](./how-celestia-works/transaction-lifecycle.md). Learn how to -[submit data to Celestia’s data availability layer](../developers/submit-data.md). +[submit data to Celestia’s data availability layer](../how-to-guides/submit-data.md). ## Fee market overview @@ -30,4 +30,4 @@ comprised of a flat fee per transaction and then a variable fee based on the size of each blob in the transaction. Understand how fees are calculated on Celestia in -[the overview on submitting PFB transactions](../developers/submit-data.md). +[the overview on submitting PFB transactions](../how-to-guides/submit-data.md). diff --git a/learn/staking-governance-supply.md b/learn/staking-governance-supply.md index 25e0b4a2d79..c3871a96c74 100644 --- a/learn/staking-governance-supply.md +++ b/learn/staking-governance-supply.md @@ -27,7 +27,7 @@ Learn | Delegation support | Yes | Learn how to -[stake on your own at the community dashboards](../../nodes/staking.md). +[stake on your own at the community dashboards](../learn/staking.md). ## Inflation @@ -53,7 +53,7 @@ TIA holders (not just stakers) can propose and vote on governance proposals to change a subset of network parameters. To learn more, see a [complete list of both the changeable and non-changeable parameters and their values](https://github.com/celestiaorg/celestia-app/blob/v1.x/specs/src/specs/params.md). Additionally, learn how to -[submit and vote on governance proposals](../nodes/celestia-app-commands.md#governance). +[submit and vote on governance proposals](../how-to-guides/celestia-app-commands.md#governance). ### Community pool @@ -63,7 +63,7 @@ receives 2% of all Celestia block rewards. TIA stakers may vote to fund ecosystem initiatives as in many other Cosmos SDK chains. Learn how to -[submit a governance proposal to spend community pool funds](../nodes/celestia-app-commands.md#community-pool). +[submit a governance proposal to spend community pool funds](../how-to-guides/celestia-app-commands.md#community-pool). ## TIA allocation at genesis diff --git a/learn/staking.md b/learn/staking.md index 5560fc73bf3..3b30c0b0d69 100644 --- a/learn/staking.md +++ b/learn/staking.md @@ -12,7 +12,7 @@ staking rewards. ## Mainnet Beta Currently, the following staking interfaces exist for the -[Mainnet Beta](../nodes/mainnet.md). +[Mainnet Beta](../how-to-guides/mainnet.md). Just connect your wallet to get started! @@ -23,7 +23,7 @@ Just connect your wallet to get started! ## Mocha testnet Currently, the following staking interfaces exist for the -[Mocha testnet](../nodes/mocha-testnet.md). +[Mocha testnet](../how-to-guides/mocha-testnet.md). Just connect your wallet to get started! diff --git a/developers/celestia-node-key.md b/tutorials/celestia-node-key.md similarity index 95% rename from developers/celestia-node-key.md rename to tutorials/celestia-node-key.md index b1d33c194d3..706eb1cddf6 100644 --- a/developers/celestia-node-key.md +++ b/tutorials/celestia-node-key.md @@ -2,7 +2,7 @@ description: Use the cel-key utility to generate a wallet on celestia-node. prev: text: "New Blobstream X deployments" - link: "/developers/blobstream-x-deploy" + link: "/how-to-guides/blobstream-x-deploy" --- # Create a wallet with celestia-node @@ -14,7 +14,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.md) +- [Setting up your environment](../how-to-guides/environment.md) Once you completed the prerequisite, you can proceed with this tutorial. @@ -58,7 +58,7 @@ the tab for your node type: :::tip You do not need to declare a network for Mainnet Beta. Refer to -[the chain ID section on the troubleshooting page for more information](../nodes/celestia-node-troubleshooting.md) +[the chain ID section on the troubleshooting page for more information](../how-to-guides/celestia-node-troubleshooting.md) ::: ::: code-group @@ -168,7 +168,7 @@ then enter your bip39 mnemonic: - Docker installed on your machine - Understanding of the - [guide on how to run celestia-node with Docker](../nodes/docker-images.md). + [guide on how to run celestia-node with Docker](../how-to-guides/docker-images.md). ### Running your node @@ -191,11 +191,11 @@ ghcr.io/celestiaorg/celestia-node:{{mochaVersions['node-latest-tag']}} celestia :::tip Refer to -[the ports section of the celestia-node troubleshooting page](../nodes/celestia-node-troubleshooting.md#ports) +[the ports section of the celestia-node troubleshooting page](../how-to-guides/celestia-node-troubleshooting.md#ports) for information on which ports are required to be open on your machine. You do not need to declare a network for Mainnet Beta. Refer to -[the chain ID section on the troubleshooting page for more information](../nodes/celestia-node-troubleshooting.md) +[the chain ID section on the troubleshooting page for more information](../how-to-guides/celestia-node-troubleshooting.md) ::: List active containers in another window with: diff --git a/developers/golang-client-tutorial.md b/tutorials/golang-client-tutorial.md similarity index 98% rename from developers/golang-client-tutorial.md rename to tutorials/golang-client-tutorial.md index ee917af0e5c..78556179d81 100644 --- a/developers/golang-client-tutorial.md +++ b/tutorials/golang-client-tutorial.md @@ -2,8 +2,8 @@ This section tutorial will guide you through using the most common RPC endpoints with the golang client library. -Install [dependencies](../nodes/environment.md) and -[celestia-node](../nodes/celestia-node.md) if you have +Install [dependencies](../how-to-guides/environment.md) and +[celestia-node](../how-to-guides/celestia-node.md) if you have not already. ## Project setup diff --git a/developers/integrate-celestia.md b/tutorials/integrate-celestia.md similarity index 97% rename from developers/integrate-celestia.md rename to tutorials/integrate-celestia.md index 13a45c86385..d7e0c0ef353 100644 --- a/developers/integrate-celestia.md +++ b/tutorials/integrate-celestia.md @@ -2,7 +2,7 @@ description: Learn how service providers can integrate with the Celestia network. prev: text: "Integrating Wallets for developers" - link: "/developers/wallets" + link: "/tutorials/wallets" --- # Integrate Celestia for service providers @@ -18,7 +18,7 @@ When getting started Celestia, we recommend checking out these resources first: - [Monolithic v. Modular](../learn/how-celestia-works/monolithic-vs-modular.md) - [Celestia's DA Layer](../learn/how-celestia-works/data-availability-layer.md) - [Learn modular](https://celestia.org/learn) -- [Overview to running nodes on Celestia](../nodes/overview.md) +- [Overview to running nodes on Celestia](../how-to-guides/nodes-overview.md) - [Build whatever](./build-whatever.md) ## Celestia service provider notes diff --git a/developers/node-api.md b/tutorials/node-api.md similarity index 100% rename from developers/node-api.md rename to tutorials/node-api.md diff --git a/developers/node-tutorial.md b/tutorials/node-tutorial.md similarity index 97% rename from developers/node-tutorial.md rename to tutorials/node-tutorial.md index dfc700699f5..211dc0fecff 100644 --- a/developers/node-tutorial.md +++ b/tutorials/node-tutorial.md @@ -33,7 +33,7 @@ you can skip to the [RPC CLI guide section](#rpc-cli-guide). If you would like to skip syncing, you can use this -[guide to sync from trusted hash and height](../nodes/celestia-node-trusted-hash.md). +[guide to sync from trusted hash and height](../how-to-guides/celestia-node-trusted-hash.md). ::: :::warning @@ -54,8 +54,8 @@ light node: ## Setting up dependencies -Install [dependencies](../nodes/environment.md) and -[celestia-node](../nodes/celestia-node.md) if you have +Install [dependencies](../how-to-guides/environment.md) and +[celestia-node](../how-to-guides/celestia-node.md) if you have not already. ### Instantiate a Celestia light node @@ -95,9 +95,9 @@ provides the light node with access to state queries (reading balances, submitti transactions, and other state-related queries). Note: You are also encouraged to find an RPC endpoint for -[Mainnet Beta](../nodes/mainnet.md#integrations), -[Mocha testnet](../nodes/mocha-testnet.md#integrations), -or [Arabica devnet](../nodes/arabica-devnet.md#integrations). +[Mainnet Beta](../how-to-guides/mainnet.md#integrations), +[Mocha testnet](../how-to-guides/mocha-testnet.md#integrations), +or [Arabica devnet](../how-to-guides/arabica-devnet.md#integrations). If you are running a production application, use a production endpoint. ::: code-group @@ -125,7 +125,7 @@ add the port after the IP address or use the port if you prefer. Refer to -[the ports section of the celestia-node troubleshooting page](../nodes/celestia-node-troubleshooting.md#ports) +[the ports section of the celestia-node troubleshooting page](../how-to-guides/celestia-node-troubleshooting.md#ports) for information on which ports are required to be open on your machine. ::: @@ -156,7 +156,7 @@ command from the celestia-node directory: :::tip You do not need to declare a network for Mainnet Beta. Refer to -[the chain ID section on the troubleshooting page for more information](../nodes/celestia-node-troubleshooting.md) +[the chain ID section on the troubleshooting page for more information](../how-to-guides/celestia-node-troubleshooting.md) ::: ```bash @@ -252,7 +252,7 @@ once your node store is set: :::note Previously, the `node.store` flag had to be specified manually for each request. This has changed in v0.14.0+ and you can -[read more about the implementation in celestia-node troubleshooting](../nodes/celestia-node-troubleshooting.md#changing-the-location-of-your-node-store). +[read more about the implementation in celestia-node troubleshooting](../how-to-guides/celestia-node-troubleshooting.md#changing-the-location-of-your-node-store). ::: ```bash @@ -574,7 +574,7 @@ To set the gas price, you can use the `--gas.price` flag. The gas price will be set to default (0.002) if no value is passed. -Learn [more about gas fees and limits](../developers/submit-data.md). +Learn [more about gas fees and limits](../how-to-guides/submit-data.md). To set a higher gas price of 0.004 utia, use the `--gas.price 0.004` flag: diff --git a/developers/prompt-scavenger.md b/tutorials/prompt-scavenger.md similarity index 98% rename from developers/prompt-scavenger.md rename to tutorials/prompt-scavenger.md index 52c95a9b034..e0fca3c8e9d 100644 --- a/developers/prompt-scavenger.md +++ b/tutorials/prompt-scavenger.md @@ -2,7 +2,7 @@ description: Learn how to interact with the Celestia Node API with this tutorial. prev: text: "Rust client tutorial" - link: "/developers/rust-client-tutorial" + link: "/tutorials/rust-client-tutorial" --- # Prompt scavenger @@ -29,13 +29,13 @@ Golang along the way, let’s get started! The following dependencies are needed to be installed or obtained: -- Golang, see [setting up environment](../nodes/environment.md) -- Celestia [light node](../nodes/light-node.md) +- Golang, see [setting up environment](../how-to-guides/environment.md) +- Celestia [light node](../how-to-guides/light-node.md) - Getting an OpenAI API Key for GPT-3.5 ### Install Celestia Node and run a light node -First, [install the celestia-node binary](../nodes/celestia-node.md). +First, [install the celestia-node binary](../how-to-guides/celestia-node.md). Let's start by initializing our light node and funding our account with some tokens. We will be using the Arabica testnet for this tutorial. diff --git a/developers/rust-client-tutorial.md b/tutorials/rust-client-tutorial.md similarity index 97% rename from developers/rust-client-tutorial.md rename to tutorials/rust-client-tutorial.md index a8a5d9414b7..9700476a5b0 100644 --- a/developers/rust-client-tutorial.md +++ b/tutorials/rust-client-tutorial.md @@ -1,15 +1,15 @@ --- next: text: "Prompt Scavenger" - link: "/developers/prompt-scavenger" + link: "/tutorials/prompt-scavenger" --- # Rust client library tutorial {#rust-client-library} This section tutorial will guide you through using the most common RPC endpoints with [Lumina](https://github.com/eigerco/lumina/tree/main/rpc)'s rust client library. -Install [dependencies](../nodes/environment.md) and -[celestia-node](../nodes/celestia-node.md) if you have +Install [dependencies](../how-to-guides/environment.md) and +[celestia-node](../how-to-guides/celestia-node.md) if you have not already. ## Project setup diff --git a/developers/wallets.md b/tutorials/wallets.md similarity index 100% rename from developers/wallets.md rename to tutorials/wallets.md