multi: minor fixes for README's
This commit is contained in:
parent
4ccdad0d66
commit
95888613d0
@ -7,7 +7,7 @@ chainntnfs
|
|||||||
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
|
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
|
||||||
(http://godoc.org/github.com/lightningnetwork/lnd/chainntnfs)
|
(http://godoc.org/github.com/lightningnetwork/lnd/chainntnfs)
|
||||||
|
|
||||||
The chainntnfs package implements as set of interfaces which allow callers to
|
The chainntnfs package implements a set of interfaces which allow callers to
|
||||||
receive notifications in response to specific on-chain events. The set of
|
receive notifications in response to specific on-chain events. The set of
|
||||||
notifications available include:
|
notifications available include:
|
||||||
|
|
||||||
@ -22,7 +22,7 @@ closures, channel contract breaches, sweeping time-locked outputs, and finally
|
|||||||
pruning the channel graph.
|
pruning the channel graph.
|
||||||
|
|
||||||
This package is intentionally general enough to be applicable outside the
|
This package is intentionally general enough to be applicable outside the
|
||||||
specific use cases within `lnd` outline above. The current sole concrete
|
specific use cases within `lnd` outlined above. The current sole concrete
|
||||||
implementation of the `ChainNotifier` interface depends on `btcd`.
|
implementation of the `ChainNotifier` interface depends on `btcd`.
|
||||||
|
|
||||||
## Installation and Updating
|
## Installation and Updating
|
||||||
|
@ -10,7 +10,7 @@ channeldb
|
|||||||
The channeldb implements the persistent storage engine for `lnd` and
|
The channeldb implements the persistent storage engine for `lnd` and
|
||||||
generically a data storage layer for the required state within the Lightning
|
generically a data storage layer for the required state within the Lightning
|
||||||
Network. The backing storage engine is
|
Network. The backing storage engine is
|
||||||
[boltdb](https://github.com/boltdb/bolt), an embedded pure-go key-value stored
|
[boltdb](https://github.com/boltdb/bolt), an embedded pure-go key-value store
|
||||||
based off of LMDB.
|
based off of LMDB.
|
||||||
|
|
||||||
The package implements an object-oriented storage model with queries and
|
The package implements an object-oriented storage model with queries and
|
||||||
|
@ -28,7 +28,7 @@ description):
|
|||||||
* Returns a list of on-chain transactions that pay to or are spends from
|
* Returns a list of on-chain transactions that pay to or are spends from
|
||||||
`lnd`.
|
`lnd`.
|
||||||
* SendCoins
|
* SendCoins
|
||||||
* Sends an amount of satoshis to a specific addresses.
|
* Sends an amount of satoshis to a specific address.
|
||||||
* SubscribeTransactions
|
* SubscribeTransactions
|
||||||
* Returns a stream which sends async notifications each time a transaction
|
* Returns a stream which sends async notifications each time a transaction
|
||||||
is created or one is received that pays to us.
|
is created or one is received that pays to us.
|
||||||
@ -36,7 +36,7 @@ description):
|
|||||||
* Allows the caller to create a transaction with an arbitrary fan-out
|
* Allows the caller to create a transaction with an arbitrary fan-out
|
||||||
(many outputs).
|
(many outputs).
|
||||||
* NewAddress
|
* NewAddress
|
||||||
* Returns a new addresses, the following address types are supported:
|
* Returns a new address, the following address types are supported:
|
||||||
pay-to-public-key-hash (p2pkh), pay-to-witness-key-hash (p2wkh), and
|
pay-to-public-key-hash (p2pkh), pay-to-witness-key-hash (p2wkh), and
|
||||||
nested-pay-to-witness-key-hash (np2wkh).
|
nested-pay-to-witness-key-hash (np2wkh).
|
||||||
* ConnectPeer
|
* ConnectPeer
|
||||||
@ -80,7 +80,7 @@ description):
|
|||||||
* GetNetworkInfo
|
* GetNetworkInfo
|
||||||
* Returns some network level statistics.
|
* Returns some network level statistics.
|
||||||
* SetAlias
|
* SetAlias
|
||||||
* Sets the node alias whchi is to be advertised on the network.
|
* Sets the node alias which is to be advertised on the network.
|
||||||
|
|
||||||
## Installation and Updating
|
## Installation and Updating
|
||||||
|
|
||||||
|
@ -13,7 +13,7 @@ generation functions for the various Lightning scripts, revocation key
|
|||||||
derivation, and the commitment update state machine.
|
derivation, and the commitment update state machine.
|
||||||
|
|
||||||
The package is used within `lnd` as the core wallet of the daemon. The wallet
|
The package is used within `lnd` as the core wallet of the daemon. The wallet
|
||||||
itself is composed of several distinct interface that decouple the
|
itself is composed of several distinct interfaces that decouple the
|
||||||
implementation of things like signing and blockchain access. This separation
|
implementation of things like signing and blockchain access. This separation
|
||||||
allows new `WalletController` implementations to be be easily dropped into
|
allows new `WalletController` implementations to be be easily dropped into
|
||||||
`lnd` without disrupting the code base. A series of integration tests at the
|
`lnd` without disrupting the code base. A series of integration tests at the
|
||||||
|
@ -10,7 +10,7 @@ lnwire
|
|||||||
The lnwire package implements the Lightning Network wire protocol.
|
The lnwire package implements the Lightning Network wire protocol.
|
||||||
|
|
||||||
This package has intentionally been designed so it can be used as a standalone
|
This package has intentionally been designed so it can be used as a standalone
|
||||||
package for any projects needing to interface with lighting peers at the wire
|
package for any projects needing to interface with lightning peers at the wire
|
||||||
protocol level.
|
protocol level.
|
||||||
|
|
||||||
## Installation and Updating
|
## Installation and Updating
|
||||||
|
Loading…
Reference in New Issue
Block a user