mango-v4/rs/doc/src/mango_v4_client/util.rs.html

234 lines
13 KiB
HTML
Raw Normal View History

<!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 `lib/client/src/util.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>util.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../mango_v4_client/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../mango_v4_client/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../mango_v4_client/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
2023-02-11 06:48:57 -08:00
</pre><pre class="rust"><code><span class="kw">use </span>solana_client::{
client_error::Result <span class="kw">as </span>ClientResult, rpc_client::RpcClient, rpc_request::RpcError,
};
<span class="kw">use </span>solana_sdk::transaction::Transaction;
<span class="kw">use </span>solana_sdk::{
clock::Slot, commitment_config::CommitmentConfig, signature::Signature,
2023-02-11 06:48:57 -08:00
transaction::uses_durable_nonce,
};
<span class="kw">use </span>std::{thread, time};
<span class="comment">// #[allow(dead_code)]
// pub fn retry&lt;T&gt;(request: impl Fn() -&gt; Result&lt;T, anchor_client::ClientError&gt;) -&gt; anyhow::Result&lt;T&gt; {
// for _i in 0..5 {
// match request() {
// Ok(res) =&gt; return Ok(res),
// Err(err) =&gt; {
// // TODO: only retry for recoverable errors
// log::error!(&quot;{:#?}&quot;, err);
// continue;
// }
// }
// }
// Err(anyhow!(&quot;Retry failed&quot;))
// }
</span><span class="doccomment">/// Some Result&lt;&gt; types don&#39;t convert to anyhow::Result nicely. Force them through stringification.
</span><span class="kw">pub trait </span>AnyhowWrap {
<span class="kw">type </span>Value;
<span class="kw">fn </span>map_err_anyhow(<span class="self">self</span>) -&gt; anyhow::Result&lt;<span class="self">Self</span>::Value&gt;;
2023-02-11 06:48:57 -08:00
}
<span class="kw">impl</span>&lt;T, E: std::fmt::Debug&gt; AnyhowWrap <span class="kw">for </span><span class="prelude-ty">Result</span>&lt;T, E&gt; {
<span class="kw">type </span>Value = T;
<span class="kw">fn </span>map_err_anyhow(<span class="self">self</span>) -&gt; anyhow::Result&lt;<span class="self">Self</span>::Value&gt; {
<span class="self">self</span>.map_err(|err| <span class="macro">anyhow::anyhow!</span>(<span class="string">&quot;{:?}&quot;</span>, err))
}
}
<span class="doccomment">/// Push to an async_channel::Sender and ignore if the channel is full
</span><span class="kw">pub trait </span>AsyncChannelSendUnlessFull&lt;T&gt; {
<span class="doccomment">/// Send a message if the channel isn&#39;t full
</span><span class="kw">fn </span>send_unless_full(<span class="kw-2">&amp;</span><span class="self">self</span>, msg: T) -&gt; <span class="prelude-ty">Result</span>&lt;(), async_channel::SendError&lt;T&gt;&gt;;
}
<span class="kw">impl</span>&lt;T&gt; AsyncChannelSendUnlessFull&lt;T&gt; <span class="kw">for </span>async_channel::Sender&lt;T&gt; {
<span class="kw">fn </span>send_unless_full(<span class="kw-2">&amp;</span><span class="self">self</span>, msg: T) -&gt; <span class="prelude-ty">Result</span>&lt;(), async_channel::SendError&lt;T&gt;&gt; {
<span class="kw">use </span>async_channel::<span class="kw-2">*</span>;
<span class="kw">match </span><span class="self">self</span>.try_send(msg) {
<span class="prelude-val">Ok</span>(()) =&gt; <span class="prelude-val">Ok</span>(()),
<span class="prelude-val">Err</span>(TrySendError::Closed(msg)) =&gt; <span class="prelude-val">Err</span>(async_channel::SendError(msg)),
<span class="prelude-val">Err</span>(TrySendError::Full(<span class="kw">_</span>)) =&gt; <span class="prelude-val">Ok</span>(()),
}
2023-02-11 06:48:57 -08:00
}
}
<span class="doccomment">/// A copy of RpcClient::send_and_confirm_transaction that returns the slot the
/// transaction confirmed in.
</span><span class="kw">pub fn </span>send_and_confirm_transaction(
rpc_client: <span class="kw-2">&amp;</span>RpcClient,
transaction: <span class="kw-2">&amp;</span>Transaction,
) -&gt; ClientResult&lt;(Signature, Slot)&gt; {
<span class="kw">const </span>SEND_RETRIES: usize = <span class="number">1</span>;
<span class="kw">const </span>GET_STATUS_RETRIES: usize = usize::MAX;
<span class="lifetime">&#39;sending</span>: <span class="kw">for _ in </span><span class="number">0</span>..SEND_RETRIES {
<span class="kw">let </span>signature = rpc_client.send_transaction(transaction)<span class="question-mark">?</span>;
<span class="kw">let </span>recent_blockhash = <span class="kw">if </span>uses_durable_nonce(transaction).is_some() {
<span class="kw">let </span>(recent_blockhash, ..) =
rpc_client.get_latest_blockhash_with_commitment(CommitmentConfig::processed())<span class="question-mark">?</span>;
recent_blockhash
} <span class="kw">else </span>{
transaction.message.recent_blockhash
};
<span class="kw">for </span>status_retry <span class="kw">in </span><span class="number">0</span>..GET_STATUS_RETRIES {
<span class="kw">let </span>response = rpc_client.get_signature_statuses(<span class="kw-2">&amp;</span>[signature])<span class="question-mark">?</span>.value;
<span class="kw">match </span>response[<span class="number">0</span>]
.clone()
.filter(|result| result.satisfies_commitment(rpc_client.commitment()))
{
<span class="prelude-val">Some</span>(tx_status) =&gt; {
<span class="kw">return if let </span><span class="prelude-val">Some</span>(e) = tx_status.err {
<span class="prelude-val">Err</span>(e.into())
} <span class="kw">else </span>{
<span class="prelude-val">Ok</span>((signature, tx_status.slot))
};
}
<span class="prelude-val">None </span>=&gt; {
<span class="kw">if </span>!rpc_client
.is_blockhash_valid(<span class="kw-2">&amp;</span>recent_blockhash, CommitmentConfig::processed())<span class="question-mark">?
</span>{
<span class="comment">// Block hash is not found by some reason
</span><span class="kw">break </span><span class="lifetime">&#39;sending</span>;
} <span class="kw">else if </span><span class="macro">cfg!</span>(not(test))
<span class="comment">// Ignore sleep at last step.
</span>&amp;&amp; status_retry &lt; GET_STATUS_RETRIES
{
<span class="comment">// Retry twice a second
</span>thread::sleep(time::Duration::from_millis(<span class="number">500</span>));
<span class="kw">continue</span>;
}
}
}
}
}
<span class="prelude-val">Err</span>(RpcError::ForUser(
<span class="string">&quot;unable to confirm transaction. \
This can happen in situations such as transaction expiration \
and insufficient fee-payer funds&quot;
</span>.to_string(),
)
.into())
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="mango_v4_client" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0 (897e37553 2022-11-02)" ></div></body></html>