Database Migrations

There are a number of database migrations in this release. Please be aware that downgrading to a previous version will not be possible once the migrations have been applied. Make sure you create a backup before updating and please report any issues with the database migrations.

Breaking changes

The configuration value (universe.public-access) and command line flag (--universe.public-access) now needs a value and is no longer a boolean. The value now controls whether the node's universe database can be accessed over RPC and either read (value r) or written to (value w) or both (value rw).
So existing nodes with the configuration file value universe.public-access=true need to change the value to universe.public-access=rw. Users specifying the command line flag --universe.public-access just need to append a value, for example --universe.public-access=rw.

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://raw.githubusercontent.com/lightninglabs/taproot-assets/main/scripts/keys/roasbeef.asc | gpg --import

Once you have the required PGP keys, you can verify the release (assuming manifest-roasbeef-v0.4.0-alpha.rc3.sig and manifest-v0.4.0-alpha.rc3.txt are in the current directory) with:

gpg --verify manifest-roasbeef-v0.4.0-alpha.rc3.sig manifest-v0.4.0-alpha.rc3.txt

You should see the following if the verification was successful:

gpg: Signature made Wed Sep 30 17:35:20 2020 PDT
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 Timestamp

From this new version onwards, in addition time-stamping the git tag with OpenTimestamps, we'll also now timestamp the manifest file along with its signature. Two new files are now included along with the rest of our release artifacts: manifest-roasbeef-v0.4.0-alpha.rc3.txt.asc.ots.

Assuming you have the opentimestamps client installed locally, the timestamps can be verified with the following commands:

ots verify manifest-roasbeef-v0.4.0-alpha.rc3.sig.ots -f manifest-roasbeef-v0.4.0-alpha.rc3.sig

Alternatively, the OpenTimestamps website can be used to verify timestamps if one doesn't have a bitcoind instance accessible locally.

These timestamps should give users confidence in the integrity of this release even after the key that signed the release expires.

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.22.3, 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:

$ git verify-tag v0.4.0-alpha.rc3
gpg: Signature made Tue Sep 15 18:55:00 2020 PDT
gpg:                using RSA key 60A1FA7DA5BFF08BDCBBE7903BBD59E99B280306
gpg: Good signature from "Olaoluwa Osuntokun <laolu32@gmail.com>" [ultimate]

Verifying the Docker Images

To verify the tapd and tapcli binaries inside the docker images against the signed, reproducible release binaries, there is a verification script in the image that can be called (before starting the container for example):

$ docker run --rm --entrypoint="" lightninglabs/taproot-assets:v0.4.0-alpha.rc3 /verify-install.sh v0.4.0-alpha.rc3
$ OK=$?
$ if [ "$OK" -ne "0" ]; then echo "Verification failed!"; exit 1; done
$ docker run lightninglabs/taproot-assets [command-line options]

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 tapd-source-v0.4.0-alpha.rc3.tar.gz are in the current directory, follow these steps:

tar -xvzf vendor.tar.gz
tar -xvzf tapd-source-v0.4.0-alpha.rc3.tar.gz
GO111MODULE=on go install -v -mod=vendor -ldflags "-X github.com/lightninglabs/taproot-assets/build.Commit=v0.4.0-alpha.rc3" ./cmd/tapd
GO111MODULE=on go install -v -mod=vendor -ldflags "-X github.com/lightninglabs/taproot-assets/build.Commit=v0.4.0-alpha.rc3" ./cmd/tapcli

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"

⚡️⚡️⚡️ OK, now to the rest of the release notes! ⚡️⚡️⚡️

Release Notes

What's Changed

itest: add main universe server harness, turn on proof courier for all test cases by @guggero in #712
Federation envoy re-attempts sync push for issuance proofs by @ffranr in #698
tapgarden: fix races and deadlocks in caretaker by @jharveyb in #693
gitignore: add non-debug binaries to ignore by @guggero in #724
tapdb: add minimalistic test framework for testing DB migrations by @guggero in #707
rpcserver+tapscript: err shadowing fixes by @jharveyb in #713
misc: group key testing by @jharveyb in #717
Update test vectors by @ffranr in #733
Add asset group burn itest, logging, and missing error handling by @ffranr in #732
Refactor fed envy event handling by @ffranr in #731
multiverse: add overlay points for universe trees by @guggero in #624
Add means to specify sqlite db file path for tapd test harness and db unit tests by @ffranr in #735
rpcserver: skip local meta data lookup for genesis proof by @guggero in #744
Multi-input PSBT spend for homogeneous input asset ID by @ffranr in #743
Add enhanced prometheus metrics for tapd by @GeorgeTsagk in #716
multi: attempt to fix issue of high number of TCP connections by explicitly closing connections and implementing an idle timer by @Roasbeef in #719
muti: fix typos by @AtomicInnovation321 in #748
proof courier: general cleanup and refactor, re-try after restart by @guggero in #734
chore: fix typos by @GoodDaisy in #752
multi: anchor fee test coverage by @jharveyb in #605
Refactor and cleanup custodian events cache handling by @ffranr in #756
itest: extend multi-input PSBT spend test to include partial value spend by @ffranr in #747
Fix typos by @cristiantroy in #764
[1/2] custodian: look up proofs in local universe as well by @guggero in #726
taprpc+tapdb: ListTransfers RPC optionally filters on anchor tx hash by @ffranr in #761
Increase group witness test coverage by @jharveyb in #549
tapdb: add support for logging migrations by @Roasbeef in #772
[tap channels preparation 1/?]: Add QueryInternalKey and QueryScriptKey RPCs, pre-fill script key info in vPSBT by @guggero in #765
makefile: add command to generate git release tags by @ffranr in #720
[2/2] proof: allow proof courier to short cut with local archive by @guggero in #730
tapdb: fix migration 15 by @guggero in #784
itest: use configurable timeout for load test by @guggero in #795
itest: universe server harness uses a dedicated LND node by @ffranr in #800
tools: exclude non-project files from go version consistency lint check by @ffranr in #775
vPSBT: add sighash support (no version bump) by @GeorgeTsagk in #779
multi: introduce new meta type for json strings by @Roasbeef in #794
[preparation 1/2]: refactor to simplify send logic, prepare for new RPCs by @guggero in #799
Linter checks for fmt.Errorf error wrap misuse by @ffranr in #812
Fix unit and integration test flakes by @guggero in #811
tapgarden: tapscript tree support for minting anchor outputs by @jharveyb in #768
A minimal version of the RFQ system by @ffranr in #767
multi: add linters for switch exhaustiveness, if-else chains, and err handling by @jharveyb in #817
[psbt saga part 2/4]: preparation: refactor send logic, make passive assets independent by @guggero in #805
Improve coin selection unit tests by @guggero in #823
Refactor the RFQ service to handle payment init via asset sale by @ffranr in #814
Makefile optimizations by @gijswijs in #842
[psbt saga part 3/4]: taprpc: add CommitVirtualPsbts and PublishAndLogTransfer RPC methods by @guggero in #787
[psbt saga part 4/4]: Multisig demo by @guggero in #796
[psbt saga 5/4]: Anchor multiple virtual transactions by @guggero in #821
sqlc: bump version by @guggero in #847
RFQ refactor towards adding asset sell request support by @ffranr in #845
makefile: fix build-itest command failure when vendor dir present by @ffranr in #851
itest: trustless swap based on vPSBT/PSBT sighash flags by @GeorgeTsagk in #804
cmd/tapcli: allow proof file or single proof on insert by @guggero in #856
Add asset sell support to the RFQ service by @ffranr in #835
tapgarden: check for ErrProofNotFound when checking for local proof file by @Roasbeef in #862
[events API 1/2]: Add new send and receive streaming RPCs by @guggero in #836
RFQ cleanup by @ffranr in #860
Add RFQ buy offer by @ffranr in #861
Add lll linter to golangci-lint configuration by @gijswijs in #868
tools: update linter to latest, update linter config by @jharveyb in #870
[events API 2/2]: Add new mint streaming RPC, notify on errors, replay previous send/receive events by @guggero in #853
itest: small fixes for tapd load test by @calvinrzachman in #869
tapgarden: add FundBatch and SealBatch requests by @jharveyb in #827
Use new WalletKit.FundPsbt coin selection option by @GeorgeTsagk in #858
Lightning channel proof-of-concept refactor commits by @ffranr in #896
tapgarden: implement SealBatch by @jharveyb in #866
RFQ modifications derived from the tap channels proof-of-concept by @ffranr in #904
[custom channels 1/3]: create aux leaf store and tlv.Blob decoders by @guggero in #878
Add version fields to RFQ wire messages by @ffranr in #911
[custom channels 2/3]: add aux leaf signer by @guggero in #885
[custom channels 3/3]: add FundingController to manage channel asset funding by @Roasbeef in #882
[custom channels 4/3]: add traffic shaper and invoice manager implementations by @guggero in #912
tapchannel: add new AuxChanCloser to enable co-op close for asset channels by @Roasbeef in #919
Add RPC price oracle service V2 by @ffranr in #926
Reduce RFQ wire message type count by @ffranr in #921
rfq+tapchannel: track locally accepted quotes in manager by @guggero in #928
RFQ enrich incoming accept messages with sent requests by @ffranr in #931
Enhance universe server/syncing CLI config control by @ffranr in #927
Add general RFQ accept wire msg type by @ffranr in #937
Custom channel bug fixes by @guggero in #936
tapd: temporarily increase query stats cache from 80k to 200k by @Roasbeef in #854
More custom channel bugfixes by @guggero in #939
Add decimal display field for mints by @GeorgeTsagk in #930
Add lock time (CSV/CLTV) support to asset scripts, finish adding versions everywhere by @guggero in #933
build: add yyforyongyu pgp key by @yyforyongyu in #950
scripts/keys: add ellemouton pgp key by @ellemouton in #949
tapgarden: batch restart fixes by @jharveyb in #941
Precision field checking by @jharveyb in #952
tapchannelmsg: increase channel data reader max record size by @ffranr in #959
server+tapchannel: modify PaymentBandwidth to return link bandwidth by @ffranr in #962
Add decimal display to taprpc.Asset by @GeorgeTsagk in #960
tapchannel: implement new AuxSweeper sub-system by @Roasbeef in #938
tapchannel: fix linter, formatting and typos by @guggero in #963
Fix proof storage clobber error for postgres backend by @gijswijs in #954
Fix duplicate asset creation in itest by @guggero in #965
Add field UnconfirmedTransfers to RPC endpoint ListAssets by @ffranr in #969
tapchannel: update lnd dep and fix bug in breach handling by @Roasbeef in #970
tapdb: implement basic migration downgrade protection by @Roasbeef in #973
tapchannel: add 30 second timeout for funding ack by @Roasbeef in #971
docs: add sample-tapd.conf by @Roasbeef in #978
tapchannel: use taproot overlay chan type for asset chans by @Roasbeef in #975
taprpc: Set dec display when metadata is empty by @jharveyb in #979
build: bump version to v0.4 rc1 by @Roasbeef in #976
add gijswijs pgp key by @gijswijs in #982
github: check out release tag before building by @guggero in #981
tapdb: backup sqlite db before running database migration by @ffranr in #968
taprpc: decimal display requires JSON meta by @jharveyb in #983
tapdb: add anchor point to SetSpent, remove LIMIT 1 by @guggero in #984
tapdb: remove duplicate assets before adding unique index by @guggero in #980
tapchannel: import funding output proofs for responder during co-op close by @Roasbeef in #987
build: bump version to v0.4.0-alpha.rc2 by @Roasbeef in #991
tapdb: Predicate asset-entries-DB update/deletion by duplicate table by @gijswijs in #993
build: update to latest lnd version w/ msg router fix by @Roasbeef in #1000
tapgarden: list batches correctly after asset transfer by @jharveyb in #992
proof: relax parsing in DecDisplayForAssetID by @Roasbeef in #1002

New Contributors

@AtomicInnovation321 made their first contribution in #748
@GoodDaisy made their first contribution in #752
@cristiantroy made their first contribution in #764
@gijswijs made their first contribution in #842
@calvinrzachman made their first contribution in #869
@yyforyongyu made their first contribution in #950
@ellemouton made their first contribution in #949

Full Changelog: v0.3.3...v0.4.0-alpha.rc3

lightninglabs/taproot-assets v0.4.0-alpha.rc3 on GitHub