Skip to content

Commit 1551e16

Browse files
author
Conor Okus
authored
Merge pull request #150 from tnull/patch-8
Update `blockchain_data` guide
2 parents 5091572 + 7306ac2 commit 1551e16

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

docs/blockchain_data/chain_activity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ a `ChannelMonitor` and passes it to the `ChainMonitor` to watch.
66

77
At this point, you need to feed LDK any chain data of interest so that it can
88
respond accordingly. It supports receiving either full blocks or pre-filtered
9-
blocks using the `chain::Listen` interface. While block data can sourced from
9+
blocks using the `chain::Listen` interface. While block data can be sourced from
1010
anywhere, it is your responsibility to call the `block_connected` and
1111
`block_disconnected` methods on `ChannelManager` and `ChainMonitor`. This allows
1212
them to update channel state and respond to on-chain events, respectively.
@@ -24,4 +24,4 @@ the `BlockSource` interface or use one of the samples that it provides.
2424

2525
::: tip Note
2626
Currently, `lightning-block-sync` is only available in Rust.
27-
:::
27+
:::

docs/blockchain_data/confirmed_transactions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ provide a block-centric interface, like Electrum?
66

77
LDK has a `chain::Confirm` interface to support this use case, analogous to the
88
block-oriented `chain::Listen` interface which we've been using up until now.
9-
With this alternative approach, you still need to give LDK block headers but
9+
With this alternative approach, you still need to give LDK block headers, but
1010
only for blocks containing transactions of interest. These are identified by
1111
`chain::Filter` as before. You also need to notify LDK of any transactions with
1212
insufficient confirmation that have been reorganized out of the chain. Use the
@@ -20,4 +20,4 @@ this interface is intended to be used.
2020
Be advised that `chain::Confirm` is a less mature interface than
2121
`chain::Listen`. As such, there is not yet a utility like `lightning-block-sync`
2222
to use for interacting with clients like Electrum.
23-
:::
23+
:::

docs/blockchain_data/full_blocks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ straight forward: call the appropriate methods on `ChannelManager` and
55
`ChainMonitor` as blocks are connected and disconnected. LDK will handle the
66
rest!
77

8-
So what happens? The `ChannelManager` examines the blocks transactions and
8+
So what happens? The `ChannelManager` examines the block's transactions and
99
updates the internal channel state as needed. The `ChainMonitor` will detect
1010
any spends of the channel funding transaction or any pertinent transaction
1111
outputs, tracking them as necessary.
1212

1313
If necessary, LDK will broadcast a transaction on your behalf. More on that
14-
later. For now, let's look at the more interesting case of pre-filtered blocks.
14+
later. For now, let's look at the more interesting case of pre-filtered blocks.

docs/blockchain_data/pre_filtered_blocks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ which transactions and outputs it is interested in. This information can then be
66
used to filter blocks prior to sending them to your node.
77

88
For example, if your block source is an Electrum client, you can pass along this
9-
information to it. Or if you are making use of a BIP 157 client, you can check
9+
information to it. Or, if you are making use of a BIP 157 client, you can check
1010
if a block contains relevant transactions before fetching it.
1111

1212
So how does this work in practice? `ChainMonitor` is parameterized by an

0 commit comments

Comments
 (0)