This commit is contained in:
bthomee
2025-11-04 00:36:48 -08:00
parent 691c2d46b0
commit 33451fdc96
3033 changed files with 499624 additions and 524738 deletions

View File

@@ -81,60 +81,41 @@ $(document).ready(function() { init_codefold(0); });
<div class="headertitle"><div class="title">NFTokenOfferID.h</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="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2023 Ripple Labs Inc.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef XRPL_PROTOCOL_NFTOKENOFFERID_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define XRPL_PROTOCOL_NFTOKENOFFERID_H_INCLUDED</span></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="preprocessor">#include &lt;xrpl/basics/base_uint.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;xrpl/json/json_forwards.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;xrpl/protocol/STTx.h&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include &lt;xrpl/protocol/TxMeta.h&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</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="l00029" name="l00029"></a><span class="lineno"> 29</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="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="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><a class="code hl_function" href="namespaceripple.html#a24dd77739d6bb105b5085085045d1d6a">canHaveNFTokenOfferID</a>(</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</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="l00043" name="l00043"></a><span class="lineno"> 43</span> TxMeta <span class="keyword">const</span>&amp; transactionMeta);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</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="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><a class="code hl_function" href="namespaceripple.html#a3f2b6c339d7a055fc42b03203fded223">getOfferIDFromCreatedOffer</a>(TxMeta <span class="keyword">const</span>&amp; transactionMeta);</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><a class="code hl_function" href="namespaceripple.html#abe13b230c8e49e3dc65f75709923abdb">insertNFTokenOfferID</a>(</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a>&amp; response,</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</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="l00052" name="l00052"></a><span class="lineno"> 52</span> TxMeta <span class="keyword">const</span>&amp; transactionMeta);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="preprocessor">#endif</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#l00148">json_value.h:149</a></div></div>
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_PROTOCOL_NFTOKENOFFERID_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_PROTOCOL_NFTOKENOFFERID_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpl/basics/base_uint.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpl/json/json_forwards.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/STTx.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/TxMeta.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</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="l00010" name="l00010"></a><span class="lineno"> 10</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="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><a class="code hl_function" href="namespaceripple.html#a24dd77739d6bb105b5085085045d1d6a">canHaveNFTokenOfferID</a>(</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</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="l00024" name="l00024"></a><span class="lineno"> 24</span> TxMeta <span class="keyword">const</span>&amp; transactionMeta);</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_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;uint256&gt;</a></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><a class="code hl_function" href="namespaceripple.html#a3f2b6c339d7a055fc42b03203fded223">getOfferIDFromCreatedOffer</a>(TxMeta <span class="keyword">const</span>&amp; transactionMeta);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><a class="code hl_function" href="namespaceripple.html#abe13b230c8e49e3dc65f75709923abdb">insertNFTokenOfferID</a>(</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a>&amp; response,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</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="l00033" name="l00033"></a><span class="lineno"> 33</span> TxMeta <span class="keyword">const</span>&amp; transactionMeta);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>} <span class="comment">// namespace ripple</span></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><span class="preprocessor">#endif</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#l00129">json_value.h:130</a></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#l00025">algorithm.h:25</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#l00038">NFTokenOfferID.cpp: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#l00058">NFTokenOfferID.cpp:58</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#l00072">NFTokenOfferID.cpp:72</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_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_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="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><!-- fragment --></div><!-- contents -->