From 82e8612b3857309d77cca1590acf5c873cc53d68 Mon Sep 17 00:00:00 2001 From: Dave Hrycyszyn Date: Mon, 29 Jul 2024 10:41:28 +0100 Subject: [PATCH] Docs on transfer operations --- side-node/src/bitcoin/driver/simple_transfer.rs | 2 ++ side-node/src/bitcoin/driver/transfer_policy.rs | 3 +++ 2 files changed, 5 insertions(+) diff --git a/side-node/src/bitcoin/driver/simple_transfer.rs b/side-node/src/bitcoin/driver/simple_transfer.rs index e9dddd7..a6bf2bb 100644 --- a/side-node/src/bitcoin/driver/simple_transfer.rs +++ b/side-node/src/bitcoin/driver/simple_transfer.rs @@ -2,6 +2,8 @@ use crate::bitcoin::client::BitcoinClient; use crate::bitcoin::driver; use bdk::wallet::AddressIndex; +/// Run the simplest transfer flow. There is no policy file, +/// it's just a normal bitcoin transaction for a sanity check. pub async fn run() -> Result<(), anyhow::Error> { let (mut dave, sammy) = driver::setup().await?; diff --git a/side-node/src/bitcoin/driver/transfer_policy.rs b/side-node/src/bitcoin/driver/transfer_policy.rs index 0b1229c..14be6b6 100644 --- a/side-node/src/bitcoin/driver/transfer_policy.rs +++ b/side-node/src/bitcoin/driver/transfer_policy.rs @@ -4,6 +4,9 @@ use bdk::miniscript::policy; use crate::bitcoin; +/// A miniscript-based simple transfer, equivalent to the `simple_transfer` +/// but using a Bitcoin miniscript policy. TODO: finish implementation, it's not +/// working yet. pub(crate) async fn run() -> anyhow::Result<()> { let (dave, _sammy) = bitcoin::driver::setup().await?;