Files
rippled/NFTokenOfferID_8cpp_source.html
2025-11-10 09:36:27 -08:00

182 lines
21 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: NFTokenOfferID.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_90ffdbabf412cfdffe6b2193e0ce938a.html">libxrpl</a></li><li class="navelem"><a class="el" href="dir_4cb643486f27a568a0d40f174f670f35.html">protocol</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">NFTokenOfferID.cpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#include &lt;xrpl/basics/base_uint.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &lt;xrpl/json/json_value.h&gt;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;xrpl/protocol/LedgerFormats.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpl/protocol/NFTokenOfferID.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpl/protocol/SField.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;xrpl/protocol/STObject.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;xrpl/protocol/STTx.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;xrpl/protocol/TER.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;xrpl/protocol/TxFormats.h&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;xrpl/protocol/TxMeta.h&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;xrpl/protocol/jss.h&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a>&gt;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a>&gt;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00019" data-start="{" data-end="}">
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="namespaceripple.html#a24dd77739d6bb105b5085085045d1d6a"> 19</a></span><a class="code hl_function" href="namespaceripple.html#a24dd77739d6bb105b5085085045d1d6a">canHaveNFTokenOfferID</a>(</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;STTx const&gt;</a> <span class="keyword">const</span>&amp; serializedTx,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_class" href="classripple_1_1TxMeta.html">TxMeta</a> <span class="keyword">const</span>&amp; transactionMeta)</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span>{</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordflow">if</span> (!serializedTx)</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_enumeration" href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126">TxType</a> <span class="keyword">const</span> tt = serializedTx-&gt;getTxnType();</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordflow">if</span> (!(tt == ttNFTOKEN_MINT &amp;&amp; serializedTx-&gt;isFieldPresent(sfAmount)) &amp;&amp;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> tt != ttNFTOKEN_CREATE_OFFER)</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// if the transaction failed nothing could have been delivered.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordflow">if</span> (transactionMeta.<a class="code hl_function" href="classripple_1_1TxMeta.html#aa5fff1a8fd590ce06ae81e8cd92f092f">getResultTER</a>() != <a class="code hl_enumvalue" href="namespaceripple.html#aabc7f150d5082c73116a1cd5962b434da28c7d8b3ed759d363503a05fcd59f151">tesSUCCESS</a>)</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>}</div>
</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;uint256&gt;</a></div>
<div class="foldopen" id="foldopen00039" data-start="{" data-end="}">
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="namespaceripple.html#a3f2b6c339d7a055fc42b03203fded223"> 39</a></span><a class="code hl_function" href="namespaceripple.html#a3f2b6c339d7a055fc42b03203fded223">getOfferIDFromCreatedOffer</a>(<a class="code hl_class" href="classripple_1_1TxMeta.html">TxMeta</a> <span class="keyword">const</span>&amp; transactionMeta)</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>{</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordflow">for</span> (<a class="code hl_class" href="classripple_1_1STObject.html">STObject</a> <span class="keyword">const</span>&amp; node : transactionMeta.<a class="code hl_function" href="classripple_1_1TxMeta.html#a3e51ec1843d8554793db386ec61e2ada">getNodes</a>())</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> {</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordflow">if</span> (node.getFieldU16(sfLedgerEntryType) != ltNFTOKEN_OFFER ||</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> node.getFName() != sfCreatedNode)</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordflow">continue</span>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordflow">return</span> node.getFieldH256(sfLedgerIndex);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> }</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordflow">return</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::nullopt</a>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>}</div>
</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00053" data-start="{" data-end="}">
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="namespaceripple.html#abe13b230c8e49e3dc65f75709923abdb"> 53</a></span><a class="code hl_function" href="namespaceripple.html#abe13b230c8e49e3dc65f75709923abdb">insertNFTokenOfferID</a>(</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a>&amp; response,</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;STTx const&gt;</a> <span class="keyword">const</span>&amp; transaction,</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <a class="code hl_class" href="classripple_1_1TxMeta.html">TxMeta</a> <span class="keyword">const</span>&amp; transactionMeta)</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>{</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordflow">if</span> (!<a class="code hl_function" href="namespaceripple.html#a24dd77739d6bb105b5085085045d1d6a">canHaveNFTokenOfferID</a>(transaction, transactionMeta))</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;uint256&gt;</a> result = <a class="code hl_function" href="namespaceripple.html#a3f2b6c339d7a055fc42b03203fded223">getOfferIDFromCreatedOffer</a>(transactionMeta);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordflow">if</span> (result.<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/utility/optional/operator_bool.html">has_value</a>())</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> response[jss::offer_id] = <a class="code hl_function" href="namespaceripple.html#ac124fe6744b7fe887dec949b56b16d50">to_string</a>(result.<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/utility/optional/value.html">value</a>());</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span>}</div>
</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span>} <span class="comment">// namespace ripple</span></div>
<div class="ttc" id="aclassJson_1_1Value_html"><div class="ttname"><a href="classJson_1_1Value.html">Json::Value</a></div><div class="ttdoc">Represents a JSON value.</div><div class="ttdef"><b>Definition</b> <a href="json__value_8h_source.html#l00130">json_value.h:131</a></div></div>
<div class="ttc" id="aclassripple_1_1STObject_html"><div class="ttname"><a href="classripple_1_1STObject.html">ripple::STObject</a></div><div class="ttdef"><b>Definition</b> <a href="STObject_8h_source.html#l00037">STObject.h:38</a></div></div>
<div class="ttc" id="aclassripple_1_1TxMeta_html"><div class="ttname"><a href="classripple_1_1TxMeta.html">ripple::TxMeta</a></div><div class="ttdef"><b>Definition</b> <a href="TxMeta_8h_source.html#l00015">TxMeta.h:16</a></div></div>
<div class="ttc" id="aclassripple_1_1TxMeta_html_a3e51ec1843d8554793db386ec61e2ada"><div class="ttname"><a href="classripple_1_1TxMeta.html#a3e51ec1843d8554793db386ec61e2ada">ripple::TxMeta::getNodes</a></div><div class="ttdeci">STArray &amp; getNodes()</div><div class="ttdef"><b>Definition</b> <a href="TxMeta_8h_source.html#l00070">TxMeta.h:70</a></div></div>
<div class="ttc" id="aclassripple_1_1TxMeta_html_aa5fff1a8fd590ce06ae81e8cd92f092f"><div class="ttname"><a href="classripple_1_1TxMeta.html#aa5fff1a8fd590ce06ae81e8cd92f092f">ripple::TxMeta::getResultTER</a></div><div class="ttdeci">TER getResultTER() const</div><div class="ttdef"><b>Definition</b> <a href="TxMeta_8h_source.html#l00038">TxMeta.h:38</a></div></div>
<div class="ttc" id="ais_same_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a></div><div class="ttdeci">T is_same_v</div></div>
<div class="ttc" id="amemory_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespaceripple_html_a24dd77739d6bb105b5085085045d1d6a"><div class="ttname"><a href="namespaceripple.html#a24dd77739d6bb105b5085085045d1d6a">ripple::canHaveNFTokenOfferID</a></div><div class="ttdeci">bool canHaveNFTokenOfferID(std::shared_ptr&lt; STTx const &gt; const &amp;serializedTx, TxMeta const &amp;transactionMeta)</div><div class="ttdoc">Add an offer_id field to the meta output parameter.</div><div class="ttdef"><b>Definition</b> <a href="NFTokenOfferID_8cpp_source.html#l00019">NFTokenOfferID.cpp:19</a></div></div>
<div class="ttc" id="anamespaceripple_html_a2ce3074a39ea65126b82fc59baf43126"><div class="ttname"><a href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126">ripple::TxType</a></div><div class="ttdeci">TxType</div><div class="ttdoc">Transaction type identifiers.</div><div class="ttdef"><b>Definition</b> <a href="TxFormats_8h_source.html#l00037">TxFormats.h:38</a></div></div>
<div class="ttc" id="anamespaceripple_html_a3f2b6c339d7a055fc42b03203fded223"><div class="ttname"><a href="namespaceripple.html#a3f2b6c339d7a055fc42b03203fded223">ripple::getOfferIDFromCreatedOffer</a></div><div class="ttdeci">std::optional&lt; uint256 &gt; getOfferIDFromCreatedOffer(TxMeta const &amp;transactionMeta)</div><div class="ttdef"><b>Definition</b> <a href="NFTokenOfferID_8cpp_source.html#l00039">NFTokenOfferID.cpp:39</a></div></div>
<div class="ttc" id="anamespaceripple_html_aabc7f150d5082c73116a1cd5962b434da28c7d8b3ed759d363503a05fcd59f151"><div class="ttname"><a href="namespaceripple.html#aabc7f150d5082c73116a1cd5962b434da28c7d8b3ed759d363503a05fcd59f151">ripple::tesSUCCESS</a></div><div class="ttdeci">@ tesSUCCESS</div><div class="ttdef"><b>Definition</b> <a href="TER_8h_source.html#l00227">TER.h:226</a></div></div>
<div class="ttc" id="anamespaceripple_html_abe13b230c8e49e3dc65f75709923abdb"><div class="ttname"><a href="namespaceripple.html#abe13b230c8e49e3dc65f75709923abdb">ripple::insertNFTokenOfferID</a></div><div class="ttdeci">void insertNFTokenOfferID(Json::Value &amp;response, std::shared_ptr&lt; STTx const &gt; const &amp;transaction, TxMeta const &amp;transactionMeta)</div><div class="ttdef"><b>Definition</b> <a href="NFTokenOfferID_8cpp_source.html#l00053">NFTokenOfferID.cpp:53</a></div></div>
<div class="ttc" id="anamespaceripple_html_ac124fe6744b7fe887dec949b56b16d50"><div class="ttname"><a href="namespaceripple.html#ac124fe6744b7fe887dec949b56b16d50">ripple::to_string</a></div><div class="ttdeci">std::string to_string(base_uint&lt; Bits, Tag &gt; const &amp;a)</div><div class="ttdef"><b>Definition</b> <a href="base__uint_8h_source.html#l00611">base_uint.h:611</a></div></div>
<div class="ttc" id="aoperator_bool_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/optional/operator_bool.html">std::optional::has_value</a></div><div class="ttdeci">T has_value(T... args)</div></div>
<div class="ttc" id="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a></div></div>
<div class="ttc" id="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a></div></div>
<div class="ttc" id="avalue_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/optional/value.html">std::optional::value</a></div><div class="ttdeci">T value(T... args)</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>