Files
lightning/doc/guides/Getting Started/home.md
Adi Shankara e83782f5de doc: Add guides and GitHub workflow for doc sync
This PR:
- adds all the guides (in markdown format) that is published at https://docs.corelightning.org/docs
- adds a github workflow to sync any future changes made to files inside the guides folder
- does not include API reference (json-rpc commands). Those will be handled in a separate PR since they're used as manpages and will require a different github workflow

Note that the guides do not exactly map to their related files in doc/, since we reorganized the overall documentation structure on readme for better readability and developer experience. For example, doc/FUZZING.md and doc/HACKING.md#Testing are merged into testing.md in the new docs. As on the creation date of this PR, content from each of the legacy documents has been synced with the new docs. Until this PR gets merged, I will continue to push any updates made to the legacy documents into the new docs.

If this looks reasonable, I will add a separate PR to clean up the legacy documents from doc/ (or mark them deprecated) to avoid redundant upkeep and maintenance.

Changelog-None
2023-06-06 12:40:19 +09:30

31 KiB

title, slug, excerpt, hidden, createdAt, updatedAt
title slug excerpt hidden createdAt updatedAt
Welcome to Core Lightning Documentation Portal home Here you can find everything you need to jump-start your journey to running and building on Core Lightning. false 2023-01-30T15:53:40.926Z 2023-02-13T15:43:05.463Z

📘 Help us improve!

The Core Lightning documentation and API reference is a work-in-progress, feel free to suggest edits or send us your feedback by clicking on Suggest Edits at the top-right of every page (login required) or via Telegram.


[block:html] { "html": "<div class="homeContent">\n \t<h1 style="margin-top: -20px;">\n

\n

Getting Started

\n <div class="navGrid">\n \n <a href="https://blockstream-core-lightning.readme.io/docs/installation" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><rect class="cls-1" x="20.53" y="65.69" width="48.93" height="2.28"/><polygon class="cls-1" points="63.76 44.17 62.32 42.41 46.5 55.73 46.5 19.92 44.22 19.92 44.22 56.14 28.39 42.41 26.85 44.18 45.06 59.92 63.76 44.17"/>\n \n

Installation

\n

Core lightning is available on many platforms and environments. Learn how to install on your preferred platform.

\n \n <a href="https://blockstream-core-lightning.readme.io/docs/configuration" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><path class="cls-1" d="M45,56.63c6.41,0,11.63-5.22,11.63-11.63s-5.22-11.63-11.63-11.63-11.63,5.22-11.63,11.63,5.22,11.63,11.63,11.63Zm0-21.09c5.21,0,9.45,4.24,9.45,9.46s-4.24,9.46-9.46,9.46h0c-5.21,0-9.45-4.24-9.45-9.46s4.24-9.46,9.46-9.46Z"/><path class="cls-1" d="M26.32,50.6c.39,1.28,.89,2.51,1.51,3.65l.11,.2-2.94,4.89,5.67,5.67,4.89-2.94,.2,.11c1.15,.62,2.37,1.13,3.65,1.51l.21,.06,1.38,5.54h8.01l1.38-5.54,.22-.06c1.28-.38,2.51-.89,3.65-1.51l.2-.11,4.89,2.94,5.67-5.67-2.94-4.89,.11-.2c.62-1.13,1.12-2.36,1.51-3.65l.06-.22,5.55-1.38v-8.01l-5.54-1.38-.06-.22c-.39-1.29-.89-2.52-1.51-3.65l-.11-.2,2.94-4.89-5.66-5.67-4.89,2.94-.2-.11c-1.15-.62-2.38-1.13-3.65-1.51l-.22-.06-1.38-5.54h-8.01l-1.38,5.54-.21,.06c-1.29,.39-2.52,.9-3.65,1.51l-.2,.11-4.89-2.94-5.67,5.67,2.94,4.89-.11,.2c-.62,1.14-1.12,2.37-1.51,3.65l-.06,.21-5.54,1.38v8.01l5.54,1.38,.06,.21Zm2.08-10.58c.34-1.15,.79-2.24,1.34-3.24l.7-1.29-2.71-4.5,3.26-3.26,4.5,2.71,1.29-.7c1-.54,2.09-.99,3.24-1.34l1.4-.42,1.27-5.09h4.61l1.27,5.1,1.4,.42c1.13,.34,2.22,.79,3.24,1.34l1.29,.7,4.5-2.71,3.26,3.26-2.71,4.5,.7,1.29c.54,.99,.99,2.08,1.33,3.23l.42,1.4,5.1,1.27v4.61l-5.1,1.26-.42,1.41c-.34,1.14-.79,2.23-1.33,3.23l-.7,1.29,2.71,4.5-3.26,3.26-4.5-2.71-1.29,.7c-1.01,.55-2.11,1-3.24,1.34l-1.4,.42-1.27,5.1h-4.61l-1.27-5.1-1.4-.42c-1.14-.34-2.23-.79-3.24-1.34l-1.29-.7-4.5,2.71-3.26-3.26,2.71-4.5-.69-1.29c-.55-1.01-1-2.1-1.34-3.25l-.42-1.4-5.1-1.27v-4.61l5.1-1.27,.42-1.4Z"/>\n \n

Configure your node

\n

Choose from a variety of configuration options as per your needs.

\n \n <a href="https://blockstream-core-lightning.readme.io/docs/upgrade" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><polygon class="cls-1" points="60.64 31.78 45.69 18.85 30.34 31.78 31.88 33.66 44.23 23.26 44.23 51.48 46.66 51.48 46.66 22.94 59.02 33.66 60.64 31.78"/><polygon class="cls-1" points="23.84 43.3 23.84 66.85 26.18 66.85 26.18 43.05 36.44 51.94 37.99 50.14 25.22 39.09 12.11 50.14 13.58 51.94 23.84 43.3"/><polygon class="cls-1" points="52.01 50.14 53.49 51.94 63.75 43.3 63.75 66.85 66.08 66.85 66.08 43.05 76.34 51.94 77.89 50.14 65.12 39.09 52.01 50.14"/>\n \n

Upgrade your node

\n

Upgrade to the latest stable releases without interruption.

\n \n <a href="https://blockstream-core-lightning.readme.io/docs/beginners-guide" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><path class="cls-1" d="M19.05,66.67h19c1.52,0,2.11,.51,2.48,.84,.06,.06,.11,.1,.17,.15,.02,.02,.04,.03,.09,.08,1.22,.93,2.67,1.42,4.2,1.42s2.99-.5,4.24-1.46c.01-.01,.03-.02,.05-.04,.05-.04,.11-.09,.14-.13,.39-.34,.97-.86,2.51-.86h19c.47,0,.84-.37,.84-.84V27.77c.04-.21-.01-.42-.14-.59-.15-.2-.39-.32-.64-.32h-2.59v-5.16c0-.37-.24-.7-.58-.82-.36-.12-.78,.03-.97,.36-1.88,3.1-6.81,3.16-11.58,3.21-4.28,.05-8.33,.1-10.24,2.38-1.89-2.22-5.89-2.3-10.11-2.38h-.13c-4.76-.06-9.68-.11-11.55-3.18-.2-.33-.61-.48-.97-.36-.36,.12-.59,.43-.59,.82v5.16h-2.62c-.47,0-.84,.37-.84,.84v38.1c0,.47,.37,.84,.84,.84Zm2.71-8.53h0c2.33,3.87,7.92,3.96,12.86,4.04h.15c4.42,.05,8.59,.1,9.43,2.61,.12,.41,.52,.66,.97,.6,.29-.06,.52-.25,.64-.55v-.06c.91-2.47,5.05-2.52,9.43-2.57,4.99-.06,10.65-.12,13.03-4.07,.02-.05,.1-.22,.1-.4V28.57h1.73v36.43h-18.13c-1.99,0-3.01,.72-3.68,1.35-.02,.02-.06,.06-.11,.09-.92,.7-2.02,1.07-3.18,1.07s-2.26-.37-3.23-1.1c-.02-.01-.04-.04-.07-.06l-.05-.05c-.48-.42-1.48-1.3-3.63-1.3H19.92V28.57h1.73v29.16c0,.19,.07,.33,.11,.42Zm44.91-.68c-1.93,2.86-6.71,2.94-11.33,3.01h-.14c-3.72,.05-7.24,.1-9.37,1.58V29.01h.03v-.36c.97-2.39,5.08-2.44,9.42-2.49,4.03-.05,8.59-.11,11.39-2.28V57.46Zm-22.51,4.62c-2.17-1.53-5.83-1.55-9.37-1.57-4.67-.05-9.49-.11-11.46-3.01V23.88c2.76,2.14,7.26,2.23,11.25,2.3h.2c4.32,.06,8.41,.1,9.38,2.49V62.08Z"/><rect class="cls-1" x="48.01" y="31.96" width="16.35" height="1.59" transform="translate(-3.61 7.17) rotate(-7.08)"/><rect class="cls-1" x="48.01" y="36.22" width="16.35" height="1.59" transform="translate(-4.13 7.2) rotate(-7.07)"/><rect class="cls-1" x="48.01" y="40.49" width="16.35" height="1.59" transform="translate(-4.66 7.23) rotate(-7.07)"/><rect class="cls-1" x="48.01" y="44.76" width="16.35" height="1.59" transform="translate(-5.18 7.26) rotate(-7.07)"/><rect class="cls-1" x="48.01" y="49.02" width="16.35" height="1.59" transform="translate(-5.71 7.3) rotate(-7.07)"/><rect class="cls-1" x="48.01" y="53.29" width="16.35" height="1.59" transform="translate(-6.23 7.33) rotate(-7.07)"/><rect class="cls-1" x="32.8" y="24.54" width="1.59" height="16.35" transform="translate(-3.01 62.02) rotate(-82.93)"/><rect class="cls-1" x="32.8" y="28.8" width="1.59" height="16.35" transform="translate(-7.25 65.76) rotate(-82.92)"/><rect class="cls-1" x="32.8" y="33.07" width="1.59" height="16.35" transform="translate(-11.48 69.5) rotate(-82.93)"/><rect class="cls-1" x="32.8" y="37.34" width="1.59" height="16.35" transform="translate(-15.71 73.24) rotate(-82.92)"/><rect class="cls-1" x="32.8" y="41.6" width="1.59" height="16.35" transform="translate(-19.95 76.98) rotate(-82.92)"/><rect class="cls-1" x="32.8" y="45.87" width="1.59" height="16.35" transform="translate(-24.18 80.72) rotate(-82.92)"/>\n \n

Beginner's guide

\n

A guide to all the basics you need to get up and running immediately.

\n \n \n

For Node Operators

\n <div class="navGrid">\n \n <a href="https://blockstream-core-lightning.readme.io/docs/analytics" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><path class="cls-1" d="M29.44,72.1v-4.39h4.57v-17.99h-11.45v17.99h4.57v4.39h2.31Zm2.36-20.16v13.66h-7.12v-13.66h7.12Z"/><path class="cls-1" d="M43.19,27.51v11.2h-4.76v21.72h4.76v7.56h2.31v-7.56h4.76v-21.72h-4.76v-11.2h-2.31Zm4.95,13.32v17.49h-7.59v-17.49h7.59Z"/><path class="cls-1" d="M60,17.9v5.13h-5.23v25.74h12.67V23.03h-5.23v-4.81h-.24v-.33h-1.98Zm-3.11,28.75V25.15h8.43v21.5h-8.43Z"/>\n \n

Analytics

\n

Analyse your node data for effective node management.

\n \n <a href="https://blockstream-core-lightning.readme.io/docs/third-party-tools-and-plugins" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><path class="cls-1" d="M19.5,71.36c.11,.03,.21,.04,.32,.04,.31,0,.59-.12,.81-.35l5.53-5.53,.2,.16c3.86,3.01,9.62,2.63,13.12-.87l6.37-6.37c.52-.53,.52-1.23,0-1.76l-2.24-2.24,5.44-5.45c.39-.52,.38-1.21-.01-1.61-.27-.27-.6-.41-.92-.39-.27,.02-.51,.14-.66,.34l-5.48,5.48-4.61-4.61,5.44-5.45c.39-.52,.38-1.21-.01-1.61-.28-.27-.61-.42-.92-.39-.27,.02-.51,.14-.66,.34l-5.48,5.48-2.24-2.24c-.26-.26-.57-.39-.91-.39h0c-.27,.02-.51,.14-.66,.33l-6.43,6.31c-3.61,3.61-3.98,9.13-.86,13.11l.16,.21-5.8,5.54c-.29,.29-.4,.7-.29,1.11,.1,.4,.4,.71,.81,.81Zm7.51-19.17l5.41-5.41,8.6,8.6,2.25,2.39-5.43,5.29c-2.03,2.02-4.8,2.76-7.44,1.97-2.62-.65-4.74-2.78-5.4-5.42-.69-2.78,.07-5.62,2-7.42Z"/><path class="cls-1" d="M63.79,24.52l-.2-.15c-1.76-1.32-3.87-2.02-6.08-2.02-2.68,0-5.18,1.03-7.04,2.89l-6.37,6.37c-.27,.27-.41,.6-.39,.92,.02,.27,.14,.51,.34,.66l12.67,12.66c.18,.18,.48,.28,.82,.28s.63-.1,.81-.28l6.38-6.25c3.61-3.61,3.98-9.13,.86-13.11l-.16-.2,5.53-5.53c.19-.19,.3-.49,.3-.81v-.07l.03-.06c.05-.09,.07-.18,.08-.29v-.09c-.04-.14-.13-.28-.28-.43-.53-.52-1.23-.52-1.76,0l-5.53,5.53Zm-.7,2.48c1.47,1.47,2.28,3.39,2.27,5.42,0,2.03-.81,3.95-2.29,5.43l-5.43,5.43-10.85-10.85,5.43-5.43c1.5-1.5,3.49-2.32,5.56-2.28h0c2.03,.02,3.91,.84,5.31,2.29Z"/>\n \n

Plugins

\n

Leverage a plethora of plugins on Core Lightning.

\n \n <a href="https://blockstream-core-lightning.readme.io/docs/faq" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><path class="cls-1" d="M28.52,64.85l-.05,.05c-.44,.43-.82,.8-1.12,1.14q-2.1,2.1-2.01,2.71c.1,.38,.33,.64,.63,.71,.97,.34,1.97,.51,2.99,.51,1.96,0,3.8-.63,5.33-1.82,2.4-1.82,3.67-4.72,3.4-7.74-.09-1.11,.27-2.14,1.01-2.88l6.29-6.29,6.15,6.15c.73,.69,1.1,1.77,1,2.97-.21,2.46,.63,4.92,2.3,6.75,1.67,1.82,3.99,2.83,6.54,2.83,3.65,0,6.8-2.09,8.21-5.44,1.4-3.43,.66-7.18-1.94-9.78-1.89-1.89-4.46-2.82-7.06-2.56-1.13,.09-2.19-.28-2.93-1.01l-6.14-6.14,6.29-6.29c.72-.72,1.8-1.1,2.88-1.01,3.03,.27,5.92-1.01,7.74-3.4,1.88-2.4,2.36-5.44,1.31-8.32-.11-.32-.39-.56-.76-.65-.53-.09-.71,.02-2.67,2.02-.51,.51-1.14,1.14-1.88,1.93l-.02,.02-2.22-1.13-1.13-2.22,.02-.02c.28-.28,.55-.54,.81-.8,.44-.43,.82-.8,1.13-1.14q2.1-2.1,2-2.71c-.1-.38-.33-.64-.63-.71-2.89-1.05-5.92-.57-8.32,1.31-2.4,1.82-3.67,4.72-3.4,7.74,.09,1.11-.27,2.14-1.01,2.88l-6.29,6.34-6.14-6.14c-.73-.73-1.1-1.8-1.01-2.93,.26-3.05-1.03-5.99-3.45-7.84-2.44-1.87-5.5-2.35-8.38-1.32-.35,.09-.58,.34-.68,.76-.09,.56,.08,.79,1.86,2.52,.24,.24,.51,.5,.81,.79l.04,.04c.37,.36,.8,.77,1.28,1.25l.02,.02-1.09,2.26-2.26,1.13-.03-.03c-.8-.8-1.42-1.42-1.92-1.97-1.98-2.03-2.14-2.2-2.71-2.01-.54,.13-.68,.5-.71,.63-1.04,2.8-.52,6.03,1.36,8.43,1.88,2.45,4.72,3.71,7.79,3.45,1.12-.09,2.19,.28,2.93,1.01l6.14,6.14-6.29,6.29c-.72,.72-1.79,1.1-2.88,1.01-3.03-.27-5.92,1-7.74,3.4-1.88,2.41-2.36,5.44-1.31,8.32,.11,.32,.38,.56,.76,.65,.55,.1,.75-.06,2.66-2.01,.51-.51,1.15-1.15,1.89-1.94l.02-.02,2.22,1.13,1.13,2.22-.02,.02c-.27,.27-.53,.52-.76,.75ZM61.55,22.08h.1l-.08,.09c-.29,.29-.56,.54-.83,.8-.22,.21-.43,.41-.61,.59-1.7,1.65-2.01,1.95-1.63,2.61l1.63,3.24c.16,.25,.27,.34,1.87,1.14,.22,.1,.46,.22,.74,.36,.29,.14,.62,.31,.96,.47,.68,.39,.98,.08,2.67-1.66l1.47-1.47v.1c.19,1.98-.52,3.93-1.95,5.36-1.41,1.41-3.39,2.15-5.41,2.01-1.66-.16-3.27,.41-4.43,1.57l-16,16.05-2.73,2.73c-1.47,1.47-1.52,2.89-1.57,4.38v.15c0,1.49,0,3.34-1.96,5.35-1.29,1.29-3,2.01-4.8,2.01-.19,0-.35,0-.6-.05h-.1l.08-.09c.29-.29,.56-.55,.83-.8,.22-.21,.43-.41,.61-.59,1.7-1.65,2-1.95,1.63-2.61l-1.62-3.23c-.16-.25-.27-.34-1.87-1.14-.21-.09-.45-.21-.74-.36-.29-.14-.62-.31-.96-.47-.68-.39-.99-.08-2.67,1.66l-1.47,1.47v-.1c-.19-1.96,.52-3.93,1.95-5.41,1.43-1.43,3.4-2.14,5.4-1.96,1.66,.16,3.27-.41,4.43-1.57l18.73-18.73c1.57-1.57,1.57-3.15,1.57-4.54,0-1.49,0-3.34,1.96-5.35,1.41-1.41,3.39-2.14,5.41-2.01Zm-9.03,33.87l-6.14-6.14,3.39-3.39,6.14,6.14c1.14,1.14,2.82,1.73,4.48,1.57,2.95-.28,5.64,1.32,6.86,4.07,1.26,2.71,.7,5.79-1.45,7.84-1.28,1.23-2.97,1.91-4.76,1.91-1.04,0-2.06-.24-3.04-.7-2.65-1.25-4.15-3.85-3.92-6.76,.16-1.72-.42-3.37-1.57-4.53ZM30.59,28.11c.12-.22,.24-.47,.38-.76,.14-.3,.31-.64,.51-1.02,.39-.68,.08-.98-1.66-2.67-.18-.18-.37-.36-.58-.56l-.04-.04c-.25-.24-.53-.5-.82-.79l-.08-.08h.1c2.02-.19,3.98,.52,5.51,2,1.46,1.46,2.19,3.47,2.01,5.51-.16,1.69,.41,3.32,1.57,4.48l6.14,6.14-3.39,3.39-6.14-6.19c-1.56-1.56-3.13-1.57-4.55-1.57h-.17c-1.58-.05-3.37-.1-5.28-2.01-1.46-1.46-2.19-3.47-2.01-5.51v-.1l3.02,3.01c.55,.55,.94,.35,2.82-.62,.44-.24,.93-.49,1.52-.79q.33-.17,1.14-1.83Zm-1.98,36.93h0Z"/><path class="cls-1" d="M61.06,65.55c2.49,0,4.51-2.02,4.51-4.51s-2.02-4.51-4.51-4.51-4.51,2.02-4.51,4.51,2.02,4.51,4.51,4.51Zm0-6.94c1.34,0,2.43,1.09,2.43,2.43s-1.09,2.43-2.43,2.43-2.43-1.09-2.43-2.43,1.09-2.43,2.43-2.43Z"/>\n \n

Troubleshooting & FAQ

\n

Common issues and frequently asked questions on operating a CLN node.

\n \n \n

For Developers

\n <div class="navGrid">\n <a href="https://blockstream-core-lightning.readme.io/docs/developers-guide" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><path class="cls-1" d="M20.73,45.06l12.94-13.15c.46-.58,.45-1.42-.07-1.94-.58-.46-1.42-.45-1.91,.04l-14.73,15.05,14.74,15.05c.23,.23,.59,.37,.97,.37,.26,0,.58-.12,.93-.34l.09-.09c.45-.6,.42-1.41-.05-1.88l-12.9-13.11Z"/><path class="cls-1" d="M58.3,30l-.02-.02c-.58-.46-1.43-.44-1.94,.08-.46,.58-.45,1.42,.03,1.9l12.9,13.11-12.94,13.15c-.46,.58-.45,1.42,.03,1.91,.23,.23,.58,.36,.97,.36s.75-.13,.98-.36l14.73-15.05-14.76-15.07Z"/><path class="cls-1" d="M50.41,26.64h-.04c-.72-.12-1.41,.29-1.64,.99l-9.74,34.1c-.12,.71,.26,1.38,.91,1.62l.43,.03c.47,0,1.08-.34,1.34-1l9.73-34.09c.12-.74-.29-1.42-1.01-1.65Z"/>\n \n

Setting up a dev environment

\n

Get up and running in your local environment with essential tools and libraries in your preferred programming language.

\n \n <a href="https://blockstream-core-lightning.readme.io/docs/app-development" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><path class="cls-1" d="M68.89,68.83l.18-.21v-.08l.05-.11v-.55l-2.22-6.8c-.05-.15-.11-.32-.27-.42L27.36,21.4c-.33-.33-.79-.51-1.28-.51h0c-.49,0-.95,.19-1.28,.51l-3.4,3.4c-.31,.31-.51,.81-.51,1.28,0,.44,.18,.88,.53,1.3l39.24,39.18,.08,.08,.17,.08s.04,.02,.06,.04l.04,.05,6.8,2.25,.45,.02,.13,.12,.11-.12h.19l.22-.24-.1-.09h0l.11,.09ZM29.47,26.37l-3.11,3.11-3.4-3.4,3.11-3.11,3.4,3.4Zm.49,5.52h-.01c-.31-.32-.83-.35-1.24-.12l-.87-.87,3.11-3.11,.86,.86c-.11,.16-.15,.34-.15,.55,0,.3,.09,.51,.29,.71,.31,.31,.85,.36,1.26,.12l.87,.87-3.11,3.11-.86-.86c.22-.37,.18-.9-.13-1.27Zm33.47,28.49h-2.06c-.57,0-1,.43-1,1v2.11l-28.05-28.05,3.11-3.11,15.63,15.69,12.36,12.36Zm2.47,4.12l-1.41,1.41-2.12-.71v-2.82h2.82l.71,2.12Z"/>\n \n

App Development

\n

Build a lightning app using Core Lightning APIs.

\n \n <a href="https://blockstream-core-lightning.readme.io/docs/plugin-development" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><path class="cls-1" d="M17.92,68h54.17c1.78,0,3.23-1.43,3.23-3.18V25.24c0-1.81-1.42-3.23-3.23-3.23H17.92c-1.81,0-3.23,1.42-3.23,3.23v39.52c0,1.81,1.42,3.23,3.23,3.23Zm-1.23-38.62v-4.19c0-.63,.49-1.14,1.11-1.18h54.28c.68,0,1.23,.55,1.23,1.23v4.14H16.69Zm0,35.38V31.33h56.62v33.43c0,.68-.55,1.23-1.23,1.23H17.92c-.68,0-1.23-.55-1.23-1.23Z"/><path class="cls-1" d="M19.07,25.63c-.59,0-1.07,.48-1.07,1.07s.48,1.07,1.07,1.07,1.07-.48,1.07-1.07-.48-1.07-1.07-1.07Z"/><path class="cls-1" d="M21.73,25.63c-.59,0-1.07,.48-1.07,1.07s.48,1.07,1.07,1.07,1.07-.48,1.07-1.07-.48-1.07-1.07-1.07Z"/><path class="cls-1" d="M24.39,25.63c-.59,0-1.07,.48-1.07,1.07s.48,1.07,1.07,1.07,1.07-.48,1.07-1.07-.48-1.07-1.07-1.07Z"/><path class="cls-1" d="M49.25,49.29c.18,.18,.44,.28,.73,.28,.29,0,.55-.1,.72-.27l2.88-2.82c1.73-1.73,1.98-4.35,.63-6.32l2.19-2.19c.17-.17,.27-.41,.28-.64,.11-.31,.03-.61-.22-.87-.44-.44-1.07-.44-1.51,0l-2.19,2.19c-.83-.54-1.78-.83-2.78-.83-1.35,0-2.6,.52-3.54,1.45l-2.88,2.88c-.23,.23-.34,.51-.32,.8,.01,.26,.14,.51,.31,.64l5.71,5.71Zm2.88-8.51c.57,.57,.88,1.31,.88,2.09s-.31,1.52-.88,2.09l-2.09,2.09-4.18-4.18,2.09-2.09c.58-.58,1.32-.88,2.15-.88,.78,0,1.5,.32,2.04,.88Z"/><path class="cls-1" d="M32.69,60.95h0c.09,.02,.18,.03,.26,.03,.27,0,.53-.11,.73-.3l2.19-2.19c1.93,1.3,4.65,1.04,6.32-.63l2.88-2.88c.44-.44,.44-1.07,0-1.51l-.65-.65,2.14-2.14c.34-.43,.32-1.04-.04-1.4-.23-.23-.52-.34-.8-.32-.26,.01-.51,.14-.65,.32l-2.09,2.09-1.37-1.37,2.14-2.14c.34-.43,.32-1.04-.04-1.4-.22-.22-.52-.34-.8-.32-.26,.01-.51,.14-.64,.31l-2.11,2.11-.65-.65c-.22-.22-.5-.34-.8-.32-.26,.01-.51,.14-.63,.31l-2.9,2.84c-1.73,1.73-1.97,4.34-.63,6.32l-2.3,2.2c-.26,.26-.36,.63-.27,.99,.09,.37,.37,.64,.73,.73Zm3.87-8.79l2.09-2.09,3.52,3.52,.67,.71-2.1,2.04h0c-.78,.78-1.85,1.07-2.87,.76-1.01-.25-1.82-1.07-2.08-2.08-.27-1.08,.02-2.17,.77-2.87Z"/>\n \n

Plugin Development

\n

Customise your Core Lightning node by leveraging its powerful modular architecture via plugins.

\n \n <a href="https://docs.corelightning.org/recipes" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><path class="cls-1" d="M28.38,24.15h-4.03v45.14H61.62v-3.43h4.03V28.92l-.3-.3v-.25h-.25l-7.12-7.12v-.25h-.25l-.3-.3H28.38v3.43Zm29.61,4.23v-4.55l4.55,4.55h-4.55Zm5.83,1.83v33.81H30.21V22.54h25.95v7.67h7.67Zm-4.03,35.64v1.6H26.18V25.98h2.2v39.87h31.41Z"/><rect class="cls-1" x="34.4" y="29.72" width="14.28" height="1.83"/><rect class="cls-1" x="34.4" y="33.66" width="23.83" height="1.83"/><rect class="cls-1" x="34.4" y="37.59" width="23.83" height="1.83"/><rect class="cls-1" x="34.4" y="41.52" width="23.49" height="1.83"/><rect class="cls-1" x="34.4" y="45.45" width="23.74" height="1.83"/><rect class="cls-1" x="34.4" y="49.39" width="23.83" height="1.83"/><rect class="cls-1" x="34.4" y="53.32" width="23.83" height="1.83"/><rect class="cls-1" x="34.4" y="57.25" width="9.05" height="1.83"/>\n \n

Recipes

\n

Explore working recipes for common use cases.

\n \n <a href="https://docs.corelightning.org/reference/" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><path class="cls-1" d="M27.29,36.86l-4.04,12.55,7.83,.06-3.79-12.61Zm-.07,6.53l1.24,4.12-2.56-.02,1.32-4.1Z"/><path class="cls-1" d="M23.48,55.06l7.28,.06,1.48,4.84,9.32,.07-10.26-30.25-7.93-.06-10.73,30.09,9.32,.07,1.51-4.82Zm-8.09,2.83l9.35-26.22,5.17,.04,8.94,26.36-5.16-.04-1.48-4.84-10.14-.08-1.51,4.82-5.16-.04Z"/><path class="cls-1" d="M59.08,40.12c.01-1.49-.53-2.64-1.6-3.41-1.01-.73-2.51-1.11-4.45-1.12l-3.59-.03-.07,9.35,3.72,.03c2.01,0,3.46-.36,4.43-1.1,1.03-.79,1.54-2,1.56-3.71Zm-7.71-2.61h1.65c1.72,.03,2.91,.34,3.54,.94,.52,.5,.59,1.14,.58,1.65,0,.99-.21,1.64-.65,2.07-.59,.58-1.67,.83-3.52,.81h-1.65l.04-5.48Z"/><path class="cls-1" d="M54.14,50.59c3.65,.01,6.54-.88,8.58-2.68,2.06-1.82,3.12-4.42,3.15-7.73,.03-3.25-.98-5.78-2.98-7.55-1.99-1.75-4.88-2.65-8.59-2.68l-11.61-.09-.23,30.17,8.73,.07,.07-9.53,2.88,.02Zm-4.8-1.98l-.07,9.53-4.85-.04,.2-26.29,9.67,.07c8.02,.06,9.67,4.53,9.64,8.27-.02,2.72-.88,4.84-2.55,6.3-1.69,1.48-4.13,2.2-7.23,2.19l-4.82-.04Z"/><path class="cls-1" d="M67.17,60.22l8.73,.07,.23-29.61v-.56l-8.73-.07-.23,30.17Zm7.01-28.18l-.2,26.29-4.85-.04,.2-26.29,4.85,.04Z"/>\n \n

API Reference

\n

View all API methods, attributes and responses.

\n \n \n

For Contributors

\n <div class="navGrid">\n <a href="https://blockstream-core-lightning.readme.io/docs/contribute-to-core-lightning" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><polygon class="cls-1" points="42.59 38.2 56.51 11.15 56.07 10.87 29.43 46.74 62.25 38.2 42.59 38.2"/><polygon class="cls-1" points="33.93 79.13 60.57 43.26 27.75 51.8 47.42 51.8 33.49 78.85 33.93 79.13"/>\n \n

CLN Architecture

\n

Familiarise yourself with the core components of Core Lightning.

\n \n <a href="https://blockstream-core-lightning.readme.io/docs/contributor-workflow" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><path class="cls-1" d="M24.95,68.76h40.1V29.01l-.32-.32v-.24h-.24l-7.7-7.7v-.24h-.24l-.32-.32H24.95v48.58ZM56.78,28.45v-5.06l5.06,5.06h-5.06Zm6.38,1.88v36.55H26.83V22.07h28.07v8.27h8.27Z"/><rect class="cls-1" x="37.29" y="32.74" width="19.76" height="1.88"/><rect class="cls-1" x="37.29" y="39.49" width="19.76" height="1.88"/><rect class="cls-1" x="37.29" y="46.24" width="19.47" height="1.88"/><rect class="cls-1" x="37.29" y="52.99" width="19.68" height="1.88"/><rect class="cls-1" x="37.29" y="59.74" width="19.76" height="1.88"/><polygon class="cls-1" points="32.17 33.79 31.23 32.85 29.91 34.17 32.17 36.43 35.96 32.65 34.64 31.33 32.17 33.79"/><polygon class="cls-1" points="32.17 40.53 31.23 39.59 29.91 40.91 32.17 43.16 35.96 39.38 34.64 38.06 32.17 40.53"/><polygon class="cls-1" points="32.17 47.27 31.23 46.32 29.91 47.64 32.17 49.9 35.96 46.12 34.64 44.8 32.17 47.27"/><polygon class="cls-1" points="32.17 54 31.23 53.06 29.91 54.38 32.17 56.64 35.96 52.85 34.64 51.54 32.17 54"/><polygon class="cls-1" points="32.17 60.74 31.23 59.8 29.91 61.11 32.17 63.37 35.96 59.59 34.64 58.27 32.17 60.74"/>\n \n

Contributor Workflow

\n

Learn the practical process and guidelines for contributing.

\n \n <a href="https://blockstream-core-lightning.readme.io/docs/testing" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><polygon class="cls-1" points="65.5 49.92 61.6 33.41 54.27 49.92 48.96 49.92 46.2 57.39 38.96 24.18 29.24 52.29 26.73 49.92 13.43 49.92 13.43 52.28 25.79 52.28 30.28 56.52 38.45 32.92 45.6 65.81 50.61 52.28 55.81 52.28 60.91 40.79 63.63 52.28 76.57 52.28 76.57 49.92 65.5 49.92"/>\n \n

Testing

\n

Understand the testing and code review practices.

\n \n <a href="https://blockstream-core-lightning.readme.io/docs/security-policy" class="navItem">\n <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 90 90">\n <style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style><g id="Layer_1-2"><circle class="cls-2" cx="45" cy="45" r="45"/><path class="cls-1" d="M30.49,55.6l-4.92,5.38c-.23-.06-.44-.09-.65-.09-1.46,0-2.64,1.18-2.64,2.64s1.18,2.64,2.64,2.64,2.64-1.18,2.64-2.64c0-.47-.13-.93-.37-1.34l4.18-4.57h4.35v.91c0,5.11,4.16,9.27,9.27,9.27s9.27-4.16,9.27-9.27v-.91h4.35l4.18,4.57c-.24,.41-.37,.87-.37,1.34,0,1.46,1.18,2.64,2.64,2.64s2.64-1.18,2.64-2.64-1.18-2.64-2.64-2.64c-.2,0-.41,.03-.65,.09l-4.92-5.38h-5.24v-6.37h8.37c.4,.98,1.37,1.63,2.44,1.63,1.46,0,2.64-1.18,2.64-2.64s-1.18-2.64-2.64-2.64c-1.07,0-2.03,.65-2.44,1.63h-8.37v-6.55h5.24l4.92-5.38c.23,.06,.44,.09,.65,.09,1.46,0,2.64-1.18,2.64-2.64s-1.18-2.64-2.64-2.64-2.64,1.18-2.64,2.64c0,.47,.13,.93,.37,1.34l-4.18,4.57h-4.35v-5.9h-3.01c-.09-1.92-1.03-3.64-2.6-4.77,.22-2.79,2.35-6.91,5.11-6.91h.68v-2.02h-.68c-3.57,0-6.4,4.11-7.03,7.99-1.13-.33-2.35-.33-3.48,0-.63-3.88-3.46-7.99-7.03-7.99h-.68v2.02h.68c2.77,0,4.89,4.13,5.11,6.91-1.57,1.13-2.5,2.85-2.6,4.77h-3.01v5.9h-4.35l-4.18-4.57c.24-.41,.37-.87,.37-1.34,0-1.46-1.18-2.64-2.64-2.64s-2.64,1.18-2.64,2.64,1.18,2.64,2.64,2.64c.2,0,.41-.03,.65-.09l4.92,5.38h5.24v6.55h-8.37c-.4-.98-1.37-1.63-2.44-1.63-1.46,0-2.64,1.18-2.64,2.64s1.18,2.64,2.64,2.64c1.07,0,2.03-.65,2.44-1.63h8.37v6.37h-5.24Zm-4.94,7.93c0,.34-.28,.62-.62,.62s-.62-.28-.62-.62,.28-.62,.62-.62,.62,.28,.62,.62Zm15.22-30.79c.15-2.22,1.98-3.94,4.23-3.94s4.08,1.72,4.23,3.94h-8.47Zm3.22,7.37c-2.15,.47-3.7,2.39-3.7,4.6v11.12c0,2.21,1.55,4.13,3.7,4.6v5.27c-3.57-.49-6.24-3.55-6.24-7.17v-23.77h6.24v5.35Zm3.7,4.6v11.12c0,1.49-1.21,2.69-2.69,2.69s-2.69-1.21-2.69-2.69v-11.12c0-1.49,1.21-2.69,2.69-2.69s2.69,1.21,2.69,2.69Zm-1.68,15.72c2.15-.47,3.7-2.39,3.7-4.6v-11.12c0-2.21-1.55-4.13-3.7-4.6v-5.35h6.24v23.77c0,3.63-2.67,6.68-6.24,7.17v-5.27Zm18.44,3.1c0-.34,.28-.62,.62-.62s.62,.28,.62,.62-.28,.62-.62,.62-.62-.28-.62-.62Zm0-15.31c0-.34,.28-.62,.62-.62s.62,.28,.62,.62-.28,.62-.62,.62-.62-.28-.62-.62Zm0-15.49c0-.34,.28-.62,.62-.62s.62,.28,.62,.62-.28,.62-.62,.62-.62-.28-.62-.62Zm-38.9,0c0,.34-.28,.62-.62,.62s-.62-.28-.62-.62,.28-.62,.62-.62,.62,.28,.62,.62Zm0,15.49c0,.34-.28,.62-.62,.62s-.62-.28-.62-.62,.28-.62,.62-.62,.62,.28,.62,.62Z"/>\n \n

Security policy

\n

Learn how to responsibly report a security issue.

\n \n \n " } [/block]