37 lines
6.7 KiB
HTML
37 lines
6.7 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="The Anchor codegen exposes a programming model where a user defines a set of methods inside of a `#[program]` module in a way similar to writing RPC request handlers. The macro then generates a bunch of code wrapping these user defined methods into something that can be executed on Solana."><title>entry in mango_v4 - 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-ba5701c5741a7b69.css" id="mainThemeStyle"><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.70.0 (90c541806 2023-05-31)" data-search-js="search-e077946657036a58.js" data-settings-js="settings-298e1ea74db45b39.js" data-settings-css="settings-7bfb4c59cc6bc502.css" data-theme-light-css="light-0f8c037637f9eb3e.css" data-theme-dark-css="dark-1097f8e92a01e3cf.css" data-theme-ayu-css="ayu-614652228113ac93.css" ></div><script src="../static.files/storage-62ce34ea385b278a.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-f61008743c98d196.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../static.files/light-0f8c037637f9eb3e.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../static.files/dark-1097f8e92a01e3cf.css"><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 fn"><!--[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">☰</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><div class="sidebar-elems"><h2><a href="index.html">In mango_v4</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>Function <a href="index.html">mango_v4</a>::<wbr><a class="fn" href="#">entry</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/lib.rs.html#44">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn entry(
|
||
program_id: &Pubkey,
|
||
accounts: &[AccountInfo<'_>],
|
||
data: &[<a class="primitive" href="https://doc.rust-lang.org/1.70.0/std/primitive.u8.html">u8</a>]
|
||
) -> ProgramResult</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The Anchor codegen exposes a programming model where a user defines
|
||
a set of methods inside of a <code>#[program]</code> module in a way similar
|
||
to writing RPC request handlers. The macro then generates a bunch of
|
||
code wrapping these user defined methods into something that can be
|
||
executed on Solana.</p>
|
||
<p>These methods fall into one categorie for now.</p>
|
||
<p>Global methods - regular methods inside of the <code>#[program]</code>.</p>
|
||
<p>Care must be taken by the codegen to prevent collisions between
|
||
methods in these different namespaces. For this reason, Anchor uses
|
||
a variant of sighash to perform method dispatch, rather than
|
||
something like a simple enum variant discriminator.</p>
|
||
<p>The execution flow of the generated code can be roughly outlined:</p>
|
||
<ul>
|
||
<li>Start program via the entrypoint.</li>
|
||
<li>Strip method identifier off the first 8 bytes of the instruction
|
||
data and invoke the identified method. The method identifier
|
||
is a variant of sighash. See docs.rs for <code>anchor_lang</code> for details.</li>
|
||
<li>If the method identifier is an IDL identifier, execute the IDL
|
||
instructions, which are a special set of hardcoded instructions
|
||
baked into every Anchor program. Then exit.</li>
|
||
<li>Otherwise, the method identifier is for a user defined
|
||
instruction, i.e., one of the methods in the user defined
|
||
<code>#[program]</code> module. Perform method dispatch, i.e., execute the
|
||
big match statement mapping method identifier to method handler
|
||
wrapper.</li>
|
||
<li>Run the method handler wrapper. This wraps the code the user
|
||
actually wrote, deserializing the accounts, constructing the
|
||
context, invoking the user’s code, and finally running the exit
|
||
routine, which typically persists account changes.</li>
|
||
</ul>
|
||
<p>The <code>entry</code> function here, defines the standard entry to a Solana
|
||
program, where execution begins.</p>
|
||
</div></details></section></div></main></body></html> |