1 <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/wallet/tx_builder.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>tx_builder.rs - source</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../favicon.svg">
2 <link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png">
3 <link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../bdk/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
4 <a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span>
10 <span id="7"> 7</span>
11 <span id="8"> 8</span>
12 <span id="9"> 9</span>
13 <span id="10"> 10</span>
14 <span id="11"> 11</span>
15 <span id="12"> 12</span>
16 <span id="13"> 13</span>
17 <span id="14"> 14</span>
18 <span id="15"> 15</span>
19 <span id="16"> 16</span>
20 <span id="17"> 17</span>
21 <span id="18"> 18</span>
22 <span id="19"> 19</span>
23 <span id="20"> 20</span>
24 <span id="21"> 21</span>
25 <span id="22"> 22</span>
26 <span id="23"> 23</span>
27 <span id="24"> 24</span>
28 <span id="25"> 25</span>
29 <span id="26"> 26</span>
30 <span id="27"> 27</span>
31 <span id="28"> 28</span>
32 <span id="29"> 29</span>
33 <span id="30"> 30</span>
34 <span id="31"> 31</span>
35 <span id="32"> 32</span>
36 <span id="33"> 33</span>
37 <span id="34"> 34</span>
38 <span id="35"> 35</span>
39 <span id="36"> 36</span>
40 <span id="37"> 37</span>
41 <span id="38"> 38</span>
42 <span id="39"> 39</span>
43 <span id="40"> 40</span>
44 <span id="41"> 41</span>
45 <span id="42"> 42</span>
46 <span id="43"> 43</span>
47 <span id="44"> 44</span>
48 <span id="45"> 45</span>
49 <span id="46"> 46</span>
50 <span id="47"> 47</span>
51 <span id="48"> 48</span>
52 <span id="49"> 49</span>
53 <span id="50"> 50</span>
54 <span id="51"> 51</span>
55 <span id="52"> 52</span>
56 <span id="53"> 53</span>
57 <span id="54"> 54</span>
58 <span id="55"> 55</span>
59 <span id="56"> 56</span>
60 <span id="57"> 57</span>
61 <span id="58"> 58</span>
62 <span id="59"> 59</span>
63 <span id="60"> 60</span>
64 <span id="61"> 61</span>
65 <span id="62"> 62</span>
66 <span id="63"> 63</span>
67 <span id="64"> 64</span>
68 <span id="65"> 65</span>
69 <span id="66"> 66</span>
70 <span id="67"> 67</span>
71 <span id="68"> 68</span>
72 <span id="69"> 69</span>
73 <span id="70"> 70</span>
74 <span id="71"> 71</span>
75 <span id="72"> 72</span>
76 <span id="73"> 73</span>
77 <span id="74"> 74</span>
78 <span id="75"> 75</span>
79 <span id="76"> 76</span>
80 <span id="77"> 77</span>
81 <span id="78"> 78</span>
82 <span id="79"> 79</span>
83 <span id="80"> 80</span>
84 <span id="81"> 81</span>
85 <span id="82"> 82</span>
86 <span id="83"> 83</span>
87 <span id="84"> 84</span>
88 <span id="85"> 85</span>
89 <span id="86"> 86</span>
90 <span id="87"> 87</span>
91 <span id="88"> 88</span>
92 <span id="89"> 89</span>
93 <span id="90"> 90</span>
94 <span id="91"> 91</span>
95 <span id="92"> 92</span>
96 <span id="93"> 93</span>
97 <span id="94"> 94</span>
98 <span id="95"> 95</span>
99 <span id="96"> 96</span>
100 <span id="97"> 97</span>
101 <span id="98"> 98</span>
102 <span id="99"> 99</span>
103 <span id="100">100</span>
104 <span id="101">101</span>
105 <span id="102">102</span>
106 <span id="103">103</span>
107 <span id="104">104</span>
108 <span id="105">105</span>
109 <span id="106">106</span>
110 <span id="107">107</span>
111 <span id="108">108</span>
112 <span id="109">109</span>
113 <span id="110">110</span>
114 <span id="111">111</span>
115 <span id="112">112</span>
116 <span id="113">113</span>
117 <span id="114">114</span>
118 <span id="115">115</span>
119 <span id="116">116</span>
120 <span id="117">117</span>
121 <span id="118">118</span>
122 <span id="119">119</span>
123 <span id="120">120</span>
124 <span id="121">121</span>
125 <span id="122">122</span>
126 <span id="123">123</span>
127 <span id="124">124</span>
128 <span id="125">125</span>
129 <span id="126">126</span>
130 <span id="127">127</span>
131 <span id="128">128</span>
132 <span id="129">129</span>
133 <span id="130">130</span>
134 <span id="131">131</span>
135 <span id="132">132</span>
136 <span id="133">133</span>
137 <span id="134">134</span>
138 <span id="135">135</span>
139 <span id="136">136</span>
140 <span id="137">137</span>
141 <span id="138">138</span>
142 <span id="139">139</span>
143 <span id="140">140</span>
144 <span id="141">141</span>
145 <span id="142">142</span>
146 <span id="143">143</span>
147 <span id="144">144</span>
148 <span id="145">145</span>
149 <span id="146">146</span>
150 <span id="147">147</span>
151 <span id="148">148</span>
152 <span id="149">149</span>
153 <span id="150">150</span>
154 <span id="151">151</span>
155 <span id="152">152</span>
156 <span id="153">153</span>
157 <span id="154">154</span>
158 <span id="155">155</span>
159 <span id="156">156</span>
160 <span id="157">157</span>
161 <span id="158">158</span>
162 <span id="159">159</span>
163 <span id="160">160</span>
164 <span id="161">161</span>
165 <span id="162">162</span>
166 <span id="163">163</span>
167 <span id="164">164</span>
168 <span id="165">165</span>
169 <span id="166">166</span>
170 <span id="167">167</span>
171 <span id="168">168</span>
172 <span id="169">169</span>
173 <span id="170">170</span>
174 <span id="171">171</span>
175 <span id="172">172</span>
176 <span id="173">173</span>
177 <span id="174">174</span>
178 <span id="175">175</span>
179 <span id="176">176</span>
180 <span id="177">177</span>
181 <span id="178">178</span>
182 <span id="179">179</span>
183 <span id="180">180</span>
184 <span id="181">181</span>
185 <span id="182">182</span>
186 <span id="183">183</span>
187 <span id="184">184</span>
188 <span id="185">185</span>
189 <span id="186">186</span>
190 <span id="187">187</span>
191 <span id="188">188</span>
192 <span id="189">189</span>
193 <span id="190">190</span>
194 <span id="191">191</span>
195 <span id="192">192</span>
196 <span id="193">193</span>
197 <span id="194">194</span>
198 <span id="195">195</span>
199 <span id="196">196</span>
200 <span id="197">197</span>
201 <span id="198">198</span>
202 <span id="199">199</span>
203 <span id="200">200</span>
204 <span id="201">201</span>
205 <span id="202">202</span>
206 <span id="203">203</span>
207 <span id="204">204</span>
208 <span id="205">205</span>
209 <span id="206">206</span>
210 <span id="207">207</span>
211 <span id="208">208</span>
212 <span id="209">209</span>
213 <span id="210">210</span>
214 <span id="211">211</span>
215 <span id="212">212</span>
216 <span id="213">213</span>
217 <span id="214">214</span>
218 <span id="215">215</span>
219 <span id="216">216</span>
220 <span id="217">217</span>
221 <span id="218">218</span>
222 <span id="219">219</span>
223 <span id="220">220</span>
224 <span id="221">221</span>
225 <span id="222">222</span>
226 <span id="223">223</span>
227 <span id="224">224</span>
228 <span id="225">225</span>
229 <span id="226">226</span>
230 <span id="227">227</span>
231 <span id="228">228</span>
232 <span id="229">229</span>
233 <span id="230">230</span>
234 <span id="231">231</span>
235 <span id="232">232</span>
236 <span id="233">233</span>
237 <span id="234">234</span>
238 <span id="235">235</span>
239 <span id="236">236</span>
240 <span id="237">237</span>
241 <span id="238">238</span>
242 <span id="239">239</span>
243 <span id="240">240</span>
244 <span id="241">241</span>
245 <span id="242">242</span>
246 <span id="243">243</span>
247 <span id="244">244</span>
248 <span id="245">245</span>
249 <span id="246">246</span>
250 <span id="247">247</span>
251 <span id="248">248</span>
252 <span id="249">249</span>
253 <span id="250">250</span>
254 <span id="251">251</span>
255 <span id="252">252</span>
256 <span id="253">253</span>
257 <span id="254">254</span>
258 <span id="255">255</span>
259 <span id="256">256</span>
260 <span id="257">257</span>
261 <span id="258">258</span>
262 <span id="259">259</span>
263 <span id="260">260</span>
264 <span id="261">261</span>
265 <span id="262">262</span>
266 <span id="263">263</span>
267 <span id="264">264</span>
268 <span id="265">265</span>
269 <span id="266">266</span>
270 <span id="267">267</span>
271 <span id="268">268</span>
272 <span id="269">269</span>
273 <span id="270">270</span>
274 <span id="271">271</span>
275 <span id="272">272</span>
276 <span id="273">273</span>
277 <span id="274">274</span>
278 <span id="275">275</span>
279 <span id="276">276</span>
280 <span id="277">277</span>
281 <span id="278">278</span>
282 <span id="279">279</span>
283 <span id="280">280</span>
284 <span id="281">281</span>
285 <span id="282">282</span>
286 <span id="283">283</span>
287 <span id="284">284</span>
288 <span id="285">285</span>
289 <span id="286">286</span>
290 <span id="287">287</span>
291 <span id="288">288</span>
292 <span id="289">289</span>
293 <span id="290">290</span>
294 <span id="291">291</span>
295 <span id="292">292</span>
296 <span id="293">293</span>
297 <span id="294">294</span>
298 <span id="295">295</span>
299 <span id="296">296</span>
300 <span id="297">297</span>
301 <span id="298">298</span>
302 <span id="299">299</span>
303 <span id="300">300</span>
304 <span id="301">301</span>
305 <span id="302">302</span>
306 <span id="303">303</span>
307 <span id="304">304</span>
308 <span id="305">305</span>
309 <span id="306">306</span>
310 <span id="307">307</span>
311 <span id="308">308</span>
312 <span id="309">309</span>
313 <span id="310">310</span>
314 <span id="311">311</span>
315 <span id="312">312</span>
316 <span id="313">313</span>
317 <span id="314">314</span>
318 <span id="315">315</span>
319 <span id="316">316</span>
320 <span id="317">317</span>
321 <span id="318">318</span>
322 <span id="319">319</span>
323 <span id="320">320</span>
324 <span id="321">321</span>
325 <span id="322">322</span>
326 <span id="323">323</span>
327 <span id="324">324</span>
328 <span id="325">325</span>
329 <span id="326">326</span>
330 <span id="327">327</span>
331 <span id="328">328</span>
332 <span id="329">329</span>
333 <span id="330">330</span>
334 <span id="331">331</span>
335 <span id="332">332</span>
336 <span id="333">333</span>
337 <span id="334">334</span>
338 <span id="335">335</span>
339 <span id="336">336</span>
340 <span id="337">337</span>
341 <span id="338">338</span>
342 <span id="339">339</span>
343 <span id="340">340</span>
344 <span id="341">341</span>
345 <span id="342">342</span>
346 <span id="343">343</span>
347 <span id="344">344</span>
348 <span id="345">345</span>
349 <span id="346">346</span>
350 <span id="347">347</span>
351 <span id="348">348</span>
352 <span id="349">349</span>
353 <span id="350">350</span>
354 <span id="351">351</span>
355 <span id="352">352</span>
356 <span id="353">353</span>
357 <span id="354">354</span>
358 <span id="355">355</span>
359 <span id="356">356</span>
360 <span id="357">357</span>
361 <span id="358">358</span>
362 <span id="359">359</span>
363 <span id="360">360</span>
364 <span id="361">361</span>
365 <span id="362">362</span>
366 <span id="363">363</span>
367 <span id="364">364</span>
368 <span id="365">365</span>
369 <span id="366">366</span>
370 <span id="367">367</span>
371 <span id="368">368</span>
372 <span id="369">369</span>
373 <span id="370">370</span>
374 <span id="371">371</span>
375 <span id="372">372</span>
376 <span id="373">373</span>
377 <span id="374">374</span>
378 <span id="375">375</span>
379 <span id="376">376</span>
380 <span id="377">377</span>
381 <span id="378">378</span>
382 <span id="379">379</span>
383 <span id="380">380</span>
384 <span id="381">381</span>
385 <span id="382">382</span>
386 <span id="383">383</span>
387 <span id="384">384</span>
388 <span id="385">385</span>
389 <span id="386">386</span>
390 <span id="387">387</span>
391 <span id="388">388</span>
392 <span id="389">389</span>
393 <span id="390">390</span>
394 <span id="391">391</span>
395 <span id="392">392</span>
396 <span id="393">393</span>
397 <span id="394">394</span>
398 <span id="395">395</span>
399 <span id="396">396</span>
400 <span id="397">397</span>
401 <span id="398">398</span>
402 <span id="399">399</span>
403 <span id="400">400</span>
404 <span id="401">401</span>
405 <span id="402">402</span>
406 <span id="403">403</span>
407 <span id="404">404</span>
408 <span id="405">405</span>
409 <span id="406">406</span>
410 <span id="407">407</span>
411 <span id="408">408</span>
412 <span id="409">409</span>
413 <span id="410">410</span>
414 <span id="411">411</span>
415 <span id="412">412</span>
416 <span id="413">413</span>
417 <span id="414">414</span>
418 <span id="415">415</span>
419 <span id="416">416</span>
420 <span id="417">417</span>
421 <span id="418">418</span>
422 <span id="419">419</span>
423 <span id="420">420</span>
424 <span id="421">421</span>
425 <span id="422">422</span>
426 <span id="423">423</span>
427 <span id="424">424</span>
428 <span id="425">425</span>
429 <span id="426">426</span>
430 <span id="427">427</span>
431 <span id="428">428</span>
432 <span id="429">429</span>
433 <span id="430">430</span>
434 <span id="431">431</span>
435 <span id="432">432</span>
436 <span id="433">433</span>
437 <span id="434">434</span>
438 <span id="435">435</span>
439 <span id="436">436</span>
440 <span id="437">437</span>
441 <span id="438">438</span>
442 <span id="439">439</span>
443 <span id="440">440</span>
444 <span id="441">441</span>
445 <span id="442">442</span>
446 <span id="443">443</span>
447 <span id="444">444</span>
448 <span id="445">445</span>
449 <span id="446">446</span>
450 <span id="447">447</span>
451 <span id="448">448</span>
452 <span id="449">449</span>
453 <span id="450">450</span>
454 <span id="451">451</span>
455 <span id="452">452</span>
456 <span id="453">453</span>
457 <span id="454">454</span>
458 <span id="455">455</span>
459 <span id="456">456</span>
460 <span id="457">457</span>
461 <span id="458">458</span>
462 <span id="459">459</span>
463 <span id="460">460</span>
464 <span id="461">461</span>
465 <span id="462">462</span>
466 <span id="463">463</span>
467 <span id="464">464</span>
468 <span id="465">465</span>
469 <span id="466">466</span>
470 <span id="467">467</span>
471 <span id="468">468</span>
472 <span id="469">469</span>
473 <span id="470">470</span>
474 <span id="471">471</span>
475 <span id="472">472</span>
476 <span id="473">473</span>
477 <span id="474">474</span>
478 <span id="475">475</span>
479 <span id="476">476</span>
480 <span id="477">477</span>
481 <span id="478">478</span>
482 <span id="479">479</span>
483 <span id="480">480</span>
484 <span id="481">481</span>
485 <span id="482">482</span>
486 <span id="483">483</span>
487 <span id="484">484</span>
488 <span id="485">485</span>
489 <span id="486">486</span>
490 <span id="487">487</span>
491 <span id="488">488</span>
492 <span id="489">489</span>
493 <span id="490">490</span>
494 <span id="491">491</span>
495 <span id="492">492</span>
496 <span id="493">493</span>
497 <span id="494">494</span>
498 <span id="495">495</span>
499 <span id="496">496</span>
500 <span id="497">497</span>
501 <span id="498">498</span>
502 <span id="499">499</span>
503 <span id="500">500</span>
504 <span id="501">501</span>
505 <span id="502">502</span>
506 <span id="503">503</span>
507 <span id="504">504</span>
508 <span id="505">505</span>
509 <span id="506">506</span>
510 <span id="507">507</span>
511 <span id="508">508</span>
512 <span id="509">509</span>
513 <span id="510">510</span>
514 <span id="511">511</span>
515 <span id="512">512</span>
516 <span id="513">513</span>
517 <span id="514">514</span>
518 <span id="515">515</span>
519 <span id="516">516</span>
520 <span id="517">517</span>
521 <span id="518">518</span>
522 <span id="519">519</span>
523 <span id="520">520</span>
524 <span id="521">521</span>
525 <span id="522">522</span>
526 <span id="523">523</span>
527 <span id="524">524</span>
528 <span id="525">525</span>
529 <span id="526">526</span>
530 <span id="527">527</span>
531 <span id="528">528</span>
532 <span id="529">529</span>
533 <span id="530">530</span>
534 <span id="531">531</span>
535 <span id="532">532</span>
536 <span id="533">533</span>
537 <span id="534">534</span>
538 <span id="535">535</span>
539 <span id="536">536</span>
540 <span id="537">537</span>
541 <span id="538">538</span>
542 <span id="539">539</span>
543 <span id="540">540</span>
544 <span id="541">541</span>
545 <span id="542">542</span>
546 <span id="543">543</span>
547 <span id="544">544</span>
548 <span id="545">545</span>
549 <span id="546">546</span>
550 <span id="547">547</span>
551 <span id="548">548</span>
552 <span id="549">549</span>
553 <span id="550">550</span>
554 <span id="551">551</span>
555 <span id="552">552</span>
556 <span id="553">553</span>
557 <span id="554">554</span>
558 <span id="555">555</span>
559 <span id="556">556</span>
560 <span id="557">557</span>
561 <span id="558">558</span>
562 <span id="559">559</span>
563 <span id="560">560</span>
564 <span id="561">561</span>
565 <span id="562">562</span>
566 <span id="563">563</span>
567 <span id="564">564</span>
568 <span id="565">565</span>
569 <span id="566">566</span>
570 <span id="567">567</span>
571 <span id="568">568</span>
572 <span id="569">569</span>
573 <span id="570">570</span>
574 <span id="571">571</span>
575 <span id="572">572</span>
576 <span id="573">573</span>
577 <span id="574">574</span>
578 <span id="575">575</span>
579 <span id="576">576</span>
580 <span id="577">577</span>
581 <span id="578">578</span>
582 <span id="579">579</span>
583 <span id="580">580</span>
584 <span id="581">581</span>
585 <span id="582">582</span>
586 <span id="583">583</span>
587 <span id="584">584</span>
588 <span id="585">585</span>
589 <span id="586">586</span>
590 <span id="587">587</span>
591 <span id="588">588</span>
592 <span id="589">589</span>
593 <span id="590">590</span>
594 <span id="591">591</span>
595 <span id="592">592</span>
596 <span id="593">593</span>
597 <span id="594">594</span>
598 <span id="595">595</span>
599 <span id="596">596</span>
600 <span id="597">597</span>
601 <span id="598">598</span>
602 <span id="599">599</span>
603 <span id="600">600</span>
604 <span id="601">601</span>
605 <span id="602">602</span>
606 <span id="603">603</span>
607 <span id="604">604</span>
608 <span id="605">605</span>
609 <span id="606">606</span>
610 <span id="607">607</span>
611 <span id="608">608</span>
612 <span id="609">609</span>
613 <span id="610">610</span>
614 <span id="611">611</span>
615 <span id="612">612</span>
616 <span id="613">613</span>
617 <span id="614">614</span>
618 <span id="615">615</span>
619 <span id="616">616</span>
620 <span id="617">617</span>
621 <span id="618">618</span>
622 <span id="619">619</span>
623 <span id="620">620</span>
624 <span id="621">621</span>
625 <span id="622">622</span>
626 <span id="623">623</span>
627 <span id="624">624</span>
628 <span id="625">625</span>
629 <span id="626">626</span>
630 <span id="627">627</span>
631 <span id="628">628</span>
632 <span id="629">629</span>
633 <span id="630">630</span>
634 <span id="631">631</span>
635 <span id="632">632</span>
636 <span id="633">633</span>
637 <span id="634">634</span>
638 <span id="635">635</span>
639 <span id="636">636</span>
640 <span id="637">637</span>
641 <span id="638">638</span>
642 <span id="639">639</span>
643 <span id="640">640</span>
644 <span id="641">641</span>
645 <span id="642">642</span>
646 <span id="643">643</span>
647 <span id="644">644</span>
648 <span id="645">645</span>
649 <span id="646">646</span>
650 <span id="647">647</span>
651 <span id="648">648</span>
652 <span id="649">649</span>
653 <span id="650">650</span>
654 <span id="651">651</span>
655 <span id="652">652</span>
656 <span id="653">653</span>
657 <span id="654">654</span>
658 <span id="655">655</span>
659 <span id="656">656</span>
660 <span id="657">657</span>
661 <span id="658">658</span>
662 <span id="659">659</span>
663 <span id="660">660</span>
664 <span id="661">661</span>
665 <span id="662">662</span>
666 <span id="663">663</span>
667 <span id="664">664</span>
668 <span id="665">665</span>
669 <span id="666">666</span>
670 <span id="667">667</span>
671 <span id="668">668</span>
672 <span id="669">669</span>
673 <span id="670">670</span>
674 <span id="671">671</span>
675 <span id="672">672</span>
676 <span id="673">673</span>
677 <span id="674">674</span>
678 <span id="675">675</span>
679 <span id="676">676</span>
680 <span id="677">677</span>
681 <span id="678">678</span>
682 <span id="679">679</span>
683 <span id="680">680</span>
684 <span id="681">681</span>
685 <span id="682">682</span>
686 <span id="683">683</span>
687 <span id="684">684</span>
688 <span id="685">685</span>
689 <span id="686">686</span>
690 <span id="687">687</span>
691 <span id="688">688</span>
692 <span id="689">689</span>
693 <span id="690">690</span>
694 <span id="691">691</span>
695 <span id="692">692</span>
696 <span id="693">693</span>
697 <span id="694">694</span>
698 <span id="695">695</span>
699 <span id="696">696</span>
700 <span id="697">697</span>
701 <span id="698">698</span>
702 <span id="699">699</span>
703 <span id="700">700</span>
704 <span id="701">701</span>
705 <span id="702">702</span>
706 <span id="703">703</span>
707 <span id="704">704</span>
708 <span id="705">705</span>
709 <span id="706">706</span>
710 <span id="707">707</span>
711 <span id="708">708</span>
712 <span id="709">709</span>
713 <span id="710">710</span>
714 <span id="711">711</span>
715 <span id="712">712</span>
716 <span id="713">713</span>
717 <span id="714">714</span>
718 <span id="715">715</span>
719 <span id="716">716</span>
720 <span id="717">717</span>
721 <span id="718">718</span>
722 <span id="719">719</span>
723 <span id="720">720</span>
724 <span id="721">721</span>
725 <span id="722">722</span>
726 <span id="723">723</span>
727 <span id="724">724</span>
728 <span id="725">725</span>
729 <span id="726">726</span>
730 <span id="727">727</span>
731 <span id="728">728</span>
732 <span id="729">729</span>
733 <span id="730">730</span>
734 <span id="731">731</span>
735 <span id="732">732</span>
736 <span id="733">733</span>
737 <span id="734">734</span>
738 <span id="735">735</span>
739 <span id="736">736</span>
740 <span id="737">737</span>
741 <span id="738">738</span>
742 </pre><div class="example-wrap"><pre class="rust ">
743 <span class="comment">// Magical Bitcoin Library</span>
744 <span class="comment">// Written in 2020 by</span>
745 <span class="comment">// Alekos Filini <alekos.filini@gmail.com></span>
746 <span class="comment">//</span>
747 <span class="comment">// Copyright (c) 2020 Magical Bitcoin</span>
748 <span class="comment">//</span>
749 <span class="comment">// Permission is hereby granted, free of charge, to any person obtaining a copy</span>
750 <span class="comment">// of this software and associated documentation files (the "Software"), to deal</span>
751 <span class="comment">// in the Software without restriction, including without limitation the rights</span>
752 <span class="comment">// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
753 <span class="comment">// copies of the Software, and to permit persons to whom the Software is</span>
754 <span class="comment">// furnished to do so, subject to the following conditions:</span>
755 <span class="comment">//</span>
756 <span class="comment">// The above copyright notice and this permission notice shall be included in all</span>
757 <span class="comment">// copies or substantial portions of the Software.</span>
758 <span class="comment">//</span>
759 <span class="comment">// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
760 <span class="comment">// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
761 <span class="comment">// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
762 <span class="comment">// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
763 <span class="comment">// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
764 <span class="comment">// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span>
765 <span class="comment">// SOFTWARE.</span>
767 <span class="doccomment">//! Transaction builder</span>
768 <span class="doccomment">//!</span>
769 <span class="doccomment">//! ## Example</span>
770 <span class="doccomment">//!</span>
771 <span class="doccomment">//! ```</span>
772 <span class="doccomment">//! # use std::str::FromStr;</span>
773 <span class="doccomment">//! # use bitcoin::*;</span>
774 <span class="doccomment">//! # use bdk::*;</span>
775 <span class="doccomment">//! # use bdk::wallet::tx_builder::CreateTx;</span>
776 <span class="doccomment">//! # let to_address = Address::from_str("2N4eQYCbKUHCCTUjBJeHcJp9ok6J2GZsTDt").unwrap();</span>
777 <span class="doccomment">//! // Create a transaction with one output to `to_address` of 50_000 satoshi, with a custom fee rate</span>
778 <span class="doccomment">//! // of 5.0 satoshi/vbyte, only spending non-change outputs and with RBF signaling</span>
779 <span class="doccomment">//! // enabled</span>
780 <span class="doccomment">//! let builder = TxBuilder::with_recipients(vec![(to_address.script_pubkey(), 50_000)])</span>
781 <span class="doccomment">//! .fee_rate(FeeRate::from_sat_per_vb(5.0))</span>
782 <span class="doccomment">//! .do_not_spend_change()</span>
783 <span class="doccomment">//! .enable_rbf();</span>
784 <span class="doccomment">//! # let builder: TxBuilder<bdk::database::MemoryDatabase, _, CreateTx> = builder;</span>
785 <span class="doccomment">//! ```</span>
787 <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">collections</span>::<span class="ident">BTreeMap</span>;
788 <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">collections</span>::<span class="ident">HashSet</span>;
789 <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">default</span>::<span class="ident">Default</span>;
790 <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">marker</span>::<span class="ident">PhantomData</span>;
792 <span class="kw">use</span> <span class="ident">bitcoin</span>::{<span class="ident">OutPoint</span>, <span class="ident">Script</span>, <span class="ident">SigHashType</span>, <span class="ident">Transaction</span>};
794 <span class="kw">use</span> <span class="kw">super</span>::<span class="ident">coin_selection</span>::{<span class="ident">CoinSelectionAlgorithm</span>, <span class="ident">DefaultCoinSelectionAlgorithm</span>};
795 <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">database</span>::<span class="ident">Database</span>;
796 <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">types</span>::{<span class="ident">FeeRate</span>, <span class="ident">KeychainKind</span>, <span class="ident">UTXO</span>};
798 <span class="doccomment">/// Context in which the [`TxBuilder`] is valid</span>
799 <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">TxBuilderContext</span>: <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="op">+</span> <span class="ident">Default</span> <span class="op">+</span> <span class="ident">Clone</span> {}
801 <span class="doccomment">/// [`Wallet::create_tx`](super::Wallet::create_tx) context</span>
802 <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Default</span>, <span class="ident">Clone</span>)]</span>
803 <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">CreateTx</span>;
804 <span class="kw">impl</span> <span class="ident">TxBuilderContext</span> <span class="kw">for</span> <span class="ident">CreateTx</span> {}
806 <span class="doccomment">/// [`Wallet::bump_fee`](super::Wallet::bump_fee) context</span>
807 <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Default</span>, <span class="ident">Clone</span>)]</span>
808 <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">BumpFee</span>;
809 <span class="kw">impl</span> <span class="ident">TxBuilderContext</span> <span class="kw">for</span> <span class="ident">BumpFee</span> {}
811 <span class="doccomment">/// A transaction builder</span>
812 <span class="doccomment">///</span>
813 <span class="doccomment">/// This structure contains the configuration that the wallet must follow to build a transaction.</span>
814 <span class="doccomment">///</span>
815 <span class="doccomment">/// For an example see [this module](super::tx_builder)'s documentation;</span>
816 <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
817 <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">TxBuilder</span><span class="op"><</span><span class="ident">D</span>: <span class="ident">Database</span>, <span class="ident">Cs</span>: <span class="ident">CoinSelectionAlgorithm</span><span class="op"><</span><span class="ident">D</span><span class="op">></span>, <span class="ident">Ctx</span>: <span class="ident">TxBuilderContext</span><span class="op">></span> {
818 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">recipients</span>: <span class="ident">Vec</span><span class="op"><</span>(<span class="ident">Script</span>, <span class="ident">u64</span>)<span class="op">></span>,
819 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">drain_wallet</span>: <span class="ident">bool</span>,
820 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">single_recipient</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Script</span><span class="op">></span>,
821 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">fee_policy</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">FeePolicy</span><span class="op">></span>,
822 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">internal_policy_path</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">BTreeMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">Vec</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span><span class="op">></span><span class="op">></span>,
823 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">external_policy_path</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">BTreeMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">Vec</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span><span class="op">></span><span class="op">></span>,
824 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">utxos</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">OutPoint</span><span class="op">></span>,
825 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">unspendable</span>: <span class="ident">HashSet</span><span class="op"><</span><span class="ident">OutPoint</span><span class="op">></span>,
826 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">manually_selected_only</span>: <span class="ident">bool</span>,
827 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">sighash</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">SigHashType</span><span class="op">></span>,
828 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">ordering</span>: <span class="ident">TxOrdering</span>,
829 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">locktime</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span>,
830 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">rbf</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">RBFValue</span><span class="op">></span>,
831 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">version</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Version</span><span class="op">></span>,
832 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">change_policy</span>: <span class="ident">ChangeSpendPolicy</span>,
833 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">force_non_witness_utxo</span>: <span class="ident">bool</span>,
834 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">add_global_xpubs</span>: <span class="ident">bool</span>,
835 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">coin_selection</span>: <span class="ident">Cs</span>,
836 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">include_output_redeem_witness_script</span>: <span class="ident">bool</span>,
838 <span class="ident">phantom</span>: <span class="ident">PhantomData</span><span class="op"><</span>(<span class="ident">D</span>, <span class="ident">Ctx</span>)<span class="op">></span>,
841 <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
842 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum</span> <span class="ident">FeePolicy</span> {
843 <span class="ident">FeeRate</span>(<span class="ident">FeeRate</span>),
844 <span class="ident">FeeAmount</span>(<span class="ident">u64</span>),
847 <span class="kw">impl</span> <span class="ident">std</span>::<span class="ident">default</span>::<span class="ident">Default</span> <span class="kw">for</span> <span class="ident">FeePolicy</span> {
848 <span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
849 <span class="ident">FeePolicy</span>::<span class="ident">FeeRate</span>(<span class="ident">FeeRate</span>::<span class="ident">default_min_relay_fee</span>())
853 <span class="comment">// Unfortunately derive doesn't work with `PhantomData`: https://github.com/rust-lang/rust/issues/26925</span>
854 <span class="kw">impl</span><span class="op"><</span><span class="ident">D</span>: <span class="ident">Database</span>, <span class="ident">Cs</span>: <span class="ident">CoinSelectionAlgorithm</span><span class="op"><</span><span class="ident">D</span><span class="op">></span>, <span class="ident">Ctx</span>: <span class="ident">TxBuilderContext</span><span class="op">></span> <span class="ident">Default</span>
855 <span class="kw">for</span> <span class="ident">TxBuilder</span><span class="op"><</span><span class="ident">D</span>, <span class="ident">Cs</span>, <span class="ident">Ctx</span><span class="op">></span>
856 <span class="kw">where</span>
857 <span class="ident">Cs</span>: <span class="ident">Default</span>,
859 <span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
860 <span class="ident">TxBuilder</span> {
861 <span class="ident">recipients</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
862 <span class="ident">drain_wallet</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
863 <span class="ident">single_recipient</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
864 <span class="ident">fee_policy</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
865 <span class="ident">internal_policy_path</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
866 <span class="ident">external_policy_path</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
867 <span class="ident">utxos</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
868 <span class="ident">unspendable</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
869 <span class="ident">manually_selected_only</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
870 <span class="ident">sighash</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
871 <span class="ident">ordering</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
872 <span class="ident">locktime</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
873 <span class="ident">rbf</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
874 <span class="ident">version</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
875 <span class="ident">change_policy</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
876 <span class="ident">force_non_witness_utxo</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
877 <span class="ident">add_global_xpubs</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
878 <span class="ident">coin_selection</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
879 <span class="ident">include_output_redeem_witness_script</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
881 <span class="ident">phantom</span>: <span class="ident">PhantomData</span>,
886 <span class="comment">// methods supported by both contexts, but only for `DefaultCoinSelectionAlgorithm`</span>
887 <span class="kw">impl</span><span class="op"><</span><span class="ident">D</span>: <span class="ident">Database</span>, <span class="ident">Ctx</span>: <span class="ident">TxBuilderContext</span><span class="op">></span> <span class="ident">TxBuilder</span><span class="op"><</span><span class="ident">D</span>, <span class="ident">DefaultCoinSelectionAlgorithm</span>, <span class="ident">Ctx</span><span class="op">></span> {
888 <span class="doccomment">/// Create an empty builder</span>
889 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
890 <span class="self">Self</span>::<span class="ident">default</span>()
894 <span class="comment">// methods supported by both contexts, for any CoinSelectionAlgorithm</span>
895 <span class="kw">impl</span><span class="op"><</span><span class="ident">D</span>: <span class="ident">Database</span>, <span class="ident">Cs</span>: <span class="ident">CoinSelectionAlgorithm</span><span class="op"><</span><span class="ident">D</span><span class="op">></span>, <span class="ident">Ctx</span>: <span class="ident">TxBuilderContext</span><span class="op">></span> <span class="ident">TxBuilder</span><span class="op"><</span><span class="ident">D</span>, <span class="ident">Cs</span>, <span class="ident">Ctx</span><span class="op">></span> {
896 <span class="doccomment">/// Set a custom fee rate</span>
897 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">fee_rate</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">fee_rate</span>: <span class="ident">FeeRate</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
898 <span class="self">self</span>.<span class="ident">fee_policy</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">FeePolicy</span>::<span class="ident">FeeRate</span>(<span class="ident">fee_rate</span>));
899 <span class="self">self</span>
902 <span class="doccomment">/// Set an absolute fee</span>
903 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">fee_absolute</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">fee_amount</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
904 <span class="self">self</span>.<span class="ident">fee_policy</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">FeePolicy</span>::<span class="ident">FeeAmount</span>(<span class="ident">fee_amount</span>));
905 <span class="self">self</span>
908 <span class="doccomment">/// Set the policy path to use while creating the transaction for a given keychain.</span>
909 <span class="doccomment">///</span>
910 <span class="doccomment">/// This method accepts a map where the key is the policy node id (see</span>
911 <span class="doccomment">/// [`Policy::id`](crate::descriptor::Policy::id)) and the value is the list of the indexes of</span>
912 <span class="doccomment">/// the items that are intended to be satisfied from the policy node (see</span>
913 <span class="doccomment">/// [`SatisfiableItem::Thresh::items`](crate::descriptor::policy::SatisfiableItem::Thresh::items)).</span>
914 <span class="doccomment">///</span>
915 <span class="doccomment">/// ## Example</span>
916 <span class="doccomment">///</span>
917 <span class="doccomment">/// An example of when the policy path is needed is the following descriptor:</span>
918 <span class="doccomment">/// `wsh(thresh(2,pk(A),sj:and_v(v:pk(B),n:older(6)),snj:and_v(v:pk(C),after(630000))))`,</span>
919 <span class="doccomment">/// derived from the miniscript policy `thresh(2,pk(A),and(pk(B),older(6)),and(pk(C),after(630000)))`.</span>
920 <span class="doccomment">/// It declares three descriptor fragments, and at the top level it uses `thresh()` to</span>
921 <span class="doccomment">/// ensure that at least two of them are satisfied. The individual fragments are:</span>
922 <span class="doccomment">///</span>
923 <span class="doccomment">/// 1. `pk(A)`</span>
924 <span class="doccomment">/// 2. `and(pk(B),older(6))`</span>
925 <span class="doccomment">/// 3. `and(pk(C),after(630000))`</span>
926 <span class="doccomment">///</span>
927 <span class="doccomment">/// When those conditions are combined in pairs, it's clear that the transaction needs to be created</span>
928 <span class="doccomment">/// differently depending on how the user intends to satisfy the policy afterwards:</span>
929 <span class="doccomment">///</span>
930 <span class="doccomment">/// * If fragments `1` and `2` are used, the transaction will need to use a specific</span>
931 <span class="doccomment">/// `n_sequence` in order to spend an `OP_CSV` branch.</span>
932 <span class="doccomment">/// * If fragments `1` and `3` are used, the transaction will need to use a specific `locktime`</span>
933 <span class="doccomment">/// in order to spend an `OP_CLTV` branch.</span>
934 <span class="doccomment">/// * If fragments `2` and `3` are used, the transaction will need both.</span>
935 <span class="doccomment">///</span>
936 <span class="doccomment">/// When the spending policy is represented as a tree (see</span>
937 <span class="doccomment">/// [`Wallet::policies`](super::Wallet::policies)), every node</span>
938 <span class="doccomment">/// is assigned a unique identifier that can be used in the policy path to specify which of</span>
939 <span class="doccomment">/// the node's children the user intends to satisfy: for instance, assuming the `thresh()`</span>
940 <span class="doccomment">/// root node of this example has an id of `aabbccdd`, the policy path map would look like:</span>
941 <span class="doccomment">///</span>
942 <span class="doccomment">/// `{ "aabbccdd" => [0, 1] }`</span>
943 <span class="doccomment">///</span>
944 <span class="doccomment">/// where the key is the node's id, and the value is a list of the children that should be</span>
945 <span class="doccomment">/// used, in no particular order.</span>
946 <span class="doccomment">///</span>
947 <span class="doccomment">/// If a particularly complex descriptor has multiple ambiguous thresholds in its structure,</span>
948 <span class="doccomment">/// multiple entries can be added to the map, one for each node that requires an explicit path.</span>
949 <span class="doccomment">///</span>
950 <span class="doccomment">/// ```</span>
951 <span class="doccomment">/// # use std::str::FromStr;</span>
952 <span class="doccomment">/// # use std::collections::BTreeMap;</span>
953 <span class="doccomment">/// # use bitcoin::*;</span>
954 <span class="doccomment">/// # use bdk::*;</span>
955 <span class="doccomment">/// # let to_address = Address::from_str("2N4eQYCbKUHCCTUjBJeHcJp9ok6J2GZsTDt").unwrap();</span>
956 <span class="doccomment">/// let mut path = BTreeMap::new();</span>
957 <span class="doccomment">/// path.insert("aabbccdd".to_string(), vec![0, 1]);</span>
958 <span class="doccomment">///</span>
959 <span class="doccomment">/// let builder = TxBuilder::with_recipients(vec![(to_address.script_pubkey(), 50_000)])</span>
960 <span class="doccomment">/// .policy_path(path, KeychainKind::External);</span>
961 <span class="doccomment">/// # let builder: TxBuilder<bdk::database::MemoryDatabase, _, _> = builder;</span>
962 <span class="doccomment">/// ```</span>
963 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">policy_path</span>(
964 <span class="kw-2">mut</span> <span class="self">self</span>,
965 <span class="ident">policy_path</span>: <span class="ident">BTreeMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">Vec</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span><span class="op">></span>,
966 <span class="ident">keychain</span>: <span class="ident">KeychainKind</span>,
967 ) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
968 <span class="kw">let</span> <span class="ident">to_update</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">keychain</span> {
969 <span class="ident">KeychainKind</span>::<span class="ident">Internal</span> <span class="op">=</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">internal_policy_path</span>,
970 <span class="ident">KeychainKind</span>::<span class="ident">External</span> <span class="op">=</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">external_policy_path</span>,
973 <span class="kw-2">*</span><span class="ident">to_update</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">policy_path</span>);
974 <span class="self">self</span>
977 <span class="doccomment">/// Replace the internal list of utxos that **must** be spent with a new list</span>
978 <span class="doccomment">///</span>
979 <span class="doccomment">/// These have priority over the "unspendable" utxos, meaning that if a utxo is present both in</span>
980 <span class="doccomment">/// the "utxos" and the "unspendable" list, it will be spent.</span>
981 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">utxos</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">utxos</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">OutPoint</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
982 <span class="self">self</span>.<span class="ident">utxos</span> <span class="op">=</span> <span class="ident">utxos</span>;
983 <span class="self">self</span>
986 <span class="doccomment">/// Add a utxo to the internal list of utxos that **must** be spent</span>
987 <span class="doccomment">///</span>
988 <span class="doccomment">/// These have priority over the "unspendable" utxos, meaning that if a utxo is present both in</span>
989 <span class="doccomment">/// the "utxos" and the "unspendable" list, it will be spent.</span>
990 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">add_utxo</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">utxo</span>: <span class="ident">OutPoint</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
991 <span class="self">self</span>.<span class="ident">utxos</span>.<span class="ident">push</span>(<span class="ident">utxo</span>);
992 <span class="self">self</span>
995 <span class="doccomment">/// Only spend utxos added by [`add_utxo`] and [`utxos`].</span>
996 <span class="doccomment">///</span>
997 <span class="doccomment">/// The wallet will **not** add additional utxos to the transaction even if they are needed to</span>
998 <span class="doccomment">/// make the transaction valid.</span>
999 <span class="doccomment">///</span>
1000 <span class="doccomment">/// [`add_utxo`]: Self::add_utxo</span>
1001 <span class="doccomment">/// [`utxos`]: Self::utxos</span>
1002 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">manually_selected_only</span>(<span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1003 <span class="self">self</span>.<span class="ident">manually_selected_only</span> <span class="op">=</span> <span class="bool-val">true</span>;
1004 <span class="self">self</span>
1007 <span class="doccomment">/// Replace the internal list of unspendable utxos with a new list</span>
1008 <span class="doccomment">///</span>
1009 <span class="doccomment">/// It's important to note that the "must-be-spent" utxos added with [`TxBuilder::utxos`] and</span>
1010 <span class="doccomment">/// [`TxBuilder::add_utxo`] have priority over these. See the docs of the two linked methods</span>
1011 <span class="doccomment">/// for more details.</span>
1012 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">unspendable</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">unspendable</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">OutPoint</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1013 <span class="self">self</span>.<span class="ident">unspendable</span> <span class="op">=</span> <span class="ident">unspendable</span>.<span class="ident">into_iter</span>().<span class="ident">collect</span>();
1014 <span class="self">self</span>
1017 <span class="doccomment">/// Add a utxo to the internal list of unspendable utxos</span>
1018 <span class="doccomment">///</span>
1019 <span class="doccomment">/// It's important to note that the "must-be-spent" utxos added with [`TxBuilder::utxos`] and</span>
1020 <span class="doccomment">/// [`TxBuilder::add_utxo`] have priority over this. See the docs of the two linked methods</span>
1021 <span class="doccomment">/// for more details.</span>
1022 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">add_unspendable</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">unspendable</span>: <span class="ident">OutPoint</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1023 <span class="self">self</span>.<span class="ident">unspendable</span>.<span class="ident">insert</span>(<span class="ident">unspendable</span>);
1024 <span class="self">self</span>
1027 <span class="doccomment">/// Sign with a specific sig hash</span>
1028 <span class="doccomment">///</span>
1029 <span class="doccomment">/// **Use this option very carefully**</span>
1030 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">sighash</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">sighash</span>: <span class="ident">SigHashType</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1031 <span class="self">self</span>.<span class="ident">sighash</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">sighash</span>);
1032 <span class="self">self</span>
1035 <span class="doccomment">/// Choose the ordering for inputs and outputs of the transaction</span>
1036 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">ordering</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">ordering</span>: <span class="ident">TxOrdering</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1037 <span class="self">self</span>.<span class="ident">ordering</span> <span class="op">=</span> <span class="ident">ordering</span>;
1038 <span class="self">self</span>
1041 <span class="doccomment">/// Use a specific nLockTime while creating the transaction</span>
1042 <span class="doccomment">///</span>
1043 <span class="doccomment">/// This can cause conflicts if the wallet's descriptors contain an "after" (OP_CLTV) operator.</span>
1044 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">nlocktime</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">locktime</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1045 <span class="self">self</span>.<span class="ident">locktime</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">locktime</span>);
1046 <span class="self">self</span>
1049 <span class="doccomment">/// Build a transaction with a specific version</span>
1050 <span class="doccomment">///</span>
1051 <span class="doccomment">/// The `version` should always be greater than `0` and greater than `1` if the wallet's</span>
1052 <span class="doccomment">/// descriptors contain an "older" (OP_CSV) operator.</span>
1053 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">version</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">version</span>: <span class="ident">i32</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1054 <span class="self">self</span>.<span class="ident">version</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">Version</span>(<span class="ident">version</span>));
1055 <span class="self">self</span>
1058 <span class="doccomment">/// Do not spend change outputs</span>
1059 <span class="doccomment">///</span>
1060 <span class="doccomment">/// This effectively adds all the change outputs to the "unspendable" list. See</span>
1061 <span class="doccomment">/// [`TxBuilder::unspendable`].</span>
1062 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">do_not_spend_change</span>(<span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1063 <span class="self">self</span>.<span class="ident">change_policy</span> <span class="op">=</span> <span class="ident">ChangeSpendPolicy</span>::<span class="ident">ChangeForbidden</span>;
1064 <span class="self">self</span>
1067 <span class="doccomment">/// Only spend change outputs</span>
1068 <span class="doccomment">///</span>
1069 <span class="doccomment">/// This effectively adds all the non-change outputs to the "unspendable" list. See</span>
1070 <span class="doccomment">/// [`TxBuilder::unspendable`].</span>
1071 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">only_spend_change</span>(<span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1072 <span class="self">self</span>.<span class="ident">change_policy</span> <span class="op">=</span> <span class="ident">ChangeSpendPolicy</span>::<span class="ident">OnlyChange</span>;
1073 <span class="self">self</span>
1076 <span class="doccomment">/// Set a specific [`ChangeSpendPolicy`]. See [`TxBuilder::do_not_spend_change`] and</span>
1077 <span class="doccomment">/// [`TxBuilder::only_spend_change`] for some shortcuts.</span>
1078 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">change_policy</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">change_policy</span>: <span class="ident">ChangeSpendPolicy</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1079 <span class="self">self</span>.<span class="ident">change_policy</span> <span class="op">=</span> <span class="ident">change_policy</span>;
1080 <span class="self">self</span>
1083 <span class="doccomment">/// Fill-in the [`psbt::Input::non_witness_utxo`](bitcoin::util::psbt::Input::non_witness_utxo) field even if the wallet only has SegWit</span>
1084 <span class="doccomment">/// descriptors.</span>
1085 <span class="doccomment">///</span>
1086 <span class="doccomment">/// This is useful for signers which always require it, like Trezor hardware wallets.</span>
1087 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">force_non_witness_utxo</span>(<span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1088 <span class="self">self</span>.<span class="ident">force_non_witness_utxo</span> <span class="op">=</span> <span class="bool-val">true</span>;
1089 <span class="self">self</span>
1092 <span class="doccomment">/// Fill-in the [`psbt::Output::redeem_script`](bitcoin::util::psbt::Output::redeem_script) and</span>
1093 <span class="doccomment">/// [`psbt::Output::witness_script`](bitcoin::util::psbt::Output::witness_script) fields.</span>
1094 <span class="doccomment">///</span>
1095 <span class="doccomment">/// This is useful for signers which always require it, like ColdCard hardware wallets.</span>
1096 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">include_output_redeem_witness_script</span>(<span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1097 <span class="self">self</span>.<span class="ident">include_output_redeem_witness_script</span> <span class="op">=</span> <span class="bool-val">true</span>;
1098 <span class="self">self</span>
1101 <span class="doccomment">/// Fill-in the `PSBT_GLOBAL_XPUB` field with the extended keys contained in both the external</span>
1102 <span class="doccomment">/// and internal descriptors</span>
1103 <span class="doccomment">///</span>
1104 <span class="doccomment">/// This is useful for offline signers that take part to a multisig. Some hardware wallets like</span>
1105 <span class="doccomment">/// BitBox and ColdCard are known to require this.</span>
1106 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">add_global_xpubs</span>(<span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1107 <span class="self">self</span>.<span class="ident">add_global_xpubs</span> <span class="op">=</span> <span class="bool-val">true</span>;
1108 <span class="self">self</span>
1111 <span class="doccomment">/// Spend all the available inputs. This respects filters like [`TxBuilder::unspendable`] and the change policy.</span>
1112 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">drain_wallet</span>(<span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1113 <span class="self">self</span>.<span class="ident">drain_wallet</span> <span class="op">=</span> <span class="bool-val">true</span>;
1114 <span class="self">self</span>
1117 <span class="doccomment">/// Choose the coin selection algorithm</span>
1118 <span class="doccomment">///</span>
1119 <span class="doccomment">/// Overrides the [`DefaultCoinSelectionAlgorithm`](super::coin_selection::DefaultCoinSelectionAlgorithm).</span>
1120 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">coin_selection</span><span class="op"><</span><span class="ident">P</span>: <span class="ident">CoinSelectionAlgorithm</span><span class="op"><</span><span class="ident">D</span><span class="op">></span><span class="op">></span>(
1121 <span class="self">self</span>,
1122 <span class="ident">coin_selection</span>: <span class="ident">P</span>,
1123 ) <span class="op">-</span><span class="op">></span> <span class="ident">TxBuilder</span><span class="op"><</span><span class="ident">D</span>, <span class="ident">P</span>, <span class="ident">Ctx</span><span class="op">></span> {
1124 <span class="ident">TxBuilder</span> {
1125 <span class="ident">recipients</span>: <span class="self">self</span>.<span class="ident">recipients</span>,
1126 <span class="ident">drain_wallet</span>: <span class="self">self</span>.<span class="ident">drain_wallet</span>,
1127 <span class="ident">single_recipient</span>: <span class="self">self</span>.<span class="ident">single_recipient</span>,
1128 <span class="ident">fee_policy</span>: <span class="self">self</span>.<span class="ident">fee_policy</span>,
1129 <span class="ident">internal_policy_path</span>: <span class="self">self</span>.<span class="ident">internal_policy_path</span>,
1130 <span class="ident">external_policy_path</span>: <span class="self">self</span>.<span class="ident">external_policy_path</span>,
1131 <span class="ident">utxos</span>: <span class="self">self</span>.<span class="ident">utxos</span>,
1132 <span class="ident">unspendable</span>: <span class="self">self</span>.<span class="ident">unspendable</span>,
1133 <span class="ident">manually_selected_only</span>: <span class="self">self</span>.<span class="ident">manually_selected_only</span>,
1134 <span class="ident">sighash</span>: <span class="self">self</span>.<span class="ident">sighash</span>,
1135 <span class="ident">ordering</span>: <span class="self">self</span>.<span class="ident">ordering</span>,
1136 <span class="ident">locktime</span>: <span class="self">self</span>.<span class="ident">locktime</span>,
1137 <span class="ident">rbf</span>: <span class="self">self</span>.<span class="ident">rbf</span>,
1138 <span class="ident">version</span>: <span class="self">self</span>.<span class="ident">version</span>,
1139 <span class="ident">change_policy</span>: <span class="self">self</span>.<span class="ident">change_policy</span>,
1140 <span class="ident">force_non_witness_utxo</span>: <span class="self">self</span>.<span class="ident">force_non_witness_utxo</span>,
1141 <span class="ident">add_global_xpubs</span>: <span class="self">self</span>.<span class="ident">add_global_xpubs</span>,
1142 <span class="ident">include_output_redeem_witness_script</span>: <span class="self">self</span>.<span class="ident">include_output_redeem_witness_script</span>,
1143 <span class="ident">coin_selection</span>,
1145 <span class="ident">phantom</span>: <span class="ident">PhantomData</span>,
1150 <span class="comment">// methods supported only by create_tx, and only for `DefaultCoinSelectionAlgorithm`</span>
1151 <span class="kw">impl</span><span class="op"><</span><span class="ident">D</span>: <span class="ident">Database</span><span class="op">></span> <span class="ident">TxBuilder</span><span class="op"><</span><span class="ident">D</span>, <span class="ident">DefaultCoinSelectionAlgorithm</span>, <span class="ident">CreateTx</span><span class="op">></span> {
1152 <span class="doccomment">/// Create a builder starting from a list of recipients</span>
1153 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_recipients</span>(<span class="ident">recipients</span>: <span class="ident">Vec</span><span class="op"><</span>(<span class="ident">Script</span>, <span class="ident">u64</span>)<span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1154 <span class="self">Self</span>::<span class="ident">default</span>().<span class="ident">set_recipients</span>(<span class="ident">recipients</span>)
1158 <span class="comment">// methods supported only by create_tx, for any `CoinSelectionAlgorithm`</span>
1159 <span class="kw">impl</span><span class="op"><</span><span class="ident">D</span>: <span class="ident">Database</span>, <span class="ident">Cs</span>: <span class="ident">CoinSelectionAlgorithm</span><span class="op"><</span><span class="ident">D</span><span class="op">></span><span class="op">></span> <span class="ident">TxBuilder</span><span class="op"><</span><span class="ident">D</span>, <span class="ident">Cs</span>, <span class="ident">CreateTx</span><span class="op">></span> {
1160 <span class="doccomment">/// Replace the recipients already added with a new list</span>
1161 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_recipients</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">recipients</span>: <span class="ident">Vec</span><span class="op"><</span>(<span class="ident">Script</span>, <span class="ident">u64</span>)<span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1162 <span class="self">self</span>.<span class="ident">recipients</span> <span class="op">=</span> <span class="ident">recipients</span>;
1163 <span class="self">self</span>
1166 <span class="doccomment">/// Add a recipient to the internal list</span>
1167 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">add_recipient</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">script_pubkey</span>: <span class="ident">Script</span>, <span class="ident">amount</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1168 <span class="self">self</span>.<span class="ident">recipients</span>.<span class="ident">push</span>((<span class="ident">script_pubkey</span>, <span class="ident">amount</span>));
1169 <span class="self">self</span>
1172 <span class="doccomment">/// Set a single recipient that will get all the selected funds minus the fee. No change will</span>
1173 <span class="doccomment">/// be created</span>
1174 <span class="doccomment">///</span>
1175 <span class="doccomment">/// This method overrides any recipient set with [`set_recipients`](Self::set_recipients) or</span>
1176 <span class="doccomment">/// [`add_recipient`](Self::add_recipient).</span>
1177 <span class="doccomment">///</span>
1178 <span class="doccomment">/// It can only be used in conjunction with [`drain_wallet`](Self::drain_wallet) to send the</span>
1179 <span class="doccomment">/// entire content of the wallet (minus filters) to a single recipient or with a</span>
1180 <span class="doccomment">/// list of manually selected UTXOs by enabling [`manually_selected_only`](Self::manually_selected_only)</span>
1181 <span class="doccomment">/// and selecting them with [`utxos`](Self::utxos) or [`add_utxo`](Self::add_utxo).</span>
1182 <span class="doccomment">///</span>
1183 <span class="doccomment">/// When bumping the fees of a transaction made with this option, the user should remeber to</span>
1184 <span class="doccomment">/// add [`maintain_single_recipient`](Self::maintain_single_recipient) to correctly update the</span>
1185 <span class="doccomment">/// single output instead of adding one more for the change.</span>
1186 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_single_recipient</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">recipient</span>: <span class="ident">Script</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1187 <span class="self">self</span>.<span class="ident">single_recipient</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">recipient</span>);
1188 <span class="self">self</span>.<span class="ident">recipients</span>.<span class="ident">clear</span>();
1190 <span class="self">self</span>
1193 <span class="doccomment">/// Enable signaling RBF</span>
1194 <span class="doccomment">///</span>
1195 <span class="doccomment">/// This will use the default nSequence value of `0xFFFFFFFD`.</span>
1196 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">enable_rbf</span>(<span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1197 <span class="self">self</span>.<span class="ident">rbf</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">RBFValue</span>::<span class="ident">Default</span>);
1198 <span class="self">self</span>
1201 <span class="doccomment">/// Enable signaling RBF with a specific nSequence value</span>
1202 <span class="doccomment">///</span>
1203 <span class="doccomment">/// This can cause conflicts if the wallet's descriptors contain an "older" (OP_CSV) operator</span>
1204 <span class="doccomment">/// and the given `nsequence` is lower than the CSV value.</span>
1205 <span class="doccomment">///</span>
1206 <span class="doccomment">/// If the `nsequence` is higher than `0xFFFFFFFD` an error will be thrown, since it would not</span>
1207 <span class="doccomment">/// be a valid nSequence to signal RBF.</span>
1208 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">enable_rbf_with_sequence</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">nsequence</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1209 <span class="self">self</span>.<span class="ident">rbf</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">RBFValue</span>::<span class="ident">Value</span>(<span class="ident">nsequence</span>));
1210 <span class="self">self</span>
1214 <span class="comment">// methods supported only by bump_fee</span>
1215 <span class="kw">impl</span><span class="op"><</span><span class="ident">D</span>: <span class="ident">Database</span><span class="op">></span> <span class="ident">TxBuilder</span><span class="op"><</span><span class="ident">D</span>, <span class="ident">DefaultCoinSelectionAlgorithm</span>, <span class="ident">BumpFee</span><span class="op">></span> {
1216 <span class="doccomment">/// Bump the fees of a transaction made with [`set_single_recipient`](Self::set_single_recipient)</span>
1217 <span class="doccomment">///</span>
1218 <span class="doccomment">/// Unless extra inputs are specified with [`add_utxo`] or [`utxos`], this flag will make</span>
1219 <span class="doccomment">/// `bump_fee` reduce the value of the existing output, or fail if it would be consumed</span>
1220 <span class="doccomment">/// entirely given the higher new fee rate.</span>
1221 <span class="doccomment">///</span>
1222 <span class="doccomment">/// If extra inputs are added and they are not entirely consumed in fees, a change output will not</span>
1223 <span class="doccomment">/// be added; the existing output will simply grow in value.</span>
1224 <span class="doccomment">///</span>
1225 <span class="doccomment">/// Fails if the transaction has more than one outputs.</span>
1226 <span class="doccomment">///</span>
1227 <span class="doccomment">/// [`add_utxo`]: Self::add_utxo</span>
1228 <span class="doccomment">/// [`utxos`]: Self::utxos</span>
1229 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">maintain_single_recipient</span>(<span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1230 <span class="self">self</span>.<span class="ident">single_recipient</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">Script</span>::<span class="ident">default</span>());
1231 <span class="self">self</span>
1235 <span class="doccomment">/// Ordering of the transaction's inputs and outputs</span>
1236 <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Ord</span>, <span class="ident">PartialOrd</span>, <span class="ident">Eq</span>, <span class="ident">PartialEq</span>, <span class="ident">Hash</span>, <span class="ident">Clone</span>, <span class="ident">Copy</span>)]</span>
1237 <span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">TxOrdering</span> {
1238 <span class="doccomment">/// Randomized (default)</span>
1239 <span class="ident">Shuffle</span>,
1240 <span class="doccomment">/// Unchanged</span>
1241 <span class="ident">Untouched</span>,
1242 <span class="doccomment">/// BIP69 / Lexicographic</span>
1243 <span class="ident">BIP69Lexicographic</span>,
1246 <span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">TxOrdering</span> {
1247 <span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1248 <span class="ident">TxOrdering</span>::<span class="ident">Shuffle</span>
1252 <span class="kw">impl</span> <span class="ident">TxOrdering</span> {
1253 <span class="doccomment">/// Sort transaction inputs and outputs by [`TxOrdering`] variant</span>
1254 <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">sort_tx</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">tx</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">Transaction</span>) {
1255 <span class="kw">match</span> <span class="self">self</span> {
1256 <span class="ident">TxOrdering</span>::<span class="ident">Untouched</span> <span class="op">=</span><span class="op">></span> {}
1257 <span class="ident">TxOrdering</span>::<span class="ident">Shuffle</span> <span class="op">=</span><span class="op">></span> {
1258 <span class="kw">use</span> <span class="ident">rand</span>::<span class="ident">seq</span>::<span class="ident">SliceRandom</span>;
1259 <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
1260 <span class="kw">use</span> <span class="ident">rand</span>::<span class="ident">SeedableRng</span>;
1262 <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">test</span>))]</span>
1263 <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rng</span> <span class="op">=</span> <span class="ident">rand</span>::<span class="ident">thread_rng</span>();
1264 <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
1265 <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rng</span> <span class="op">=</span> <span class="ident">rand</span>::<span class="ident">rngs</span>::<span class="ident">StdRng</span>::<span class="ident">seed_from_u64</span>(<span class="number">0</span>);
1267 <span class="ident">tx</span>.<span class="ident">output</span>.<span class="ident">shuffle</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">rng</span>);
1269 <span class="ident">TxOrdering</span>::<span class="ident">BIP69Lexicographic</span> <span class="op">=</span><span class="op">></span> {
1270 <span class="ident">tx</span>.<span class="ident">input</span>.<span class="ident">sort_unstable_by_key</span>(<span class="op">|</span><span class="ident">txin</span><span class="op">|</span> {
1271 (<span class="ident">txin</span>.<span class="ident">previous_output</span>.<span class="ident">txid</span>, <span class="ident">txin</span>.<span class="ident">previous_output</span>.<span class="ident">vout</span>)
1273 <span class="ident">tx</span>.<span class="ident">output</span>
1274 .<span class="ident">sort_unstable_by_key</span>(<span class="op">|</span><span class="ident">txout</span><span class="op">|</span> (<span class="ident">txout</span>.<span class="ident">value</span>, <span class="ident">txout</span>.<span class="ident">script_pubkey</span>.<span class="ident">clone</span>()));
1280 <span class="doccomment">/// Transaction version</span>
1281 <span class="doccomment">///</span>
1282 <span class="doccomment">/// Has a default value of `1`</span>
1283 <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Ord</span>, <span class="ident">PartialOrd</span>, <span class="ident">Eq</span>, <span class="ident">PartialEq</span>, <span class="ident">Hash</span>, <span class="ident">Clone</span>, <span class="ident">Copy</span>)]</span>
1284 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct</span> <span class="ident">Version</span>(<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">i32</span>);
1286 <span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">Version</span> {
1287 <span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1288 <span class="ident">Version</span>(<span class="number">1</span>)
1292 <span class="doccomment">/// RBF nSequence value</span>
1293 <span class="doccomment">///</span>
1294 <span class="doccomment">/// Has a default value of `0xFFFFFFFD`</span>
1295 <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Ord</span>, <span class="ident">PartialOrd</span>, <span class="ident">Eq</span>, <span class="ident">PartialEq</span>, <span class="ident">Hash</span>, <span class="ident">Clone</span>, <span class="ident">Copy</span>)]</span>
1296 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum</span> <span class="ident">RBFValue</span> {
1297 <span class="ident">Default</span>,
1298 <span class="ident">Value</span>(<span class="ident">u32</span>),
1301 <span class="kw">impl</span> <span class="ident">RBFValue</span> {
1302 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">get_value</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u32</span> {
1303 <span class="kw">match</span> <span class="self">self</span> {
1304 <span class="ident">RBFValue</span>::<span class="ident">Default</span> <span class="op">=</span><span class="op">></span> <span class="number">0xFFFFFFFD</span>,
1305 <span class="ident">RBFValue</span>::<span class="ident">Value</span>(<span class="ident">v</span>) <span class="op">=</span><span class="op">></span> <span class="kw-2">*</span><span class="ident">v</span>,
1310 <span class="doccomment">/// Policy regarding the use of change outputs when creating a transaction</span>
1311 <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Ord</span>, <span class="ident">PartialOrd</span>, <span class="ident">Eq</span>, <span class="ident">PartialEq</span>, <span class="ident">Hash</span>, <span class="ident">Clone</span>, <span class="ident">Copy</span>)]</span>
1312 <span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">ChangeSpendPolicy</span> {
1313 <span class="doccomment">/// Use both change and non-change outputs (default)</span>
1314 <span class="ident">ChangeAllowed</span>,
1315 <span class="doccomment">/// Only use change outputs (see [`TxBuilder::only_spend_change`])</span>
1316 <span class="ident">OnlyChange</span>,
1317 <span class="doccomment">/// Only use non-change outputs (see [`TxBuilder::do_not_spend_change`])</span>
1318 <span class="ident">ChangeForbidden</span>,
1321 <span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">ChangeSpendPolicy</span> {
1322 <span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
1323 <span class="ident">ChangeSpendPolicy</span>::<span class="ident">ChangeAllowed</span>
1327 <span class="kw">impl</span> <span class="ident">ChangeSpendPolicy</span> {
1328 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">is_satisfied_by</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">utxo</span>: <span class="kw-2">&</span><span class="ident">UTXO</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
1329 <span class="kw">match</span> <span class="self">self</span> {
1330 <span class="ident">ChangeSpendPolicy</span>::<span class="ident">ChangeAllowed</span> <span class="op">=</span><span class="op">></span> <span class="bool-val">true</span>,
1331 <span class="ident">ChangeSpendPolicy</span>::<span class="ident">OnlyChange</span> <span class="op">=</span><span class="op">></span> <span class="ident">utxo</span>.<span class="ident">keychain</span> <span class="op">=</span><span class="op">=</span> <span class="ident">KeychainKind</span>::<span class="ident">Internal</span>,
1332 <span class="ident">ChangeSpendPolicy</span>::<span class="ident">ChangeForbidden</span> <span class="op">=</span><span class="op">></span> <span class="ident">utxo</span>.<span class="ident">keychain</span> <span class="op">=</span><span class="op">=</span> <span class="ident">KeychainKind</span>::<span class="ident">External</span>,
1337 <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
1338 <span class="kw">mod</span> <span class="ident">test</span> {
1339 <span class="kw">const</span> <span class="ident">ORDERING_TEST_TX</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span> <span class="op">=</span> <span class="string">"0200000003c26f3eb7932f7acddc5ddd26602b77e7516079b03090a16e2c2f54\
1340 85d1fd600f0100000000ffffffffc26f3eb7932f7acddc5ddd26602b77e75160\
1341 79b03090a16e2c2f5485d1fd600f0000000000ffffffff571fb3e02278217852\
1342 dd5d299947e2b7354a639adc32ec1fa7b82cfb5dec530e0500000000ffffffff\
1343 03e80300000000000002aaeee80300000000000001aa200300000000000001ff\
1344 00000000"</span>;
1345 <span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ordering_test_tx</span> {
1346 () <span class="op">=</span><span class="op">></span> {
1347 <span class="ident">deserialize</span>::<span class="op"><</span><span class="ident">bitcoin</span>::<span class="ident">Transaction</span><span class="op">></span>(<span class="kw-2">&</span><span class="ident">Vec</span>::<span class="op"><</span><span class="ident">u8</span><span class="op">></span>::<span class="ident">from_hex</span>(<span class="ident">ORDERING_TEST_TX</span>).<span class="ident">unwrap</span>())
1348 .<span class="ident">unwrap</span>()
1352 <span class="kw">use</span> <span class="ident">bitcoin</span>::<span class="ident">consensus</span>::<span class="ident">deserialize</span>;
1353 <span class="kw">use</span> <span class="ident">bitcoin</span>::<span class="ident">hashes</span>::<span class="ident">hex</span>::<span class="ident">FromHex</span>;
1355 <span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
1357 <span class="attribute">#[<span class="ident">test</span>]</span>
1358 <span class="kw">fn</span> <span class="ident">test_output_ordering_default_shuffle</span>() {
1359 <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">TxOrdering</span>::<span class="ident">default</span>(), <span class="ident">TxOrdering</span>::<span class="ident">Shuffle</span>);
1362 <span class="attribute">#[<span class="ident">test</span>]</span>
1363 <span class="kw">fn</span> <span class="ident">test_output_ordering_untouched</span>() {
1364 <span class="kw">let</span> <span class="ident">original_tx</span> <span class="op">=</span> <span class="macro">ordering_test_tx</span><span class="macro">!</span>();
1365 <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">tx</span> <span class="op">=</span> <span class="ident">original_tx</span>.<span class="ident">clone</span>();
1367 <span class="ident">TxOrdering</span>::<span class="ident">Untouched</span>.<span class="ident">sort_tx</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">tx</span>);
1369 <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">original_tx</span>, <span class="ident">tx</span>);
1372 <span class="attribute">#[<span class="ident">test</span>]</span>
1373 <span class="kw">fn</span> <span class="ident">test_output_ordering_shuffle</span>() {
1374 <span class="kw">let</span> <span class="ident">original_tx</span> <span class="op">=</span> <span class="macro">ordering_test_tx</span><span class="macro">!</span>();
1375 <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">tx</span> <span class="op">=</span> <span class="ident">original_tx</span>.<span class="ident">clone</span>();
1377 <span class="ident">TxOrdering</span>::<span class="ident">Shuffle</span>.<span class="ident">sort_tx</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">tx</span>);
1379 <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">original_tx</span>.<span class="ident">input</span>, <span class="ident">tx</span>.<span class="ident">input</span>);
1380 <span class="macro">assert_ne</span><span class="macro">!</span>(<span class="ident">original_tx</span>.<span class="ident">output</span>, <span class="ident">tx</span>.<span class="ident">output</span>);
1383 <span class="attribute">#[<span class="ident">test</span>]</span>
1384 <span class="kw">fn</span> <span class="ident">test_output_ordering_bip69</span>() {
1385 <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">str</span>::<span class="ident">FromStr</span>;
1387 <span class="kw">let</span> <span class="ident">original_tx</span> <span class="op">=</span> <span class="macro">ordering_test_tx</span><span class="macro">!</span>();
1388 <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">tx</span> <span class="op">=</span> <span class="ident">original_tx</span>.<span class="ident">clone</span>();
1390 <span class="ident">TxOrdering</span>::<span class="ident">BIP69Lexicographic</span>.<span class="ident">sort_tx</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">tx</span>);
1392 <span class="macro">assert_eq</span><span class="macro">!</span>(
1393 <span class="ident">tx</span>.<span class="ident">input</span>[<span class="number">0</span>].<span class="ident">previous_output</span>,
1394 <span class="ident">bitcoin</span>::<span class="ident">OutPoint</span>::<span class="ident">from_str</span>(
1395 <span class="string">"0e53ec5dfb2cb8a71fec32dc9a634a35b7e24799295ddd5278217822e0b31f57:5"</span>
1397 .<span class="ident">unwrap</span>()
1399 <span class="macro">assert_eq</span><span class="macro">!</span>(
1400 <span class="ident">tx</span>.<span class="ident">input</span>[<span class="number">1</span>].<span class="ident">previous_output</span>,
1401 <span class="ident">bitcoin</span>::<span class="ident">OutPoint</span>::<span class="ident">from_str</span>(
1402 <span class="string">"0f60fdd185542f2c6ea19030b0796051e7772b6026dd5ddccd7a2f93b73e6fc2:0"</span>
1404 .<span class="ident">unwrap</span>()
1406 <span class="macro">assert_eq</span><span class="macro">!</span>(
1407 <span class="ident">tx</span>.<span class="ident">input</span>[<span class="number">2</span>].<span class="ident">previous_output</span>,
1408 <span class="ident">bitcoin</span>::<span class="ident">OutPoint</span>::<span class="ident">from_str</span>(
1409 <span class="string">"0f60fdd185542f2c6ea19030b0796051e7772b6026dd5ddccd7a2f93b73e6fc2:1"</span>
1411 .<span class="ident">unwrap</span>()
1414 <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">tx</span>.<span class="ident">output</span>[<span class="number">0</span>].<span class="ident">value</span>, <span class="number">800</span>);
1415 <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">tx</span>.<span class="ident">output</span>[<span class="number">1</span>].<span class="ident">script_pubkey</span>, <span class="ident">From</span>::<span class="ident">from</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="number">0xAA</span>]));
1416 <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">tx</span>.<span class="ident">output</span>[<span class="number">2</span>].<span class="ident">script_pubkey</span>, <span class="ident">From</span>::<span class="ident">from</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="number">0xAA</span>, <span class="number">0xEE</span>]));
1419 <span class="kw">fn</span> <span class="ident">get_test_utxos</span>() <span class="op">-</span><span class="op">></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">UTXO</span><span class="op">></span> {
1420 <span class="macro">vec</span><span class="macro">!</span>[
1421 <span class="ident">UTXO</span> {
1422 <span class="ident">outpoint</span>: <span class="ident">OutPoint</span> {
1423 <span class="ident">txid</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
1424 <span class="ident">vout</span>: <span class="number">0</span>,
1426 <span class="ident">txout</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
1427 <span class="ident">keychain</span>: <span class="ident">KeychainKind</span>::<span class="ident">External</span>,
1429 <span class="ident">UTXO</span> {
1430 <span class="ident">outpoint</span>: <span class="ident">OutPoint</span> {
1431 <span class="ident">txid</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
1432 <span class="ident">vout</span>: <span class="number">1</span>,
1434 <span class="ident">txout</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
1435 <span class="ident">keychain</span>: <span class="ident">KeychainKind</span>::<span class="ident">Internal</span>,
1440 <span class="attribute">#[<span class="ident">test</span>]</span>
1441 <span class="kw">fn</span> <span class="ident">test_change_spend_policy_default</span>() {
1442 <span class="kw">let</span> <span class="ident">change_spend_policy</span> <span class="op">=</span> <span class="ident">ChangeSpendPolicy</span>::<span class="ident">default</span>();
1443 <span class="kw">let</span> <span class="ident">filtered</span> <span class="op">=</span> <span class="ident">get_test_utxos</span>()
1444 .<span class="ident">into_iter</span>()
1445 .<span class="ident">filter</span>(<span class="op">|</span><span class="ident">u</span><span class="op">|</span> <span class="ident">change_spend_policy</span>.<span class="ident">is_satisfied_by</span>(<span class="ident">u</span>))
1446 .<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span><span class="op">></span>();
1448 <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">filtered</span>.<span class="ident">len</span>(), <span class="number">2</span>);
1451 <span class="attribute">#[<span class="ident">test</span>]</span>
1452 <span class="kw">fn</span> <span class="ident">test_change_spend_policy_no_internal</span>() {
1453 <span class="kw">let</span> <span class="ident">change_spend_policy</span> <span class="op">=</span> <span class="ident">ChangeSpendPolicy</span>::<span class="ident">ChangeForbidden</span>;
1454 <span class="kw">let</span> <span class="ident">filtered</span> <span class="op">=</span> <span class="ident">get_test_utxos</span>()
1455 .<span class="ident">into_iter</span>()
1456 .<span class="ident">filter</span>(<span class="op">|</span><span class="ident">u</span><span class="op">|</span> <span class="ident">change_spend_policy</span>.<span class="ident">is_satisfied_by</span>(<span class="ident">u</span>))
1457 .<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span><span class="op">></span>();
1459 <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">filtered</span>.<span class="ident">len</span>(), <span class="number">1</span>);
1460 <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">filtered</span>[<span class="number">0</span>].<span class="ident">keychain</span>, <span class="ident">KeychainKind</span>::<span class="ident">External</span>);
1463 <span class="attribute">#[<span class="ident">test</span>]</span>
1464 <span class="kw">fn</span> <span class="ident">test_change_spend_policy_only_internal</span>() {
1465 <span class="kw">let</span> <span class="ident">change_spend_policy</span> <span class="op">=</span> <span class="ident">ChangeSpendPolicy</span>::<span class="ident">OnlyChange</span>;
1466 <span class="kw">let</span> <span class="ident">filtered</span> <span class="op">=</span> <span class="ident">get_test_utxos</span>()
1467 .<span class="ident">into_iter</span>()
1468 .<span class="ident">filter</span>(<span class="op">|</span><span class="ident">u</span><span class="op">|</span> <span class="ident">change_spend_policy</span>.<span class="ident">is_satisfied_by</span>(<span class="ident">u</span>))
1469 .<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span><span class="op">></span>();
1471 <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">filtered</span>.<span class="ident">len</span>(), <span class="number">1</span>);
1472 <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">filtered</span>[<span class="number">0</span>].<span class="ident">keychain</span>, <span class="ident">KeychainKind</span>::<span class="ident">Internal</span>);
1475 <span class="attribute">#[<span class="ident">test</span>]</span>
1476 <span class="kw">fn</span> <span class="ident">test_default_tx_version_1</span>() {
1477 <span class="kw">let</span> <span class="ident">version</span> <span class="op">=</span> <span class="ident">Version</span>::<span class="ident">default</span>();
1478 <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">version</span>.<span class="number">0</span>, <span class="number">1</span>);
1482 </section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../../";window.currentCrate = "bdk";</script><script src="../../../main.js"></script><script src="../../../source-script.js"></script><script src="../../../source-files.js"></script><script defer src="../../../search-index.js"></script></body></html>
projects / bitcoindevkit.org / blob