<html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Index of module types" rel=Appendix href="index_module_types.html"> <link title="Bitcoin" rel="Chapter" href="Bitcoin.html"> <link title="Bitcoin_ocamlnet" rel="Chapter" href="Bitcoin_ocamlnet.html"><title>Index of values</title> </head> <body> <div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> </div> <h1>Index of values</h1> <table> <tr><td align="left"><br>A</td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALaddnode">addnode</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Allows manually adding/removing a node. </div> </td></tr> <tr><td><a href="Bitcoin.html#VALamount_of_float">amount_of_float</a> [<a href="Bitcoin.html">Bitcoin</a>]</td> <td><div class="info"> Converts a BTC quantity expressed as a <code class="code">float</code> into its <a href="Bitcoin.html#TYPEamount_t"><code class="code">Bitcoin.amount_t</code></a> representation. </div> </td></tr> <tr><td align="left"><br>B</td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALbackupwallet">backupwallet</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Safely backs up wallet file to the given destination, which can be either a directory or a path with filename. </div> </td></tr> <tr><td><a href="Bitcoin_ocamlnet.Httpclient.Monad.html#VALbind">bind</a> [<a href="Bitcoin_ocamlnet.Httpclient.Monad.html">Bitcoin_ocamlnet.Httpclient.Monad</a>]</td> <td></td></tr> <tr><td><a href="Bitcoin.HTTPCLIENT.Monad.html#VALbind">bind</a> [<a href="Bitcoin.HTTPCLIENT.Monad.html">Bitcoin.HTTPCLIENT.Monad</a>]</td> <td></td></tr> <tr><td align="left"><br>C</td></tr> <tr><td><a href="Bitcoin_ocamlnet.Httpclient.Monad.html#VALcatch">catch</a> [<a href="Bitcoin_ocamlnet.Httpclient.Monad.html">Bitcoin_ocamlnet.Httpclient.Monad</a>]</td> <td></td></tr> <tr><td><a href="Bitcoin.HTTPCLIENT.Monad.html#VALcatch">catch</a> [<a href="Bitcoin.HTTPCLIENT.Monad.html">Bitcoin.HTTPCLIENT.Monad</a>]</td> <td></td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALcreatemultisig">createmultisig</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Creates a m-of-n multi-signature address. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALcreaterawtransaction">createrawtransaction</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> <code class="code">createrawtransaction inputs outputs</code> creates a raw transaction that transfers the given inputs (a list of transaction outputs) to the given outputs (a list of addresses and amounts). </div> </td></tr> <tr><td align="left"><br>D</td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALdecoderawtransaction">decoderawtransaction</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns an object containing information concerning the given raw transaction. </div> </td></tr> <tr><td><a href="Bitcoin.CONNECTION.html#VALdefault">default</a> [<a href="Bitcoin.CONNECTION.html">Bitcoin.CONNECTION</a>]</td> <td></td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALdumpprivkey">dumpprivkey</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns the private key corresponding to the given address. </div> </td></tr> <tr><td align="left"><br>E</td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALencryptwallet">encryptwallet</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Encrypts the wallet with the given passphrase. </div> </td></tr> <tr><td align="left"><br>F</td></tr> <tr><td><a href="Bitcoin_ocamlnet.Httpclient.Monad.html#VALfail">fail</a> [<a href="Bitcoin_ocamlnet.Httpclient.Monad.html">Bitcoin_ocamlnet.Httpclient.Monad</a>]</td> <td></td></tr> <tr><td><a href="Bitcoin.HTTPCLIENT.Monad.html#VALfail">fail</a> [<a href="Bitcoin.HTTPCLIENT.Monad.html">Bitcoin.HTTPCLIENT.Monad</a>]</td> <td></td></tr> <tr><td><a href="Bitcoin.html#VALfloat_of_amount">float_of_amount</a> [<a href="Bitcoin.html">Bitcoin</a>]</td> <td><div class="info"> Converts a BTC quantity expressed as an <a href="Bitcoin.html#TYPEamount_t"><code class="code">Bitcoin.amount_t</code></a> into its <code class="code">float</code> representation. </div> </td></tr> <tr><td align="left"><br>G</td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetaccount">getaccount</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns the account associated with the given address. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetaccountaddress">getaccountaddress</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns the receiving address currently associated with the given account. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetaddednodeinfo">getaddednodeinfo</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns the list of nodes manually added with <a href="Bitcoin.ENGINE.html#VALaddnode"><code class="code">Bitcoin.ENGINE.addnode</code></a>. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetaddednodeinfo_verbose">getaddednodeinfo_verbose</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns the list of nodes manually added with <a href="Bitcoin.ENGINE.html#VALaddnode"><code class="code">Bitcoin.ENGINE.addnode</code></a>. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetaddressesbyaccount">getaddressesbyaccount</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Return all addresses associated with the given account. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetbalance">getbalance</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> If <code class="code">account</code> is provided, returns the balance available in that account. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetblock">getblock</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns the available data for the block with the given block hash. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetblockcount">getblockcount</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns the number of blocks in the longest block chain. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetblockhash">getblockhash</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns the block hash for the block located at the given index in the longest block chain. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetblocktemplate">getblocktemplate</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns data needed to construct a block to work on. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetconnectioncount">getconnectioncount</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns the number of connections to peer nodes. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetdifficulty">getdifficulty</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns the current difficulty (as a multiple of the minimum difficulty). </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetgenerate">getgenerate</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Are we currently trying to generate new blocks? </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgethashespersec">gethashespersec</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns number of hashes per second we currently attain when attempting block generation. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetinfo">getinfo</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns an object containing various state information. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetmininginfo">getmininginfo</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns an object containing mining related information. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetnewaddress">getnewaddress</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns a newly generated address. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetpeerinfo">getpeerinfo</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns information about each connected peer. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetrawmempool">getrawmempool</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns all transaction IDs currently in the memory pool. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetrawtransaction">getrawtransaction</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns the raw transaction corresponding to the given transaction ID. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetrawtransaction_verbose">getrawtransaction_verbose</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns all the raw information concerning the transaction with the given ID. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetreceivedbyaccount">getreceivedbyaccount</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns the total amount received on the given account. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetreceivedbyaddress">getreceivedbyaddress</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns the total amount received on this address. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgettransaction">gettransaction</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns an object containing various information about the given transaction. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgettxout">gettxout</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns detailed information concerning a given unspent transaction output. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgettxoutsetinfo">gettxoutsetinfo</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns some statistics about the current set of unspent transaction outputs. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetwork_with_data">getwork_with_data</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Tries to solve the given block, returning a boolean indicating success status. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALgetwork_without_data">getwork_without_data</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns formatted hash data to work on. </div> </td></tr> <tr><td align="left"><br>I</td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALimportprivkey">importprivkey</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Adds a private key to the wallet. </div> </td></tr> <tr><td align="left"><br>K</td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALkeypoolrefill">keypoolrefill</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Refills the keypool. </div> </td></tr> <tr><td align="left"><br>L</td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALlistaccounts">listaccounts</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns a list of all accounts and associated balance. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALlistaddressgroupings">listaddressgroupings</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns a list of the groups of addresses whose common ownership has been made public by common use as inputs or as the resulting change in past transactions. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALlistlockunspent">listlockunspent</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns a list of temporarily unspendable transaction outputs. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALlistreceivedbyaccount">listreceivedbyaccount</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns a list of the total amount received by each account. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALlistreceivedbyaddress">listreceivedbyaddress</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns a list of the total amount received by each address. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALlistsinceblock">listsinceblock</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns a pair consisting of a list of all transactions and the block hash of the latest block. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALlisttransactions">listtransactions</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns up to <code class="code">count</code> most recent transactions skipping the first <code class="code">from</code> transactions for <code class="code">account</code>. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALlistunspent">listunspent</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns a list of the unspent transaction outputs that have between <code class="code">minconf</code> and <code class="code">maxconf</code> confirmations (these default to 1 and 999_999, respectively). </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALlockunspent">lockunspent</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Updates the list of temporarily unspendable transaction outputs. </div> </td></tr> <tr><td align="left"><br>M</td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALmove">move</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> <code class="code">move ?minconf ?comment from_account to_account amount</code> transfers the given amount from one account to another. </div> </td></tr> <tr><td align="left"><br>P</td></tr> <tr><td><a href="Bitcoin_ocamlnet.Httpclient.html#VALpost_string">post_string</a> [<a href="Bitcoin_ocamlnet.Httpclient.html">Bitcoin_ocamlnet.Httpclient</a>]</td> <td></td></tr> <tr><td><a href="Bitcoin.HTTPCLIENT.html#VALpost_string">post_string</a> [<a href="Bitcoin.HTTPCLIENT.html">Bitcoin.HTTPCLIENT</a>]</td> <td></td></tr> <tr><td align="left"><br>R</td></tr> <tr><td><a href="Bitcoin_ocamlnet.Httpclient.Monad.html#VALreturn">return</a> [<a href="Bitcoin_ocamlnet.Httpclient.Monad.html">Bitcoin_ocamlnet.Httpclient.Monad</a>]</td> <td></td></tr> <tr><td><a href="Bitcoin.HTTPCLIENT.Monad.html#VALreturn">return</a> [<a href="Bitcoin.HTTPCLIENT.Monad.html">Bitcoin.HTTPCLIENT.Monad</a>]</td> <td></td></tr> <tr><td align="left"><br>S</td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALsendfrom">sendfrom</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Transfers a given amount to the specified address, deducting the balance of the given account. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALsendmany">sendmany</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Makes multiple transfers from a given account. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALsendrawtransaction">sendrawtransaction</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Transmits the given raw transaction to the network. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALsendtoaddress">sendtoaddress</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Transfers a given amount to the specified address, deducting the balance of the defaul account. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALsetaccount">setaccount</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Associates the given address with the given account. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALsetgenerate">setgenerate</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Turns on/off the generation of new blocks (a.k.a. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALsettxfee">settxfee</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Sets the transaction fee to be used in subsequent transactions. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALsignmessage">signmessage</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Signs the given message with the private key of the given address. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALsignrawtransaction">signrawtransaction</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Signs a raw transaction, returning a pair with the signed transaction in hex format and a boolean indicating whether all private keys required for a successful signing have been found. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALsubmitblock">submitblock</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Attempts to submit new block to network. </div> </td></tr> <tr><td align="left"><br>V</td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALvalidateaddress">validateaddress</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Is the given address a valid Bitcoin address? If so, this function returns an object containing miscelaneous information about that address. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALverifymessage">verifymessage</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Returns a boolean indicating whether a supposedly signed message does indeed correspond to a source message signed with the given address. </div> </td></tr> <tr><td align="left"><br>W</td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALwalletlock">walletlock</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> Removes the wallet decryption key from memory, thus effectively locking the wallet. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALwalletpassphrase">walletpassphrase</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> <code class="code">walletpassphrase passphrase timeout</code> unlocks an encrypted wallet, storing the decryption key in memory. </div> </td></tr> <tr><td><a href="Bitcoin.ENGINE.html#VALwalletpassphrasechange">walletpassphrasechange</a> [<a href="Bitcoin.ENGINE.html">Bitcoin.ENGINE</a>]</td> <td><div class="info"> <code class="code">walletpassphrasechange old_passphrase new_passphrase</code> changes the wallet passphrase from <code class="code">old_passphrase</code> to <code class="code">new_passphrase</code>. </div> </td></tr> </table> </body> </html>
