X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fchain%2Fmod.rs;h=cec09459233daef7b9c38582e17f984d10fa0d6d;hb=431f807907ae390a255641719dd5cb3279bc9d5b;hp=2e1eaea4e5f5b7d54c9828f4b6db769388f0ec89;hpb=da298e498fc8bdf6af2b2becf82b0123118f46b4;p=rust-lightning diff --git a/lightning/src/chain/mod.rs b/lightning/src/chain/mod.rs index 2e1eaea4..cec09459 100644 --- a/lightning/src/chain/mod.rs +++ b/lightning/src/chain/mod.rs @@ -38,7 +38,8 @@ pub struct BestBlock { } impl BestBlock { - /// Returns the best block from the genesis of the given network. + /// Constructs a `BestBlock` that represents the genesis block at height 0 of the given + /// network. pub fn from_genesis(network: Network) -> Self { BestBlock { block_hash: genesis_block(network).header.block_hash(), @@ -46,7 +47,7 @@ impl BestBlock { } } - /// Returns the best block as identified by the given block hash and height. + /// Returns a `BestBlock` as identified by the given block hash and height. pub fn new(block_hash: BlockHash, height: u32) -> Self { BestBlock { block_hash, height } }