Files
2026-07-26 05:59:32 +00:00

117 lines
45 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-blockchain/get-started/run-a-logos-blockchain-node-from-cli" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.10.2"><title data-rh=true>Run a Logos Blockchain node on the public testnet from the CLI | Logos documentation</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:image content=https://docs.logos.co/img/social-card.jpg /><meta data-rh=true name=twitter:image content=https://docs.logos.co/img/social-card.jpg /><meta data-rh=true property=og:url content=https://docs.logos.co/blockchain/get-started/run-a-logos-blockchain-node-from-cli /><meta data-rh=true property=og:locale content=en /><meta data-rh=true name=docusaurus_locale content=en /><meta data-rh=true name=docsearch:language content=en /><meta data-rh=true name=docusaurus_version content=current /><meta data-rh=true name=docusaurus_tag content=docs-default-current /><meta data-rh=true name=docsearch:version content=current /><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current /><meta data-rh=true property=og:title content="Run a Logos Blockchain node on the public testnet from the CLI | Logos documentation"/><meta data-rh=true name=description content="Start a node and verify runtime and consensus signals."/><meta data-rh=true property=og:description content="Start a node and verify runtime and consensus signals."/><link data-rh=true rel=icon href=/img/favicon.png /><link data-rh=true rel=canonical href=https://docs.logos.co/blockchain/get-started/run-a-logos-blockchain-node-from-cli /><link data-rh=true rel=alternate href=https://docs.logos.co/blockchain/get-started/run-a-logos-blockchain-node-from-cli hreflang=en /><link data-rh=true rel=alternate href=https://docs.logos.co/blockchain/get-started/run-a-logos-blockchain-node-from-cli hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.logos.co/blockchain/get-started/run-a-logos-blockchain-node-from-cli","name":"Run a Logos Blockchain node on the public testnet from the CLI","position":1}]}</script><link rel=icon href=/img/favicon.png media="(prefers-color-scheme: light)"><link rel=icon href=/img/favicon-dark.png media="(prefers-color-scheme: dark)"><link rel=stylesheet href=/assets/css/styles.e45c7411.css /><script src=/assets/js/runtime~main.ea6c7eaa.js defer></script><script src=/assets/js/main.78385118.js defer></script></head><body><svg style="display: none;"><defs>
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
</defs></svg>
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme-597")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/img/logo-light.png /><link rel=preload as=image href=/img/logo-dark.png /><div role=region aria-label="Skip to main content"><a class=skipToContent_fXgn href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/><div class=navbar__logo><img src=/img/logo-light.png alt=Logos class="themedComponent_mlkZ themedComponent--light_NVdE"/><img src=/img/logo-dark.png alt=Logos class="themedComponent_mlkZ themedComponent--dark_xIcU"/></div></a><a class="navbar__item navbar__link" href=/get-started/what-is-logos>Get started</a><div class="navbar__item dropdown dropdown--hoverable"><a href=# aria-haspopup=true aria-expanded=false role=button class=navbar__link>Your path</a><ul class=dropdown__menu><li><a class=dropdown__link href=/run-an-app>Run an app</a><li><a class=dropdown__link href=/run-a-node/get-started/run-logos-node-blockchain-storage-delivery>Run a node</a><li><a class=dropdown__link href=/build-an-app>Build an app</a><li><a class=dropdown__link href=/contribute/welcome>Contribute</a></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href=# aria-haspopup=true aria-expanded=false role=button class=navbar__link>Explore</a><ul class=dropdown__menu><li><a class=dropdown__link href=/basecamp/get-started/install-logos-basecamp>Basecamp</a><li><a aria-current=page class="dropdown__link dropdown__link--active" href=/blockchain/get-started/introduction-to-the-logos-blockchain>Blockchain</a><li><a class=dropdown__link href=/lez/get-started/introduction-to-the-logos-execution-zone>LEZ</a><li><a class=dropdown__link href=/core/build-modules/start-a-logos-module-from-the-cli>Core</a><li><a class=dropdown__link href=/messaging/get-started/introduction-to-logos-messaging>Messaging</a><li><a class=dropdown__link href=/storage/get-started/run-logos-storage-node>Storage</a><li><a class=dropdown__link href=/mixnet/get-started/discover-nodes-and-send-messages-via-the-anoncomms-mixnet-demo-app>Mixnet</a><li><a class=dropdown__link href=/peer-discovery/welcome>Peer discovery</a></ul></div></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href=https://github.com/logos-co/logos-docs target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type=button disabled title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill=currentColor d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill=currentColor d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill=currentColor d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"/></svg></button></div><div class=navbarSearchContainer_Bca1></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class=docsWrapper_hBAB><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type=button></button><div class=docRoot_UBD9><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class=sidebarViewport_aRkj><div class=sidebar_njMd><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role=button aria-expanded=true href=/blockchain/get-started/introduction-to-the-logos-blockchain><span class=categoryLinkLabel_W154>Get started</span></a></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/blockchain/get-started/introduction-to-the-logos-blockchain><span class=linkLabel_WmDU>Introduction to the Logos Blockchain</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/blockchain/get-started/run-a-logos-blockchain-node-from-basecamp><span class=linkLabel_WmDU>Run a Logos Blockchain node from Basecamp</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/blockchain/get-started/run-a-logos-blockchain-node-from-cli><span class=linkLabel_WmDU>Run a Logos Blockchain node on the public testnet from the CLI</span></a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=false href=/blockchain/node-app/build-and-run-logos-blockchain-node-app-ui><span class=categoryLinkLabel_W154>Blockchain UI app</span></a></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=false href=/blockchain/zone-sdk/inscribe-data-on-chain-using-zone-sdk><span class=categoryLinkLabel_W154>Zone SDK</span></a></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=false href=/blockchain/blend/join-the-blend-network-as-a-core-node><span class=categoryLinkLabel_W154>Blend</span></a></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=false href=/blockchain/concepts/about-bedrock><span class=categoryLinkLabel_W154>Concepts</span></a></div></ul></nav></div></div></aside><main class=docMainContainer_TBSr><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_VOVn"><div class=docItemContainer_Djhp><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_YNFT><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><span class=breadcrumbs__link>Get started</span><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Run a Logos Blockchain node on the public testnet from the CLI</span></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type=button class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Run a Logos Blockchain node on the public testnet from the CLI</h1></header>
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id=start-a-node-and-verify-runtime-and-consensus-signals>Start a node and verify runtime and consensus signals.<a href=#start-a-node-and-verify-runtime-and-consensus-signals class=hash-link aria-label="Direct link to Start a node and verify runtime and consensus signals." title="Direct link to Start a node and verify runtime and consensus signals." translate=no></a></h4>
<p>With this tutorial, you will install the <a href=https://docs.logos.co/get-started/glossary#logos-blockchain target=_blank rel="noopener noreferrer" class="">Logos Blockchain</a> node, connect to the public testnet, and verify that your node is running. The Logos Blockchain is the blockchain component of the Logos technology stack, providing a privacy-preserving and censorship-resistant framework for decentralised applications. This procedure is for node operators setting up a node for the first time.</p>
<p>There is currently no dynamic wallet key management. To add new keys you must manually edit <code>user_config.yaml</code> and restart the node. If the node is restarted while <a href=https://docs.logos.co/get-started/glossary#bootstrapping target=_blank rel="noopener noreferrer" class="">bootstrapping</a>, it does not save sync progress and restarts from the beginning.</p>
<p>Before you start, ensure you have:</p>
<ul>
<li class="">Linux x86_64, macOS, or a Raspberry Pi 5 with <a href=https://www.raspberrypi.com/software/ target=_blank rel="noopener noreferrer" class="">Raspberry Pi OS</a> installed</li>
<li class="">glibc version 2.39 or later (Linux only)</li>
<li class="">At least 64 GB of storage</li>
</ul>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=what-to-expect>What to expect<a href=#what-to-expect class=hash-link aria-label="Direct link to What to expect" title="Direct link to What to expect" translate=no></a></h2>
<ul>
<li class="">You can install the node binary, generate a configuration, and join the public testnet.</li>
<li class="">You can verify that your node is syncing and connected to peers using the local API.</li>
<li class="">You can receive test tokens from the faucet and automatically participate in the consensus lottery once your stake matures.</li>
</ul>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=step-1-install-logos-core-tools>Step 1: Install Logos core tools<a href=#step-1-install-logos-core-tools class=hash-link aria-label="Direct link to Step 1: Install Logos core tools" title="Direct link to Step 1: Install Logos core tools" translate=no></a></h2>
<ol>
<li class="">
<p>Use the <code>install-node-tools.sh</code> helper script to install <a href=https://github.com/logos-co/logos-logoscore-cli/releases/tag/0.2.0 target=_blank rel="noopener noreferrer" class=""><code>logoscore</code></a>, <a href=https://github.com/logos-co/logos-package-downloader/releases/tag/0.2.0 target=_blank rel="noopener noreferrer" class=""><code>lgpd</code></a>, and <a href=https://github.com/logos-co/logos-package-manager/releases/tag/0.2.0 target=_blank rel="noopener noreferrer" class=""><code>lgpm</code></a> into <code>./bin</code>:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">curl -fsSL https://raw.githubusercontent.com/logos-co/logos-docs/main/resources/scripts/install-node-tools.sh | sh</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">export PATH="$PWD/bin:$PATH"</span><br/></div></code></pre></div></div>
</li>
</ol>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=step-2-load-the-logos-blockchain-module>Step 2: Load the Logos Blockchain module<a href=#step-2-load-the-logos-blockchain-module class=hash-link aria-label="Direct link to Step 2: Load the Logos Blockchain module" title="Direct link to Step 2: Load the Logos Blockchain module" translate=no></a></h2>
<p>Download the Logos Blockchain <a href=https://docs.logos.co/get-started/glossary#module target=_blank rel="noopener noreferrer" class="">module</a> with <code>lgpd</code>, then install it with <code>lgpm</code> before loading it with <code>logoscore</code>.</p>
<ol>
<li class="">
<p>Download the module:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">lgpd download blockchain_module --version 0.2.0 --output ./</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"># writes ./blockchain_module-0.2.0.lgx</span><br/></div></code></pre></div></div>
</li>
<li class="">
<p>Install the module:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">lgpm --modules-dir ./modules install --file blockchain_module-0.2.0.lgx</span><br/></div></code></pre></div></div>
</li>
<li class="">
<p>Launch <code>logoscore</code> in daemon mode and load the Logos Blockchain module:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">logoscore -m ./modules -D &</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">logoscore load-module blockchain_module</span><br/></div></code></pre></div></div>
</li>
</ol>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=step-3-configure-and-start-the-node>Step 3: Configure and start the node<a href=#step-3-configure-and-start-the-node class=hash-link aria-label="Direct link to Step 3: Configure and start the node" title="Direct link to Step 3: Configure and start the node" translate=no></a></h2>
<p>The <code>generate_user_config</code> subcommand generates a user configuration that includes per-node settings such as keys, ports, and peer addresses, along with fresh cryptographic keys and an auto-detected public IP.</p>
<div class="theme-admonition theme-admonition-info admonition_xJq3 alert alert--info"><div class=admonitionHeading_Gvgb><span class=admonitionIcon_Rf37><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>info</div><div class=admonitionContent_BuS1><p>Make sure to use the current bootstrap peer addresses in the <a href=https://github.com/logos-blockchain/logos-blockchain/releases/latest target=_blank rel="noopener noreferrer" class="">Logos Blockchain Node release notes</a> for your selected release.</div></div>
<ol>
<li class="">
<p>Generate your <code>user_config.yaml</code> by running <code>generate_user_config</code> with the bootstrap peer addresses. For example, for release 0.2.0:</p>
<div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">logoscore call blockchain_module generate_user_config '{</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> "initial_peers": [</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> "/ip4/65.109.51.37/udp/3000/quic-v1/p2p/12D3KooWFrouXfmrR4nsLMtE7wu15DoMJ6VtoUtHinREZCvbWHar",</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> "/ip4/65.109.51.37/udp/3001/quic-v1/p2p/12D3KooWJRGau8M1rjT7R5e4YYsgdFhsMX35nRDtMwCDjxQkXAHz",</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> "/ip4/65.109.51.37/udp/3002/quic-v1/p2p/12D3KooWQXJavMDTRscjauFSgVAB1VLB6Rzpy2uY5SU9Tk7927tb",</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> "/ip4/65.109.51.37/udp/50001/quic-v1/p2p/12D3KooWSQc7CcGtvWDPF1yCbBthFnQjprfCVHmfmNDUrSmqQsU1"</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> ]</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">}'</span><br/></div></code></pre></div></div>
<ul>
<li class="">To change the API port, set <code>api.backend.listen_address</code> in <code>user_config.yaml</code> before starting. The default is <code>8080</code>.</li>
</ul>
<div class="theme-admonition theme-admonition-info admonition_xJq3 alert alert--info"><div class=admonitionHeading_Gvgb><span class=admonitionIcon_Rf37><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>info</div><div class=admonitionContent_BuS1><p>To migrate an existing version 0.1.2 blockchain config to version 0.2.0, run the <code>migrate_user_config_0_1_2</code> command of the blockchain module and stop the module before restarting it in the next step:<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">logoscore call blockchain_module migrate_user_config_0_1_2 \</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> user_config.yaml \</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> old_user_config.yaml \</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> my_keystore.yaml</span><br/></div><div class=token-line style=color:#393A34><span class="token plain" style=display:inline-block></span><br/></div><div class=token-line style=color:#393A34><span class="token plain">logoscore call blockchain_module stop</span><br/></div></code></pre></div></div></div></div>
</li>
<li class="">
<p>Start the node:</p>
<div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">logoscore call blockchain_module start user_config.yaml ""</span><br/></div></code></pre></div></div>
</li>
</ol>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=step-4-verify-that-your-node-is-running-and-connected-to-peers>Step 4: Verify that your node is running and connected to peers<a href=#step-4-verify-that-your-node-is-running-and-connected-to-peers class=hash-link aria-label="Direct link to Step 4: Verify that your node is running and connected to peers" title="Direct link to Step 4: Verify that your node is running and connected to peers" translate=no></a></h2>
<p>Wait for your node to finish syncing and reach <code>Online</code> mode before requesting tokens. Pipe the <code>get_cryptarchia_info</code> command through <code>jq .</code> to format JSON output.</p>
<ol>
<li class="">
<p>Check the consensus state:</p>
<div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">logoscore call blockchain_module get_cryptarchia_info | jq -r .result.value | jq .</span><br/></div><div class=token-line style=color:#393A34><span class="token plain" style=display:inline-block></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"># Alternatively, send a request directly to your node port</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">curl -s http://localhost:8080/cryptarchia/info | jq .</span><br/></div></code></pre></div></div>
<p>Example response:</p>
<div class="language-json codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-json codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token punctuation" style=color:#393A34>{</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token property" style=color:#36acaa>"lib"</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"3d0c...4e6d"</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token property" style=color:#36acaa>"lib_slot"</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token number" style=color:#36acaa>0</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token property" style=color:#36acaa>"tip"</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"f44d...e2f5"</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token property" style=color:#36acaa>"slot"</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token number" style=color:#36acaa>70899</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token property" style=color:#36acaa>"height"</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token number" style=color:#36acaa>120</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token property" style=color:#36acaa>"mode"</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"Bootstrapping"</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token punctuation" style=color:#393A34>}</span><br/></div></code></pre></div></div>
<ul>
<li class=""><code>mode</code> starts as <code>Bootstrapping</code> while syncing and transitions to <code>Online</code> once caught up.</li>
<li class="">Confirm <code>slot</code> and <code>height</code> are increasing. <code>height</code> counts confirmed blocks; <code>slot</code> counts elapsed time intervals, with a new block expected roughly every 10 seconds.</li>
</ul>
</li>
<li class="">
<p>Check peer connectivity:</p>
<div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">curl -s http://localhost:8080/network/info | jq .</span><br/></div></code></pre></div></div>
<p>Example response:</p>
<div class="language-json codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-json codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token punctuation" style=color:#393A34>{</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token property" style=color:#36acaa>"listen_addresses"</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>[</span><span class="token string" style=color:#e3116c>"/ip4/127.0.0.1/udp/3001/quic-v1"</span><span class="token punctuation" style=color:#393A34>]</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token property" style=color:#36acaa>"peer_id"</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"12D3...fuS2"</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token property" style=color:#36acaa>"n_peers"</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token number" style=color:#36acaa>16</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token property" style=color:#36acaa>"n_connections"</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token number" style=color:#36acaa>19</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token property" style=color:#36acaa>"n_pending_connections"</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token number" style=color:#36acaa>0</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token punctuation" style=color:#393A34>}</span><br/></div></code></pre></div></div>
<ul>
<li class="">Confirm <code>n_peers</code> is greater than <code>0</code>.</li>
</ul>
</li>
<li class="">
<p>After 3060 seconds, run the <code>get_cryptarchia_info</code> command again and confirm <code>slot</code> and <code>height</code> have increased.</p>
</li>
<li class="">
<p>Wait until <code>mode</code> transitions to <code>Online</code> before continuing. Bootstrapping should take approximately 1 hour.</p>
</li>
</ol>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=step-5-request-tokens-from-the-faucet>Step 5: Request tokens from the faucet<a href=#step-5-request-tokens-from-the-faucet class=hash-link aria-label="Direct link to Step 5: Request tokens from the faucet" title="Direct link to Step 5: Request tokens from the faucet" translate=no></a></h2>
<p>A faucet distributes free tokens on test networks so you can experiment without financial risk. Navigate to the <a href=https://testnet.blockchain.logos.co/web/faucet/ target=_blank rel="noopener noreferrer" class="">public faucet site</a> after your node reaches <code>Online</code> mode.</p>
<ol>
<li class="">
<p>Find the keys associated with your node:</p>
<div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">grep -A3 known_keys user_config.yaml</span><br/></div></code></pre></div></div>
<p>Example output:</p>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-text codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">known_keys:</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> 57364103d3ff29c35d2073cba0526ef729b8e08490bddfc6b74128b6613fe923: ...</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> de3233cec107e6589f83d4f3094caa65c633b5b33601211353779dc01972ca14: ...</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">voucher_master_key_id: de3233cec107e6589f83d4f3094caa65c633b5b33601211353779dc01972ca14</span><br/></div></code></pre></div></div>
</li>
<li class="">
<p>Choose any key from <code>known_keys</code>, enter it in <strong>Destination Public Key (Hex)</strong> on the faucet site, and press <strong>Request Funds</strong>.</p>
<p><img decoding=async loading=lazy alt="Image of the faucet UI after requesting funds with a public key" src=/assets/images/node-faucet-ea6535ffbfd684702139e140a632bbc8.png width=857 height=712 class=img_ev3q /></p>
</li>
<li class="">
<p>Wait 1 to 2 minutes, then check your balance. Replace <code>&lt;your-chosen-key></code> with the key you used:</p>
<div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">curl -s http://localhost:8080/wallet/&lt;your-chosen-key>/balance | jq .</span><br/></div></code></pre></div></div>
<p>Example response:</p>
<div class="language-json codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-json codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token punctuation" style=color:#393A34>{</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token property" style=color:#36acaa>"tip"</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"5d16d4bd3712dc5869fc624e59774552b4fb0c974a6efa516563b3778bac9258"</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token property" style=color:#36acaa>"balance"</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token number" style=color:#36acaa>1000</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token property" style=color:#36acaa>"address"</span><span class="token operator" style=color:#393A34>:</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"57364103d3ff29c35d2073cba0526ef729b8e08490bddfc6b74128b6613fe923"</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token punctuation" style=color:#393A34>}</span><br/></div></code></pre></div></div>
<ul>
<li class="">Only one faucet transaction can be included per block. During high demand, your transaction may be dropped; retry the request and wait 1 to 2 minutes before checking again.</li>
</ul>
</li>
</ol>
<div class="theme-admonition theme-admonition-info admonition_xJq3 alert alert--info"><div class=admonitionHeading_Gvgb><span class=admonitionIcon_Rf37><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>info</div><div class=admonitionContent_BuS1><p>Your tokens become eligible for consensus after 3.5 hours. Confirm that your node is participating by checking that <code>mode</code> remains <code>Online</code> and <code>height</code> continues to increase.<p>Block proposal is probabilistic. Your node will not propose on every <a href=https://docs.logos.co/get-started/glossary#slot target=_blank rel="noopener noreferrer" class="">slot</a>; participation depends on your stake relative to total active stake in the network.</div></div>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=troubleshooting-the-logos-blockchain-node>Troubleshooting the Logos Blockchain node<a href=#troubleshooting-the-logos-blockchain-node class=hash-link aria-label="Direct link to Troubleshooting the Logos Blockchain node" title="Direct link to Troubleshooting the Logos Blockchain node" translate=no></a></h2>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=the-testnet-explorer-shows-an-error-when-i-click-on-a-transaction>The testnet explorer shows an error when I click on a transaction?<a href=#the-testnet-explorer-shows-an-error-when-i-click-on-a-transaction class=hash-link aria-label="Direct link to The testnet explorer shows an error when I click on a transaction?" title="Direct link to The testnet explorer shows an error when I click on a transaction?" translate=no></a></h3>
<p>The <a href=https://testnet.blockchain.logos.co/web/ target=_blank rel="noopener noreferrer" class="">testnet explorer</a> does not support clicking on individual transactions. Searching by address is also not supported. Transaction hashes returned by the faucet may appear truncated and may not be immediately findable.</p>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=my-wallet-balance-is-not-updating-after-requesting-tokens>My wallet balance is not updating after requesting tokens?<a href=#my-wallet-balance-is-not-updating-after-requesting-tokens class=hash-link aria-label="Direct link to My wallet balance is not updating after requesting tokens?" title="Direct link to My wallet balance is not updating after requesting tokens?" translate=no></a></h3>
<p>Only one faucet transaction can be included per block. During high demand, your transaction may be dropped. Retry the request and wait 1 to 2 minutes before checking your balance again.</div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href=https://github.com/logos-co/logos-docs/tree/main/docs/blockchain/get-started/run-a-logos-blockchain-node-from-cli.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_Z9Sw aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/blockchain/get-started/run-a-logos-blockchain-node-from-basecamp><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Run a Logos Blockchain node from Basecamp</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/blockchain/node-app/build-and-run-logos-blockchain-node-app-ui><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Build and run the Logos Blockchain UI app</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#what-to-expect class="table-of-contents__link toc-highlight">What to expect</a><li><a href=#step-1-install-logos-core-tools class="table-of-contents__link toc-highlight">Step 1: Install Logos core tools</a><li><a href=#step-2-load-the-logos-blockchain-module class="table-of-contents__link toc-highlight">Step 2: Load the Logos Blockchain module</a><li><a href=#step-3-configure-and-start-the-node class="table-of-contents__link toc-highlight">Step 3: Configure and start the node</a><li><a href=#step-4-verify-that-your-node-is-running-and-connected-to-peers class="table-of-contents__link toc-highlight">Step 4: Verify that your node is running and connected to peers</a><li><a href=#step-5-request-tokens-from-the-faucet class="table-of-contents__link toc-highlight">Step 5: Request tokens from the faucet</a><li><a href=#troubleshooting-the-logos-blockchain-node class="table-of-contents__link toc-highlight">Troubleshooting the Logos Blockchain node</a><ul><li><a href=#the-testnet-explorer-shows-an-error-when-i-click-on-a-transaction class="table-of-contents__link toc-highlight">The testnet explorer shows an error when I click on a transaction?</a><li><a href=#my-wallet-balance-is-not-updating-after-requesting-tokens class="table-of-contents__link toc-highlight">My wallet balance is not updating after requesting tokens?</a></ul></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/get-started/what-is-logos>Get started</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/logos-co/logos-docs target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2026 Logos. Built with Docusaurus.</div></div></div></footer></div></body>