This guide provides instructions for upgrading to specific versions of CometBFT.
For users explicitly making use of the Go APIs provided in the crypto/merkle
package, please note that, in order to fix a potential security issue, we had to
make a breaking change here. This change should only affect a small minority of
users. For more details, please see
#557.
This is the first official release of CometBFT, forked originally from Tendermint Core v0.34.24 and subsequently updated in Informal Systems' public fork of Tendermint Core for v0.34.25 and v0.34.26.
If you already make use of Tendermint Core (either the original Tendermint Core
v0.34.24, or Informal Systems' public fork), you can upgrade to CometBFT
v0.34.27 by replacing your dependency in your go.mod file:
go mod edit -replace github.com/tendermint/tendermint=github.com/cometbft/[email protected]We make use of the original module URL in order to minimize the impact of
switching to CometBFT. This is only possible in our v0.34 release series, and we
will be switching our module URL to github.com/cometbft/cometbft in the next
major release.
CometBFT, by default, will consider its home directory in ~/.cometbft from now
on instead of ~/.tendermint.
The environment variable prefixes have now changed from TM to CMT. For
example, TMHOME or TM_HOME become CMTHOME or CMT_HOME.
We have implemented a fallback check in case TMHOME is still set and CMTHOME
is not, but you will start to see a warning message in the logs if the old
TMHOME variable is set. This fallback check will be removed entirely in a
subsequent major release of CometBFT.
CometBFT must be compiled using Go 1.19 or higher. The use of Go 1.18 is not supported, since this version has reached end-of-life with the release of Go 1.20.
If you run into any trouble with this upgrade, please contact us.
For historical upgrading instructions for Tendermint Core v0.34.24 and earlier, please see the Tendermint Core upgrading instructions.