ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-28 06:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e1dae4fb62ce2d05ca34c66a26724e0568d0f75a
rippled/classripple_1_1cryptoconditions_1_1PreimageSha256.html
bthomee e7f4ae8bed deploy: afc05659ed
2025-08-19 09:49:50 -07:00

517 lines
30 KiB
HTML
Raw Blame History

<!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: ripple::cryptoconditions::PreimageSha256 Class Reference</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>
<!-- 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1cryptoconditions.html">cryptoconditions</a></li><li class="navelem"><a class="el" href="classripple_1_1cryptoconditions_1_1PreimageSha256.html">PreimageSha256</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1cryptoconditions_1_1PreimageSha256-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::cryptoconditions::PreimageSha256 Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="PreimageSha256_8h_source.html">PreimageSha256.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::cryptoconditions::PreimageSha256:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1cryptoconditions_1_1PreimageSha256__inherit__graph.png" border="0" usemap="#aripple_1_1cryptoconditions_1_1PreimageSha256_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1cryptoconditions_1_1PreimageSha256_inherit__map" id="aripple_1_1cryptoconditions_1_1PreimageSha256_inherit__map">
<area shape="rect" title=" " alt="" coords="5,93,180,133"/>
<area shape="rect" href="structripple_1_1cryptoconditions_1_1Fulfillment.html" title=" " alt="" coords="5,5,180,45"/>
<area shape="poly" title=" " alt="" coords="95,59,95,93,90,93,90,59"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::cryptoconditions::PreimageSha256:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1cryptoconditions_1_1PreimageSha256__coll__graph.png" border="0" usemap="#aripple_1_1cryptoconditions_1_1PreimageSha256_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1cryptoconditions_1_1PreimageSha256_coll__map" id="aripple_1_1cryptoconditions_1_1PreimageSha256_coll__map">
<area shape="rect" title=" " alt="" coords="167,299,342,339"/>
<area shape="rect" href="structripple_1_1cryptoconditions_1_1Fulfillment.html" title=" " alt="" coords="167,196,342,236"/>
<area shape="poly" title=" " alt="" coords="257,250,257,299,252,299,252,250"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="144,101,232,126"/>
<area shape="poly" title=" " alt="" coords="131,132,81,149,36,173,20,187,11,201,9,217,17,234,47,265,85,287,126,301,167,310,166,315,125,306,82,292,44,269,12,238,4,218,6,200,16,183,33,168,79,144,129,127"/>
<area shape="poly" title=" " alt="" coords="186,139,187,156,191,171,201,183,214,194,211,198,197,187,187,173,181,157,181,140"/>
<area shape="rect" href="classripple_1_1Buffer.html" title="Like std::vector&lt;char&gt; but better." alt="" coords="366,203,473,229"/>
<area shape="poly" title=" " alt="" coords="246,120,301,133,357,155,389,178,412,201,408,205,385,182,354,160,299,138,245,125"/>
<area shape="poly" title=" " alt="" coords="390,238,287,301,284,296,388,234"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html" title=" " alt="" coords="376,93,530,133"/>
<area shape="poly" title=" " alt="" coords="445,147,426,204,421,202,440,146"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="406,5,500,31"/>
<area shape="poly" title=" " alt="" coords="456,44,456,93,450,93,450,44"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a33fc8b3aeb76e17a2f1c6c63d7761e22" id="r_a33fc8b3aeb76e17a2f1c6c63d7761e22"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1cryptoconditions_1_1PreimageSha256.html#a33fc8b3aeb76e17a2f1c6c63d7761e22">PreimageSha256</a> (<a class="el" href="classripple_1_1Buffer.html">Buffer</a> &amp;&amp;b) noexcept</td></tr>
<tr class="separator:a33fc8b3aeb76e17a2f1c6c63d7761e22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff5ba2b2733e820bba7da7882fb036d3" id="r_aff5ba2b2733e820bba7da7882fb036d3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1cryptoconditions_1_1PreimageSha256.html#aff5ba2b2733e820bba7da7882fb036d3">PreimageSha256</a> (<a class="el" href="classripple_1_1Slice.html">Slice</a> s) noexcept</td></tr>
<tr class="separator:aff5ba2b2733e820bba7da7882fb036d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac16287043405acdbeb79c5c501bb1ff1" id="r_ac16287043405acdbeb79c5c501bb1ff1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple_1_1cryptoconditions.html#aa3107e15003c13674a275abb96856ccd">Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1cryptoconditions_1_1PreimageSha256.html#ac16287043405acdbeb79c5c501bb1ff1">type</a> () const override</td></tr>
<tr class="memdesc:ac16287043405acdbeb79c5c501bb1ff1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type of this condition. <br /></td></tr>
<tr class="separator:ac16287043405acdbeb79c5c501bb1ff1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32a6bdb571dd1145d85d88b91a5f682a" id="r_a32a6bdb571dd1145d85d88b91a5f682a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Buffer.html">Buffer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1cryptoconditions_1_1PreimageSha256.html#a32a6bdb571dd1145d85d88b91a5f682a">fingerprint</a> () const override</td></tr>
<tr class="memdesc:a32a6bdb571dd1145d85d88b91a5f682a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the fulfillment's fingerprint: <br /></td></tr>
<tr class="separator:a32a6bdb571dd1145d85d88b91a5f682a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae123cad97af124620811e003c84594b4" id="r_ae123cad97af124620811e003c84594b4"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1cryptoconditions_1_1PreimageSha256.html#ae123cad97af124620811e003c84594b4">cost</a> () const override</td></tr>
<tr class="memdesc:ae123cad97af124620811e003c84594b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the cost associated with this fulfillment. <br /></td></tr>
<tr class="separator:ae123cad97af124620811e003c84594b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87fc55bbedc439c4f10ca9675eee37b5" id="r_a87fc55bbedc439c4f10ca9675eee37b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1cryptoconditions_1_1Condition.html">Condition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1cryptoconditions_1_1PreimageSha256.html#a87fc55bbedc439c4f10ca9675eee37b5">condition</a> () const override</td></tr>
<tr class="memdesc:a87fc55bbedc439c4f10ca9675eee37b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the condition associated with the given fulfillment. <br /></td></tr>
<tr class="separator:a87fc55bbedc439c4f10ca9675eee37b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06d9ff9c6ad66a7a53b91c6bd5aa75f2" id="r_a06d9ff9c6ad66a7a53b91c6bd5aa75f2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1cryptoconditions_1_1PreimageSha256.html#a06d9ff9c6ad66a7a53b91c6bd5aa75f2">validate</a> (<a class="el" href="classripple_1_1Slice.html">Slice</a>) const override</td></tr>
<tr class="memdesc:a06d9ff9c6ad66a7a53b91c6bd5aa75f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Validates a fulfillment. <br /></td></tr>
<tr class="separator:a06d9ff9c6ad66a7a53b91c6bd5aa75f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ade137b93c9e4daab7b64d57655c1d9ec" id="r_ade137b93c9e4daab7b64d57655c1d9ec"><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="el" href="structripple_1_1cryptoconditions_1_1Fulfillment.html">Fulfillment</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1cryptoconditions_1_1PreimageSha256.html#ade137b93c9e4daab7b64d57655c1d9ec">deserialize</a> (<a class="el" href="classripple_1_1Slice.html">Slice</a> s, <a class="elRef" href="http://en.cppreference.com/w/cpp/error/error_code.html">std::error_code</a> &amp;ec)</td></tr>
<tr class="memdesc:ade137b93c9e4daab7b64d57655c1d9ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse the payload for a <a class="el" href="classripple_1_1cryptoconditions_1_1PreimageSha256.html">PreimageSha256</a> condition. <br /></td></tr>
<tr class="separator:ade137b93c9e4daab7b64d57655c1d9ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a62cb7844ba6809e8d2c47178245c993d" id="r_a62cb7844ba6809e8d2c47178245c993d"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1cryptoconditions_1_1PreimageSha256.html#a62cb7844ba6809e8d2c47178245c993d">maxPreimageLength</a> = 128</td></tr>
<tr class="memdesc:a62cb7844ba6809e8d2c47178245c993d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum allowed length of a preimage. <br /></td></tr>
<tr class="separator:a62cb7844ba6809e8d2c47178245c993d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88f1cd77d14691539f91ef7a501fc1f3" id="r_a88f1cd77d14691539f91ef7a501fc1f3"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1cryptoconditions_1_1Fulfillment.html#a88f1cd77d14691539f91ef7a501fc1f3">maxSerializedFulfillment</a> = 256</td></tr>
<tr class="memdesc:a88f1cd77d14691539f91ef7a501fc1f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The largest binary fulfillment we support. <br /></td></tr>
<tr class="separator:a88f1cd77d14691539f91ef7a501fc1f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a1d8265482964990db39196b535558a29" id="r_a1d8265482964990db39196b535558a29"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Buffer.html">Buffer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1cryptoconditions_1_1PreimageSha256.html#a1d8265482964990db39196b535558a29">payload_</a></td></tr>
<tr class="separator:a1d8265482964990db39196b535558a29"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="PreimageSha256_8h_source.html#l00036">36</a> of file <a class="el" href="PreimageSha256_8h_source.html">PreimageSha256.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a33fc8b3aeb76e17a2f1c6c63d7761e22" name="a33fc8b3aeb76e17a2f1c6c63d7761e22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33fc8b3aeb76e17a2f1c6c63d7761e22">&#9670;&#160;</a></span>PreimageSha256() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::cryptoconditions::PreimageSha256::PreimageSha256 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Buffer.html">Buffer</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>b</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="PreimageSha256_8h_source.html#l00107">107</a> of file <a class="el" href="PreimageSha256_8h_source.html">PreimageSha256.h</a>.</p>
</div>
</div>
<a id="aff5ba2b2733e820bba7da7882fb036d3" name="aff5ba2b2733e820bba7da7882fb036d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff5ba2b2733e820bba7da7882fb036d3">&#9670;&#160;</a></span>PreimageSha256() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::cryptoconditions::PreimageSha256::PreimageSha256 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Slice.html">Slice</a>&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="PreimageSha256_8h_source.html#l00111">111</a> of file <a class="el" href="PreimageSha256_8h_source.html">PreimageSha256.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ade137b93c9e4daab7b64d57655c1d9ec" name="ade137b93c9e4daab7b64d57655c1d9ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade137b93c9e4daab7b64d57655c1d9ec">&#9670;&#160;</a></span>deserialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="el" href="structripple_1_1cryptoconditions_1_1Fulfillment.html">Fulfillment</a> &gt; ripple::cryptoconditions::PreimageSha256::deserialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Slice.html">Slice</a>&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/error/error_code.html">std::error_code</a> &amp;&#160;</td>
<td class="paramname"><em>ec</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse the payload for a <a class="el" href="classripple_1_1cryptoconditions_1_1PreimageSha256.html">PreimageSha256</a> condition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>A slice containing the DER encoded payload </td></tr>
<tr><td class="paramname">ec</td><td>indicates success or failure of the operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the preimage, if successful; empty pointer otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="PreimageSha256_8h_source.html#l00057">57</a> of file <a class="el" href="PreimageSha256_8h_source.html">PreimageSha256.h</a>.</p>
</div>
</div>
<a id="ac16287043405acdbeb79c5c501bb1ff1" name="ac16287043405acdbeb79c5c501bb1ff1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac16287043405acdbeb79c5c501bb1ff1">&#9670;&#160;</a></span>type()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple_1_1cryptoconditions.html#aa3107e15003c13674a275abb96856ccd">Type</a> ripple::cryptoconditions::PreimageSha256::type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the type of this condition. </p>
<p>Implements <a class="el" href="structripple_1_1cryptoconditions_1_1Fulfillment.html#a2428ca1b532098a302b65a1bf5e8583c">ripple::cryptoconditions::Fulfillment</a>.</p>
<p class="definition">Definition at line <a class="el" href="PreimageSha256_8h_source.html#l00116">116</a> of file <a class="el" href="PreimageSha256_8h_source.html">PreimageSha256.h</a>.</p>
</div>
</div>
<a id="a32a6bdb571dd1145d85d88b91a5f682a" name="a32a6bdb571dd1145d85d88b91a5f682a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32a6bdb571dd1145d85d88b91a5f682a">&#9670;&#160;</a></span>fingerprint()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Buffer.html">Buffer</a> ripple::cryptoconditions::PreimageSha256::fingerprint </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the fulfillment's fingerprint: </p>
<p>The fingerprint is an octet string uniquely representing this fulfillment's condition with respect to other conditions of the same type. </p>
<p>Implements <a class="el" href="structripple_1_1cryptoconditions_1_1Fulfillment.html#ad684947e5ed39d6d75ec6916d783e270">ripple::cryptoconditions::Fulfillment</a>.</p>
<p class="definition">Definition at line <a class="el" href="PreimageSha256_8h_source.html#l00122">122</a> of file <a class="el" href="PreimageSha256_8h_source.html">PreimageSha256.h</a>.</p>
</div>
</div>
<a id="ae123cad97af124620811e003c84594b4" name="ae123cad97af124620811e003c84594b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae123cad97af124620811e003c84594b4">&#9670;&#160;</a></span>cost()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ripple::cryptoconditions::PreimageSha256::cost </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculates the cost associated with this fulfillment. </p>
<ul>
<li>The cost function is deterministic and depends on the type and properties of the condition and the fulfillment that the condition is generated from. </li>
</ul>
<p>Implements <a class="el" href="structripple_1_1cryptoconditions_1_1Fulfillment.html#a8852eb8fce1a48d3ca774066fe9b4ccb">ripple::cryptoconditions::Fulfillment</a>.</p>
<p class="definition">Definition at line <a class="el" href="PreimageSha256_8h_source.html#l00131">131</a> of file <a class="el" href="PreimageSha256_8h_source.html">PreimageSha256.h</a>.</p>
</div>
</div>
<a id="a87fc55bbedc439c4f10ca9675eee37b5" name="a87fc55bbedc439c4f10ca9675eee37b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87fc55bbedc439c4f10ca9675eee37b5">&#9670;&#160;</a></span>condition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1cryptoconditions_1_1Condition.html">Condition</a> ripple::cryptoconditions::PreimageSha256::condition </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the condition associated with the given fulfillment. </p>
<p>This process is completely deterministic. All implementations will, if compliant, produce the identical condition for the same fulfillment. </p>
<p>Implements <a class="el" href="structripple_1_1cryptoconditions_1_1Fulfillment.html#ad5db6505a78cb1f16e465576d579e369">ripple::cryptoconditions::Fulfillment</a>.</p>
<p class="definition">Definition at line <a class="el" href="PreimageSha256_8h_source.html#l00137">137</a> of file <a class="el" href="PreimageSha256_8h_source.html">PreimageSha256.h</a>.</p>
</div>
</div>
<a id="a06d9ff9c6ad66a7a53b91c6bd5aa75f2" name="a06d9ff9c6ad66a7a53b91c6bd5aa75f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06d9ff9c6ad66a7a53b91c6bd5aa75f2">&#9670;&#160;</a></span>validate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ripple::cryptoconditions::PreimageSha256::validate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Slice.html">Slice</a>&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Validates a fulfillment. </p>
<p>Implements <a class="el" href="structripple_1_1cryptoconditions_1_1Fulfillment.html#a7a671d3eaa064536a29f9db7ad8df9ec">ripple::cryptoconditions::Fulfillment</a>.</p>
<p class="definition">Definition at line <a class="el" href="PreimageSha256_8h_source.html#l00143">143</a> of file <a class="el" href="PreimageSha256_8h_source.html">PreimageSha256.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a62cb7844ba6809e8d2c47178245c993d" name="a62cb7844ba6809e8d2c47178245c993d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62cb7844ba6809e8d2c47178245c993d">&#9670;&#160;</a></span>maxPreimageLength</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ripple::cryptoconditions::PreimageSha256::maxPreimageLength = 128</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum allowed length of a preimage. </p>
<p>The specification does not specify a minimum supported length, nor does it require all conditions to support the same minimum length.</p>
<p>While future versions of this code will never lower this limit, they may opt to raise it. </p>
<p class="definition">Definition at line <a class="el" href="PreimageSha256_8h_source.html#l00048">48</a> of file <a class="el" href="PreimageSha256_8h_source.html">PreimageSha256.h</a>.</p>
</div>
</div>
<a id="a1d8265482964990db39196b535558a29" name="a1d8265482964990db39196b535558a29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d8265482964990db39196b535558a29">&#9670;&#160;</a></span>payload_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Buffer.html">Buffer</a> ripple::cryptoconditions::PreimageSha256::payload_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="PreimageSha256_8h_source.html#l00104">104</a> of file <a class="el" href="PreimageSha256_8h_source.html">PreimageSha256.h</a>.</p>
</div>
</div>
<a id="a88f1cd77d14691539f91ef7a501fc1f3" name="a88f1cd77d14691539f91ef7a501fc1f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88f1cd77d14691539f91ef7a501fc1f3">&#9670;&#160;</a></span>maxSerializedFulfillment</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ripple::cryptoconditions::Fulfillment::maxSerializedFulfillment = 256</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The largest binary fulfillment we support. </p>
<dl class="section note"><dt>Note</dt><dd>This value will be increased in the future, but it must never decrease, as that could cause fulfillments that were previously considered valid to no longer be allowed. </dd></dl>
<p class="definition">Definition at line <a class="el" href="Fulfillment_8h_source.html#l00041">41</a> of file <a class="el" href="Fulfillment_8h_source.html">Fulfillment.h</a>.</p>
</div>
</div>
</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>
Reference in New Issue View Git Blame Copy Permalink