documentation for the console

12 years ago · 89df580149
1 changed files with 61 additions and 0 deletions
--- a/docs/console.html
+++ b/docs/console.html
@ -0,0 +1,61 @@
+<html>
+<head>
+This is the documentation for the Electrum Console.<br/>
+</head>
+<body>
+<div style="width:45em">
+<br/>
+Most Electrum command-line commands are also available in the console. <br/>
+The results are Python objects, even though they are
+sometimes rendered as JSON for clarity.<br/>
+<br/>
+Let us call <tt>listunspent()</tt>, to see the list of unspent outputs in the wallet:
+<pre>
+>> listunspent()
+[
+    {
+        "address": "12cmY5RHRgx8KkUKASDcDYRotget9FNso3", 
+        "index": 0, 
+        "raw_output_script": "76a91411bbdc6e3a27c44644d83f783ca7df3bdc2778e688ac", 
+        "tx_hash": "e7029df9ac8735b04e8e957d0ce73987b5c9c5e920ec4a445130cdeca654f096", 
+        "value": 0.01
+    }, 
+    {
+        "address": "1GavSCND6TB7HuCnJSTEbHEmCctNGeJwXF", 
+        "index": 0, 
+        "raw_output_script": "76a914aaf437e25805f288141bfcdc27887ee5492bd13188ac", 
+        "tx_hash": "b30edf57ca2a31560b5b6e8dfe567734eb9f7d3259bb334653276efe520735df", 
+        "value": 9.04735316
+    }
+]
+</pre>
+Note that the result is rendered as JSON. <br/>
+However, if we save it to a Python variable, it is rendered as a Python object:
+<pre>
+>> u = listunspent()
+>> u
+[{'tx_hash': u'e7029df9ac8735b04e8e957d0ce73987b5c9c5e920ec4a445130cdeca654f096', 'index': 0, 'raw_output_script': '76a91411bbdc6e3a27c44644d83f783ca7df3bdc2778e688ac', 'value': 0.01, 'address': '12cmY5RHRgx8KkUKASDcDYRotget9FNso3'}, {'tx_hash': u'b30edf57ca2a31560b5b6e8dfe567734eb9f7d3259bb334653276efe520735df', 'index': 0, 'raw_output_script': '76a914aaf437e25805f288141bfcdc27887ee5492bd13188ac', 'value': 9.04735316, 'address': '1GavSCND6TB7HuCnJSTEbHEmCctNGeJwXF'}]
+</pre>
+<br/>
+This makes it possible to combine Electrum commands with Python.<br/>
+For example, let us pick only the addresses in the previous result:
+<pre>
+>> map(lambda x:x.get('address'), listunspent())
+[
+    "12cmY5RHRgx8KkUKASDcDYRotget9FNso3", 
+    "1GavSCND6TB7HuCnJSTEbHEmCctNGeJwXF"
+]
+</pre>
+Here we combine two commands, <tt>listunspent</tt>
+and <tt>dumpprivkeys</tt>, in order to dump the private keys of all adresses that have unspent outputs:
+<pre>
+>> dumpprivkeys( map(lambda x:x.get('address'), listunspent()) )
+{
+    "12cmY5RHRgx8KkUKASDcDYRotget9FNso3": "***************************************************", 
+    "1GavSCND6TB7HuCnJSTEbHEmCctNGeJwXF": "***************************************************"
+}
+</pre>
+Note that <tt>dumpprivkey</tt> will ask for your password if your wallet is encrypted.
+</div> 
+</body>
+</html>