frost/bdk
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add TODOs for missing_docs

Browse Source
This commit is contained in:
Steve Myers 2020-12-07 18:21:18 -08:00
parent 3491bfbf30
commit 602ae3d63a
No known key found for this signature in database
GPG Key ID: 8105A46B22C2D051
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/descriptor/mod.rs
View File

@ -44,7 +44,9 @@ pub use miniscript::{
pub mod checksum; pub mod checksum;
mod dsl; mod dsl;
pub mod error; pub mod error;
#[allow(missing_docs)] // TODO add missing docs and remove this allow
pub mod policy; pub mod policy;
#[allow(missing_docs)] // TODO add missing docs and remove this allow
pub mod template; pub mod template;
pub use self::checksum::get_checksum; pub use self::checksum::get_checksum;
@ -64,6 +66,7 @@ pub type ExtendedDescriptor = Descriptor<DescriptorPublicKey>;
/// [`psbt::Output`]: bitcoin::util::psbt::Output /// [`psbt::Output`]: bitcoin::util::psbt::Output
pub type HDKeyPaths = BTreeMap<PublicKey, (Fingerprint, DerivationPath)>; pub type HDKeyPaths = BTreeMap<PublicKey, (Fingerprint, DerivationPath)>;
#[allow(missing_docs)] // TODO add missing docs and remove this allow
/// Trait for types which can be converted into an [`ExtendedDescriptor`] and a [`KeyMap`] usable by a wallet in a specific [`Network`] /// Trait for types which can be converted into an [`ExtendedDescriptor`] and a [`KeyMap`] usable by a wallet in a specific [`Network`]
pub trait ToWalletDescriptor { pub trait ToWalletDescriptor {
fn to_wallet_descriptor( fn to_wallet_descriptor(
@ -185,6 +188,7 @@ impl ToWalletDescriptor for (ExtendedDescriptor, KeyMap, ValidNetworks) {
} }
} }
#[allow(missing_docs)] // TODO add missing docs and remove this allow
/// Trait implemented on [`Descriptor`]s to add a method to extract the spending [`policy`] /// Trait implemented on [`Descriptor`]s to add a method to extract the spending [`policy`]
pub trait ExtractPolicy { pub trait ExtractPolicy {
fn extract_policy( fn extract_policy(

5
src/wallet/mod.rs
View File

@ -46,11 +46,15 @@ use miniscript::psbt::PsbtInputSatisfier;
#[allow(unused_imports)] #[allow(unused_imports)]
use log::{debug, error, info, trace}; use log::{debug, error, info, trace};
#[allow(missing_docs)] // TODO add missing docs and remove this allow
pub mod address_validator; pub mod address_validator;
#[allow(missing_docs)] // TODO add missing docs and remove this allow
pub mod coin_selection; pub mod coin_selection;
pub mod export; pub mod export;
#[allow(missing_docs)] // TODO add missing docs and remove this allow
pub mod signer; pub mod signer;
pub mod time; pub mod time;
#[allow(missing_docs)] // TODO add missing docs and remove this allow
pub mod tx_builder; pub mod tx_builder;
pub(crate) mod utils; pub(crate) mod utils;
@ -930,6 +934,7 @@ where
Ok((psbt, finished)) Ok((psbt, finished))
} }
#[allow(missing_docs)] // TODO add missing docs and remove this allow
pub fn secp_ctx(&self) -> &SecpCtx { pub fn secp_ctx(&self) -> &SecpCtx {
&self.secp &self.secp
} }