120 lines
13 KiB
HTML
120 lines
13 KiB
HTML
<!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 `pczt/src/lib.rs`."><title>lib.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-c233d2bd.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="pczt" data-themes="" data-resource-suffix="" data-rustdoc-version="1.88.0-nightly (6bc57c6bf 2025-04-22)" data-channel="nightly" data-search-js="search-f7877310.js" data-settings-js="settings-5514c975.js" ><script src="../../static.files/storage-4e99c027.js"></script><script defer src="../../static.files/src-script-63605ae7.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-7ef8a74a.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">pczt/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! The Partially Created Zcash Transaction (PCZT) format.
|
|
<a href=#2 id=2 data-nosnippet>2</a>//!
|
|
<a href=#3 id=3 data-nosnippet>3</a>//! This format enables splitting up the logical steps of creating a Zcash transaction
|
|
<a href=#4 id=4 data-nosnippet>4</a>//! across distinct entities. The entity roles roughly match those specified in
|
|
<a href=#5 id=5 data-nosnippet>5</a>//! [BIP 174: Partially Signed Bitcoin Transaction Format] and [BIP 370: PSBT Version 2],
|
|
<a href=#6 id=6 data-nosnippet>6</a>//! with additional Zcash-specific roles.
|
|
<a href=#7 id=7 data-nosnippet>7</a>//!
|
|
<a href=#8 id=8 data-nosnippet>8</a>//! [BIP 174: Partially Signed Bitcoin Transaction Format]: https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki
|
|
<a href=#9 id=9 data-nosnippet>9</a>//! [BIP 370: PSBT Version 2]: https://github.com/bitcoin/bips/blob/master/bip-0370.mediawiki
|
|
<a href=#10 id=10 data-nosnippet>10</a>//!
|
|
<a href=#11 id=11 data-nosnippet>11</a></span><span class="attr">#![cfg_attr(feature = <span class="string">"std"</span>, doc = <span class="string">"## Feature flags"</span>)]
|
|
<a href=#12 id=12 data-nosnippet>12</a>#![cfg_attr(feature = <span class="string">"std"</span>, doc = <span class="macro">document_features::document_features!</span>())]
|
|
<a href=#13 id=13 data-nosnippet>13</a></span><span class="doccomment">//!
|
|
<a href=#14 id=14 data-nosnippet>14</a>
|
|
<a href=#15 id=15 data-nosnippet>15</a></span><span class="attr">#![no_std]
|
|
<a href=#16 id=16 data-nosnippet>16</a>#![cfg_attr(docsrs, feature(doc_cfg))]
|
|
<a href=#17 id=17 data-nosnippet>17</a>#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
|
<a href=#18 id=18 data-nosnippet>18</a></span><span class="comment">// Catch documentation errors caused by code changes.
|
|
<a href=#19 id=19 data-nosnippet>19</a></span><span class="attr">#![deny(rustdoc::broken_intra_doc_links)]
|
|
<a href=#20 id=20 data-nosnippet>20</a>
|
|
<a href=#21 id=21 data-nosnippet>21</a>#[macro_use]
|
|
<a href=#22 id=22 data-nosnippet>22</a></span><span class="kw">extern crate </span>alloc;
|
|
<a href=#23 id=23 data-nosnippet>23</a>
|
|
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span>alloc::vec::Vec;
|
|
<a href=#25 id=25 data-nosnippet>25</a>
|
|
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span>getset::Getters;
|
|
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">use </span>serde::{Deserialize, Serialize};
|
|
<a href=#28 id=28 data-nosnippet>28</a>
|
|
<a href=#29 id=29 data-nosnippet>29</a><span class="attr">#[cfg(feature = <span class="string">"signer"</span>)]
|
|
<a href=#30 id=30 data-nosnippet>30</a></span><span class="kw">use </span>{roles::signer::EffectsOnly, zcash_primitives::transaction::TransactionData};
|
|
<a href=#31 id=31 data-nosnippet>31</a>
|
|
<a href=#32 id=32 data-nosnippet>32</a><span class="kw">pub mod </span>roles;
|
|
<a href=#33 id=33 data-nosnippet>33</a>
|
|
<a href=#34 id=34 data-nosnippet>34</a><span class="kw">pub mod </span>common;
|
|
<a href=#35 id=35 data-nosnippet>35</a><span class="kw">pub mod </span>orchard;
|
|
<a href=#36 id=36 data-nosnippet>36</a><span class="kw">pub mod </span>sapling;
|
|
<a href=#37 id=37 data-nosnippet>37</a><span class="kw">pub mod </span>transparent;
|
|
<a href=#38 id=38 data-nosnippet>38</a>
|
|
<a href=#39 id=39 data-nosnippet>39</a><span class="kw">const </span>MAGIC_BYTES: <span class="kw-2">&</span>[u8] = <span class="string">b"PCZT"</span>;
|
|
<a href=#40 id=40 data-nosnippet>40</a><span class="kw">const </span>PCZT_VERSION_1: u32 = <span class="number">1</span>;
|
|
<a href=#41 id=41 data-nosnippet>41</a>
|
|
<a href=#42 id=42 data-nosnippet>42</a><span class="doccomment">/// A partially-created Zcash transaction.
|
|
<a href=#43 id=43 data-nosnippet>43</a></span><span class="attr">#[derive(Clone, Debug, Serialize, Deserialize, Getters)]
|
|
<a href=#44 id=44 data-nosnippet>44</a></span><span class="kw">pub struct </span>Pczt {
|
|
<a href=#45 id=45 data-nosnippet>45</a> <span class="doccomment">/// Global fields that are relevant to the transaction as a whole.
|
|
<a href=#46 id=46 data-nosnippet>46</a> </span><span class="attr">#[getset(get = <span class="string">"pub"</span>)]
|
|
<a href=#47 id=47 data-nosnippet>47</a> </span>global: common::Global,
|
|
<a href=#48 id=48 data-nosnippet>48</a>
|
|
<a href=#49 id=49 data-nosnippet>49</a> <span class="comment">//
|
|
<a href=#50 id=50 data-nosnippet>50</a> // Protocol-specific fields.
|
|
<a href=#51 id=51 data-nosnippet>51</a> //
|
|
<a href=#52 id=52 data-nosnippet>52</a> // Unlike the `TransactionData` type in `zcash_primitives`, these are not optional.
|
|
<a href=#53 id=53 data-nosnippet>53</a> // This is because a PCZT does not always contain a semantically-valid transaction,
|
|
<a href=#54 id=54 data-nosnippet>54</a> // and there may be phases where we need to store protocol-specific metadata before
|
|
<a href=#55 id=55 data-nosnippet>55</a> // it has been determined whether there are protocol-specific inputs or outputs.
|
|
<a href=#56 id=56 data-nosnippet>56</a> //
|
|
<a href=#57 id=57 data-nosnippet>57</a> </span><span class="attr">#[getset(get = <span class="string">"pub"</span>)]
|
|
<a href=#58 id=58 data-nosnippet>58</a> </span>transparent: transparent::Bundle,
|
|
<a href=#59 id=59 data-nosnippet>59</a> <span class="attr">#[getset(get = <span class="string">"pub"</span>)]
|
|
<a href=#60 id=60 data-nosnippet>60</a> </span>sapling: sapling::Bundle,
|
|
<a href=#61 id=61 data-nosnippet>61</a> <span class="attr">#[getset(get = <span class="string">"pub"</span>)]
|
|
<a href=#62 id=62 data-nosnippet>62</a> </span>orchard: orchard::Bundle,
|
|
<a href=#63 id=63 data-nosnippet>63</a>}
|
|
<a href=#64 id=64 data-nosnippet>64</a>
|
|
<a href=#65 id=65 data-nosnippet>65</a><span class="kw">impl </span>Pczt {
|
|
<a href=#66 id=66 data-nosnippet>66</a> <span class="doccomment">/// Parses a PCZT from its encoding.
|
|
<a href=#67 id=67 data-nosnippet>67</a> </span><span class="kw">pub fn </span>parse(bytes: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, ParseError> {
|
|
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">if </span>bytes.len() < <span class="number">8 </span>{
|
|
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw">return </span><span class="prelude-val">Err</span>(ParseError::TooShort);
|
|
<a href=#70 id=70 data-nosnippet>70</a> }
|
|
<a href=#71 id=71 data-nosnippet>71</a> <span class="kw">if </span><span class="kw-2">&</span>bytes[..<span class="number">4</span>] != MAGIC_BYTES {
|
|
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">return </span><span class="prelude-val">Err</span>(ParseError::NotPczt);
|
|
<a href=#73 id=73 data-nosnippet>73</a> }
|
|
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">let </span>version = u32::from_le_bytes(bytes[<span class="number">4</span>..<span class="number">8</span>].try_into().unwrap());
|
|
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">if </span>version != PCZT_VERSION_1 {
|
|
<a href=#76 id=76 data-nosnippet>76</a> <span class="kw">return </span><span class="prelude-val">Err</span>(ParseError::UnknownVersion(version));
|
|
<a href=#77 id=77 data-nosnippet>77</a> }
|
|
<a href=#78 id=78 data-nosnippet>78</a>
|
|
<a href=#79 id=79 data-nosnippet>79</a> <span class="comment">// This is a v1 PCZT.
|
|
<a href=#80 id=80 data-nosnippet>80</a> </span>postcard::from_bytes(<span class="kw-2">&</span>bytes[<span class="number">8</span>..]).map_err(ParseError::Invalid)
|
|
<a href=#81 id=81 data-nosnippet>81</a> }
|
|
<a href=#82 id=82 data-nosnippet>82</a>
|
|
<a href=#83 id=83 data-nosnippet>83</a> <span class="doccomment">/// Serializes this PCZT.
|
|
<a href=#84 id=84 data-nosnippet>84</a> </span><span class="kw">pub fn </span>serialize(<span class="kw-2">&</span><span class="self">self</span>) -> Vec<u8> {
|
|
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">let </span><span class="kw-2">mut </span>bytes = <span class="macro">vec!</span>[];
|
|
<a href=#86 id=86 data-nosnippet>86</a> bytes.extend_from_slice(MAGIC_BYTES);
|
|
<a href=#87 id=87 data-nosnippet>87</a> bytes.extend_from_slice(<span class="kw-2">&</span>PCZT_VERSION_1.to_le_bytes());
|
|
<a href=#88 id=88 data-nosnippet>88</a> postcard::to_extend(<span class="self">self</span>, bytes).expect(<span class="string">"can serialize into memory"</span>)
|
|
<a href=#89 id=89 data-nosnippet>89</a> }
|
|
<a href=#90 id=90 data-nosnippet>90</a>
|
|
<a href=#91 id=91 data-nosnippet>91</a> <span class="doccomment">/// Gets the effects of this transaction.
|
|
<a href=#92 id=92 data-nosnippet>92</a> </span><span class="attr">#[cfg(feature = <span class="string">"signer"</span>)]
|
|
<a href=#93 id=93 data-nosnippet>93</a> </span><span class="kw">pub fn </span>into_effects(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><TransactionData<EffectsOnly>> {
|
|
<a href=#94 id=94 data-nosnippet>94</a> <span class="kw">let </span><span class="self">Self </span>{
|
|
<a href=#95 id=95 data-nosnippet>95</a> global,
|
|
<a href=#96 id=96 data-nosnippet>96</a> transparent,
|
|
<a href=#97 id=97 data-nosnippet>97</a> sapling,
|
|
<a href=#98 id=98 data-nosnippet>98</a> orchard,
|
|
<a href=#99 id=99 data-nosnippet>99</a> } = <span class="self">self</span>;
|
|
<a href=#100 id=100 data-nosnippet>100</a>
|
|
<a href=#101 id=101 data-nosnippet>101</a> <span class="kw">let </span>transparent = transparent.into_parsed().ok()<span class="question-mark">?</span>;
|
|
<a href=#102 id=102 data-nosnippet>102</a> <span class="kw">let </span>sapling = sapling.into_parsed().ok()<span class="question-mark">?</span>;
|
|
<a href=#103 id=103 data-nosnippet>103</a> <span class="kw">let </span>orchard = orchard.into_parsed().ok()<span class="question-mark">?</span>;
|
|
<a href=#104 id=104 data-nosnippet>104</a>
|
|
<a href=#105 id=105 data-nosnippet>105</a> roles::signer::pczt_to_tx_data(<span class="kw-2">&</span>global, <span class="kw-2">&</span>transparent, <span class="kw-2">&</span>sapling, <span class="kw-2">&</span>orchard).ok()
|
|
<a href=#106 id=106 data-nosnippet>106</a> }
|
|
<a href=#107 id=107 data-nosnippet>107</a>}
|
|
<a href=#108 id=108 data-nosnippet>108</a>
|
|
<a href=#109 id=109 data-nosnippet>109</a><span class="doccomment">/// Errors that can occur while parsing a PCZT.
|
|
<a href=#110 id=110 data-nosnippet>110</a></span><span class="attr">#[derive(Debug)]
|
|
<a href=#111 id=111 data-nosnippet>111</a></span><span class="kw">pub enum </span>ParseError {
|
|
<a href=#112 id=112 data-nosnippet>112</a> <span class="doccomment">/// The bytes do not contain a PCZT.
|
|
<a href=#113 id=113 data-nosnippet>113</a> </span>NotPczt,
|
|
<a href=#114 id=114 data-nosnippet>114</a> <span class="doccomment">/// The PCZT encoding was invalid.
|
|
<a href=#115 id=115 data-nosnippet>115</a> </span>Invalid(postcard::Error),
|
|
<a href=#116 id=116 data-nosnippet>116</a> <span class="doccomment">/// The bytes are too short to contain a PCZT.
|
|
<a href=#117 id=117 data-nosnippet>117</a> </span>TooShort,
|
|
<a href=#118 id=118 data-nosnippet>118</a> <span class="doccomment">/// The PCZT has an unknown version.
|
|
<a href=#119 id=119 data-nosnippet>119</a> </span>UnknownVersion(u32),
|
|
<a href=#120 id=120 data-nosnippet>120</a>}</code></pre></div></section></main></body></html> |