diff --git a/README.md b/README.md index 62ddc75..2b5898b 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,19 @@ The rest of the files in this repo are the standard Jekyll site files. ## Running the site locally +### Prerequisites + +You're going to need: + + - **Linux or OS X** — Windows may work, but is unsupported. + - **Ruby, version 2.2.5 or newer** + - **Bundler** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal. + +### Running locally + +```shell +git clone https://github.com/lightninglabs/lightning-dev-site +``` Install Jekyll: ``` $ gem install jekyll bundler @@ -32,6 +45,8 @@ Run the site and watch for changes: ``` $ bundle exec jekyll serve ``` +* If running remotely add: `--host=0.0.0.0` + ## Regenerating documentation @@ -40,12 +55,17 @@ $ bundle exec jekyll serve pip install Jinja2 ``` -# Get the latest INSTALL.md +### Get the latest INSTALL.md ```shell curl -o INSTALL.md -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/docs/INSTALL.md ``` -# Get the latest gRPC guides +### Fetch the latest Docker guide +```shell +curl -o DOCKER-README.md -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/docker/README.md +``` + +### Get the latest gRPC guides ```shell curl -o python.md -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/docs/grpc/python.md curl -o javascript.md -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/docs/grpc/javascript.md diff --git a/_config.yml b/_config.yml index 9145d1a..a90951d 100644 --- a/_config.yml +++ b/_config.yml @@ -14,8 +14,7 @@ # You can create any custom variable you would like, and they will be accessible # in the templates via {{ site.myvariable }}. title: Lightning Network Developers -author: Max Fang -email: max@lightning.engineering +email: hello@lightning.engineering description: > # this means to ignore newlines until "baseurl:" Developer resources and documentation for the Lightning Network Daemon. baseurl: "" # the subpath of your site, e.g. /blog diff --git a/_includes/footer.html b/_includes/footer.html index b7a6c9c..744eb45 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -2,11 +2,10 @@
-

{{ site.title | escape }}

-
    +
  • {% if site.author %} {{ site.author | escape }} diff --git a/_pages/contribute.md b/_pages/contribute.md index 259c45a..9eac39e 100644 --- a/_pages/contribute.md +++ b/_pages/contribute.md @@ -170,7 +170,7 @@ A quick summary of test practices follows: or RPC's will need to be accompanied by integration tests which use the [`networkHarness`framework](https://github.com/lightningnetwork/lnd/blob/master/lntest/harness.go) contained within `lnd`. For example integration tests, see - [`lnd_test.go`](https://github.com/lightningnetwork/lnd/blob/master/lnd_test.go#L181). + [`lnd_test.go`](https://github.com/lightningnetwork/lnd/blob/master/lntest/itest/lnd_test.go#L203). Throughout the process of contributing to `lnd`, you'll likely also be extensively using the commands within our `Makefile`. As a result, we recommend @@ -376,7 +376,7 @@ Functions should _not_ just be laid out as a bare contiguous block of code. #### 4.7. Protobuf Compilation -The `lnd` project uses `protobuf`, and its extension [`gRPC`](www.grpc.io) in +The `lnd` project uses `protobuf`, and its extension [`gRPC`](https://www.grpc.io/) in several areas and as the primary RPC interface. In order to ensure uniformity of all protos checked, in we require that all contributors pin against the _exact same_ version of `protoc`. As of the writing of this article, the `lnd` @@ -490,7 +490,7 @@ you rework the code, but generally you will simply be given feedback for you to make the necessary changes. During the process of responding to review comments, we prefer that changes be -made with [fixup commits](https://robots.thoughtbot.com/autosquashing-git-commits). +made with [fixup commits](https://thoughtbot.com/blog/autosquashing-git-commits). The reason for this is two fold: it makes it easier for the reviewer to see what changes have been made between versions (since Github doesn't easily show prior versions like Critique) and it makes it easier on the PR author as they diff --git a/_pages/lapps.md b/_pages/lapps.md index 97af76f..96358b5 100644 --- a/_pages/lapps.md +++ b/_pages/lapps.md @@ -11,67 +11,69 @@ compatible apps built on Eclair and c-lightning. ### Wallets -#### [Lightning Desktop App](https://github.com/lightninglabs/lightning-app) by Lightning Labs: - -The Lightning Desktop App is a cross-platform wallet powered by `lnd`. This -application is temporarily down as we upgrade it to be compliant with the LND -beta release. See the [original -announcement](https://blog.lightning.engineering/announcement/2017/10/12/test-blitz.html) -for more information, or checkout the -[code](https://github.com/lightninglabs/lightning-app) or -[releases](https://github.com/lightninglabs/lightning-app/releases) Screenshot of Lightning Desktop App -Channel View - -#### [Zap](https://zap.jackmallers.com/) Wallet by Jack Mallers -Currently in Beta, the Zap wallet is a mobile and desktop app focused on ease of -use and general user experience. -Check out the [Zap website](https://zap.jackmallers.com/) or read the code on -[Github](https://github.com/lightninglabs/lightning-app/releases) - +* [Lightning App](https://github.com/lightninglabs/lightning-app) by Lightning Labs: + a cross-platform wallet powered by `lnd`. See the announcement for + [desktop](https://blog.lightning.engineering/announcement/2019/04/23mainnet-app.html) + and [mobile](https://blog.lightning.engineering/announcement/2019/06/19/mobile-app.html) + for more information. Checkout the [code](https://github.com/lightninglabs/lightning-app) + and find the releases for + [desktop](https://github.com/lightninglabs/lightning-app/releases), + [Android](https://play.google.com/apps/testing/engineering.lightning.LightningMainnet) + and [iOS](https://testflight.apple.com/join/xx23MrBp). +Screenshot of Lightning Desktop App + +* [Zap](https://zap.jackmallers.com/) Wallet by Jack Mallers: a mobile and desktop app focused on ease of + use and general user experience. Check out the [Zap website](https://zap.jackmallers.com/) or read the code on + [GitHub](https://github.com/LN-Zap). Zap Wallet payment request view * [HTLC.me](https://htlc.me/): Hosted wallet great for quickly trying out Lightning payments on the Bitcoin testnet. +* [ZeusLN](https://zeusln.app/): + A mobile Bitcoin app for Lightning Network Daemon (lnd) node operators. Runs on Android and iOS. +* [Breez](https://breez.technology/): Breez is a Lightning Network mobile client and a hub. + It provides a platform for simple, instantaneous bitcoin payments. Supports Android and iOS. ### Integrations * [Bitrefill](https://en.bitrefill.com/): Recharge prepaid phone cards with Bitcoin and Litecoin * [Y'alls](http://yalls.org/): Read and write articles, with Lightning Network - micropayments - Screenshot of Yalls home view + micropayments +Screenshot of Yalls home view * [LNCast](http://lncast.com/): Lightning Network Podcasts -* [Block & Jerry's](http://www.blockandjerrys.fun/): Virtual ice cream shop -* [adWatcher Microservice](http://adwatcher.hopto.org:7777/): Earn satoshis by - watching ads or video content * [Bard](https://www.bard.fun/): Simple paywall for watching a music visualizer -* [CoinMall](https://coinmall.com/): Buy & sell digital products with - cryptocurrencies. -* [Free DNS Demo](http://freedns.lightning-network.ro/): Purchase subdomains - with off-chain payments. -* [Zigzag](http://zigzag.bitlum.io/): Cryptocurrency trading using Lightning +* [HodlHodl.com](https://hodlhodl.com/?set_asset=btcln): Peer-to-peer cryptocurrency + exchange with Lightning integration +* [Zigzag.io](https://zigzag.io/#/): Cryptocurrency trading using Lightning (custodial) +* [lntxbot](https://telegram.me/lntxbot) Lightning integration to Telegram with + tipping, send and receive and satellite API usage (custodial) +* [paywall.link](https://paywall.link/) Put any website behind a paywall and pay with Lightning + +### Lightning network explorers + +* [1ml.com](https://1ml.com/) +* [explore.casa](https://explore.casa/) +* [explorer.acinq.co](https://explorer.acinq.co/) +* [ln.alhur.es](https://ln.alhur.es/) ### Protocol Services -* [Lightning Faucet](httos://faucet.lightning.community/): Receive free testnet - Bitcoin (or [Litecoin](https://ltc.faucet.lightning.community/)) -* [lnd.fun](http://lnd.fun/): Panel for webmasters to manage their full lightning node. - Screenshot of lnd.fun dashboard home view -* [kibana](https://stats.preimage.net/): Visualization of the Lightning Network -* [1ML](https://1ml.com/): Lightning Network search and analysis engine +* [Lightning Faucet](https://faucet.lightning.community/): Receive free testnet + Bitcoin +* [lnd.fun](http://lnd.fun/): Panel for webmasters to manage their full lightning node +Screenshot of lnd.fun dashboard home view ### Developer Tools * [WooCommerce Plugin](https://github.com/joaodealmeida/woocommerce-gateway-lightning): - Gateway plugin to accept Lightning payments at WooCommerce stores, built on - LND + Gateway plugin to accept Lightning payments at WooCommerce stores * [LND Explorer](https://demo1.lndexplorer.com/): demo for a web interface for LND. Code on [Github](https://github.com/altangent/lnd-explorer) * [Light-weight LND Dashboard](https://github.com/mably/lncli-web): A - lightweight web client for LND. + lightweight web client for LND * [LightningJ](http://www.lightningj.org/): A project intending to simplify the integration of Lightning implementations for Java developers, containing simple to use API implementations and converters between JSON and XML. @@ -81,23 +83,32 @@ Check out the [Zap website](https://zap.jackmallers.com/) or read the code on tips via the Lightning Network * [Slack tipbot](https://github.com/CryptoFR/ln-tip-slack): Custodial Slack tipbot -* [CoinTippy](http://cointippy.com/): Custodial tip bot available on - multiple platforms, including Reddit, Twitter, and Telegram. +* [LightningPay-PHP](https://github.com/robclark56/lightningPay-PHP): PHP plugin + for eCommerce website to add _Pay by Lightning_ to accept order payments via the + Lightning Network. +* [Tippin.me](https://tippin.me/) LN tips integrated to Twitter (custodial) +* [Lightning Gifts](https://lightning.gifts/) Create fee-less Bitcoin gift + vouchers to share with friends, family, and your haters. Powered by the Lightning Network ⚡ ### Gaming -* [Hammercoin](https://hammerco.in/): A role-playing game using Lightning for - in-game payments -* [Sarutobi](https://play.google.com/store/apps/details?id=com.mandelduck.sarutobi): - A game with Bitcoin and blockchain-based game items. [Release - announcement](https://blog.indiesquare.me/sarutobi-android-release-and-cross-game-promotion-through-tokens-59a1c58cc7b1#.eaa1svobj) -* [Bitquest](http://bitquest.co/): The first Minecraft server denominated in - cryptocurrency. [CoinJournal - article](https://coinjournal.net/you-can-go-on-a-digital-treasure-hunt-for-bitcoin-in-minecraft/) * [Lightning Gem](https://lightninggem.com/): Betting game using Lightning for payments -* [Thunderdice](http://thunderdice.ws/): Off-chain SatoshiDice - - Screenshot of Thunder Dice Homepage +* [Kriptode.com](https://kriptode.com/) Lightning based games and more. +* [Satoshis.place](https://satoshis.place/) Internet graffiti paid with Lightning + +### Physical applications +* [Ben Arc](https://twitter.com/BTCSocialist)'s various [projects](https://github.com/arcbtc/) +based on Arduino, ESP32 and the M5Stack. + * [M5StackSats](https://github.com/arcbtc/M5StackSats): + A bitcoin point of sale terminal using the ESP32 based M5Stack + * [Physically faucet](https://github.com/arcbtc/physically-faucet): + A Lightning Network bitcoin faucet using the api + * [Flux capacitor](https://github.com/arcbtc/flux-capacitor): + A dynamic Lightning Network point of sale device + * [The Fossa](https://github.com/arcbtc/The-Fossa): + The Free and Open Source Software (FOSS) ATM, dump that stinky loose fiat change for glorious sats! +* [LightningATM](https://github.com/21isenough/LightningATM): + This ATM accepts coins and sends bitcoin over the Lightning Network ### Eclair Lapps @@ -105,7 +116,7 @@ Eclair is a Scala implementation of the Lightning Network built by [ACINQ](https * [Eclair](https://github.com/ACINQ/eclair) app: on [desktop](https://github.com/ACINQ/eclair/releases) and - [Android](https://play.google.com/store/apps/details?id=fr.acinq.eclair.wallet) + [Android](https://play.google.com/store/apps/details?id=fr.acinq.eclair.wallet.mainnet2) * [Starblocks](https://starblocks.acinq.co/#/): Virtual coffee shop * [Strike](https://strike.acinq.co/#/): Stripe-like Lightning payment aggregator API (custodial) @@ -128,31 +139,30 @@ c-lightning is a specification-compliant LN implementation in C, under the payments at WooCommerce stores, based on Lightning Charge. * [Week of Lapps](https://blockstream.com/2018/03/29/blockstreams-week-of-lapps-ends.html) - built on Lightning Charge by Nadav Idgi. - * [Nanopos](https://github.com/ElementsProject/nanopos) — A simple + built on Lightning Charge by Nadav Idgi. + * [Nanopos](https://github.com/ElementsProject/nanopos): A simple point-of-sale system for fixed-price goods - * [FileBazaar](https://github.com/ElementsProject/filebazaar) — A system for + * [FileBazaar](https://github.com/ElementsProject/filebazaar): A system for selling files such as documents, images, and videos * [Lightning Publisher for - WordPress](https://github.com/ElementsProject/wordpress-lightning-publisher) - — A patronage model for unlocking WordPress blog entries - * [Paypercall](https://github.com/ElementsProject/paypercall) — A programmer’s + WordPress](https://github.com/ElementsProject/wordpress-lightning-publisher): + A patronage model for unlocking WordPress blog entries + * [Paypercall](https://github.com/ElementsProject/paypercall): A programmer’s toolkit for Lightning that enables micropayments for individual API calls - * [Ifpaytt](https://github.com/ElementsProject/ifpaytt) — An extension of + * [Ifpaytt](https://github.com/ElementsProject/ifpaytt): An extension of paypercall that allows web developers using IFTTT to request payments for service usage - * [Lightning Jukebox](https://github.com/ElementsProject/lightning-jukebox) — + * [Lightning Jukebox](https://github.com/ElementsProject/lightning-jukebox): A fun demo that reimagines a classic technology for the Lightning Network - * [Nanotip](https://github.com/ElementsProject/nanotip) — The simple tip jar, + * [Nanotip](https://github.com/ElementsProject/nanotip): The simple tip jar, rebuilt to issue Lightning Network invoices -* [BitcoinLightning.shop](https://bitcoinlightning.shop): Shop with Bitcoin - Lightning, built on BTCPay and the c-lightning WooCommerce Plugin -* [Elaine Ou's Twitter bot](https://elaineou.com/shop/): Pay for likes, - retweets, and follows +* [Elaine Ou's projects](https://elaineou.com/shop/): + * [Lightning-powered vending machine](https://github.com/elaineo/Jellybean) + * [Bitcoin-payable Twitter bot with Lightning Charge](https://github.com/elaineo/lightningbot) + * [Twitter relay for Lightning JSON-RPC interface](https://github.com/elaineo/LightningBuddy) ### Requests -If you would like your Lightning app considered for this page, please email a -link and one sentence description of your app to -[max@lightning.engineering](mailto:max@lightning.engineering). If applicable, -please specify which Lightning implementation it is built on. +If you would like a Lightning app considered for this page, please send a +link and a one sentence description to . +If applicable, please specify which Lightning implementation it is built on. diff --git a/_pages/overview.md b/_pages/overview.md index 8d28b4e..206a4b2 100644 --- a/_pages/overview.md +++ b/_pages/overview.md @@ -7,9 +7,9 @@ permalink: /overview/ ### Introduction The LND Overview and Developer Guide aims to provide *just* enough information -about LND to enable readers to build applications. It start with a conceptual +about LND to enable readers to build applications. It starts with a conceptual review of the Lightning Network, before jumping into the important aspects of -working with specifically LND. If you are already comfortable with how the +working specifically with LND. If you are already comfortable with how the Lightning Network works, feel free to skip down to the [Components](#components) section. The command line examples are for illustrative purposes only and will be covered in more depth in the [installation guide](/guides/installation/) and @@ -64,7 +64,7 @@ the underlying blockchain, but with modern data processing and latency limits - payments can be made nearly as quickly as packets can be sent. Hash Time-Locked Contracts (HTLCs) allow transactions to be sent between parties -who do not have a direct channels by routing it through multiple hops, so anyone +who do not have a direct channel by routing them through multiple hops, so anyone connected to the Lightning Network is part of a single, interconnected global financial system. @@ -215,7 +215,7 @@ security, we generally want to keep as little as possible in hot wallets, and as much as possible in cold wallets. It is possible to construct Lightning channels where the keys are cold, but they -would need to be brought back online you conduct a channel update. Only with hot +would need to be brought back online to conduct a channel update. Only with hot wallets can the Lightning Network attain a high volume of transactions. This is only a surface level introduction to Lightning integration. For a more @@ -249,11 +249,7 @@ layers we encounter when reasoning about `lnd`: #### Software Components There are distinct software components we should be aware of when developing on -- `btcd` / `btcutil`: `lnd` currently uses [`btcd` roasbeef - fork](https://github.com/roasbeef/btcd) to interface with the underlying - blockchain. `btcd` comes with `btcutil`, also [roasbeef - fork](https://github.com/Roasbeef/btcutil), that allows us to drive `btcd` - from the command line. +- [`btcd`](https://github.com/btcsuite/btcd) or [`bitcoind`](https://github.com/bitcoin/bitcoin) is used by `lnd` to interface with the underlying blockchain. - `lnd` / `lncli`: LND stands for Lightning Network Daemon and serves as the main software component driving the Lightning Network. It manages a database, connects to peers, opens / closes channels, generates payment invoices, sends, @@ -262,9 +258,9 @@ There are distinct software components we should be aware of when developing on - [Neutrino](https://github.com/lightninglabs/neutrino) is an experimental Bitcoin light client designed to support Lightning mobile clients. This is a wallet UI usable with `lnd`. Neutrino is not required from an application - development standpoint, but can be regarded as the primary way the LND end - user interacts with the Lightning Network and thus and applications built on - top of it. + development standpoint, but can be regarded as the primary way for an + end-user of `lnd` to interact with the Bitcoin Network and the applications + built on top of it. #### LND Interfaces @@ -274,18 +270,17 @@ There are several ways to drive `lnd`. instantaneously. A full list of commands can be viewed with `lncli --help`. To see a breakdown of the parameters for a particular command, run `lncli --help` -- gRPC is the preferred programmatic way interact with `lnd`. It includes simple +- gRPC is the preferred programmatic way to interact with `lnd`. It includes simple methods that return a response immediately, as well as response-streaming and bidrectional streaming methods. Check out the guides for working with gRPC for [Python](/guides/python-grpc/) and [Javascript](/guides/javascript-grpc/) - LND also features a REST proxy someone can use if they are accustomed to - standard RESTful APIs. However, gRPC is higher performance and can provide - real-time notifications. + standard RESTful APIs. However, REST does not have full streaming RPC coverage. All of these LND interfaces are documented in the [API Reference](//api.lightning.community), featuring a description of the parameters, responses, and code examples for Python, Javascript, and command -line arguments if it exists. +line arguments if those exist. ### Channel Lifecycle @@ -362,7 +357,7 @@ not attempt them. This will affect any web application with `lnd` integration, since if an invoice for a good or service is not fulfilled within the given timeframe, a new one should be generated. -Other possibly unexpected rules include that the payee should accept up the +Other possibly unexpected rules include that the payee should accept up to twice the amount encoded in the transaction, so that the payer can make payments harder to track by adding in small variations. diff --git a/_pages/resources.md b/_pages/resources.md index 936d9e8..30b345e 100644 --- a/_pages/resources.md +++ b/_pages/resources.md @@ -168,7 +168,4 @@ for anyone's needs. If something important is missing, or you feel that additional resources or -links would be helpful, please email [Max -Fang](mailto:max@lightning.engineering) or message him on the Lightning -Community Slack. - +links would be helpful, please send a message in the [LND Developer Slack](https://join.slack.com/t/lightningcommunity/shared_invite/enQtMzQ0OTQyNjE5NjU1LWRiMGNmOTZiNzU0MTVmYzc1ZGFkZTUyNzUwOGJjMjYwNWRkNWQzZWE3MTkwZjdjZGE5ZGNiNGVkMzI2MDU4ZTE) diff --git a/assets/lapps/lnd_desktop_app.png b/assets/lapps/lnd_desktop_app.png index 9583f8c..69dbc51 100644 Binary files a/assets/lapps/lnd_desktop_app.png and b/assets/lapps/lnd_desktop_app.png differ diff --git a/assets/lapps/zap.png b/assets/lapps/zap.png index ed5fdf0..c62e32a 100644 Binary files a/assets/lapps/zap.png and b/assets/lapps/zap.png differ diff --git a/guides/docker.md b/guides/docker.md index df7ecf4..68dfa67 100644 --- a/guides/docker.md +++ b/guides/docker.md @@ -313,10 +313,10 @@ The `Faucet` node address can be found at the [Faucet Lightning Community webpag ```bash # Run "Alice" container and log into it: -$ docker-compose up -d "alice"; docker exec -i -t "alice" bash +$ docker-compose run -d --name alice lnd_btc; docker exec -i -t "alice" bash # Connect "Alice" to the "Faucet" node: -alice$ lncli --network=simnet connect @ +alice$ lncli --network=testnet connect @ ``` After a connection is achieved, the `Faucet` node should create the channel diff --git a/guides/installation.md b/guides/installation.md index 5887715..f8feb31 100644 --- a/guides/installation.md +++ b/guides/installation.md @@ -4,7 +4,6 @@ title: Installation --- -# Table of Contents * [Installation](#installation) * [Preliminaries](#preliminaries) * [Installing lnd](#installing-lnd) @@ -18,10 +17,11 @@ title: Installation * [Running lnd using the btcd backend](#running-lnd-using-the-btcd-backend) * [Using Neutrino](#using-neutrino) * [Using bitcoind or litecoind](#using-bitcoind-or-litecoind) +* [Creating a Wallet](#creating-a-wallet) * [Macaroons](#macaroons) * [Network Reachability](#network-reachability) -* [Simnet vs. Testnet Development](#simnet-vs.-testnet-development) -* [Creating an lnd.conf (Optional)](#creating-an-lnd.conf-(optional)) +* [Simnet vs. Testnet Development](#simnet-vs-testnet-development) +* [Creating an lnd.conf (Optional)](#creating-an-lndconf-optional) # Installation @@ -32,23 +32,46 @@ title: Installation * **Go:** `lnd` is written in Go. To install, run one of the following commands: - **Note**: The minimum version of Go supported is Go 1.11. We recommend that + **Note**: The minimum version of Go supported is Go 1.13. We recommend that users use the latest version of Go, which at the time of writing is - [`1.11`](https://blog.golang.org/go1.11). + [`1.13`](https://blog.golang.org/go1.13). On Linux: + + (x86-64) + ``` + wget https://dl.google.com/go/go1.13.linux-amd64.tar.gz + sha256sum go1.13.linux-amd64.tar.gz | awk -F " " '{ print $1 }' + ``` + + The final output of the command above should be + `68a2297eb099d1a76097905a2ce334e3155004ec08cdea85f24527be3c48e856`. If it + isn't, then the target REPO HAS BEEN MODIFIED, and you shouldn't install + this version of Go. If it matches, then proceed to install Go: + ``` + tar -C /usr/local -xzf go1.13.linux-amd64.tar.gz + export PATH=$PATH:/usr/local/go/bin ``` - sudo apt-get install golang-1.11-go + + (ARMv6) + ``` + wget https://dl.google.com/go/go1.13.linux-armv6l.tar.gz + sha256sum go1.13.linux-armv6l.tar.gz | awk -F " " '{ print $1 }' ``` - > Note that golang-1.11-go puts binaries in /usr/lib/go-1.11/bin. If you want them on your PATH, you need to make that change yourself. Alternatively, you can run: + + The final output of the command above should be + `931906d67cae1222f501e7be26e0ee73ba89420be0c4591925901cb9a4e156f0`. If it + isn't, then the target REPO HAS BEEN MODIFIED, and you shouldn't install + this version of Go. If it matches, then proceed to install Go: ``` - sudo ln -s /usr/lib/go-1.11/bin/go /usr/local/bin/go + tar -C /usr/local -xzf go1.13.linux-armv6l.tar.gz + export PATH=$PATH:/usr/local/go/bin ``` On Mac OS X: ``` - brew install go + brew install go@1.13 ``` On FreeBSD: @@ -57,9 +80,9 @@ title: Installation ``` Alternatively, one can download the pre-compiled binaries hosted on the - [golang download page](https://golang.org/dl/). If one seeks to install + [Golang download page](https://golang.org/dl/). If one seeks to install from source, then more detailed installation instructions can be found - [here](http://golang.org/doc/install). + [here](https://golang.org/doc/install). At this point, you should set your `$GOPATH` environment variable, which represents the path to your workspace. By default, `$GOPATH` is set to @@ -74,10 +97,10 @@ title: Installation We recommend placing the above in your .bashrc or in a setup script so that you can avoid typing this every time you open a new terminal window. - * **go modules:** This project uses [go modules](https://github.com/golang/go/wiki/Modules) + * **Go modules:** This project uses [Go modules](https://github.com/golang/go/wiki/Modules) to manage dependencies as well as to provide *reproducible builds*. - Usage of go modules (with go 1.11) means that you no longer need to clone + Usage of Go modules (with Go 1.12) means that you no longer need to clone `lnd` into your `$GOPATH` for development purposes. Instead, your `lnd` repo can now live anywhere! @@ -92,7 +115,7 @@ make && make install ``` **NOTE**: Our instructions still use the `$GOPATH` directory from prior -versions of Go, but with go 1.11, it's now possible for `lnd` to live +versions of Go, but with Go 1.12, it's now possible for `lnd` to live _anywhere_ on your file system. For Windows WSL users, make will need to be referenced directly via @@ -251,7 +274,7 @@ btcctl --testnet --rpcuser=REPLACEME --rpcpass=REPLACEME getpeerinfo | more If you are on testnet, run this command after `btcd` has finished syncing. Otherwise, replace `--bitcoin.testnet` with `--bitcoin.simnet`. If you are installing `lnd` in preparation for the -[tutorial](http://dev.lightning.community/tutorial), you may skip this step. +[tutorial](https://dev.lightning.community/tutorial), you may skip this step. ``` lnd --bitcoin.active --bitcoin.testnet --debuglevel=debug --btcd.rpcuser=kek --btcd.rpcpass=kek --externalip=X.X.X.X ``` @@ -260,8 +283,8 @@ lnd --bitcoin.active --bitcoin.testnet --debuglevel=debug --btcd.rpcuser=kek --b In order to run `lnd` in its light client mode, you'll need to locate a full-node which is capable of serving this new light client mode. `lnd` uses -[BIP 157](https://github.com/bitcoin/bips/tree/master/bip-0157) and [BIP -158](https://github.com/bitcoin/bips/tree/master/bip-0158) for its light client +[BIP 157](https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki) and [BIP +158](https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki) for its light client mode. A public instance of such a node can be found at `faucet.lightning.community`. @@ -347,6 +370,20 @@ lnd --bitcoin.active --bitcoin.testnet --debuglevel=debug --bitcoin.node=bitcoin `lnd` plus any application that consumes the RPC could cause `lnd` to miss crucial updates from the backend. + +# Creating a wallet +If `lnd` is being run for the first time, create a new wallet with: +``` +lncli create +``` +This will prompt for a wallet password, and optionally a cipher seed +passphrase. + +`lnd` will then print a 24 word cipher seed mnemonic, which can be used to +recover the wallet in case of data loss. The user should write this down and +keep in a safe place. + + # Macaroons `lnd`'s authentication system is called **macaroons**, which are decentralized @@ -424,3 +461,15 @@ for Litecoin accordingly. See a more detailed sample config file available and explore the other sections for node configuration, including `[Btcd]`, `[Bitcoind]`, `[Neutrino]`, `[Ltcd]`, and `[Litecoind]` depending on which chain and node type you're using. + + + + +### Next Steps + +* **[Tutorial](/tutorial/):** Get acquainted with the skills necessary for `lnd` development. +* **[Developer Guides](/guides/):** Look through developer manuals on gRPC, + Docker, and more. +* **[Resources](/resources/):** Learn about the Lightning Network +* **[Code Contribution Guidelines](/contribute/):** Contribute to `lnd` itself. + diff --git a/guides/javascript-grpc.md b/guides/javascript-grpc.md index c7a3d42..59dd88a 100644 --- a/guides/javascript-grpc.md +++ b/guides/javascript-grpc.md @@ -232,7 +232,7 @@ client.getInfo({}, (err, res) => { ... }); ### Conclusion With the above, you should have all the `lnd` related `gRPC` dependencies -installed locally in your project. In order to get up to speed with `protofbuf` +installed locally in your project. In order to get up to speed with `protobuf` usage from Javascript, see [this official `protobuf` reference for Javascript](https://developers.google.com/protocol-buffers/docs/reference/javascript-generated). Additionally, [this official gRPC diff --git a/guides/python-grpc.md b/guides/python-grpc.md index 65236aa..9c8b7d4 100644 --- a/guides/python-grpc.md +++ b/guides/python-grpc.md @@ -188,7 +188,7 @@ stub.GetInfo(ln.GetInfoRequest()) With the above, you should have all the `lnd` related `gRPC` dependencies installed locally into your virtual environment. In order to get up to speed -with `protofbuf` usage from Python, see [this official `protobuf` tutorial for +with `protobuf` usage from Python, see [this official `protobuf` tutorial for Python](https://developers.google.com/protocol-buffers/docs/pythontutorial). Additionally, [this official gRPC resource](http://www.grpc.io/docs/tutorials/basic/python.html) provides more diff --git a/render.py b/render.py index f678ef4..ab20ab0 100755 --- a/render.py +++ b/render.py @@ -1,4 +1,4 @@ -#!/usr/local/bin/python2.7 +#!/usr/bin/python2.7 from jinja2 import Environment, FileSystemLoader, select_autoescape diff --git a/tutorial/01-lncli.md b/tutorial/01-lncli.md index 5b93a07..beb469f 100644 --- a/tutorial/01-lncli.md +++ b/tutorial/01-lncli.md @@ -252,7 +252,7 @@ Open up a new terminal window, set `$GOPATH` and include `$GOPATH/bin` in your `PATH` as usual. Let's create Alice's wallet and set her passphrase: ```bash cd $GOPATH/dev/alice -alice$ lncli --rpcserver=localhost:10001 --macaroonpath=data/admin.macaroon create +alice$ lncli --rpcserver=localhost:10001 --macaroonpath=data/chain/bitcoin/simnet/admin.macaroon create ``` You'll be asked to input and confirm a wallet password for Alice, which must be longer than 8 characters. You also have the option to add a passphrase to your @@ -262,7 +262,7 @@ passphrase. You can now request some basic information as follows: ```bash -alice$ lncli --rpcserver=localhost:10001 --macaroonpath=data/admin.macaroon getinfo +alice$ lncli --rpcserver=localhost:10001 --macaroonpath=data/chain/bitcoin/simnet/admin.macaroon getinfo ``` `lncli` just made an RPC call to the Alice `lnd` node. This is a good way to test if your nodes are up and running and `lncli` is functioning properly. Note @@ -275,21 +275,21 @@ respectively. ```bash # In a new terminal window, setting $GOPATH, etc. cd $GOPATH/dev/bob -bob$ lncli --rpcserver=localhost:10002 --macaroonpath=data/admin.macaroon create +bob$ lncli --rpcserver=localhost:10002 --macaroonpath=data/chain/bitcoin/simnet/admin.macaroon create # Note that you'll have to enter an 8+ character password and "n" for the mnemonic. # In a new terminal window: cd $GOPATH/dev/charlie -charlie$ lncli --rpcserver=localhost:10003 --macaroonpath=data/admin.macaroon create +charlie$ lncli --rpcserver=localhost:10003 --macaroonpath=data/chain/bitcoin/simnet/admin.macaroon create # Note that you'll have to enter an 8+ character password and "n" for the mnemonic. ``` To avoid typing the `--rpcserver=localhost:1000X` and `--macaroonpath` flag every time, we can set some aliases. Add the following to your `.bashrc`: ```bash -alias lncli-alice="lncli --rpcserver=localhost:10001 --macaroonpath=data/admin.macaroon" -alias lncli-bob="lncli --rpcserver=localhost:10002 --macaroonpath=data/admin.macaroon" -alias lncli-charlie="lncli --rpcserver=localhost:10003 --macaroonpath=data/admin.macaroon" +alias lncli-alice="lncli --rpcserver=localhost:10001 --macaroonpath=data/chain/bitcoin/simnet/admin.macaroon" +alias lncli-bob="lncli --rpcserver=localhost:10002 --macaroonpath=data/chain/bitcoin/simnet/admin.macaroon" +alias lncli-charlie="lncli --rpcserver=localhost:10003 --macaroonpath=data/chain/bitcoin/simnet/admin.macaroon" ``` To make sure this was applied to all of your current terminal windows, rerun @@ -406,7 +406,7 @@ alice$ lncli-alice connect @localhost:10012 } ``` -Notice that `localhost:10012` corresponds to the `--peerport=10012` flag we set +Notice that `localhost:10012` corresponds to the `--listen=localhost:10012` flag we set when starting the Bob `lnd` node. Let's check that Alice and Bob are now aware of each other. @@ -604,7 +604,7 @@ btcctl --simnet --rpcuser=kek --rpcpass=kek generate 1 # Check that Bob's on-chain balance was credited by his settled amount in the # channel. Recall that Bob previously had no on-chain Bitcoin: -alice$ lncli-bob walletbalance +bob$ lncli-bob walletbalance { "total_balance": "20001", "confirmed_balance": "20001", @@ -626,7 +626,7 @@ repository](https://github.com/lightninglabs/lightning-faucet)._ [//]: # (TODO Max: Replace the link to Github LN Faucet to an internal guide for interacting with the Lightning Faucet) #### Navigation -- [Proceed to Stage 2 - Web Client](/tutorial/02-web-client) +- [Proceed to Stage 2 - Web Client](/tutorial/02-web-client.md) - [Return to main tutorial page](/tutorial/) ### Questions diff --git a/tutorial/index.md b/tutorial/index.md index 9da414e..24efdd2 100644 --- a/tutorial/index.md +++ b/tutorial/index.md @@ -7,7 +7,7 @@ title: Tutorial This tutorial will get you up to speed with all the skills necessary to work with [`lnd`](https://github.com/lightningnetwork/lnd). We will be building a -Bitcoin micropayments paywell into a news site! +Bitcoin micropayments paywall into a news site! Those seeking more conceptual familiarity with the Lightning Network can read through the [LND Overview and Developer Guide](/overview/). It also contains a