Version 3.2.7

[dcorral]

/kind chore

Items

• rpc: getburninfo performance improvements #1788
• Add support for batch generation of voting TXs  #1786
• Update listtransactions help dialogue #1785
• Restore ForEachAccount #1789
• Add missing CalculateOwnerRewards calls #1766
• Cache getblockchaininfo result #1791
• Add concurrency to liquidated vault validation #1803
• Test framework: Initial impl of exhaustive state verification with rollback #1713
• Add lock before vault liquidation #1806
• Abstract errors #1804
• Track reward addresses in settings #1802
• Eliminate the use of CLockFreeGuard with AtomicMutex #1800
• Switch getburninfo to use BufferPool #1799
• Introduce a generic thread-safe buffer pool #1798
• Fix CLockFreeGuard, introduce AtomicMutex #1797
• Fix getburninfo memoization #1796
• Remove int type warning #1793
• Add scope to lock #1807

Prerequisites

Previous master commit: f0a33ce8e2f1888e79af7e6ddebf1d9d628158c0

• Functional tests
• Jellyfish tests
• CI diff checks (Manually verified from https://github.com/DeFiCh/ain/actions/runs/4345287078/attempts/1)
• Other CI analyzer checks

Prepare Version

• Bump Version (configure.ac)
  • <major>: Planned consensus upgrades and major breaking releases
  • <minor>: Unplanned consensus upgrades and fixes
  • <patch>: Non-breaking releases (API additions are accepted)
• Major / Minor upgrade-only:
  • Bump Protocol Version (version.h)

Release notes checklist

• Release type:
  • Mandatory: Consensus
  • Recommended: Significant fixes, index changes, performance, or major additions
  • Optional: Everything else, including minor RPC additions
• Indexes
  • Reindex mandatory
  • Reindex optional (added features / fixes but node still continues without affecting consensus)
  • Reindex not-needed
• Document RPC changes since previous release
• Add release notes as comment below that's to be copied over once release is tagged

Planned release checklist / Post-release checklist

Note: Manual ops that's to be automated eventually after which it's a single checkpoint in pre-req.

• Approximate block height during point of this PR: https://defiscan.live/blocks/2719940

All versions

• Setup node with scratch sync
  • VM: mainnet-ain-scratch-<version>[+flags]
• Setup node with recent snap
  • VM: mainnet-ain-snap-<height>-<version>[+flags]

If re-index not mandatory:

• Update rollover node that's been incrementally rolled over from scratch
  • VM: mainnet-ain-rollover-scratch[+flags]
• Update rollover node from last version from one of it's snapshots
  • VM: mainnet-ain-rollover-snap-<height>[+flags]

Checks

• Sync to tip (at least till <rel-time-height>+120 blocks)
• Verify diff checks after across above VMs

Note: <version>: Separated units by _` if dot not allowed

[dcorral]

Recommended Upgrade

• Performance improvements:
  • Thread pool and concurrency optimizations: (#1788, #1803)
  • Cache getblockchaininfo result (#1791)
  • Remove CLockFreeGuard entirely in subsequent PRs and replace it with standard patterns of std::unique_lock coupled with AtomicMutex. (#1800), (#1797), (#1796)
• RPC
  • New votegovbatch (#1786)
  • listtransactions Adds previously undocumented output fields (#1785)
• Fixes
  • Restore ForEachAccount #1785 fixes:
    • #1778, #1783
  • Add missing CalculateOwnerRewards (#1766) fixes: (#1763)

Upgrade Notes

• For >= 3.2.4, no reindex needed. Drop-in upgrade.
• For >= 3.2.0 and <= 3.2.3, reindex is recommended, but optional and can be drop-in upgrade.
• For nodes >=3.0.x, one of the following is required:
  • Sync from any of snapshots from the DeFiChain team (below)
• For all other updates, one of the following is required: a fresh sync, the most recent snapshot.
• For nodes that are being restored from recent snapshot, as with all updates before: -rescan for the wallet txs and additionally -spv_resync for users who hold BTC. If either isn't used, they may not be shown in the wallet until rescanned/resynced.

Flag Changes

• None

RPC Changes

• New votegovbatch Create multiple voting TXs with a single RPC call.

Network Snapshot

• [Asia] https://defi-snapshots.s3.ap-southeast-1.amazonaws.com/index.txt
• [EU] https://defi-snapshots-europe.s3.eu-central-1.amazonaws.com/index.txt
• [Sydney] https://defi-snapshots-sydney.s3.ap-southeast-2.amazonaws.com/index.txt
• [US] https://defi-snapshots-us.s3.amazonaws.com/index.txt

What's Changed

• rpc: getburninfo performance improvements #1788
• Add support for batch generation of voting TXs  #1786
• Update listtransactions help dialogue #1785
• Restore ForEachAccount #1789
• Add missing CalculateOwnerRewards calls #1766
• Cache getblockchaininfo result #1791
• Add concurrency to liquidated vault validation #1803
• Test framework: Initial impl of exhaustive state verification with rollback #1713
• Add lock before vault liquidation #1806
• Abstract errors #1804
• Track reward addresses in settings #1802
• Eliminate the use of CLockFreeGuard with AtomicMutex #1800
• Switch getburninfo to use BufferPool #1799
• Introduce a generic thread-safe buffer pool #1798
• Fix CLockFreeGuard, introduce AtomicMutex #1797
• Fix getburninfo memoization #1796
• Remove int type warning #1793

Full Changelog: v3.2.6...v3.2.7

[prasannavl]

Updated release notes

Key motivations:

• The immediate section below Upgrade type is for "user centric" information. Helpful summary in simple form of the key updates where necessary.
• Definitely not: Copy paste of PR info or automated info unless that's absolutely relevant.
• Non-goal: Capture everything (that's what the below sections are for)
• Please take extra caution to ensure that "Upgrade Notes" aren't confusing. Get some one else to proof read.
  "Reindex is recommended but optional for people affected by bug X" is both incorrect and adds more confusion.

---

Recommended Upgrade

• Stability fixes:
  • Fixes missing tokens on the balance RPCs in edge cases even though consensus level balances were unaffected.
    • Issue: Nodes missed to index a cascaded chain of calculation that resulted from spent governance voting reward tokens
• Performance improvements:
  • getburninfo calculation is now done in parallel and is memoized on first call. Only the differential heights is recalculated making it much cheaper to be called.
  • Validation of vault liquidation logic is now done in parallel when hardware supports it and should be visible improvements on the sync performance with more hardware cores.

Upgrade Notes

• For >= 3.2.4, no reindex needed. Drop-in upgrade.
  • Reindex is optional, however recommended for wallets affected by (#1763)
• For >= 3.2.0 and <= 3.2.3, reindex is recommended, but optional and can be drop-in upgrade.
• For nodes >=3.0.x, one of the following is required:
  • Sync from any of snapshots from the DeFiChain team (below)
• For all other updates, one of the following is required: a fresh sync, the most recent snapshot.
• For nodes that are being restored from recent snapshot, as with all updates before: -rescan for the wallet txs and additionally -spv_resync for users who hold BTC. If either isn't used, they may not be shown in the wallet until rescanned/resynced.

Flag Changes

• None

RPC Changes

• Undocumented API for advanced uses only: votegovbatch

Network Snapshot

• [Asia] https://defi-snapshots.s3.ap-southeast-1.amazonaws.com/index.txt
• [EU] https://defi-snapshots-europe.s3.eu-central-1.amazonaws.com/index.txt
• [Sydney] https://defi-snapshots-sydney.s3.ap-southeast-2.amazonaws.com/index.txt
• [US] https://defi-snapshots-us.s3.amazonaws.com/index.txt

What's Changed

• Update listtransactions help dialogue by @shohamc1 in Update listtransactions help dialogue #1785
• Cache getblockchaininfo result by @Jouzo in Cache getblockchaininfo result #1791
• Add support for batch generation of voting TXs by @Bushstar in Add support for batch generation of voting TXs  #1786
• rpc: getburninfo performance improvements by @prasannavl in rpc: getburninfo performance improvements #1788
• Remove int type warning by @Mixa84 in Remove int type warning #1793
• Add missing CalculateOwnerRewards calls by @Bushstar in Add missing CalculateOwnerRewards calls #1766
• Restore ForEachAccount by @Bushstar in Restore ForEachAccount #1789
• Fix getburninfo memoization by @prasannavl in Fix getburninfo memoization #1796
• Fix CLockFreeGuard, introduce AtomicMutex by @prasannavl in Fix CLockFreeGuard, introduce AtomicMutex #1797
• Introduce a generic thread-safe buffer pool by @prasannavl in Introduce a generic thread-safe buffer pool #1798
• Switch getburninfo to use BufferPool by @prasannavl in Switch getburninfo to use BufferPool #1799
• Track reward addresses in settings by @Bushstar in Track reward addresses in settings #1802
• Eliminate the use of CLockFreeGuard with AtomicMutex by @prasannavl in Eliminate the use of CLockFreeGuard with AtomicMutex #1800
• Test framework: Initial impl of exhaustive state verification with rollback by @dcorral in Test framework: Initial impl of exhaustive state verification with rollback #1713
• Add concurrency to liquidated vault validation by @prasannavl in Add concurrency to liquidated vault validation #1803
• Abstract errors by @prasannavl in Abstract errors #1804
• Add lock before vault liquidation by @Jouzo in Add lock before vault liquidation #1806
• Add scope to lock by @Bushstar in Add scope to lock #1807
• Version 3.2.7 by @dcorral in Version 3.2.7 #1790

Full Changelog: v3.2.6...v3.2.7