| <!-- 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_driver.offchain 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&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('namespaceresdb__driver_1_1offchain.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="#func-members">Functions</a> | |
| <a href="#var-members">Variables</a> </div> |
| <div class="headertitle"><div class="title">resdb_driver.offchain Namespace Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <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:ae946599a00df50b86e9f3f3367ecbefd" id="r_ae946599a00df50b86e9f3f3367ecbefd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__driver_1_1offchain.html#ae946599a00df50b86e9f3f3367ecbefd">_prepare_create_transaction_dispatcher</a> (operation, **kwargs)</td></tr> |
| <tr class="separator:ae946599a00df50b86e9f3f3367ecbefd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4acfc24f20a52dd24243ef25c74cc478" id="r_a4acfc24f20a52dd24243ef25c74cc478"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__driver_1_1offchain.html#a4acfc24f20a52dd24243ef25c74cc478">_prepare_transaction</a> (operation, signers=None, recipients=None, asset=None, metadata=None, inputs=None)</td></tr> |
| <tr class="separator:a4acfc24f20a52dd24243ef25c74cc478"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abf02fabcc7d067310080675e92786f2c" id="r_abf02fabcc7d067310080675e92786f2c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__driver_1_1offchain.html#abf02fabcc7d067310080675e92786f2c">_prepare_transfer_transaction_dispatcher</a> (operation, **kwargs)</td></tr> |
| <tr class="separator:abf02fabcc7d067310080675e92786f2c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5d2ab47f56db80f174d6c9384e84a4e0" id="r_a5d2ab47f56db80f174d6c9384e84a4e0"><td class="memItemLeft" align="right" valign="top">dict </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__driver_1_1offchain.html#a5d2ab47f56db80f174d6c9384e84a4e0">fulfill_transaction</a> (transaction, *private_keys)</td></tr> |
| <tr class="memdesc:a5d2ab47f56db80f174d6c9384e84a4e0"><td class="mdescLeft"> </td><td class="mdescRight">Fulfills the given transaction. <br /></td></tr> |
| <tr class="separator:a5d2ab47f56db80f174d6c9384e84a4e0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6124408413523ffeb74728a96730c00e" id="r_a6124408413523ffeb74728a96730c00e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__driver_1_1offchain.html#a6124408413523ffeb74728a96730c00e">prepare_create_transaction</a> (*signers, recipients=None, asset=None, metadata=None)</td></tr> |
| <tr class="memdesc:a6124408413523ffeb74728a96730c00e"><td class="mdescLeft"> </td><td class="mdescRight">Prepares a <code>"CREATE"</code> transaction payload, ready to be fulfilled. <br /></td></tr> |
| <tr class="separator:a6124408413523ffeb74728a96730c00e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2b2beb547176338573a9b0daf90b7d86" id="r_a2b2beb547176338573a9b0daf90b7d86"><td class="memItemLeft" align="right" valign="top">dict </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__driver_1_1offchain.html#a2b2beb547176338573a9b0daf90b7d86">prepare_transaction</a> (*operation="CREATE", signers=None, recipients=None, asset=None, metadata=None, inputs=None)</td></tr> |
| <tr class="memdesc:a2b2beb547176338573a9b0daf90b7d86"><td class="mdescLeft"> </td><td class="mdescRight">Prepares a transaction payload, ready to be fulfilled. <br /></td></tr> |
| <tr class="separator:a2b2beb547176338573a9b0daf90b7d86"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5a563b4eb30fade27d223f6ea868a043" id="r_a5a563b4eb30fade27d223f6ea868a043"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__driver_1_1offchain.html#a5a563b4eb30fade27d223f6ea868a043">prepare_transfer_transaction</a> (*inputs, recipients, asset, metadata=None)</td></tr> |
| <tr class="memdesc:a5a563b4eb30fade27d223f6ea868a043"><td class="mdescLeft"> </td><td class="mdescRight">Prepares a <code>"TRANSFER"</code> transaction payload, ready to be fulfilled. <br /></td></tr> |
| <tr class="separator:a5a563b4eb30fade27d223f6ea868a043"><td class="memSeparator" colspan="2"> </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:a0b14e488ae28d98d262453f3e9cd6e4d" id="r_a0b14e488ae28d98d262453f3e9cd6e4d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__driver_1_1offchain.html#a0b14e488ae28d98d262453f3e9cd6e4d">logger</a> = logging.getLogger(__name__)</td></tr> |
| <tr class="separator:a0b14e488ae28d98d262453f3e9cd6e4d"><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">Module for offchain operations. Connection to resdb nodes not required! |
| </pre> </div><h2 class="groupheader">Function Documentation</h2> |
| <a id="ae946599a00df50b86e9f3f3367ecbefd" name="ae946599a00df50b86e9f3f3367ecbefd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae946599a00df50b86e9f3f3367ecbefd">◆ </a></span>_prepare_create_transaction_dispatcher()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">_prepare_create_transaction_dispatcher </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>operation</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">** </td> |
| <td class="paramname"><em>kwargs</em> </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"> |
| |
| </div> |
| </div> |
| <a id="a4acfc24f20a52dd24243ef25c74cc478" name="a4acfc24f20a52dd24243ef25c74cc478"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4acfc24f20a52dd24243ef25c74cc478">◆ </a></span>_prepare_transaction()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">_prepare_transaction </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>operation</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>signers</em> = <code>None</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>recipients</em> = <code>None</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>asset</em> = <code>None</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>metadata</em> = <code>None</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>inputs</em> = <code>None</code> </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"> |
| |
| </div> |
| </div> |
| <a id="abf02fabcc7d067310080675e92786f2c" name="abf02fabcc7d067310080675e92786f2c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abf02fabcc7d067310080675e92786f2c">◆ </a></span>_prepare_transfer_transaction_dispatcher()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">_prepare_transfer_transaction_dispatcher </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>operation</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">** </td> |
| <td class="paramname"><em>kwargs</em> </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"> |
| |
| </div> |
| </div> |
| <a id="a5d2ab47f56db80f174d6c9384e84a4e0" name="a5d2ab47f56db80f174d6c9384e84a4e0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5d2ab47f56db80f174d6c9384e84a4e0">◆ </a></span>fulfill_transaction()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"> dict fulfill_transaction </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>transaction</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">* </td> |
| <td class="paramname"><em>private_keys</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Fulfills the given transaction. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">transaction</td><td>The transaction to be fulfilled. </td></tr> |
| <tr><td class="paramname">private_keys</td><td>One or more private keys to be used for fulfilling the transaction.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The fulfilled transaction payload, ready to be sent to a ResDB federation.</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">:exc:`~.exceptions.MissingPrivateKeyError`</td><td>If a private key is missing. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a6124408413523ffeb74728a96730c00e" name="a6124408413523ffeb74728a96730c00e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6124408413523ffeb74728a96730c00e">◆ </a></span>prepare_create_transaction()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">prepare_create_transaction </td> |
| <td>(</td> |
| <td class="paramtype">* </td> |
| <td class="paramname"><em>signers</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>recipients</em> = <code>None</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>asset</em> = <code>None</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>metadata</em> = <code>None</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Prepares a <code>"CREATE"</code> transaction payload, ready to be fulfilled. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">signers</td><td>(:obj:<code>list</code> | :obj:<code>tuple</code> | :obj:<code>str</code>): One or more public keys representing the issuer(s) of the asset being created. </td></tr> |
| <tr><td class="paramname">recipients</td><td>(:obj:<code>list</code> | :obj:<code>tuple</code> | :obj:<code>str</code>, optional): One or more public keys representing the new recipients(s) of the asset being created. Defaults to <code>None</code>. </td></tr> |
| <tr><td class="paramname">asset</td><td>(:obj:<code>dict</code>, optional): The asset to be created. Defaults to <code>None</code>. </td></tr> |
| <tr><td class="paramname">metadata</td><td>(:obj:<code>dict</code>, optional): Metadata associated with the transaction. Defaults to <code>None</code>.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The prepared <code>"CREATE"</code> transaction.</dd></dl> |
| <p>.. important:: </p><pre class="fragment">* If ``asset`` is set, it MUST be in the form of:: |
| |
| { |
| 'data': { |
| ... |
| } |
| } |
| |
| * If ``recipients`` is not given, or evaluates to |
| ``False``, it will be set equal to ``signers``:: |
| |
| if not recipients: |
| recipients = signers |
| </pre> |
| </div> |
| </div> |
| <a id="a2b2beb547176338573a9b0daf90b7d86" name="a2b2beb547176338573a9b0daf90b7d86"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2b2beb547176338573a9b0daf90b7d86">◆ </a></span>prepare_transaction()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"> dict prepare_transaction </td> |
| <td>(</td> |
| <td class="paramtype">* </td> |
| <td class="paramname"><em>operation</em> = <code>"CREATE"</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>signers</em> = <code>None</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>recipients</em> = <code>None</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>asset</em> = <code>None</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>metadata</em> = <code>None</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>inputs</em> = <code>None</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Prepares a transaction payload, ready to be fulfilled. </p> |
| <p>Depending on the value of <code>operation</code>, simply dispatches to either :func:<code>~.prepare_create_transaction</code> or :func:<code>~.prepare_transfer_transaction</code>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">operation</td><td>(str): The operation to perform. Must be <code>'CREATE'</code> or <code>'TRANSFER'</code>. Case insensitive. Defaults to <code>'CREATE'</code>. </td></tr> |
| <tr><td class="paramname">signers</td><td>(:obj:<code>list</code> | :obj:<code>tuple</code> | :obj:<code>str</code>, optional): One or more public keys representing the issuer(s) of the asset being created. Only applies for <code>'CREATE'</code> operations. Defaults to <code>None</code>. </td></tr> |
| <tr><td class="paramname">recipients</td><td>(:obj:<code>list</code> | :obj:<code>tuple</code> | :obj:<code>str</code>, optional): One or more public keys representing the new recipients(s) of the asset being created or transferred. Defaults to <code>None</code>. </td></tr> |
| <tr><td class="paramname">asset</td><td>(:obj:<code>dict</code>, optional): The asset to be created orctransferred. MUST be supplied for <code>'TRANSFER'</code> operations. Defaults to <code>None</code>. </td></tr> |
| <tr><td class="paramname">metadata</td><td>(:obj:<code>dict</code>, optional): Metadata associated with the transaction. Defaults to <code>None</code>. </td></tr> |
| <tr><td class="paramname">inputs</td><td>(:obj:<code>dict</code> | :obj:<code>list</code> | :obj:<code>tuple</code>, optional): One or more inputs holding the condition(s) that this transaction intends to fulfill. Each input is expected to be a :obj:<code>dict</code>. Only applies to, and MUST be supplied for, <code>'TRANSFER'</code> operations.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The prepared transaction</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">:class:`~.exceptions.ResdbException`</td><td>If ``operation`` is not <code>'CREATE'</code> or <code>'TRANSFER'</code>.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>.. important:: </p><pre class="fragment">**CREATE operations** |
| |
| * ``signers`` MUST be set. |
| * ``recipients``, ``asset``, and ``metadata`` MAY be set. |
| * If ``asset`` is set, it MUST be in the form of:: |
| |
| { |
| 'data': { |
| ... |
| } |
| } |
| |
| * The argument ``inputs`` is ignored. |
| * If ``recipients`` is not given, or evaluates to |
| ``False``, it will be set equal to ``signers``:: |
| |
| if not recipients: |
| recipients = signers |
| |
| **TRANSFER operations** |
| |
| * ``recipients``, ``asset``, and ``inputs`` MUST be set. |
| * ``asset`` MUST be in the form of:: |
| |
| { |
| 'id': '<Asset ID (i.e. TX ID of its CREATE transaction)>' |
| } |
| |
| * ``metadata`` MAY be set. |
| * The argument ``signers`` is ignored. |
| </pre> |
| </div> |
| </div> |
| <a id="a5a563b4eb30fade27d223f6ea868a043" name="a5a563b4eb30fade27d223f6ea868a043"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5a563b4eb30fade27d223f6ea868a043">◆ </a></span>prepare_transfer_transaction()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">prepare_transfer_transaction </td> |
| <td>(</td> |
| <td class="paramtype">* </td> |
| <td class="paramname"><em>inputs</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>recipients</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>asset</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>metadata</em> = <code>None</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Prepares a <code>"TRANSFER"</code> transaction payload, ready to be fulfilled. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">inputs</td><td>(:obj:<code>dict</code> | :obj:<code>list</code> | :obj:<code>tuple</code>): One or more inputs holding the condition(s) that this transaction intends to fulfill. Each input is expected to be a :obj:<code>dict</code>. </td></tr> |
| <tr><td class="paramname">recipients</td><td>(:obj:<code>str</code> | :obj:<code>list</code> | :obj:<code>tuple</code>): One or more public keys representing the new recipients(s) of the asset being transferred. </td></tr> |
| <tr><td class="paramname">asset</td><td>(:obj:<code>dict</code>): A single-key dictionary holding the <code>id</code> of the asset being transferred with this transaction. </td></tr> |
| <tr><td class="paramname">metadata</td><td>(:obj:<code>dict</code>): Metadata associated with the transaction. Defaults to <code>None</code>.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The prepared <code>"TRANSFER"</code> transaction.</dd></dl> |
| <p>.. important:: </p><pre class="fragment">* ``asset`` MUST be in the form of:: |
| |
| { |
| 'id': '<Asset ID (i.e. TX ID of its CREATE transaction)>' |
| } |
| </pre><p> Example: </p><pre class="fragment"># .. todo:: Replace this section with docs. |
| |
| In case it may not be clear what an input should look like, say |
| Alice (public key: ``'3Cxh1eKZk3Wp9KGBWFS7iVde465UvqUKnEqTg2MW4wNf'``) |
| wishes to transfer an asset over to Bob |
| (public key: ``'EcRawy3Y22eAUSS94vLF8BVJi62wbqbD9iSUSUNU9wAA'``). |
| Let the asset creation transaction payload be denoted by |
| ``tx``:: |
| |
| # noqa E501 |
| >>> tx |
| {'asset': {'data': {'msg': 'Hello Resdb!'}}, |
| 'id': '9650055df2539223586d33d273cb8fd05bd6d485b1fef1caf7c8901a49464c87', |
| 'inputs': [{'fulfillment': {'public_key': '3Cxh1eKZk3Wp9KGBWFS7iVde465UvqUKnEqTg2MW4wNf', |
| 'type': 'ed25519-sha-256'}, |
| 'fulfills': None, |
| 'owners_before': ['3Cxh1eKZk3Wp9KGBWFS7iVde465UvqUKnEqTg2MW4wNf']}], |
| 'metadata': None, |
| 'operation': 'CREATE', |
| 'outputs': [{'amount': '1', |
| 'condition': {'details': {'public_key': '3Cxh1eKZk3Wp9KGBWFS7iVde465UvqUKnEqTg2MW4wNf', |
| 'type': 'ed25519-sha-256'}, |
| 'uri': 'ni:///sha-256;7ApQLsLLQgj5WOUipJg1txojmge68pctwFxvc3iOl54?fpt=ed25519-sha-256&cost=131072'}, |
| 'public_keys': ['3Cxh1eKZk3Wp9KGBWFS7iVde465UvqUKnEqTg2MW4wNf']}], |
| 'version': '2.0'} |
| |
| Then, the input may be constructed in this way:: |
| |
| output_index |
| output = tx['transaction']['outputs'][output_index] |
| input_ = { |
| 'fulfillment': output['condition']['details'], |
| 'input': { |
| 'output_index': output_index, |
| 'transaction_id': tx['id'], |
| }, |
| 'owners_before': output['public_keys'], |
| } |
| |
| Displaying the input on the prompt would look like:: |
| |
| >>> input_ |
| {'fulfillment': { |
| 'public_key': '3Cxh1eKZk3Wp9KGBWFS7iVde465UvqUKnEqTg2MW4wNf', |
| 'type': 'ed25519-sha-256'}, |
| 'input': {'output_index': 0, |
| 'transaction_id': '9650055df2539223586d33d273cb8fd05bd6d485b1fef1caf7c8901a49464c87'}, |
| 'owners_before': ['3Cxh1eKZk3Wp9KGBWFS7iVde465UvqUKnEqTg2MW4wNf']} |
| |
| |
| To prepare the transfer: |
| |
| >>> prepare_transfer_transaction( |
| ... inputs=input_, |
| ... recipients='EcRawy3Y22eAUSS94vLF8BVJi62wbqbD9iSUSUNU9wAA', |
| ... asset=tx['transaction']['asset'], |
| ... ) |
| </pre> |
| </div> |
| </div> |
| <h2 class="groupheader">Variable Documentation</h2> |
| <a id="a0b14e488ae28d98d262453f3e9cd6e4d" name="a0b14e488ae28d98d262453f3e9cd6e4d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0b14e488ae28d98d262453f3e9cd6e4d">◆ </a></span>logger</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">logger = logging.getLogger(__name__)</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </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__driver.html">resdb_driver</a></li><li class="navelem"><a class="el" href="namespaceresdb__driver_1_1offchain.html">offchain</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> |
