Releases: maticnetwork/heimdall
v0.3.5
This version consists of several bug fixes and minor improvements.
What's Changed
- helper: return error in client call to fetch root hash by @manav2401 in #1007
- Merge master to develop by @pratikspatil024 in #1009
- helper: improve logging for default config values by @manav2401 in #1010
- Update code comments by @manav2401 in #1001
- dev: chg: pos-1465: remove snyk and sonarqube by @marcello33 in #1012
- Fix typo by @yorickdowne in #1014
- Fix HaltHeight and HaltTime config/CLI options so that they work by @svenski123 in #1003
- mardizzone/POS-1311: go and deps upgrade by @marcello33 in #1019
- fixed typo in multiple go files by @criadoperez in #1018
- Fix:SignBytes representation of empty string data field in the event-… by @VAIBHAVJINDAL3012 in #1016
- helper: change newHexToStringAlgoHeight height for mumbai by @Raneet10 in #1027
- update tendermint version by @Raneet10 in #1024
- scripts: fix lint by @Raneet10 in #1028
New Contributors
- @yorickdowne made their first contribution in #1014
- @svenski123 made their first contribution in #1003
- @criadoperez made their first contribution in #1018
Special Mentions
- A big 'thank you' to @svenski123 for highlighting the heimdall sync issue and his invaluable contributions to this release by suggesting the solution for the same.Your expertise and hard work have made a significant impact (#1004)
Full Changelog: v0.3.4...v0.3.5-beta-1
v1.0.0-beta
This version introduces new hardfork and several bug fixes.
Important Information
- This release contains a new hardfork called
Aalborg
which will activate milestone on Polygon PoS chain which will bring faster and deterministic finality. - Please refer to this PIP-11 for more info.
- Make sure to upgrade Bor to v1.0.0-beta before upgrading Heimdall to this version.
- Make sure to start Heimdall service with
--chain=mumbai
for Mumbai chain and--chain=mainnet
for Mainnet chain otherwise hardfork won't be activated.
What's Changed
- gov,types: fix tests by @Raneet10 in #1000
- exempt draft PRs by @temaniarpit27 in #1034
- Typos on go files by @criadoperez in #1032
- Improvements on Makefile by @criadoperez in #1033
- Vaibhav/milestone iteration1 by @VAIBHAVJINDAL3012 in #1038
- Fix:Stop the rotation of validatorSet at any update in it. by @VAIBHAVJINDAL3012 in #983
- Vaibhav/milestone by @VAIBHAVJINDAL3012 in #939
- BB13203 Issue by @VAIBHAVJINDAL3012 in #984
- Combine multiple hardforks into one by @VAIBHAVJINDAL3012 in #1039
- checkpoint: Fix checkpoint ack condition by @Raneet10 in #1043
- version change by @temaniarpit27 in #1046
- Fix:Milestone hardfork fixes by @VAIBHAVJINDAL3012 in #1045
- Arpit/version change by @temaniarpit27 in #1047
- auth: update error type when milestone tx arrives before HF by @VAIBHAVJINDAL3012 in #1049
Full Changelog: v0.3.5-beta-1...v1.0.0-beta
v0.3.5-beta-1
This version consists of several bug fixes and minor improvements.
What's Changed
- helper: return error in client call to fetch root hash by @manav2401 in #1007
- Merge master to develop by @pratikspatil024 in #1009
- helper: improve logging for default config values by @manav2401 in #1010
- Update code comments by @manav2401 in #1001
- dev: chg: pos-1465: remove snyk and sonarqube by @marcello33 in #1012
- Fix typo by @yorickdowne in #1014
- Fix HaltHeight and HaltTime config/CLI options so that they work by @svenski123 in #1003
- mardizzone/POS-1311: go and deps upgrade by @marcello33 in #1019
- fixed typo in multiple go files by @criadoperez in #1018
- Fix:SignBytes representation of empty string data field in the event-… by @VAIBHAVJINDAL3012 in #1016
- helper: change newHexToStringAlgoHeight height for mumbai by @Raneet10 in #1027
- update tendermint version by @Raneet10 in #1024
- scripts: fix lint by @Raneet10 in #1028
New Contributors
- @yorickdowne made their first contribution in #1014
- @svenski123 made their first contribution in #1003
- @criadoperez made their first contribution in #1018
Special Mentions
- A big 'thank you' to @svenski123 for highlighting the heimdall sync issue and his invaluable contributions to this release by suggesting the solution for the same.Your expertise and hard work have made a significant impact (#1004)
Full Changelog: v0.3.4...v0.3.5-beta-1
v0.3.4
Version v0.3.4 is a new incremental release containing several new features and fixes.
What's Changed
- Add missing backticks by @wysenynja in #886
- Testing Toolkit v1 PR Template by @marcello33 in #887
- OpenTelemetry Support by @0xsharma in #895
- Log misspell by @mrostamii in #896
- Created service package by @0xKrishna in #899
- mardizzone/pos-944 snyk and govuln integration by @marcello33 in #898
- Updating packager as binutils changed version so that apt-get install… by @djpolygon in #918
- Add a flag to turn on/off self healing by @cffls in #920
- dev: chg: update PR template to include nodes audience check by @marcello33 in #921
- Merge remote-tracking branch 'upstream/master' into develop by @cffls in #924
- Add a flag to turn on/off self healing by @cffls in #925
- Don't overwrite heimdall-config in heimdalld init by @cffls in #926
- Run unit tests in single core by @cffls in #927
- Remove unwanted import as it is creating cyclic dependency by @0xKrishna in #931
- dev: chg: minor fix to slightly change PR template structure by @marcello33 in #923
- sonarqube integration by @marcello33 in #935
- CI: update CI to use matic-cli master branch by @Raneet10 in #936
- Merge develop into qa by @cffls in #940
- heimdal init respects the chain flag by @pratikspatil024 in #942
- updated coment regarding --heimdall_rest_server by @pratikspatil024 in #943
- dev: chg: POS-1215 move sonarqube to own ci by @marcello33 in #946
- mardizzone/hotfix-snyk: remove vcs build when running snyk by @marcello33 in #952
- Added logs_writer flag by @0xKrishna in #953
- Updated readme with correct docs link by @0xKrishna in #955
- dev: chg: POS-1114 & POS-1180: fix unstakeInit bug and introduce constants by @marcello33 in #962
- mardizzone/merge-master-to-qa by @marcello33 in #964
- mardizzone/merge-qa-to-develop by @marcello33 in #965
- dev: chg: bump crypto package by @marcello33 in #967
- Merge develop to qa by @marcello33 in #969
- dev: chg: continue on error when uploading snyk results to GH by @marcello33 in #975
- Adding self hosted 18.04 runner usage by @djpolygon in #982
- Added logs to event-record handler by @0xKrishna in #976
- dev: chg: use node-16 contracts branch by @marcello33 in #988
- Added a script to increase the version by @pratikspatil024 in #989
- mardizzone/fix-govulncheck-action by @marcello33 in #991
- Enable migration of root chain contract addresses by @cffls in #987
- clerk/client/rest :: add : blocktime check in recordListHandlerFn by @0xsharma in #993
- Merge master to qa by @pratikspatil024 in #997
- Merge qa to develop by @pratikspatil024 in #998
- ci: update CI yaml config by @Raneet10 in #999
- Merge v0.3.4-beta-candidate to qa by @pratikspatil024 in #1005
- version bump to v0.3.4 by @pratikspatil024 in #1006
New Contributors
- @wysenynja made their first contribution in #886
- @mrostamii made their first contribution in #896
Full Changelog: v0.3.3...v0.3.4
v0.3.4-beta
What's Changed
- Add missing backticks by @wysenynja in #886
- Testing Toolkit v1 PR Template by @marcello33 in #887
- OpenTelemetry Support by @0xsharma in #895
- Log misspell by @mrostamii in #896
- Created service package by @0xKrishna in #899
- mardizzone/pos-944 snyk and govuln integration by @marcello33 in #898
- Updating packager as binutils changed version so that apt-get install… by @djpolygon in #918
- Add a flag to turn on/off self healing by @cffls in #920
- dev: chg: update PR template to include nodes audience check by @marcello33 in #921
- Merge remote-tracking branch 'upstream/master' into develop by @cffls in #924
- Add a flag to turn on/off self healing by @cffls in #925
- Don't overwrite heimdall-config in heimdalld init by @cffls in #926
- Run unit tests in single core by @cffls in #927
- Remove unwanted import as it is creating cyclic dependency by @0xKrishna in #931
- dev: chg: minor fix to slightly change PR template structure by @marcello33 in #923
- sonarqube integration by @marcello33 in #935
- CI: update CI to use matic-cli master branch by @Raneet10 in #936
- Merge develop into qa by @cffls in #940
- heimdal init respects the chain flag by @pratikspatil024 in #942
- updated coment regarding --heimdall_rest_server by @pratikspatil024 in #943
- dev: chg: POS-1215 move sonarqube to own ci by @marcello33 in #946
- mardizzone/hotfix-snyk: remove vcs build when running snyk by @marcello33 in #952
- Added logs_writer flag by @0xKrishna in #953
- Updated readme with correct docs link by @0xKrishna in #955
- dev: chg: POS-1114 & POS-1180: fix unstakeInit bug and introduce constants by @marcello33 in #962
- mardizzone/merge-master-to-qa by @marcello33 in #964
- mardizzone/merge-qa-to-develop by @marcello33 in #965
- dev: chg: bump crypto package by @marcello33 in #967
- Merge develop to qa by @marcello33 in #969
- dev: chg: continue on error when uploading snyk results to GH by @marcello33 in #975
- Adding self hosted 18.04 runner usage by @djpolygon in #982
- Added logs to event-record handler by @0xKrishna in #976
- dev: chg: use node-16 contracts branch by @marcello33 in #988
- Added a script to increase the version by @pratikspatil024 in #989
- mardizzone/fix-govulncheck-action by @marcello33 in #991
- Enable migration of root chain contract addresses by @cffls in #987
- clerk/client/rest :: add : blocktime check in recordListHandlerFn by @0xsharma in #993
- Merge master to qa by @pratikspatil024 in #997
- Merge qa to develop by @pratikspatil024 in #998
- ci: update CI yaml config by @Raneet10 in #999
New Contributors
- @wysenynja made their first contribution in #886
- @mrostamii made their first contribution in #896
Full Changelog: v0.3.3...v0.3.4-beta
v0.3.3
Version v0.3.3
is a new incremental release containing several new features:
- PR template for heimdall
- Support for OpenTelemetry Collector to allow developers to trace multiple functions and send traces to observability dashboards like Datadog, Jaeger etc.
- Changes to heimdalld folder, So that heimdall process can be started from other services/scripts by using
NewHeimdallService
as a constructor method to start the process andGetHeimdallApp
to get the heimdall app object in external services - Removed code dependency on bor repo
- Integration of security tools such as
govuln
,snyk
andsonarqube
- Updated packager for
binutils
- Flag to turn on/off self-healing process (disabled by default)
- Minor improvements
- Version bump
What's Changed
- Merge qa to master by @marcello33 in #970
- mardizzone/version-bump by @marcello33 in #971
- Version bump (0.3.3) by @pratikspatil024 in #974
- dev: add: add login to docker hub for release workflow by @marcello33 in #977
- hotfix/docker-auth by @marcello33 in #978
v0.3.2
This is an incremental release to v0.3.1-beta and contains some important fixes.
What's Changed
- bump : go version to v1.20 by @0xsharma in #954
- Hotfixes and unstakeInit bugfix by @marcello33 in #958
- packaging: bump version by @Raneet10 in #959
Full Changelog: v0.3.0...v0.3.2
v0.3.1-beta
Change log:
Improvements and feature additions:
- OpenTelemetry Support (#895)
- Resttruct heimdalld (#899)
- Add a flag to turn on/off self healing (#925)
- Don't overwrite heimdall-config in heimdalld init (#926)
- Remove unwanted import as it is creating cyclic dependency (#931)
Bug fixes
Testing and benchmarking
v0.3.0
We have released a new version of Bor and Heimdall - v0.3.0 with an incremented minor version. As explained in the previous post, we have added a new CLI in Bor and have also changed the way Bor and Heimdall are deployed to follow DevOps best practices and make it easier to manage the processes. This upgrade is backwards incompatible. Please ensure that all Mumbai nodes are upgraded soon, before the release of the next version v0.3.1 that will contain a hardfork which is scheduled to kick in on 7th Dec 2022 (tentative).
Important Note: For our next releases, v0.3.1 and onward, upgrading to version 0.3.0 is necessary.
Changes from deployment perspective
- Provide a new approach to install heimdall binary with a shell script.
- Remove
bridge
binary and add it as a subcommand inheimdalld
. - Remove
heimdalld-rest-server.service
andheimdalld-bridge.service
, and moveheimdalld.service
file from/etc/systemd/system
to/lib/systemd/system
. - Change default heimdall home from
~/.heimdalld
to/var/lib/heimdall
. - A new user named
heimdall
will be created during package installation if it doesn’t exist. This user will be running heimdall service. - Heimdall packaging installation is now simplified to
sudo dpkg -i heimdalld-$version-$arch.deb
- Heimdall profile installation for new hosts is accomplished by running
sudo dpkg -i heimdalld-$network-$nodetype-config_$version-$arch.deb
Detailed changelog
- In v0.2.x,
heimdalld
andbridge
are two separate binaries. In v0.3.0,bridge
will become a subcommand ofheimdalld
. - In v0.2.x,
heimdalld
,bridge
, andrest-server
are run in three different processes. In v0.3.0, they could be launched together in a single process with one CLI command. - In v0.3.0, building different
heimdalld
binary for different network is no longer needed.heimdalld
binary will support both mainnet and mumbai testnet. - Log level of heimdall is changed from a single letter to a full word. Example:
BeforeI[2022-09-22|19:11:42.896] Served RPC HTTP response
AfterINFO [2022-09-22|19:11:42.896] Served RPC HTTP response
- heimdall no longer needs a genesis file. Instead, the genesis file will be embedded in the binary of heimdalld.
- Provide possibility to log in
json
format by setting the paramlogs_type = "json"
in theheimdall-config.toml
file. - Change
TaskDelayBetweenEachVal
from 24s to 10s to reduceStateSynced
event delays - Log elapsed time for each method involved in the
StateSynced
flow. - Add benchmark tests for the most time consuming functions involved in the
StateSynced
flow.
Full Changelog: v0.2.12...v0.3.0-beta
v0.3.0-beta
We have released a new version of Bor and Heimdall - v0.3.0 with an incremented minor version. As explained in the previous post, we have added a new CLI in Bor and have also changed the way Bor and Heimdall are deployed to follow DevOps best practices and make it easier to manage the processes. This upgrade is backwards incompatible. Please ensure that all Mumbai nodes are upgraded soon, before the release of the next version v0.3.1 that will contain a hardfork which is scheduled to kick in on 7th Dec 2022 (tentative).
Important Note: For our next releases, v0.3.1 and onward, upgrading to version 0.3.0 is necessary.
Changes from deployment perspective
- Provide a new approach to install heimdall binary with a shell script.
- Remove
bridge
binary and add it as a subcommand inheimdalld
. - Remove
heimdalld-rest-server.service
andheimdalld-bridge.service
, and moveheimdalld.service
file from/etc/systemd/system
to/lib/systemd/system
. - Change default heimdall home from
~/.heimdalld
to/var/lib/heimdall
. - A new user named
heimdall
will be created during package installation if it doesn’t exist. This user will be running heimdall service. - Heimdall packaging installation is now simplified to
sudo dpkg -i heimdalld-$version-$arch.deb
- Heimdall profile installation for new hosts is accomplished by running
sudo dpkg -i heimdalld-$network-$nodetype-config_$version-$arch.deb
Detailed changelog
- In v0.2.x,
heimdalld
andbridge
are two separate binaries. In v0.3.0,bridge
will become a subcommand ofheimdalld
. - In v0.2.x,
heimdalld
,bridge
, andrest-server
are run in three different processes. In v0.3.0, they could be launched together in a single process with one CLI command. - In v0.3.0, building different
heimdalld
binary for different network is no longer needed.heimdalld
binary will support both mainnet and mumbai testnet. - Log level of heimdall is changed from a single letter to a full word. Example:
BeforeI[2022-09-22|19:11:42.896] Served RPC HTTP response
AfterINFO [2022-09-22|19:11:42.896] Served RPC HTTP response
- heimdall no longer needs a genesis file. Instead, the genesis file will be embedded in the binary of heimdalld.
- Provide possibility to log in
json
format by setting the paramlogs_type = "json"
in theheimdall-config.toml
file. - Change
TaskDelayBetweenEachVal
from 24s to 10s to reduceStateSynced
event delays - Log elapsed time for each method involved in the
StateSynced
flow. - Add benchmark tests for the most time consuming functions involved in the
StateSynced
flow.
Full Changelog: v0.2.12...v0.3.0-beta