docs: fix spelling errors
This commit is contained in:
parent
c20a4da9fc
commit
94f8fa530b
@ -158,7 +158,7 @@ BDK and LDK together.
|
|||||||
- Add the ability to specify which leaves to sign in a taproot transaction through `TapLeavesOptions` in `SignOptions`
|
- Add the ability to specify which leaves to sign in a taproot transaction through `TapLeavesOptions` in `SignOptions`
|
||||||
- Add the ability to specify whether a taproot transaction should be signed using the internal key or not, using `sign_with_tap_internal_key` in `SignOptions`
|
- Add the ability to specify whether a taproot transaction should be signed using the internal key or not, using `sign_with_tap_internal_key` in `SignOptions`
|
||||||
- Consolidate params `fee_amount` and `amount_needed` in `target_amount` in `CoinSelectionAlgorithm::coin_select` signature.
|
- Consolidate params `fee_amount` and `amount_needed` in `target_amount` in `CoinSelectionAlgorithm::coin_select` signature.
|
||||||
- Change the meaning of the `fee_amount` field inside `CoinSelectionResult`: from now on the `fee_amount` will represent only the fees asociated with the utxos in the `selected` field of `CoinSelectionResult`.
|
- Change the meaning of the `fee_amount` field inside `CoinSelectionResult`: from now on the `fee_amount` will represent only the fees associated with the utxos in the `selected` field of `CoinSelectionResult`.
|
||||||
- New `RpcBlockchain` implementation with various fixes.
|
- New `RpcBlockchain` implementation with various fixes.
|
||||||
- Return balance in separate categories, namely `confirmed`, `trusted_pending`, `untrusted_pending` & `immature`.
|
- Return balance in separate categories, namely `confirmed`, `trusted_pending`, `untrusted_pending` & `immature`.
|
||||||
|
|
||||||
@ -449,7 +449,7 @@ final transaction is created by calling `finish` on the builder.
|
|||||||
#### Changed
|
#### Changed
|
||||||
- Simplify the architecture of blockchain traits
|
- Simplify the architecture of blockchain traits
|
||||||
- Improve sync
|
- Improve sync
|
||||||
- Remove unused varaint HeaderParseFail
|
- Remove unused variant `HeaderParseFail`
|
||||||
|
|
||||||
### CLI
|
### CLI
|
||||||
#### Added
|
#### Added
|
||||||
@ -529,7 +529,7 @@ final transaction is created by calling `finish` on the builder.
|
|||||||
- Use TXIN_DEFAULT_WEIGHT constant in coin selection
|
- Use TXIN_DEFAULT_WEIGHT constant in coin selection
|
||||||
- Replace `must_use` with `required` in coin selection
|
- Replace `must_use` with `required` in coin selection
|
||||||
- Take both spending policies into account in create_tx
|
- Take both spending policies into account in create_tx
|
||||||
- Check last derivation in cache to avoid recomputation
|
- Check last derivation in cache to avoid recomputing
|
||||||
- Use the branch-and-bound cs by default
|
- Use the branch-and-bound cs by default
|
||||||
- Make coin_select return UTXOs instead of TxIns
|
- Make coin_select return UTXOs instead of TxIns
|
||||||
- Build output lookup inside complete transaction
|
- Build output lookup inside complete transaction
|
||||||
@ -550,7 +550,7 @@ final transaction is created by calling `finish` on the builder.
|
|||||||
- Require esplora feature for repl example
|
- Require esplora feature for repl example
|
||||||
|
|
||||||
#### Security
|
#### Security
|
||||||
- Use dirs-next instead of dirs since the latter is unmantained
|
- Use dirs-next instead of dirs since the latter is unmaintained
|
||||||
|
|
||||||
## [0.1.0-beta.1] - 2020-09-08
|
## [0.1.0-beta.1] - 2020-09-08
|
||||||
|
|
||||||
|
@ -91,7 +91,7 @@ This is also enforced by the CI.
|
|||||||
Security
|
Security
|
||||||
--------
|
--------
|
||||||
|
|
||||||
Security is a high priority of BDK; disclosure of security vulnerabilites helps
|
Security is a high priority of BDK; disclosure of security vulnerabilities helps
|
||||||
prevent user loss of funds.
|
prevent user loss of funds.
|
||||||
|
|
||||||
Note that BDK is currently considered "pre-production" during this time, there
|
Note that BDK is currently considered "pre-production" during this time, there
|
||||||
|
@ -231,7 +231,7 @@ impl Wallet {
|
|||||||
pub enum NewError<P> {
|
pub enum NewError<P> {
|
||||||
/// There was problem with the descriptors passed in
|
/// There was problem with the descriptors passed in
|
||||||
Descriptor(crate::descriptor::DescriptorError),
|
Descriptor(crate::descriptor::DescriptorError),
|
||||||
/// We were unable to load the wallet's data from the persistance backend
|
/// We were unable to load the wallet's data from the persistence backend
|
||||||
Persist(P),
|
Persist(P),
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -243,7 +243,7 @@ where
|
|||||||
match self {
|
match self {
|
||||||
NewError::Descriptor(e) => e.fmt(f),
|
NewError::Descriptor(e) => e.fmt(f),
|
||||||
NewError::Persist(e) => {
|
NewError::Persist(e) => {
|
||||||
write!(f, "failed to load wallet from persistance backend: {}", e)
|
write!(f, "failed to load wallet from persistence backend: {}", e)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -455,9 +455,9 @@ impl<D> Wallet<D> {
|
|||||||
|
|
||||||
/// Returns a iterators of all the script pubkeys for the `Internal` and External` variants in `KeychainKind`.
|
/// Returns a iterators of all the script pubkeys for the `Internal` and External` variants in `KeychainKind`.
|
||||||
///
|
///
|
||||||
/// This is inteded to be used when doing a full scan of your addresses (e.g. after restoring
|
/// This is intended to be used when doing a full scan of your addresses (e.g. after restoring
|
||||||
/// from seed words). You pass the `BTreeMap` of iterators to a blockchain data source (e.g.
|
/// from seed words). You pass the `BTreeMap` of iterators to a blockchain data source (e.g.
|
||||||
/// electrum server) which will go through each address until it reaches a *stop grap*.
|
/// electrum server) which will go through each address until it reaches a *stop gap*.
|
||||||
///
|
///
|
||||||
/// Note carefully that iterators go over **all** script pubkeys on the keychains (not what
|
/// Note carefully that iterators go over **all** script pubkeys on the keychains (not what
|
||||||
/// script pubkeys the wallet is storing internally).
|
/// script pubkeys the wallet is storing internally).
|
||||||
|
@ -215,7 +215,7 @@ impl<A: Anchor> FullTxOut<A> {
|
|||||||
/// Whether the `txout` is considered mature.
|
/// Whether the `txout` is considered mature.
|
||||||
///
|
///
|
||||||
/// Depending on the implementation of [`confirmation_height_upper_bound`] in [`Anchor`], this
|
/// Depending on the implementation of [`confirmation_height_upper_bound`] in [`Anchor`], this
|
||||||
/// method may return false-negatives. In other words, interpretted confirmation count may be
|
/// method may return false-negatives. In other words, interpreted confirmation count may be
|
||||||
/// less than the actual value.
|
/// less than the actual value.
|
||||||
///
|
///
|
||||||
/// [`confirmation_height_upper_bound`]: Anchor::confirmation_height_upper_bound
|
/// [`confirmation_height_upper_bound`]: Anchor::confirmation_height_upper_bound
|
||||||
@ -242,7 +242,7 @@ impl<A: Anchor> FullTxOut<A> {
|
|||||||
/// This method does not take into account the lock time.
|
/// This method does not take into account the lock time.
|
||||||
///
|
///
|
||||||
/// Depending on the implementation of [`confirmation_height_upper_bound`] in [`Anchor`], this
|
/// Depending on the implementation of [`confirmation_height_upper_bound`] in [`Anchor`], this
|
||||||
/// method may return false-negatives. In other words, interpretted confirmation count may be
|
/// method may return false-negatives. In other words, interpreted confirmation count may be
|
||||||
/// less than the actual value.
|
/// less than the actual value.
|
||||||
///
|
///
|
||||||
/// [`confirmation_height_upper_bound`]: Anchor::confirmation_height_upper_bound
|
/// [`confirmation_height_upper_bound`]: Anchor::confirmation_height_upper_bound
|
||||||
|
@ -18,7 +18,7 @@ pub type ChangeSet = BTreeMap<u32, Option<BlockHash>>;
|
|||||||
///
|
///
|
||||||
/// Each checkpoint contains the height and hash of a block ([`BlockId`]).
|
/// Each checkpoint contains the height and hash of a block ([`BlockId`]).
|
||||||
///
|
///
|
||||||
/// Internaly, checkpoints are nodes of a reference-counted linked-list. This allows the caller to
|
/// Internally, checkpoints are nodes of a reference-counted linked-list. This allows the caller to
|
||||||
/// cheaply clone a [`CheckPoint`] without copying the whole list and to view the entire chain
|
/// cheaply clone a [`CheckPoint`] without copying the whole list and to view the entire chain
|
||||||
/// without holding a lock on [`LocalChain`].
|
/// without holding a lock on [`LocalChain`].
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
@ -498,7 +498,7 @@ fn merge_chains(
|
|||||||
prev_orig = curr_orig.take();
|
prev_orig = curr_orig.take();
|
||||||
|
|
||||||
// OPTIMIZATION: we have run out of update blocks so we don't need to continue
|
// OPTIMIZATION: we have run out of update blocks so we don't need to continue
|
||||||
// iterating becuase there's no possibility of adding anything to changeset.
|
// iterating because there's no possibility of adding anything to changeset.
|
||||||
if u.is_none() {
|
if u.is_none() {
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@ -507,7 +507,7 @@ fn merge_chains(
|
|||||||
if o.hash() == u.hash() {
|
if o.hash() == u.hash() {
|
||||||
// We have found our point of agreement 🎉 -- we require that the previous (i.e.
|
// We have found our point of agreement 🎉 -- we require that the previous (i.e.
|
||||||
// higher because we are iterating backwards) block in the original chain was
|
// higher because we are iterating backwards) block in the original chain was
|
||||||
// invalidated (if it exists). This ensures that there is an unambigious point of
|
// invalidated (if it exists). This ensures that there is an unambiguous point of
|
||||||
// connection to the original chain from the update chain (i.e. we know the
|
// connection to the original chain from the update chain (i.e. we know the
|
||||||
// precisely which original blocks are invalid).
|
// precisely which original blocks are invalid).
|
||||||
if !prev_orig_was_invalidated && !point_of_agreement_found {
|
if !prev_orig_was_invalidated && !point_of_agreement_found {
|
||||||
|
@ -27,19 +27,19 @@ where
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Stage a `changeset` to be commited later with [`commit`].
|
/// Stage a `changeset` to be committed later with [`commit`].
|
||||||
///
|
///
|
||||||
/// [`commit`]: Self::commit
|
/// [`commit`]: Self::commit
|
||||||
pub fn stage(&mut self, changeset: C) {
|
pub fn stage(&mut self, changeset: C) {
|
||||||
self.stage.append(changeset)
|
self.stage.append(changeset)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Get the changes that have not been commited yet.
|
/// Get the changes that have not been committed yet.
|
||||||
pub fn staged(&self) -> &C {
|
pub fn staged(&self) -> &C {
|
||||||
&self.stage
|
&self.stage
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Commit the staged changes to the underlying persistance backend.
|
/// Commit the staged changes to the underlying persistence backend.
|
||||||
///
|
///
|
||||||
/// Changes that are committed (if any) are returned.
|
/// Changes that are committed (if any) are returned.
|
||||||
///
|
///
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# BDK Esplora
|
# BDK Esplora
|
||||||
|
|
||||||
BDK Esplora extends [`esplora_client`](crate::esplora_client) to update [`bdk_chain`] structures
|
BDK Esplora extends [`esplora-client`] to update [`bdk_chain`] structures
|
||||||
from an Esplora server.
|
from an Esplora server.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
@ -31,3 +31,6 @@ use bdk_esplora::EsploraExt;
|
|||||||
```
|
```
|
||||||
|
|
||||||
For full examples, refer to [`example-crates/wallet_esplora`](https://github.com/bitcoindevkit/bdk/tree/master/example-crates/wallet_esplora) (blocking) and [`example-crates/wallet_esplora_async`](https://github.com/bitcoindevkit/bdk/tree/master/example-crates/wallet_esplora_async).
|
For full examples, refer to [`example-crates/wallet_esplora`](https://github.com/bitcoindevkit/bdk/tree/master/example-crates/wallet_esplora) (blocking) and [`example-crates/wallet_esplora_async`](https://github.com/bitcoindevkit/bdk/tree/master/example-crates/wallet_esplora_async).
|
||||||
|
|
||||||
|
[`esplora-client`]: https://docs.rs/esplora-client/
|
||||||
|
[`bdk_chain`]: https://docs.rs/bdk-chain/
|
||||||
|
@ -2,4 +2,4 @@
|
|||||||
|
|
||||||
This is a directory for crates that are experimental and have not been released yet.
|
This is a directory for crates that are experimental and have not been released yet.
|
||||||
Keep in mind that they may never be released.
|
Keep in mind that they may never be released.
|
||||||
Things in `/example-crates` may use them to demonsrate how things might look in the future.
|
Things in `/example-crates` may use them to demonstrate how things might look in the future.
|
||||||
|
@ -35,7 +35,7 @@ pub struct PlanKey<Ak> {
|
|||||||
impl<Ak> TemplateItem<Ak> {
|
impl<Ak> TemplateItem<Ak> {
|
||||||
pub fn expected_size(&self) -> usize {
|
pub fn expected_size(&self) -> usize {
|
||||||
match self {
|
match self {
|
||||||
TemplateItem::Sign { .. } => 64, /* size of sig TODO: take into consideration sighash falg */
|
TemplateItem::Sign { .. } => 64, /* size of sig TODO: take into consideration sighash flag */
|
||||||
TemplateItem::Pk { .. } => 32,
|
TemplateItem::Pk { .. } => 32,
|
||||||
TemplateItem::One => varint_len(1),
|
TemplateItem::One => varint_len(1),
|
||||||
TemplateItem::Zero => 0, /* zero means an empty witness element */
|
TemplateItem::Zero => 0, /* zero means an empty witness element */
|
||||||
|
Loading…
x
Reference in New Issue
Block a user