Skip to content

Commit 01f6bde

Browse files
github-actions[bot]github-actions[bot]
authored
Merge pull request #829 from lightninglabs/docs-lnd
Update lnd documentation
2 parents 7e695f5 + 2857d75 commit 01f6bde

File tree

3 files changed

+293
-173
lines changed

3 files changed

+293
-173
lines changed

‎docs/lnd/key_import.md

Lines changed: 113 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,34 @@
1-
# Key Import
2-
3-
## Overview
1+
# Overview
42

5-
This document serves as an introductory point for users interested in reducing their hot-wallet risks, allowing them to maintain on-chain funds outside of `lnd` but still be able to manage them within `lnd`. As of `v0.13.0-beta`, `lnd` is able to import BIP-0049 and BIP-0084 extended public keys either at the account path (`m/purpose'/coin_type'/account'`) or at the address index path (`m/purpose'/coin_type'/account'/change/address_index`) as watch-only through the `WalletKit` APIs.
3+
This document serves as an introductory point for users interested in reducing
4+
their hot-wallet risks, allowing them to maintain on-chain funds outside of
5+
`lnd` but still be able to manage them within `lnd`. As of `v0.13.0-beta`, `lnd`
6+
is able to import BIP-0049 and BIP-0084 extended public keys either at the
7+
account path (`m/purpose'/coin_type'/account'`) or at the address index path
8+
(`m/purpose'/coin_type'/account'/change/address_index`) as watch-only through
9+
the `WalletKit` APIs.
610

7-
Note that in order to follow the rest of this document and/or use the `WalletKit` APIs, users will need to obtain an `lnd` build compiled with the `walletrpc` tag. Our release builds already include this tag by default, so this would only be necessary when compiling from source.
11+
Note that in order to follow the rest of this document and/or use the
12+
`WalletKit` APIs, users will need to obtain an `lnd` build compiled with the
13+
`walletrpc` tag. Our release builds already include this tag by default, so this
14+
would only be necessary when compiling from source.
815

9-
## `lnd`'s Default Wallet Accounts
16+
# `lnd`'s Default Wallet Accounts
1017

1118
Upon initializing `lnd`, a wallet is created with four default accounts:
1219

13-
* A custom BIP-0049 account (more on this later) to generate NP2WKH external addresses.
20+
* A custom BIP-0049 account (more on this later) to generate NP2WKH external
21+
addresses.
1422
* A BIP-0084 account to generate P2WKH external and change addresses.
15-
* A catch-all BIP-0049 account where all imported BIP-0049 address keys (NP2WKH addresses) exist within.
16-
* A catch-all BIP-0084 account where all imported BIP-0049 address keys (P2WKH addresses) exist within.
23+
* A catch-all BIP-0049 account where all imported BIP-0049 address keys (NP2WKH
24+
addresses) exist within.
25+
* A catch-all BIP-0084 account where all imported BIP-0049 address keys (P2WKH
26+
addresses) exist within.
1727

18-
Prior to `v0.13.0-beta`, these accounts were abstracted away from users. As part of the key import feature, they are now exposed through the new `WalletKit` RPCs (`ListAccounts`, `ImportAccount`, `ImportPublicKey`) and the `lncli wallet accounts` command.
28+
Prior to `v0.13.0-beta`, these accounts were abstracted away from users. As part
29+
of the key import feature, they are now exposed through the new `WalletKit` RPCs
30+
(`ListAccounts`, `ImportAccount`, `ImportPublicKey`) and the `lncli wallet
31+
accounts` command.
1932

2033
```shell
2134
$ lncli wallet accounts
@@ -34,9 +47,12 @@ OPTIONS:
3447
--help, -h show help
3548
```
3649

37-
### Account Details
50+
## Account Details
3851

39-
Before interacting with the new set of APIs, users will want to become familiar with how wallet accounts are represented within `lnd`. The `WalletKit.ListAccounts` RPC or `lncli wallet accounts list` command can be used to retrieve the details of accounts.
52+
Before interacting with the new set of APIs, users will want to become familiar
53+
with how wallet accounts are represented within `lnd`. The
54+
`WalletKit.ListAccounts` RPC or `lncli wallet accounts list` command can be used
55+
to retrieve the details of accounts.
4056

4157
```shell
4258
$ lncli wallet accounts list
@@ -66,38 +82,79 @@ $ lncli wallet accounts list
6682
}
6783
```
6884

69-
There's a lot to unpack in the response above, so let's cover each account field in detail. As mentioned above, four default accounts should exist, though only two are shown in the output. The catch-all imported accounts are hidden by default until a key has been imported into them.
70-
71-
* `name`: Each account has a name it can be identified by. `lnd`'s default spendable accounts have the name "default". The default catch-all imported accounts have the name "imported".
72-
* `extended_public_key`: The BIP-0044 extended public key for the account. Any addresses generated for the account are derived from this key. Each key has a version prefix that identifies the chain and derivation scheme being used. At the time of writing, `lnd` supports the following versions:
73-
* `xpub/tpub`: The commonly used version prefix originally intended for BIP-0032 mainnet/testnet extended keys. Since `lnd` does not support BIP-0032 extended keys, this version serves as a catch-all for the other versions.
85+
There's a lot to unpack in the response above, so let's cover each account field
86+
in detail. As mentioned above, four default accounts should exist, though only
87+
two are shown in the output. The catch-all imported accounts are hidden by
88+
default until a key has been imported into them.
89+
90+
* `name`: Each account has a name it can be identified by. `lnd`'s default
91+
spendable accounts have the name "default". The default catch-all imported
92+
accounts have the name "imported".
93+
* `extended_public_key`: The BIP-0044 extended public key for the account. Any
94+
addresses generated for the account are derived from this key. Each key has a
95+
version prefix that identifies the chain and derivation scheme being used. At
96+
the time of writing, `lnd` supports the following versions:
97+
* `xpub/tpub`: The commonly used version prefix originally intended for
98+
BIP-0032 mainnet/testnet extended keys. Since `lnd` does not support
99+
BIP-0032 extended keys, this version serves as a catch-all for the other
100+
versions.
74101
* `ypub/upub`: The version prefix for BIP-0049 mainnet/testnet extended keys.
75102
* `zpub/vpub`: The version prefix for BIP-0084 mainnet/testnet extended keys.
76-
* `address_type`: The type of addresses the account can derive. There are three supported address types:
77-
* `WITNESS_PUBKEY_HASH`: The standard derivation scheme for BIP-0084 with P2WKH for external and change addresses.
78-
* `NESTED_WITNESS_PUBKEY_HASH`: The standard derivation scheme for BIP-0049 with P2WKH for external and change addresses.
79-
* `HYBRID_NESTED_WITNESS_PUBKEY_HASH` A custom derivation scheme for BIP-0049 used by `lnd` where NP2WKH is used for external addresses and P2WKH for change addresses.
80-
* `master_key_fingerprint`: The 4 byte fingerprint of the master key corresponding to the account. This is usually required by hardware wallet/external signers to identify the proper signing key.
81-
* `derivation_path`: The BIP-0044 derivation path used on the master key to obtain the account key.
103+
* `address_type`: The type of addresses the account can derive. There are three
104+
supported address types:
105+
* `WITNESS_PUBKEY_HASH`: The standard derivation scheme for BIP-0084 with
106+
P2WKH for external and change addresses.
107+
* `NESTED_WITNESS_PUBKEY_HASH`: The standard derivation scheme for BIP-0049
108+
with P2WKH for external and change addresses.
109+
* `HYBRID_NESTED_WITNESS_PUBKEY_HASH` A custom derivation scheme for BIP-0049
110+
used by `lnd` where NP2WKH is used for external addresses and P2WKH for
111+
change addresses.
112+
* `master_key_fingerprint`: The 4 byte fingerprint of the master key
113+
corresponding to the account. This is usually required by hardware
114+
wallet/external signers to identify the proper signing key.
115+
* `derivation_path`: The BIP-0044 derivation path used on the master key to
116+
obtain the account key.
82117
* `external_key_count`: The number of external addresses generated.
83118
* `internal_key_count`: The number of change addresses generated.
84-
* `watch_only`: Whether the wallet has private key information for the account. `lnd`'s default wallet accounts always have private key information, so this value is `false`.
119+
* `watch_only`: Whether the wallet has private key information for the account.
120+
`lnd`'s default wallet accounts always have private key information, so this
121+
value is `false`.
85122

86-
## Key Import
123+
# Key Import
87124

88-
An existing limitation to the key import APIs is that events (deposits/spends) for imported keys, including those derived from an imported account, will only be detected by lnd if they happen after the import. Rescans to detect past events are currently not supported, but will come at a later time.
125+
An existing limitation to the key import APIs is that events (deposits/spends)
126+
for imported keys, including those derived from an imported account, will only
127+
be detected by lnd if they happen after the import. Rescans to detect past
128+
events are currently not supported, but will come at a later time.
89129

90-
### Account Key Import
130+
## Account Key Import
91131

92-
The `WalletKit.ImportAccount` RPC and `lncli wallet accounts import` command can be used to import an account. At the time of writing, importing an account has the following request parameters:
132+
The `WalletKit.ImportAccount` RPC and `lncli wallet accounts import` command can
133+
be used to import an account. At the time of writing, importing an account has
134+
the following request parameters:
93135

94136
* `name` (required): A name to identify the imported account with.
95-
* `extended_public_key` (required): A public key that corresponds to a wallet account represented as an extended key. It must conform to a derivation path of the form `m/purpose'/coin_type'/account'`.
96-
* `master_key_fingerprint` (optional): The fingerprint of the root key (also known as the key with derivation path m/) from which the account public key was derived from. This may be required by some hardware wallets for proper identification and signing.
97-
* `address_type` (optional): An address type is only required when the extended account public key has a legacy version (xpub, tpub, etc.), such that the wallet cannot detect what address scheme it belongs to.
98-
* `dry_run` (optional): Whether a dry run should be attempted when importing the account. This serves as a way to confirm whether the account is being imported correctly by returning the first N addresses for the external and internal branches of the account. If these addresses match as expected, then it should be safe to import the account as is.
99-
100-
For the sake of simplicity, we'll present an example with two `lnd` nodes Alice and Bob, where Alice acts as a signer _only_, and Bob manages Alice's on-chain BIP-0084 account by crafting transactions and watching/spending addresses. Since Alice will only act as a signer, we'll want to import her BIP-0084 account into Bob's node, which will require knowledge of Alice's extended public key.
137+
* `extended_public_key` (required): A public key that corresponds to a wallet account
138+
represented as an extended key. It must conform to a derivation path of the
139+
form `m/purpose'/coin_type'/account'`.
140+
* `master_key_fingerprint` (optional): The fingerprint of the root key (also
141+
known as the key with derivation path m/) from which the account public key
142+
was derived from. This may be required by some hardware wallets for proper
143+
identification and signing.
144+
* `address_type` (optional): An address type is only required when the extended
145+
account public key has a legacy version (xpub, tpub, etc.), such that the
146+
wallet cannot detect what address scheme it belongs to.
147+
* `dry_run` (optional): Whether a dry run should be attempted when importing the
148+
account. This serves as a way to confirm whether the account is being imported
149+
correctly by returning the first N addresses for the external and internal
150+
branches of the account. If these addresses match as expected, then it should
151+
be safe to import the account as is.
152+
153+
For the sake of simplicity, we'll present an example with two `lnd` nodes Alice
154+
and Bob, where Alice acts as a signer _only_, and Bob manages Alice's on-chain
155+
BIP-0084 account by crafting transactions and watching/spending addresses. Since
156+
Alice will only act as a signer, we'll want to import her BIP-0084 account into
157+
Bob's node, which will require knowledge of Alice's extended public key.
101158

102159
Alice's BIP-0084 extended public key can be obtained as follows.
103160

@@ -125,7 +182,11 @@ Bob can then import the account with the following command:
125182
$ lncli-bob wallet accounts import vpub5Z9beF6NYCrHeDmKC38tM3xXMDFFSARa9sdHRPChEMGqtxiELfZB8hm6FwBpBvfPpX2HGG8edYVV9Wupe43PEJJhhfnz1egtQNNaDXyYExn alice
126183
```
127184

128-
Before Bob imports the account, they may want to confirm the account is being imported using the correct derivation scheme. This can be done with the dry run request parameter. When a dry run is done, the response will include the usual account details, as well as the first 5 external and change addresses, which can be used to confirm they match with what the account owner expects.
185+
Before Bob imports the account, they may want to confirm the account is being
186+
imported using the correct derivation scheme. This can be done with the dry run
187+
request parameter. When a dry run is done, the response will include the usual
188+
account details, as well as the first 5 external and change addresses, which can
189+
be used to confirm they match with what the account owner expects.
129190

130191
```shell
131192
$ lncli-bob wallet accounts import vpub5Z9beF6NYCrHeDmKC38tM3xXMDFFSARa9sdHRPChEMGqtxiELfZB8hm6FwBpBvfPpX2HGG8edYVV9Wupe43PEJJhhfnz1egtQNNaDXyYExn alice --dry_run
@@ -157,7 +218,8 @@ $ lncli-bob wallet accounts import vpub5Z9beF6NYCrHeDmKC38tM3xXMDFFSARa9sdHRPChE
157218
}
158219
```
159220

160-
Once Bob has confirmed the correct account derivation scheme is being used, the account can be imported without the dry run parameter.
221+
Once Bob has confirmed the correct account derivation scheme is being used, the
222+
account can be imported without the dry run parameter.
161223

162224
```shell
163225
$ lncli-bob wallet accounts import vpub5Z9beF6NYCrHeDmKC38tM3xXMDFFSARa9sdHRPChEMGqtxiELfZB8hm6FwBpBvfPpX2HGG8edYVV9Wupe43PEJJhhfnz1egtQNNaDXyYExn alice
@@ -175,11 +237,15 @@ $ lncli-bob wallet accounts import vpub5Z9beF6NYCrHeDmKC38tM3xXMDFFSARa9sdHRPChE
175237
}
176238
```
177239

178-
#### Generating Addresses from an Imported Account
240+
### Generating Addresses from an Imported Account
179241

180-
External addresses from an imported account can be generated through the existing `Lightning.NewAddress` RPC and `lncli newaddress` command, as they now take an additional optional parameter to specify which account the address should be derived from.
242+
External addresses from an imported account can be generated through the
243+
existing `Lightning.NewAddress` RPC and `lncli newaddress` command, as they now
244+
take an additional optional parameter to specify which account the address
245+
should be derived from.
181246

182-
Following the example above, Bob is able to generate an external address for an incoming deposit as follows:
247+
Following the example above, Bob is able to generate an external address for an
248+
incoming deposit as follows:
183249

184250
```shell
185251
$ lncli-bob newaddress p2wkh --account=alice
@@ -188,11 +254,16 @@ $ lncli-bob newaddress p2wkh --account=alice
188254
}
189255
```
190256

191-
Change addresses cannot be generated on demand, they are generated automatically when a transaction is crafted that requires a change output.
257+
Change addresses cannot be generated on demand, they are generated automatically
258+
when a transaction is crafted that requires a change output.
192259

193-
#### Crafting Transactions through PSBTs from an Imported Account
260+
### Crafting Transactions through PSBTs from an Imported Account
194261

195-
Assuming a deposit of 1 tBTC was made to the address above (`bcrt1q8zdjz2q92eh7jw9ah3upf2u9553226gq79el5l`), Bob should be able to craft a transaction spending their new UTXO. Since Bob is unable to sign the transaction themselves, they'll use PSBTs to craft the transaction, and provide it to Alice to sign.
262+
Assuming a deposit of 1 tBTC was made to the address above
263+
(`bcrt1q8zdjz2q92eh7jw9ah3upf2u9553226gq79el5l`), Bob should be able to craft a
264+
transaction spending their new UTXO. Since Bob is unable to sign the transaction
265+
themselves, they'll use PSBTs to craft the transaction, and provide it to Alice
266+
to sign.
196267

197268
```shell
198269
$ lncli-bob wallet psbt fund --account=alice --outputs="{\"bcrt1qpjqr663tylcksysa4u76xvremee9k8af3pqd5h\": 500000}" --sat_per_vbyte=1

0 commit comments

Comments
 (0)