gulliver/oc-mint
0
0
Fork 0
mirror of https://github.com/OpenCoin/oc-mint-cpp.git synced 2024-12-22 07:39:40 +01:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
oc-mint/structCDD.html

223 lines
14 KiB
HTML
Raw Permalink 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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>oc-issuer: CDD Struct 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">oc-issuer
&#160;<span id="projectnumber">0.0.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structCDD-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CDD Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>currency description document
<a href="structCDD.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="model_8hpp_source.html">model.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for CDD:</div>
<div class="dyncontent">
<div class="center"><img src="structCDD__coll__graph.png" border="0" usemap="#aCDD_coll__map" alt="Collaboration graph"/></div>
<map name="aCDD_coll__map" id="aCDD_coll__map">
<area shape="rect" title="currency description document" alt="" coords="21,199,71,225"/>
<area shape="rect" href="structPublicKey.html" title=" " alt="" coords="55,109,141,136"/>
<area shape="rect" href="structBigInt.html" title=" " alt="" coords="5,5,65,32"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab9fae7c03b33ad03797d77375cf04339"><td class="memItemLeft" align="right" valign="top"><a id="ab9fae7c03b33ad03797d77375cf04339"></a>
crow::json::wvalue&#160;</td><td class="memItemRight" valign="bottom"><b>to_json</b> () const</td></tr>
<tr class="separator:ab9fae7c03b33ad03797d77375cf04339"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a710e3b326f0e723e828eb8f772ba20e1"><td class="memItemLeft" align="right" valign="top"><a id="a710e3b326f0e723e828eb8f772ba20e1"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>additional_info</b></td></tr>
<tr class="separator:a710e3b326f0e723e828eb8f772ba20e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a403be8e0ca38688083903228b09335e4"><td class="memItemLeft" align="right" valign="top"><a id="a403be8e0ca38688083903228b09335e4"></a>
time_t&#160;</td><td class="memItemRight" valign="bottom"><b>cdd_expiry_date</b></td></tr>
<tr class="separator:a403be8e0ca38688083903228b09335e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9811557ae05a93f3e0f4d60de232999"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCDD.html#ad9811557ae05a93f3e0f4d60de232999">cdd_location</a></td></tr>
<tr class="separator:ad9811557ae05a93f3e0f4d60de232999"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad794846513f799bf95b24ba87b4d4e62"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCDD.html#ad794846513f799bf95b24ba87b4d4e62">cdd_serial</a></td></tr>
<tr class="separator:ad794846513f799bf95b24ba87b4d4e62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ba450ff02f12bf3af8719b2f29168c2"><td class="memItemLeft" align="right" valign="top"><a id="a9ba450ff02f12bf3af8719b2f29168c2"></a>
time_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCDD.html#a9ba450ff02f12bf3af8719b2f29168c2">cdd_signing_date</a></td></tr>
<tr class="memdesc:a9ba450ff02f12bf3af8719b2f29168c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">serial number of currency description document <br /></td></tr>
<tr class="separator:a9ba450ff02f12bf3af8719b2f29168c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaba1ee48b6280dfda78561c2997196fa"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCDD.html#aaba1ee48b6280dfda78561c2997196fa">currency_divisor</a></td></tr>
<tr class="separator:aaba1ee48b6280dfda78561c2997196fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab66042479ed546a6793612097bb12c71"><td class="memItemLeft" align="right" valign="top"><a id="ab66042479ed546a6793612097bb12c71"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCDD.html#ab66042479ed546a6793612097bb12c71">currency_name</a></td></tr>
<tr class="memdesc:ab66042479ed546a6793612097bb12c71"><td class="mdescLeft">&#160;</td><td class="mdescRight">divisor used for coins of this currency <br /></td></tr>
<tr class="separator:ab66042479ed546a6793612097bb12c71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad66bb395b1c12318a213f86fc85bc4d7"><td class="memItemLeft" align="right" valign="top"><a id="ad66bb395b1c12318a213f86fc85bc4d7"></a>
std::vector&lt; unsigned &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCDD.html#ad66bb395b1c12318a213f86fc85bc4d7">denominations</a></td></tr>
<tr class="memdesc:ad66bb395b1c12318a213f86fc85bc4d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">name of the currency (e.g. OpenCent) <br /></td></tr>
<tr class="separator:ad66bb395b1c12318a213f86fc85bc4d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfb668ef274bb89fb1ba2e64a164c26c"><td class="memItemLeft" align="right" valign="top"><a id="acfb668ef274bb89fb1ba2e64a164c26c"></a>
<a class="el" href="structBigInt.html">BigInt</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCDD.html#acfb668ef274bb89fb1ba2e64a164c26c">id</a></td></tr>
<tr class="memdesc:acfb668ef274bb89fb1ba2e64a164c26c"><td class="mdescLeft">&#160;</td><td class="mdescRight">the available denominations of this currency <br /></td></tr>
<tr class="separator:acfb668ef274bb89fb1ba2e64a164c26c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9077a71d57bda145f965a05777113dbf"><td class="memItemLeft" align="right" valign="top"><a id="a9077a71d57bda145f965a05777113dbf"></a>
std::vector&lt; <a class="el" href="structWeightedUrl.html">WeightedUrl</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCDD.html#a9077a71d57bda145f965a05777113dbf">info_service</a></td></tr>
<tr class="memdesc:a9077a71d57bda145f965a05777113dbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">an identity for this currency <br /></td></tr>
<tr class="separator:a9077a71d57bda145f965a05777113dbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94dc9c8f471db7b42392189dd985a1a6"><td class="memItemLeft" align="right" valign="top"><a id="a94dc9c8f471db7b42392189dd985a1a6"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>issuer_cipher_suite</b></td></tr>
<tr class="separator:a94dc9c8f471db7b42392189dd985a1a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a243ef3c2adc0215feba8cb58ddfdcae5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPublicKey.html">PublicKey</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCDD.html#a243ef3c2adc0215feba8cb58ddfdcae5">issuer_public_master_key</a></td></tr>
<tr class="separator:a243ef3c2adc0215feba8cb58ddfdcae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add181b29991626c971a661bd002edcec"><td class="memItemLeft" align="right" valign="top"><a id="add181b29991626c971a661bd002edcec"></a>
std::vector&lt; <a class="el" href="structWeightedUrl.html">WeightedUrl</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCDD.html#add181b29991626c971a661bd002edcec">mint_service</a></td></tr>
<tr class="memdesc:add181b29991626c971a661bd002edcec"><td class="mdescLeft">&#160;</td><td class="mdescRight">the public key of this currency <br /></td></tr>
<tr class="separator:add181b29991626c971a661bd002edcec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fe515c83b7c1c87c0cfd99250c6aa37"><td class="memItemLeft" align="right" valign="top"><a id="a6fe515c83b7c1c87c0cfd99250c6aa37"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>protocol_version</b></td></tr>
<tr class="separator:a6fe515c83b7c1c87c0cfd99250c6aa37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af092a255e884501a553c476e75246636"><td class="memItemLeft" align="right" valign="top"><a id="af092a255e884501a553c476e75246636"></a>
std::vector&lt; <a class="el" href="structWeightedUrl.html">WeightedUrl</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>redeem_service</b></td></tr>
<tr class="separator:af092a255e884501a553c476e75246636"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9592025777fa1a2a9b5274456469f77c"><td class="memItemLeft" align="right" valign="top"><a id="a9592025777fa1a2a9b5274456469f77c"></a>
std::vector&lt; <a class="el" href="structWeightedUrl.html">WeightedUrl</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>renew_service</b></td></tr>
<tr class="separator:a9592025777fa1a2a9b5274456469f77c"><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>currency description document </p>
<p>this structure describes a currency based on opencoin protocol. It can be converted to json to provide the specified currency description document. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ad9811557ae05a93f3e0f4d60de232999"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9811557ae05a93f3e0f4d60de232999">&#9670;&nbsp;</a></span>cdd_location</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string CDD::cdd_location</td>
</tr>
</table>
</div><div class="memdoc">
<p>expiry date of this document (e.g. 2023-07-22T15:45:53.164685) </p>
</div>
</div>
<a id="ad794846513f799bf95b24ba87b4d4e62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad794846513f799bf95b24ba87b4d4e62">&#9670;&nbsp;</a></span>cdd_serial</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t CDD::cdd_serial</td>
</tr>
</table>
</div><div class="memdoc">
<p>URL of location of this document (e.g <a href="https://opencent.org">https://opencent.org</a>) </p>
</div>
</div>
<a id="aaba1ee48b6280dfda78561c2997196fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaba1ee48b6280dfda78561c2997196fa">&#9670;&nbsp;</a></span>currency_divisor</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t CDD::currency_divisor</td>
</tr>
</table>
</div><div class="memdoc">
<p>date of signing this document (e.g. 2022-07-22T15:45:53.164685) </p>
</div>
</div>
<a id="a243ef3c2adc0215feba8cb58ddfdcae5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a243ef3c2adc0215feba8cb58ddfdcae5">&#9670;&nbsp;</a></span>issuer_public_master_key</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structPublicKey.html">PublicKey</a> CDD::issuer_public_master_key</td>
</tr>
</table>
</div><div class="memdoc">
<p>the cipher suite used for this currencey (currently only RSA-SHA256-PSS-CHAUM82 is supported) </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>src/<a class="el" href="model_8hpp_source.html">model.hpp</a></li>
<li>src/json_serialisation.cpp</li>
</ul>
</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.1
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink