| <!-- HTML header for doxygen 1.9.8--> |
| <!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>ResilientDB SDK: Transaction 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="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.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" /> |
| <link href="doxygen_html_style.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="projectlogo"><img alt="Logo" src="logo.png"/></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function(){initNavTree('classresdb__driver_1_1validate_1_1Transaction.html',''); initResizable(); }); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- 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 class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="classresdb__driver_1_1validate_1_1Transaction-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">Transaction Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <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:a86921868b54930bd2407ce362a91e2af" id="r_a86921868b54930bd2407ce362a91e2af"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1validate_1_1Transaction.html#a86921868b54930bd2407ce362a91e2af">from_dict</a> (cls, tx_body)</td></tr> |
| <tr class="separator:a86921868b54930bd2407ce362a91e2af"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ababb11233c234e7b426fc800b07c9849" id="r_ababb11233c234e7b426fc800b07c9849"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1validate_1_1Transaction.html#ababb11233c234e7b426fc800b07c9849">validate</a> (self, resdb, current_transactions=[])</td></tr> |
| <tr class="memdesc:ababb11233c234e7b426fc800b07c9849"><td class="mdescLeft"> </td><td class="mdescRight">Validate transaction spend. <br /></td></tr> |
| <tr class="separator:ababb11233c234e7b426fc800b07c9849"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:ad34e7fb3c33543e9f3a1e48486fa7692" id="r_ad34e7fb3c33543e9f3a1e48486fa7692"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1validate_1_1Transaction.html#ad34e7fb3c33543e9f3a1e48486fa7692">operation</a></td></tr> |
| <tr class="separator:ad34e7fb3c33543e9f3a1e48486fa7692"><td class="memSeparator" colspan="2"> </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:aefb03b15145c89af2a9d5f5b7f1e58c0" id="r_aefb03b15145c89af2a9d5f5b7f1e58c0"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1validate_1_1Transaction.html#aefb03b15145c89af2a9d5f5b7f1e58c0">ASSET</a> = "asset"</td></tr> |
| <tr class="separator:aefb03b15145c89af2a9d5f5b7f1e58c0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aac88ed3c288db9514ba94b1864b7b32d" id="r_aac88ed3c288db9514ba94b1864b7b32d"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1validate_1_1Transaction.html#aac88ed3c288db9514ba94b1864b7b32d">DATA</a> = "data"</td></tr> |
| <tr class="separator:aac88ed3c288db9514ba94b1864b7b32d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acd29b68b08092d4a3f75a94c1e562c2e" id="r_acd29b68b08092d4a3f75a94c1e562c2e"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1validate_1_1Transaction.html#acd29b68b08092d4a3f75a94c1e562c2e">METADATA</a> = "metadata"</td></tr> |
| <tr class="separator:acd29b68b08092d4a3f75a94c1e562c2e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a86921868b54930bd2407ce362a91e2af" name="a86921868b54930bd2407ce362a91e2af"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a86921868b54930bd2407ce362a91e2af">◆ </a></span>from_dict()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">from_dict </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>cls</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>tx_body</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="ababb11233c234e7b426fc800b07c9849" name="ababb11233c234e7b426fc800b07c9849"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ababb11233c234e7b426fc800b07c9849">◆ </a></span>validate()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">validate </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>self</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>resdb</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>current_transactions</em> = <code>[]</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Validate transaction spend. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">resdb</td><td>An instantiated resdb_driver.Resdb object. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The transaction (Transaction) if the transaction is valid else it raises an exception describing the reason why the transaction is invalid.</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">ValidationError</td><td>If the transaction is invalid </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="aefb03b15145c89af2a9d5f5b7f1e58c0" name="aefb03b15145c89af2a9d5f5b7f1e58c0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aefb03b15145c89af2a9d5f5b7f1e58c0">◆ </a></span>ASSET</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">str ASSET = "asset"</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="aac88ed3c288db9514ba94b1864b7b32d" name="aac88ed3c288db9514ba94b1864b7b32d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aac88ed3c288db9514ba94b1864b7b32d">◆ </a></span>DATA</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">str DATA = "data"</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="acd29b68b08092d4a3f75a94c1e562c2e" name="acd29b68b08092d4a3f75a94c1e562c2e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acd29b68b08092d4a3f75a94c1e562c2e">◆ </a></span>METADATA</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">str METADATA = "metadata"</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="ad34e7fb3c33543e9f3a1e48486fa7692" name="ad34e7fb3c33543e9f3a1e48486fa7692"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad34e7fb3c33543e9f3a1e48486fa7692">◆ </a></span>operation</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">operation</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/github/workspace/resdb_driver/<a class="el" href="validate_8py.html">validate.py</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceresdb__driver.html">resdb_driver</a></li><li class="navelem"><a class="el" href="namespaceresdb__driver_1_1validate.html">validate</a></li><li class="navelem"><a class="el" href="classresdb__driver_1_1validate_1_1Transaction.html">Transaction</a></li> |
| <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |