blob: d0698a7e3a1c9c0c441f28388102f27a779dae85 [file] [log] [blame]
<!-- 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: resdb_validator.transaction Namespace 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&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>
</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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('namespaceresdb__validator_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="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">resdb_validator.transaction Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__validator_1_1transaction_1_1Input.html">Input</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__validator_1_1transaction_1_1Output.html">Output</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__validator_1_1transaction_1_1Transaction.html">Transaction</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__validator_1_1transaction_1_1TransactionLink.html">TransactionLink</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a426f90eb6b933d89f886ee103f714ad5" id="r_a426f90eb6b933d89f886ee103f714ad5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__validator_1_1transaction.html#a426f90eb6b933d89f886ee103f714ad5">_fulfillment_from_details</a> (data, _depth=0)</td></tr>
<tr class="separator:a426f90eb6b933d89f886ee103f714ad5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cae139668c19cfeddd2c9e0742f369d" id="r_a3cae139668c19cfeddd2c9e0742f369d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__validator_1_1transaction.html#a3cae139668c19cfeddd2c9e0742f369d">_fulfillment_to_details</a> (fulfillment)</td></tr>
<tr class="separator:a3cae139668c19cfeddd2c9e0742f369d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a52c26a4f636a64c89ad572528ab67b5a" id="r_a52c26a4f636a64c89ad572528ab67b5a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__validator_1_1transaction.html#a52c26a4f636a64c89ad572528ab67b5a">UnspentOutput</a></td></tr>
<tr class="separator:a52c26a4f636a64c89ad572528ab67b5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><pre class="fragment">Transaction related models to parse and construct transaction
payloads.
Attributes:
UnspentOutput (namedtuple): Object holding the information
representing an unspent output.</pre> </div><h2 class="groupheader">Function Documentation</h2>
<a id="a426f90eb6b933d89f886ee103f714ad5" name="a426f90eb6b933d89f886ee103f714ad5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a426f90eb6b933d89f886ee103f714ad5">&#9670;&#160;</a></span>_fulfillment_from_details()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">_fulfillment_from_details </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>_depth</em> = <code>0</code>&#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">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Load a fulfillment for a signing spec dictionary
Args:
data: tx.output[].condition.details dictionary
</pre>
</div>
</div>
<a id="a3cae139668c19cfeddd2c9e0742f369d" name="a3cae139668c19cfeddd2c9e0742f369d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cae139668c19cfeddd2c9e0742f369d">&#9670;&#160;</a></span>_fulfillment_to_details()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">_fulfillment_to_details </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>fulfillment</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Encode a fulfillment as a details dictionary
Args:
fulfillment: Crypto-conditions Fulfillment object
</pre>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a52c26a4f636a64c89ad572528ab67b5a" name="a52c26a4f636a64c89ad572528ab67b5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52c26a4f636a64c89ad572528ab67b5a">&#9670;&#160;</a></span>UnspentOutput</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UnspentOutput</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line"><span class="lineno"> 1</span>= namedtuple(</div>
<div class="line"><span class="lineno"> 2</span> <span class="stringliteral">&#39;UnspentOutput&#39;</span>, (</div>
<div class="line"><span class="lineno"> 3</span> <span class="comment"># TODO &#39;utxo_hash&#39;: sha3_256(f&#39;{txid}{output_index}&#39;.encode())</span></div>
<div class="line"><span class="lineno"> 4</span> <span class="comment"># &#39;utxo_hash&#39;, # noqa</span></div>
<div class="line"><span class="lineno"> 5</span> <span class="stringliteral">&#39;transaction_id&#39;</span>,</div>
<div class="line"><span class="lineno"> 6</span> <span class="stringliteral">&#39;output_index&#39;</span>,</div>
<div class="line"><span class="lineno"> 7</span> <span class="stringliteral">&#39;amount&#39;</span>,</div>
<div class="line"><span class="lineno"> 8</span> <span class="stringliteral">&#39;asset_id&#39;</span>,</div>
<div class="line"><span class="lineno"> 9</span> <span class="stringliteral">&#39;condition_uri&#39;</span>,</div>
<div class="line"><span class="lineno"> 10</span> )</div>
<div class="line"><span class="lineno"> 11</span>)</div>
</div><!-- fragment -->
</div>
</div>
</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__validator.html">resdb_validator</a></li><li class="navelem"><a class="el" href="namespaceresdb__validator_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>