This marks the fourth public release of poold, and the second minor release after the initial public release.
This release contains new features as well as bug fixes and one breaking change to the output of the batch snapshot response (see Release Notes below).
Verifying the Release
In order to verify the release, you'll need to have gpg or gpg2 installed on your system. Once you've obtained a copy (and hopefully verified that as well), you'll first need to import the keys that have signed this release if you haven't done so already:
curl https://keybase.io/roasbeef/pgp_keys.asc | gpg --import
Once you have the required PGP keys, you can verify the release (assuming manifest-v0.4.1-alpha.txt and manifest-v0.4.1-alpha.txt.asc are in the current directory) with:
gpg --verify manifest-v0.4.1-alpha.txt.asc
You should see the following if the verification was successful:
gpg: assuming signed data in 'manifest-v0.4.1-alpha.txt'
gpg: Signature made Thu Nov 12 16:31:37 2020 PST
gpg: using RSA key 60A1FA7DA5BFF08BDCBBE7903BBD59E99B280306
gpg: Good signature from "Olaoluwa Osuntokun <laolu32@gmail.com>" [ultimate]
That will verify the signature of the manifest file, which ensures integrity and authenticity of the archive you've downloaded locally containing the binaries. Next, depending on your operating system, you should then re-compute the sha256 hash of the archive with shasum -a 256 <filename>, compare it with the corresponding one in the manifest file, and ensure they match exactly.
Verifying the Release Binaries
Our release binaries are fully reproducible. Third parties are able to verify that the release binaries were produced properly without having to trust the release manager(s). See our reproducible builds guide for how this can be achieved. The release binaries are compiled with go1.15.5, which is required by verifiers to arrive at the same ones.
The make release command can be used to ensure one rebuilds with all the same flags used for the release. If one wishes to build for only a single platform, then make release sys=<OS-ARCH> tag=<tag> can be used.
Finally, you can also verify the tag itself with the following command:
The signature on the tag itself can be verified with:
git verify-tag v0.4.1-alpha
Building the Contained Release
Users are able to rebuild the target release themselves without having to fetch any of the dependencies. In order to do so, assuming that vendor.tar.gz and poold-source-v0.4.1-alpha.tar.gz are in the current directory, follow these steps:
tar -xvzf vendor.tar.gz
tar -xvzf lnd-source-v0.4.1-alpha.tar.gz
GO111MODULE=on go install -v -mod=vendor ./cmd/poold
GO111MODULE=on go install -v -mod=vendor ./cmd/pool
The -mod=vendor flag tells the go build command that it doesn't need to fetch the dependencies, and instead, they're all enclosed in the local vendor directory.
Additionally, it's now possible to use the enclosed release.sh script to bundle a release for a specific system like so:
make release sys="linux-arm64 darwin-amd64"
Release Notes
Bug fixes
Pending channels from batches that were never finalized and never made it to the chain are now also cleaned up on restart.
A misleading and dangerous sounding error message related to removing those pending channels was demoted to DBG instead of WRN.
A bug that lead to a de-synced account state was fixed by properly removing stale batch snapshots if a new pending batch is accepted.
Improvements
The trader client was updated to support multiple distinct lease durations for orders. New markets with other (most likely longer) lease durations will be added over time, depending on demand. The current available markets can be queried with the pool auction leasedurations command.
Accounts can now be renewed in one on-chain transaction instead of needing to close and re-open them with 2 transactions. New accounts are now created with a default expiration of 30 days (expressed in blocks). This value can be overwritten by setting the --expiry_height (absolute) or --expiry_height (relative) flags on the pool accounts new command.
Further improvements:
- Update to be compatible with
lnd v0.12.0-beta.rc5and later: #199 - Update documentation on how to cancel orders: ae48cf3
- Refactor work to the funding manager for better unit testing: #187
Breaking Changes
As a preparation for supporting multiple distinct lease duration buckets, the batch snapshot responses (pool auction snapshot command or BatchSnapshot RPC method) no longer contain a single clearing_price_rate field. Previous versions of Pool clients will always show a value of 0 for all snapshots.
After updating to v0.4.1-alpha, there is a new field matched_markets that is a map of the lease duration (by default 2016 blocks) and the orders that were matched for the duration, with the rate given as clearing_price_rate.
Example:
$ pool auction snapshot
[
{
"version": 0,
"batch_id": "...",
"prev_batch_id": "...",
"batch_tx_id": "...",
"batch_tx": "...",
"batch_tx_fee_rate_sat_per_kw": 254,
"creation_timestamp_ns": 11651379494838206464,
"matched_markets": {
"2016": {
"matched_orders": [
{
"ask": {
"lease_duration_blocks": 4032,
"rate_fixed": 2
},
"bid": {
"lease_duration_blocks": 144,
"rate_fixed": 6
},
"matching_rate": 6,
"total_sats_cleared": 5000000,
"units_matched": 50
}
],
"clearing_price_rate": 6
}
}
}
]Contributors (Alphabetical Order)
BLdotN
Olaoluwa Osuntokun
Oliver Gugger
Wilmer Paulino