NODE.rdoc in bitcoin-ruby-0.0.6

- old
+ new

@@ -31,11 +31,11 @@
 
 <tt>--skip-validation</tt>::
   Skip validation of received blockchain data. Can be used to speed up import/sync when
   blockchain data is received from a trusted source.
 
-<tt>--check-blocks <i><count></i>::
+<tt>--check-blocks <i><count></i></tt>::
   Check consistency of the +count+ most recent blocks. Pass -1 to check all blocks.
 
 <tt>-v --verbose</tt>::
   Display debug output.
 
@@ -47,126 +47,179 @@
 
 == Command socket
 
 The node opens a separate command socket which you can connect to and query statistics
 or get notified about new blocks/tx, etc. See below for a list of available commands.
+For more details, see Bitcoin::Network::CommandHandler.
 
 === CLI interface
 
-The easiest way is to just call `bitcoin_node` again in the same way you started it,
-but with an extra command argument:
+The `bitcoin_node_cli` command can be used to interface with a running node, send it commands
+and subscribe to notifications about new blocks/txs, etc.
+The easiest way is to just call `bitcoin_node_cli` in the same way you started
+`bitcoin_node`, but with extra command arguments:
 
- bitcoin_node info
- bitcoin_node -c config.yml info
- bitcoin_node monitor "block tx"
+ bitcoin_node_cli info
+ bitcoin_node_cli -c config.yml info
+ bitcoin_node_cli monitor "block tx"
 
 
 === CommandClient
 
 If you are programming in an EventMachine context, you might find the
 Bitcoin::Network::CommandClient convenient.
 
 === Raw socket
 
 Of course you can also connect to the socket by any other means you like, just
-send [<command>, <params>] pairs and receive [<command>, <response>] pairs back (both
-encoded in JSON):
+your commands as valid JSON, like:
 
- $ echo -e '["tslb", []]\0' | nc 127.0.0.1 9999
- ["tslb",{"tslb":2700}]
+ {"id": 0, "method": <command>, "params": <params>}
 
+and you'll receive responses in the form:
 
+ {"id": <id>, "method": <method>, "result": <result>}
+
+For example:
+
+ $ echo -e '{"id": 1, "method": "tslb", "params": {}}\0' | nc 127.0.0.1 9999
+ {"id":1,"method":"tslb","result":{"tslb":10}}
+
+
 === Commands
 
 ==== info
 
 Get various statistics.
 
- bitcoin_node info
+ bitcoin_node_cli info
 
 ==== config
 
 Get the currently active configuration.
 
- bitcoin_node config
+ bitcoin_node_cli config
 
 ==== connections
 
 Get currently connected peers.
 
- bitcoin_node connections
+ bitcoin_node_cli connections
 
 ==== connect
 
 Connect to given peer(s).
 
- bitcoin_node connect <ip>:<port>[,<ip>:<port>]
+ bitcoin_node_cli connect <ip>:<port>[,<ip>:<port>]
 
 ==== disconnect
 
 Disconnect given peer(s).
 
- bitcoin_node disconnect <ip>:<port>[,<ip>,<port>]
+ bitcoin_node_cli disconnect <ip>:<port>[,<ip>,<port>]
 
 ==== getblocks
 
 Trigger the node to ask its peers for new blocks.
 
- bitcoin_node getblocks
+ bitcoin_node_cli getblocks
 
 ==== getaddr
 
 Trigger the node to ask its for new peer addresses.
 
- bitcoin_node getaddr
+ bitcoin_node_cli getaddr
 
 ==== addrs
 
 Get known peer addresses (used by bin/bitcoin_dns_seed)
 
- bitcoin_node addrs [count]
+ bitcoin_node_cli addrs [count]
 
 ==== tslb
 
 Get Time Since Last Block.
 
- bitcoin_node tslb
+ bitcoin_node_cli tslb
 
 ==== create_tx
 
-TODO
+Create a transaction, collecting outputs from given +keys+, spending to +recipients+
+with an optional +fee+.
+Keys is an array that can contain either privkeys, pubkeys or addresses.
+When a privkey is given, the corresponding inputs are signed. If not, the
+signature_hash is computed and passed along with the response.
+After creating an unsigned transaction, one just needs to sign the sig_hashes
+and send everything to #assemble_tx, to receive the complete transaction that
+can be relayed to the network.
 
+ bitcoin_node_cli create_tx 'keys=[<addr|pub|priv>, <...>]' 'recipients=[[<addr>, <amount>], ...]'
+
 ==== assemble_tx
 
-TODO
+Assemble an unsigned transaction from the +tx+ and +sig_pubkeys+ params and return
+a valid transaction that can be relayed to the network.
+The +tx+ is the regular transaction structure, with empty input scripts
+(as returned by #create_tx when called without privkeys).
++sig_pubkeys+ is an array of [signature, pubkey] pairs used to build the input scripts.
 
+ bitcoin_node_cli assemble_tx tx=<hex> 'sig_pubkeys=[[<sig>, <pub>], ...]'
+
 ==== relay_tx
 
 Relay given transaction (in hex).
 
- bitcoin_node relay_tx <tx in hex>
+ bitcoin_node_cli relay_tx <tx in hex>
 
 ==== store_block
 
 Validate and store given block (in hex) as if it was received by a peer.
 
- bitcoin_node store_block <block in hex>
+ bitcoin_node_cli store_block <block in hex>
 
 ==== store_tx
 
 Store given transaction (in hex) as if it was received by a peer.
 
- bitcoin_node store_tx <tx in hex>
+ bitcoin_node_cli store_tx <tx in hex>
 
 ==== stop
 
 Stop the bitcoin node.
 
- bitcoin_node stop
+ bitcoin_node_cli stop
 
 ==== help
 
 List all available commands.
 
- bitcoin_node help
+ bitcoin_node_cli help
 
 
+=== Monitors
+
+==== block
+
+Monitor new blocks that are accepted into the main chain.
+If +last+ parameter is given, it will send all blocks since then.
+
+ bitcoin_node_cli monitor channel=block
+ bitcoin_node_cli monitor channel=block last=1234
+
+==== tx
+
+Monitor new transactions.
+If +conf+ parameter is given, it will only send txs with at least that many confirmations.
+If +last+ parameter is given, it will send all txs since then.
+
+ bitcoin_node_cli monitor channel=tx
+ bitcoin_node_cli monitor channel=tx conf=1 last=b187505ce2acbafcb02948657c0cadb855fbcbf0491f12670f9ff8d271de1983
+
+==== output
+
+Monitor transaction outputs.
+If +conf+ parameter is given, it will only send outputs with at least that many confirmations.
+If +last+ parameter is given, it will send all outputs since then.
+If +addresses+ parameter is given, it will only send outputs related to those addresses.
+
+ bitcoin_node_cli monitor channel=output
+ bitcoin_node_cli monitor channel=output conf=1 last=b187505ce2acbafcb02948657c0cadb855fbcbf0491f12670f9ff8d271de1983:0