Browse Source

Add release blurb.

master
Neil Booth 8 years ago
parent
commit
c32b04d1a7
  1. 9
      RELEASE-NOTES
  2. 23
      samples/scripts/NOTES
  3. 2
      server/version.py

9
RELEASE-NOTES

@ -1,3 +1,12 @@
Version 0.03
------------
- merged bauerj's abstracted DB engine contribution to make it easy to
play with different backends. In addition to LevelDB this adds
support for RocksDB and LMDB. We're interested in your comparitive
performance experiences.
Version 0.02 Version 0.02
------------ ------------

23
samples/scripts/NOTES

@ -1,7 +1,5 @@
The following environment variables are required: The following environment variables are required:
COIN - see lib/coins.py, must be a coin NAME
NETWORK - see lib/coins.py, must be a coin NET
DB_DIRECTORY - path to the database directory (if relative, to run script) DB_DIRECTORY - path to the database directory (if relative, to run script)
USERNAME - the username the server will run as USERNAME - the username the server will run as
SERVER_MAIN - path to the server_main.py script (if relative, to run script) SERVER_MAIN - path to the server_main.py script (if relative, to run script)
@ -11,18 +9,15 @@ DAEMON_URL - the URL used to connect to the daemon. Should be of the form
DAEMON_HOST and DAEMON_PORT. DAEMON_PORT is optional and DAEMON_HOST and DAEMON_PORT. DAEMON_PORT is optional and
will default appropriately for COIN. will default appropriately for COIN.
In addition either RPC_URL must be given as the full RPC URL for
connecting to the daemon, or you must specify RPC_HOST, RPC_USER,
RPC_PASSWORD and optionally RPC_PORT (it defaults appropriately for
the coin and network otherwise).
The other environment variables are all optional and will adopt The other environment variables are all optional and will adopt
sensible defaults if not specified. sensible defaults if not specified.
REORG_LIMIT - maximum number of blocks to be able to handle in a chain COIN - see lib/coins.py, must be a coin NAME. Defaults to Bitcoin.
reorganisation. ElectrumX retains some fairly compact NETWORK - see lib/coins.py, must be a coin NET. Defaults to mainnet.
undo information for this many blocks in levelDB. REORG_LIMIT - maximum number of blocks to be able to handle in a chain
Default is 200. reorganisation. ElectrumX retains some fairly compact
undo information for this many blocks in levelDB.
Default is 200.
Your performance might change by tweaking these cache settings. Cache Your performance might change by tweaking these cache settings. Cache
size is only checked roughly every minute, so the caches can grow size is only checked roughly every minute, so the caches can grow
@ -47,5 +42,7 @@ UTXO_MB - amount of UTXO and history cache, in MB, to retain before
very dependent on hardware and you may have different very dependent on hardware and you may have different
results. results.
DB_ENGINE - database engine for the transaction database, either rocksdb, DB_ENGINE - database engine for the transaction database. Default is
leveldb or lmdb leveldb. Supported alternatives are rocksdb and lmdb,
which will require installation of the appropriate python
packages.

2
server/version.py

@ -1 +1 @@
VERSION = "ElectrumX 0.02" VERSION = "ElectrumX 0.03"

Loading…
Cancel
Save