Update various references from Zcash to KMD
This commit is contained in:
Jonathan "Duke" Leto
@@ -1,12 +1,12 @@
|
||||
* zcash.conf: contains configuration settings for zcashd
|
||||
* zcashd.pid: stores the process id of zcashd while running
|
||||
* komodo.conf: contains configuration settings for komodod
|
||||
* komodod.pid: stores the process id of komodod while running
|
||||
* blocks/blk000??.dat: block data (custom, 128 MiB per file)
|
||||
* blocks/rev000??.dat; block undo data (custom)
|
||||
* blocks/index/*; block index (LevelDB)
|
||||
* chainstate/*; block chain state database (LevelDB)
|
||||
* database/*: BDB database environment
|
||||
* db.log: wallet database log file
|
||||
* debug.log: contains debug information and general logging generated by zcashd
|
||||
* debug.log: contains debug information and general logging generated by komodod
|
||||
* fee_estimates.dat: stores statistics used to estimate minimum transaction fees and priorities required for confirmation
|
||||
* peers.dat: peer IP address database (custom format)
|
||||
* wallet.dat: personal wallet (BDB) with keys and transactions
|
||||
|
||||
@@ -64,7 +64,7 @@ Command | Parameters | Description
|
||||
z_exportkey | zaddr | _Requires an unlocked wallet or an unencrypted wallet._<br><br>Return a zkey for a given zaddr belonging to the node’s wallet.<br><br>The key will be returned as a string formatted using Base58Check as described in the Zcash protocol spec.<br><br>Output:AKWUAkypwQjhZ6LLNaMuuuLcmZ6gt5UFyo8m3jGutvALmwZKLdR5
|
||||
z_importkey | zkey [rescan=true] | _Wallet must be unlocked._<br><br>Add a zkey as returned by z_exportkey to a node's wallet.<br><br>The key should be formatted using Base58Check as described in the Zcash protocol spec.<br><br>Set rescan to true (the default) to rescan the entire local block database for transactions affecting any address or pubkey script in the wallet (including transactions affecting the newly-added address for this spending key).
|
||||
z_exportwallet | filename | _Requires an unlocked wallet or an unencrypted wallet._<br><br>Creates or overwrites a file with taddr private keys and zaddr private keys in a human-readable format.<br><br>Filename is the file in which the wallet dump will be placed. May be prefaced by an absolute file path. An existing file with that name will be overwritten.<br><br>No value is returned but a JSON-RPC error will be reported if a failure occurred.
|
||||
z_importwallet | filename | _Requires an unlocked wallet or an unencrypted wallet._<br><br>Imports private keys from a file in wallet export file format (see z_exportwallet). These keys will be added to the keys currently in the wallet. This call may need to rescan all or parts of the block chain for transactions affecting the newly-added keys, which may take several minutes.<br><br>Filename is the file to import. The path is relative to zcashd’s working directory.<br><br>No value is returned but a JSON-RPC error will be reported if a failure occurred.
|
||||
z_importwallet | filename | _Requires an unlocked wallet or an unencrypted wallet._<br><br>Imports private keys from a file in wallet export file format (see z_exportwallet). These keys will be added to the keys currently in the wallet. This call may need to rescan all or parts of the block chain for transactions affecting the newly-added keys, which may take several minutes.<br><br>Filename is the file to import. The path is relative to komodod’s working directory.<br><br>No value is returned but a JSON-RPC error will be reported if a failure occurred.
|
||||
|
||||
### Payment
|
||||
|
||||
|
||||
22
doc/tor.md
22
doc/tor.md
@@ -33,7 +33,7 @@ outgoing connections be anonymized, but more is possible.
|
||||
|
||||
In a typical situation, this suffices to run behind a Tor proxy:
|
||||
|
||||
./zcashd -proxy=127.0.0.1:9050
|
||||
./komodod -proxy=127.0.0.1:9050
|
||||
|
||||
|
||||
2. Run a Zcash hidden server
|
||||
@@ -48,7 +48,7 @@ config file):
|
||||
HiddenServicePort 18233 127.0.0.1:18233
|
||||
|
||||
The directory can be different of course, but (both) port numbers should be equal to
|
||||
your zcashd's P2P listen port (8233 by default).
|
||||
your komodod's P2P listen port (8233 by default).
|
||||
|
||||
-externalip=X You can tell Zcash about its publicly reachable address using
|
||||
this option, and this can be a .onion address. Given the above
|
||||
@@ -70,7 +70,7 @@ your zcashd's P2P listen port (8233 by default).
|
||||
|
||||
In a typical situation, where you're only reachable via Tor, this should suffice:
|
||||
|
||||
./zcashd -proxy=127.0.0.1:9050 -externalip=zctestseie6wxgio.onion -listen
|
||||
./komodod -proxy=127.0.0.1:9050 -externalip=zctestseie6wxgio.onion -listen
|
||||
|
||||
(obviously, replace the Onion address with your own). It should be noted that you still
|
||||
listen on all devices and another node could establish a clearnet connection, when knowing
|
||||
@@ -81,14 +81,14 @@ your address. To mitigate this, additionally bind the address of your Tor proxy:
|
||||
If you don't care too much about hiding your node, and want to be reachable on IPv4
|
||||
as well, use `discover` instead:
|
||||
|
||||
./zcashd ... -discover
|
||||
./komodod ... -discover
|
||||
|
||||
and open port 8233 on your firewall (or use -upnp).
|
||||
|
||||
If you only want to use Tor to reach onion addresses, but not use it as a proxy
|
||||
for normal IPv4/IPv6 communication, use:
|
||||
|
||||
./zcashd -onion=127.0.0.1:9050 -externalip=zctestseie6wxgio.onion -discover
|
||||
./komodod -onion=127.0.0.1:9050 -externalip=zctestseie6wxgio.onion -discover
|
||||
|
||||
|
||||
3. Automatically listen on Tor
|
||||
@@ -110,12 +110,12 @@ and, if not disabled, configured using the `-torcontrol` and `-torpassword` sett
|
||||
To show verbose debugging information, pass `-debug=tor`.
|
||||
|
||||
Connecting to Tor's control socket API requires one of two authentication methods to be
|
||||
configured. For cookie authentication the user running zcashd must have write access
|
||||
configured. For cookie authentication the user running komodod must have write access
|
||||
to the `CookieAuthFile` specified in Tor configuration. In some cases this is
|
||||
preconfigured and the creation of a hidden service is automatic. If permission problems
|
||||
are seen with `-debug=tor` they can be resolved by adding both the user running tor and
|
||||
the user running zcashd to the same group and setting permissions appropriately. On
|
||||
Debian-based systems the user running zcashd can be added to the debian-tor group,
|
||||
the user running komodod to the same group and setting permissions appropriately. On
|
||||
Debian-based systems the user running komodod can be added to the debian-tor group,
|
||||
which has the appropriate permissions. An alternative authentication method is the use
|
||||
of the `-torpassword` flag and a `hash-password` which can be enabled and specified in
|
||||
Tor configuration.
|
||||
@@ -125,9 +125,9 @@ Tor configuration.
|
||||
-----------------------------------
|
||||
|
||||
To test your set-up, you might want to try connecting via Tor on a different computer to just a
|
||||
a single Zcash hidden server. Launch zcashd as follows:
|
||||
a single Zcash hidden server. Launch komodod as follows:
|
||||
|
||||
./zcashd -onion=127.0.0.1:9050 -connect=zctestseie6wxgio.onion
|
||||
./komodod -onion=127.0.0.1:9050 -connect=zctestseie6wxgio.onion
|
||||
|
||||
Now use zcash-cli to verify there is only a single peer connection.
|
||||
|
||||
@@ -146,4 +146,4 @@ Now use zcash-cli to verify there is only a single peer connection.
|
||||
|
||||
To connect to multiple Tor nodes, use:
|
||||
|
||||
./zcashd -onion=127.0.0.1:9050 -addnode=zctestseie6wxgio.onion -dnsseed=0 -onlynet=onion
|
||||
./komodod -onion=127.0.0.1:9050 -addnode=zctestseie6wxgio.onion -dnsseed=0 -onlynet=onion
|
||||
|
||||
10
doc/zmq.md
10
doc/zmq.md
@@ -46,7 +46,7 @@ operation.
|
||||
|
||||
By default, the ZeroMQ feature is automatically compiled in if the
|
||||
necessary prerequisites are found. To disable, use --disable-zmq
|
||||
during the *configure* step of building zcashd:
|
||||
during the *configure* step of building komodod:
|
||||
|
||||
$ ./configure --disable-zmq (other options)
|
||||
|
||||
@@ -67,8 +67,8 @@ address. The same address can be used in more than one notification.
|
||||
|
||||
For instance:
|
||||
|
||||
$ zcashd -zmqpubhashtx=tcp://127.0.0.1:28332 \
|
||||
-zmqpubrawtx=ipc:///tmp/zcashd.tx.raw
|
||||
$ komodod -zmqpubhashtx=tcp://127.0.0.1:28332 \
|
||||
-zmqpubrawtx=ipc:///tmp/komodod.tx.raw
|
||||
|
||||
Each PUB notification has a topic and body, where the header
|
||||
corresponds to the notification type. For instance, for the
|
||||
@@ -88,9 +88,9 @@ arriving. Please see `contrib/zmq/zmq_sub.py` for a working example.
|
||||
|
||||
## Remarks
|
||||
|
||||
From the perspective of zcashd, the ZeroMQ socket is write-only; PUB
|
||||
From the perspective of komodod, the ZeroMQ socket is write-only; PUB
|
||||
sockets don't even have a read function. Thus, there is no state
|
||||
introduced into zcashd directly. Furthermore, no information is
|
||||
introduced into komodod directly. Furthermore, no information is
|
||||
broadcast that wasn't already received from the public P2P network.
|
||||
|
||||
No authentication or authorization is done on connecting clients; it
|
||||
|
||||
@@ -235,8 +235,8 @@ UniValue getrawtransaction(const UniValue& params, bool fHelp)
|
||||
" ],\n"
|
||||
" \"vjoinsplit\" : [ (array of json objects, only for version >= 2)\n"
|
||||
" {\n"
|
||||
" \"vpub_old\" : x.xxx, (numeric) public input value in ZEC\n"
|
||||
" \"vpub_new\" : x.xxx, (numeric) public output value in ZEC\n"
|
||||
" \"vpub_old\" : x.xxx, (numeric) public input value in KMD\n"
|
||||
" \"vpub_new\" : x.xxx, (numeric) public output value in KMD\n"
|
||||
" \"anchor\" : \"hex\", (string) the anchor\n"
|
||||
" \"nullifiers\" : [ (json array of string)\n"
|
||||
" \"hex\" (string) input note nullifier\n"
|
||||
@@ -585,8 +585,8 @@ UniValue decoderawtransaction(const UniValue& params, bool fHelp)
|
||||
" ],\n"
|
||||
" \"vjoinsplit\" : [ (array of json objects, only for version >= 2)\n"
|
||||
" {\n"
|
||||
" \"vpub_old\" : x.xxx, (numeric) public input value in ZEC\n"
|
||||
" \"vpub_new\" : x.xxx, (numeric) public output value in ZEC\n"
|
||||
" \"vpub_old\" : x.xxx, (numeric) public input value in KMD\n"
|
||||
" \"vpub_new\" : x.xxx, (numeric) public output value in KMD\n"
|
||||
" \"anchor\" : \"hex\", (string) the anchor\n"
|
||||
" \"nullifiers\" : [ (json array of string)\n"
|
||||
" \"hex\" (string) input note nullifier\n"
|
||||
|
||||
@@ -2508,7 +2508,7 @@ UniValue getwalletinfo(const UniValue& params, bool fHelp)
|
||||
" \"keypoololdest\": xxxxxx, (numeric) the timestamp (seconds since GMT epoch) of the oldest pre-generated key in the key pool\n"
|
||||
" \"keypoolsize\": xxxx, (numeric) how many new keys are pre-generated\n"
|
||||
" \"unlocked_until\": ttt, (numeric) the timestamp in seconds since epoch (midnight Jan 1 1970 GMT) that the wallet is unlocked for transfers, or 0 if the wallet is locked\n"
|
||||
" \"paytxfee\": x.xxxx, (numeric) the transaction fee configuration, set in ZEC/KB\n"
|
||||
" \"paytxfee\": x.xxxx, (numeric) the transaction fee configuration, set in KMD/KB\n"
|
||||
"}\n"
|
||||
"\nExamples:\n"
|
||||
+ HelpExampleCli("getwalletinfo", "")
|
||||
@@ -3380,7 +3380,7 @@ UniValue z_getbalance(const UniValue& params, bool fHelp)
|
||||
"1. \"address\" (string) The selected address. It may be a transparent or private address.\n"
|
||||
"2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times.\n"
|
||||
"\nResult:\n"
|
||||
"amount (numeric) The total amount in ZEC received for this address.\n"
|
||||
"amount (numeric) The total amount in KMD received for this address.\n"
|
||||
"\nExamples:\n"
|
||||
"\nThe total amount received by address \"myaddress\"\n"
|
||||
+ HelpExampleCli("z_getbalance", "\"myaddress\"") +
|
||||
@@ -3607,7 +3607,7 @@ UniValue z_sendmany(const UniValue& params, bool fHelp)
|
||||
"2. \"amounts\" (array, required) An array of json objects representing the amounts to send.\n"
|
||||
" [{\n"
|
||||
" \"address\":address (string, required) The address is a taddr or zaddr\n"
|
||||
" \"amount\":amount (numeric, required) The numeric amount in ZEC is the value\n"
|
||||
" \"amount\":amount (numeric, required) The numeric amount in KMD is the value\n"
|
||||
" \"memo\":memo (string, optional) If the address is a zaddr, raw data represented in hexadecimal string format\n"
|
||||
" }, ... ]\n"
|
||||
"3. minconf (numeric, optional, default=1) Only use funds confirmed at least this many times.\n"
|
||||
|
||||
Reference in New Issue
Block a user