Add disburse crate #641

Merged
paratoxic merged 14 commits from payout into master 2026-10-13 22:03:48 +00:00
Owner

//! Transaction construction for disbursing BTC to a payout list.
//!
//! The external interface is TransactionBuilder::new, which takes the raw
//! payout list, the network, the funding outpoint, the change address, and
//! the fee rate. Construction is infallible: payouts are parsed and
//! classified into entries, which can be inspected with
//! TransactionBuilder::entries to report dust and invalid payouts before
//! building.
//!
//! To build the transaction, call TransactionBuilder::build_standard or
//! TransactionBuilder::build_payable. build_standard pays only
//! above-dust payouts, keeps the transaction within standard weight, and
//! trims the smallest payouts if necessary. build_payable pays every valid
//! payout, permitting dust and overweight transactions.
//!
//! Internally, TransactionBuilder builds the transaction in multiple
//! steps, each responsible for a single concern, such as adding change and
//! deducting the fee, and asserts invariants on the resulting transaction
//! before returning it.

//! Transaction construction for disbursing BTC to a payout list. //! //! The external interface is `TransactionBuilder::new`, which takes the raw //! payout list, the network, the funding outpoint, the change address, and //! the fee rate. Construction is infallible: payouts are parsed and //! classified into entries, which can be inspected with //! `TransactionBuilder::entries` to report dust and invalid payouts before //! building. //! //! To build the transaction, call `TransactionBuilder::build_standard` or //! `TransactionBuilder::build_payable`. `build_standard` pays only //! above-dust payouts, keeps the transaction within standard weight, and //! trims the smallest payouts if necessary. `build_payable` pays every valid //! payout, permitting dust and overweight transactions. //! //! Internally, `TransactionBuilder` builds the transaction in multiple //! steps, each responsible for a single concern, such as adding change and //! deducting the fee, and asserts invariants on the resulting transaction //! before returning it.
Change
All checks were successful
CI / ckpool (pull_request) Successful in 40s
CI / lint (pull_request) Successful in 5m21s
CI / test-linux (pull_request) Successful in 11m1s
9b8315697e
Improve
All checks were successful
CI / ckpool (pull_request) Successful in 28s
CI / lint (pull_request) Successful in 2m28s
CI / test-linux (pull_request) Successful in 7m33s
a30373eeb0
Tweak
All checks were successful
CI / ckpool (pull_request) Successful in 34s
CI / lint (pull_request) Successful in 2m1s
CI / test-linux (pull_request) Successful in 6m15s
feab25e913
Relevel
Some checks failed
CI / test-linux (pull_request) Has been cancelled
CI / lint (pull_request) Has been cancelled
CI / ckpool (pull_request) Has been cancelled
9d23c86768
Change
All checks were successful
CI / ckpool (pull_request) Successful in 21s
CI / lint (pull_request) Successful in 1m38s
CI / test-linux (pull_request) Successful in 5m53s
56b77e33e0
Solidify
All checks were successful
CI / ckpool (pull_request) Successful in 27s
CI / lint (pull_request) Successful in 2m3s
CI / test-linux (pull_request) Successful in 6m58s
56ddd670ab
Extend
Some checks failed
CI / ckpool (pull_request) Successful in 34s
CI / lint (pull_request) Successful in 1m55s
CI / test-linux (pull_request) Has been cancelled
3c6c052ccb
Improve
Some checks failed
CI / ckpool (pull_request) Successful in 36s
CI / lint (pull_request) Successful in 2m2s
CI / test-linux (pull_request) Failing after 7m6s
ddf28e0c97
Expose
Some checks failed
CI / ckpool (pull_request) Successful in 47s
CI / lint (pull_request) Successful in 2m31s
CI / test-linux (pull_request) Failing after 7m21s
05e6ce5fbd
Rework
Some checks failed
CI / ckpool (pull_request) Successful in 34s
CI / lint (pull_request) Successful in 2m5s
CI / test-linux (pull_request) Failing after 6m47s
25e56b3691
Collapse
All checks were successful
CI / ckpool (pull_request) Successful in 21s
CI / lint (pull_request) Successful in 1m50s
CI / test-linux (pull_request) Successful in 6m29s
bcca5df2e1
Rename
All checks were successful
CI / ckpool (pull_request) Successful in 29s
CI / lint (pull_request) Successful in 1m46s
CI / test-linux (pull_request) Successful in 7m19s
a0adc8fe77
Modify
All checks were successful
CI / ckpool (pull_request) Successful in 31s
CI / lint (pull_request) Successful in 1m54s
CI / test-linux (pull_request) Successful in 5m59s
90b520bf07
parabit approved these changes 2026-10-13 18:52:06 +00:00
parabit left a comment

LGTM

I will want to tinker the interface a bit as it has some rough edges, but it is very usable already!

LGTM I will want to tinker the interface a bit as it has some rough edges, but it is very usable already!
Relevel
All checks were successful
CI / ckpool (pull_request) Successful in 28s
CI / lint (pull_request) Successful in 2m8s
CI / test-linux (pull_request) Successful in 9m9s
68e2c1976e
paratoxic merged commit 8d0735ad24 into master 2026-10-13 22:03:48 +00:00
paratoxic deleted branch payout 2026-10-13 22:03:48 +00:00
paratoxic referenced this pull request from a commit 2026-10-13 22:03:50 +00:00
Sign in to join this conversation.
No description provided.