mirrors/electrs
1
0
Fork 0
mirror of https://github.com/romanz/electrs.git synced 2024-11-19 01:43:29 +01:00
Code Issues Projects Releases Wiki Activity
5537c963c0
electrs/RELEASE-NOTES.md
Martin Habovstiak 5537c963c0 Detailed documentation of db_dir 
This warns users that they shouldn't touch `db_dir` internals except for
deleting the old `mainnet` database. It explains in details how to do
upgrade and deleting properly, calls it out in release notes and fixes
small style mistake in nearby heading.

It can be thought of as more explicit/detailed version of
8b8ebea0018d3e9a97ce965845b1914df4b4d8a4 or a textual alternative to
PR #513.
2021-09-29 22:15:53 +02:00

7.0 KiB
Raw Blame History

0.9.0 (TBD)

IMPORTANT: This release contains major changes, please read carefully!

The four main things to watch out for:

  • Database schema changed - this will cause reindex after upgrade.
  • mainnet subdirectory was renamed to bitcoin, you should delete mainnet after successful reindex.
  • We now use bitcoin p2p protocol to fetch blocks - some configurations may not work.
  • Trace log level now logs much more information - make sure it's not used in production.

See upgrading section of our docs to learn more.

Full list of changes:

  • Add electrs logo (#510)

0.9.0-rc2 (Sep 23 2021)

  • Prevent panic during logging of p2p messages (#490)
  • Don't collect process' Prometheus metrics by default (#492)
  • Support initial sync resume (#494)

0.9.0-rc1 (Sep 17 2021)

  • Fix incorrect ordering of same-block transactions (#297)
  • Change DB index format and use Zstd compression (instead of Snappy)
  • The database will be reindexed automatically when it encounters old version (#477)
  • Don't use bitcoind JSON RPC for fetching blocks (#373)
  • Use p2p protocol for headers and block fetching only. This is safer than reading blk*dat files and faster than JSON RPC.
  • Support Electrum JSON RPC batching and errors
  • Use rust-bitcoincore-rpc crate
  • Increase default index_lookup_limit to 200
  • Implement 'blockchain.scripthash.listunspent' RPC (#475)
  • Update RocksDB to 6.11.4 (#473)
  • Allow logging configuration via RUST_LOG environment variable (using env_logger)

0.8.12 (14 Sep 2021)

  • Fail if cookie is specified (#478)
  • Move usage in README up and recommend our guide (#463)
  • A bunch of improvements to issue templates (#462)

0.8.11 (18 Aug 2021)

  • Update dependencies (#401, #402)
  • Add python example in RPC examples (#415, #417)
  • Add regtest and signet networks in examples (#425)
  • Clippy fixes (#430)
  • CI fixes (#437, #438, #441)
  • Update relevant versions (#450)
  • Drop unused compression algorithms for RocksDB

0.8.10 (14 May 2021)

0.8.9 (19 Mar 2021)

  • Use non-batched RPC to reduce bitcoind memory usage (#373)
  • Fix inverted logic of deprecation (#379)
  • Ignore individual mempool transaction fetch fails (#381)
  • Increase default wait_duration_secs to 10s (#384)

0.8.8 (22 Feb 2021)

  • Deprecate --cookie configuration (@Kixunil)
  • Update dependencies (@Kixunil)
  • Improve documentation (@Kixunil)

0.8.7 (15 Jan 2021)

  • Support signet (#239)

0.8.6 (25 Nov 2020)

  • Fix Electrum fee histogram duplicates
  • Fix Electrum protocol negotiation
  • Update multiple crates (@kixunil): lru, prometheus, dirs-next
  • Support Rust 1.41.1 (for Debian stable)
  • Update bitcoin crate (@dr-orlovsky)
  • Fix a deadlock when shutting down (@kixunil)

0.8.5 (1 July 2020)

  • Add a 'blocks_dir' option (@darosior)
  • Return fee for unconfirmed transactions history (for Electrum 4.0)
  • Handle SIGUSR1 for external notifications

0.8.4 (3 June 2020)

  • Update to latest rust-bitcoin (@dr-orlovsky)
  • Fix deadlock and refactor RPC threading (@Kixunil)

0.8.3 (30 Jan 2020)

  • Fix memory leak (@champo)

0.8.2 (6 Dec 2019)

0.8.1 (20 Nov 2019)

  • Allow setting --cookie-file path via configuration (@Kixunil)
  • Bump rust-rocksdb to 0.13.0, using RockDB 6.2.4

0.8.0 (28 Oct 2019)

  • Use configure_me instead of clap to support config files, environment variables and man pages (@Kixunil)
  • Don't accept --cookie via CLI arguments (@Kixunil)
  • Define cache size in MB instead of number of elements (@dagurval)
  • Support Rust >=1.34 (for Debian)
  • Bump rust-rocksdb to 0.12.3, using RockDB 6.1.2
  • Bump bitcoin crate to 0.21 (@MichelKansou)

0.7.1 (27 July 2019)

  • Allow stopping bulk indexing via SIGINT/SIGTERM
  • Cache list of transaction IDs for blocks (@dagurval)

0.7.0 (13 June 2019)

  • Support Bitcoin Core 0.18
  • Build with LTO
  • Allow building with latest Rust (via feature flag)
  • Use iterators instead of returning vectors (@Kixunil)
  • Use atomics instead of Mutex<u64> (@Kixunil)
  • Better handling invalid blocks (@azuchi)

0.6.2 (17 May 2019)

  • Support Rust 1.32 (for Debian)

0.6.1 (9 May 2019)

  • Fix crash during initial sync
  • Switch to signal-hook crate

0.6.0 (29 Apr 2019)

  • Update to Rust 1.34
  • Prefix Prometheus metrics with 'electrs_'
  • Update RocksDB crate to 0.12.1
  • Update Bitcoin crate to 0.18
  • Support latest bitcoind mempool entry vsize field name
  • Fix "chain-trimming" reorgs
  • Serve by default on IPv4 localhost

0.5.0 (3 Mar 2019)

  • Limit query results, to prevent RPC server to get stuck (see --txid-limit flag)
  • Update RocksDB crate to 0.11
  • Update Bitcoin crate to 0.17

0.4.3 (23 Dec 2018)

  • Support Rust 2018 edition (1.31)
  • Upgrade to Electrum protocol 1.4 (from 1.2)
  • Let server banner be configurable via command-line flag
  • Improve query.get_merkle_proof() performance

0.4.2 (22 Nov 2018)

  • Update to rust-bitcoin 0.15.1
  • Use bounded LRU cache for transaction retrieval
  • Support 'server.ping' and partially 'blockchain.block.header' Electrum RPC

0.4.1 (14 Oct 2018)

  • Don't run full compaction after initial import is over (when using JSONRPC)

0.4.0 (22 Sep 2018)

  • Optimize for low-memory systems by using different RocksDB settings
  • Rename --skip_bulk_import flag to --jsonrpc-import

0.3.2 (14 Sep 2018)

  • Optimize block headers processing during startup
  • Handle TCP disconnections during long RPCs
  • Use # of CPUs for bulk indexing threads
  • Update rust-bitcoin to 0.14
  • Optimize block headers processing during startup

0.3.1 (20 Aug 2018)

  • Reconnect to bitcoind only on transient errors
  • Poll mempool after transaction broadcasting

0.3.0 (14 Aug 2018)

  • Optimize for low-memory systems
  • Improve compaction performance
  • Handle disconnections from bitcoind by retrying
  • Make blk*.dat ingestion more robust
  • Support regtest network
  • Support more Electrum RPC methods
  • Export more Prometheus metrics (CPU, RAM, file descriptors)
  • Add scripts/run.sh for building and running electrs
  • Add some Python tools (as API usage examples)
  • Change default Prometheus monitoring ports

0.2.0 (14 Jul 2018)

  • Allow specifying custom bitcoind data directory
  • Allow specifying JSONRPC cookie from commandline
  • Improve initial bulk indexing performance
  • Support 32-bit systems

0.1.0 (2 Jul 2018)