| <!-- 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: Input 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__validator_1_1transaction_1_1Input.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="classresdb__validator_1_1transaction_1_1Input-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">Input Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="dynheader"> |
| Inheritance diagram for Input:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classresdb__validator_1_1transaction_1_1Input.png" alt=""/> |
| </div></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:a909a2bc6a3c96fc53d3ae93305e81486" id="r_a909a2bc6a3c96fc53d3ae93305e81486"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__validator_1_1transaction_1_1Input.html#a909a2bc6a3c96fc53d3ae93305e81486">__eq__</a> (self, other)</td></tr> |
| <tr class="separator:a909a2bc6a3c96fc53d3ae93305e81486"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a171e6903c0464958dd8a214b15a038cb" id="r_a171e6903c0464958dd8a214b15a038cb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__validator_1_1transaction_1_1Input.html#a171e6903c0464958dd8a214b15a038cb">__hash__</a> (self)</td></tr> |
| <tr class="separator:a171e6903c0464958dd8a214b15a038cb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a75ab2c98fec93b1d239dcf74ca8cbfad" id="r_a75ab2c98fec93b1d239dcf74ca8cbfad"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__validator_1_1transaction_1_1Input.html#a75ab2c98fec93b1d239dcf74ca8cbfad">__init__</a> (self, <a class="el" href="classresdb__validator_1_1transaction_1_1Input.html#a0b3bc56243babe30af560b9c4c905af8">fulfillment</a>, <a class="el" href="classresdb__validator_1_1transaction_1_1Input.html#a052e2dd43cb455094f36be561f42928d">owners_before</a>, <a class="el" href="classresdb__validator_1_1transaction_1_1Input.html#ae4cb945fde8f7a519314db1186e5b3bc">fulfills</a>=None)</td></tr> |
| <tr class="separator:a75ab2c98fec93b1d239dcf74ca8cbfad"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a606efe96f9319b688d283cbe9fc690ca" id="r_a606efe96f9319b688d283cbe9fc690ca"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__validator_1_1transaction_1_1Input.html#a606efe96f9319b688d283cbe9fc690ca">from_dict</a> (cls, data)</td></tr> |
| <tr class="separator:a606efe96f9319b688d283cbe9fc690ca"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a029e5a793ce7ba96b8dd50805007f80b" id="r_a029e5a793ce7ba96b8dd50805007f80b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__validator_1_1transaction_1_1Input.html#a029e5a793ce7ba96b8dd50805007f80b">generate</a> (cls, public_keys)</td></tr> |
| <tr class="separator:a029e5a793ce7ba96b8dd50805007f80b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a34ea8af38721a6873df4a2baf3e8cb93" id="r_a34ea8af38721a6873df4a2baf3e8cb93"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__validator_1_1transaction_1_1Input.html#a34ea8af38721a6873df4a2baf3e8cb93">to_dict</a> (self)</td></tr> |
| <tr class="separator:a34ea8af38721a6873df4a2baf3e8cb93"><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:a0b3bc56243babe30af560b9c4c905af8" id="r_a0b3bc56243babe30af560b9c4c905af8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__validator_1_1transaction_1_1Input.html#a0b3bc56243babe30af560b9c4c905af8">fulfillment</a></td></tr> |
| <tr class="separator:a0b3bc56243babe30af560b9c4c905af8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae4cb945fde8f7a519314db1186e5b3bc" id="r_ae4cb945fde8f7a519314db1186e5b3bc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__validator_1_1transaction_1_1Input.html#ae4cb945fde8f7a519314db1186e5b3bc">fulfills</a></td></tr> |
| <tr class="separator:ae4cb945fde8f7a519314db1186e5b3bc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a052e2dd43cb455094f36be561f42928d" id="r_a052e2dd43cb455094f36be561f42928d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__validator_1_1transaction_1_1Input.html#a052e2dd43cb455094f36be561f42928d">owners_before</a></td></tr> |
| <tr class="separator:a052e2dd43cb455094f36be561f42928d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><pre class="fragment">A Input is used to spend assets locked by an Output. |
| |
| Wraps around a Crypto-condition Fulfillment. |
| |
| Attributes: |
| fulfillment (:class:`cryptoconditions.Fulfillment`): A Fulfillment |
| to be signed with a private key. |
| owners_before (:obj:`list` of :obj:`str`): A list of owners after a |
| Transaction was confirmed. |
| fulfills (:class:`~resdb_validator.transaction. TransactionLink`, |
| optional): A link representing the input of a `TRANSFER` |
| Transaction. |
| </pre> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a75ab2c98fec93b1d239dcf74ca8cbfad" name="a75ab2c98fec93b1d239dcf74ca8cbfad"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a75ab2c98fec93b1d239dcf74ca8cbfad">◆ </a></span>__init__()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">__init__ </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>fulfillment</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>owners_before</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>fulfills</em> = <code>None</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <pre class="fragment">Create an instance of an :class:`~.Input`. |
| |
| Args: |
| fulfillment (:class:`cryptoconditions.Fulfillment`): A |
| Fulfillment to be signed with a private key. |
| owners_before (:obj:`list` of :obj:`str`): A list of owners |
| after a Transaction was confirmed. |
| fulfills (:class:`~resdb_validator.transaction. |
| TransactionLink`, optional): A link representing the input |
| of a `TRANSFER` Transaction. |
| </pre> |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a909a2bc6a3c96fc53d3ae93305e81486" name="a909a2bc6a3c96fc53d3ae93305e81486"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a909a2bc6a3c96fc53d3ae93305e81486">◆ </a></span>__eq__()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">__eq__ </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>other</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a171e6903c0464958dd8a214b15a038cb" name="a171e6903c0464958dd8a214b15a038cb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a171e6903c0464958dd8a214b15a038cb">◆ </a></span>__hash__()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">__hash__ </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>self</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a606efe96f9319b688d283cbe9fc690ca" name="a606efe96f9319b688d283cbe9fc690ca"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a606efe96f9319b688d283cbe9fc690ca">◆ </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>data</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <pre class="fragment">Transforms a Python dictionary to an Input object. |
| |
| Note: |
| Optionally, this method can also serialize a Cryptoconditions- |
| Fulfillment that is not yet signed. |
| |
| Args: |
| data (dict): The Input to be transformed. |
| |
| Returns: |
| :class:`~resdb_validator.transaction.Input` |
| |
| Raises: |
| InvalidSignature: If an Input's URI couldn't be parsed. |
| </pre> |
| </div> |
| </div> |
| <a id="a029e5a793ce7ba96b8dd50805007f80b" name="a029e5a793ce7ba96b8dd50805007f80b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a029e5a793ce7ba96b8dd50805007f80b">◆ </a></span>generate()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">generate </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>public_keys</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a34ea8af38721a6873df4a2baf3e8cb93" name="a34ea8af38721a6873df4a2baf3e8cb93"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a34ea8af38721a6873df4a2baf3e8cb93">◆ </a></span>to_dict()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">to_dict </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>self</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <pre class="fragment">Transforms the object to a Python dictionary. |
| |
| Note: |
| If an Input hasn't been signed yet, this method returns a |
| dictionary representation. |
| |
| Returns: |
| dict: The Input as an alternative serialization format. |
| </pre> |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a0b3bc56243babe30af560b9c4c905af8" name="a0b3bc56243babe30af560b9c4c905af8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0b3bc56243babe30af560b9c4c905af8">◆ </a></span>fulfillment</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">fulfillment</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="ae4cb945fde8f7a519314db1186e5b3bc" name="ae4cb945fde8f7a519314db1186e5b3bc"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae4cb945fde8f7a519314db1186e5b3bc">◆ </a></span>fulfills</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">fulfills</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a052e2dd43cb455094f36be561f42928d" name="a052e2dd43cb455094f36be561f42928d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a052e2dd43cb455094f36be561f42928d">◆ </a></span>owners_before</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">owners_before</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/service/sdk_validator/resdb_validator/<a class="el" href="service_2sdk__validator_2resdb__validator_2transaction_8py.html">transaction.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__validator.html">resdb_validator</a></li><li class="navelem"><a class="el" href="namespaceresdb__validator_1_1transaction.html">transaction</a></li><li class="navelem"><a class="el" href="classresdb__validator_1_1transaction_1_1Input.html">Input</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> |
