github.com/opzlabs/tendermint@v0.34.27-terra.rc.2/UPGRADING.md (about) 1 # Upgrading CometBFT 2 3 This guide provides instructions for upgrading to specific versions of CometBFT. 4 5 ## v0.34.27 6 7 This is the first official release of CometBFT, forked originally from 8 [Tendermint Core v0.34.24][v03424] and subsequently updated in Informal Systems' 9 public fork of Tendermint Core for [v0.34.25][v03425] and [v0.34.26][v03426]. 10 11 ### Upgrading from Tendermint Core 12 13 If you already make use of Tendermint Core (either the original Tendermint Core 14 v0.34.24, or Informal Systems' public fork), you can upgrade to CometBFT 15 v0.34.27 by replacing your dependency in your `go.mod` file: 16 17 ```bash 18 go mod edit -replace github.com/tendermint/tendermint=github.com/cometbft/cometbft@v0.34.27 19 ``` 20 21 We make use of the original module URL in order to minimize the impact of 22 switching to CometBFT. This is only possible in our v0.34 release series, and we 23 will be switching our module URL to `github.com/cometbft/cometbft` in the next 24 major release. 25 26 ### Home directory 27 28 CometBFT, by default, will consider its home directory in `~/.cometbft` from now 29 on instead of `~/.tendermint`. 30 31 ### Environment variables 32 33 The environment variable prefixes have now changed from `TM` to `CMT`. For 34 example, `TMHOME` or `TM_HOME` become `CMTHOME` or `CMT_HOME`. 35 36 We have implemented a fallback check in case `TMHOME` is still set and `CMTHOME` 37 is not, but you will start to see a warning message in the logs if the old 38 `TMHOME` variable is set. This fallback check will be removed entirely in a 39 subsequent major release of CometBFT. 40 41 ### Building CometBFT 42 43 CometBFT must be compiled using Go 1.19 or higher. The use of Go 1.18 is not 44 supported, since this version has reached end-of-life with the release of [Go 1.20][go120]. 45 46 ### Troubleshooting 47 48 If you run into any trouble with this upgrade, please [contact us][discussions]. 49 50 --- 51 52 For historical upgrading instructions for Tendermint Core v0.34.24 and earlier, 53 please see the [Tendermint Core upgrading instructions][tmupgrade]. 54 55 [v03424]: https://github.com/tendermint/tendermint/releases/tag/v0.34.24 56 [v03425]: https://github.com/informalsystems/tendermint/releases/tag/v0.34.25 57 [v03426]: https://github.com/informalsystems/tendermint/releases/tag/v0.34.26 58 [discussions]: https://github.com/cometbft/cometbft/discussions 59 [tmupgrade]: https://github.com/tendermint/tendermint/blob/35581cf54ec436b8c37fabb43fdaa3f48339a170/UPGRADING.md 60 [go120]: https://go.dev/blog/go1.20