blockworks-foundation
/
mango-v4
mirror of https://github.com/blockworks-foundation/mango-v4.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
mango-v4/rs/doc/mango_v4/health/trait.AccountRetriever.html

45 lines
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="This trait abstracts how to find accounts needed for the health computation."><title>AccountRetriever in mango_v4::health - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-c4dbdcde0fbd8430.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-db279b6232be9c13.css"><link rel="stylesheet" disabled href="../../static.files/dark-cf923f49f397b216.css"><link rel="stylesheet" disabled href="../../static.files/ayu-be46fdc453a55015.css"><script src="../../static.files/storage-3891ce972e3a2bf8.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-98a684e84ae5b08b.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc trait"><!--[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="logo-container" href="../../mango_v4/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../../mango_v4/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">AccountRetriever</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.bank_and_oracle">bank_and_oracle</a></li><li><a href="#tymethod.perp_market_and_oracle_price">perp_market_and_oracle_price</a></li><li><a href="#tymethod.serum_oo">serum_oo</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In mango_v4::health</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../index.html">mango_v4</a>::<wbr><a href="index.html">health</a>::<wbr><a class="trait" href="#">AccountRetriever</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/mango_v4/health/account_retriever.rs.html#25-41">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait AccountRetriever {
// Required methods
fn <a href="#tymethod.bank_and_oracle" class="fn">bank_and_oracle</a>(
&amp;self,
group: &amp;Pubkey,
active_token_position_index: <a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.usize.html">usize</a>,
token_index: <a class="type" href="../state/type.TokenIndex.html" title="type mango_v4::state::TokenIndex">TokenIndex</a>
) -&gt; Result&lt;(&amp;<a class="struct" href="../state/struct.Bank.html" title="struct mango_v4::state::Bank">Bank</a>, <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>)&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.serum_oo" class="fn">serum_oo</a>(
&amp;self,
active_serum_oo_index: <a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.usize.html">usize</a>,
key: &amp;Pubkey
) -&gt; Result&lt;&amp;OpenOrders&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.perp_market_and_oracle_price" class="fn">perp_market_and_oracle_price</a>(
&amp;self,
group: &amp;Pubkey,
active_perp_position_index: <a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.usize.html">usize</a>,
perp_market_index: <a class="type" href="../state/type.PerpMarketIndex.html" title="type mango_v4::state::PerpMarketIndex">PerpMarketIndex</a>
) -&gt; Result&lt;(&amp;<a class="struct" href="../state/struct.PerpMarket.html" title="struct mango_v4::state::PerpMarket">PerpMarket</a>, <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>)&gt;;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This trait abstracts how to find accounts needed for the health computation.</p>
<p>There are different ways they are retrieved from remainingAccounts, based
on the instruction:</p>
<ul>
<li>FixedOrderAccountRetriever requires the remainingAccounts to be in a well
defined order and is the fastest. It’s used where possible.</li>
<li>ScanningAccountRetriever does a linear scan for each account it needs.
It needs more compute, but works when a union of bank/oracle/market accounts
are passed because health needs to be computed for different baskets in
one instruction (such as for liquidation instructions).</li>
</ul>
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.bank_and_oracle" class="method"><a class="srclink rightside" href="../../src/mango_v4/health/account_retriever.rs.html#26-31">source</a><h4 class="code-header">fn <a href="#tymethod.bank_and_oracle" class="fn">bank_and_oracle</a>(
&amp;self,
group: &amp;Pubkey,
active_token_position_index: <a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.usize.html">usize</a>,
token_index: <a class="type" href="../state/type.TokenIndex.html" title="type mango_v4::state::TokenIndex">TokenIndex</a>
) -&gt; Result&lt;(&amp;<a class="struct" href="../state/struct.Bank.html" title="struct mango_v4::state::Bank">Bank</a>, <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>)&gt;</h4></section><section id="tymethod.serum_oo" class="method"><a class="srclink rightside" href="../../src/mango_v4/health/account_retriever.rs.html#33">source</a><h4 class="code-header">fn <a href="#tymethod.serum_oo" class="fn">serum_oo</a>(
&amp;self,
active_serum_oo_index: <a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.usize.html">usize</a>,
key: &amp;Pubkey
) -&gt; Result&lt;&amp;OpenOrders&gt;</h4></section><section id="tymethod.perp_market_and_oracle_price" class="method"><a class="srclink rightside" href="../../src/mango_v4/health/account_retriever.rs.html#35-40">source</a><h4 class="code-header">fn <a href="#tymethod.perp_market_and_oracle_price" class="fn">perp_market_and_oracle_price</a>(
&amp;self,
group: &amp;Pubkey,
active_perp_position_index: <a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.usize.html">usize</a>,
perp_market_index: <a class="type" href="../state/type.PerpMarketIndex.html" title="type mango_v4::state::PerpMarketIndex">PerpMarketIndex</a>
) -&gt; Result&lt;(&amp;<a class="struct" href="../state/struct.PerpMarket.html" title="struct mango_v4::state::PerpMarket">PerpMarket</a>, <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>)&gt;</h4></section></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-AccountRetriever-for-ScanningAccountRetriever%3C'a,+'info%3E" class="impl"><a class="srclink rightside" href="../../src/mango_v4/health/account_retriever.rs.html#390-412">source</a><a href="#impl-AccountRetriever-for-ScanningAccountRetriever%3C'a,+'info%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, 'info&gt; <a class="trait" href="trait.AccountRetriever.html" title="trait mango_v4::health::AccountRetriever">AccountRetriever</a> for <a class="struct" href="struct.ScanningAccountRetriever.html" title="struct mango_v4::health::ScanningAccountRetriever">ScanningAccountRetriever</a>&lt;'a, 'info&gt;</h3></section><section id="impl-AccountRetriever-for-FixedOrderAccountRetriever%3CT%3E" class="impl"><a class="srclink rightside" href="../../src/mango_v4/health/account_retriever.rs.html#117-194">source</a><a href="#impl-AccountRetriever-for-FixedOrderAccountRetriever%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T: <a class="trait" href="../accounts_zerocopy/trait.KeyedAccountReader.html" title="trait mango_v4::accounts_zerocopy::KeyedAccountReader">KeyedAccountReader</a>&gt; <a class="trait" href="trait.AccountRetriever.html" title="trait mango_v4::health::AccountRetriever">AccountRetriever</a> for <a class="struct" href="struct.FixedOrderAccountRetriever.html" title="struct mango_v4::health::FixedOrderAccountRetriever">FixedOrderAccountRetriever</a>&lt;T&gt;</h3></section></div><script src="../../implementors/mango_v4/health/account_retriever/trait.AccountRetriever.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mango_v4" data-themes="" data-resource-suffix="" data-rustdoc-version="1.69.0 (84c898d65 2023-04-16)" data-search-js="search-8a59a8356673ec1f.js" data-settings-js="settings-f0c5c39777a9a2f6.js" data-settings-css="settings-0bcba95ff279c1db.css" ></div></body></html>
Reference in New Issue View Git Blame Copy Permalink