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 and GetHeimdallApp to get the heimdall app object in external services
• Removed code dependency on bor repo
• Integration of security tools such as govuln, snyk and sonarqube
• 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

• Add missing backticks (#886)
• Log misspell (#896)

Testing and benchmarking

• Testing Toolkit v1 PR Template (#887)
• snyk and govuln integration (#898)
• update PR template to include nodes audience check (#921)
• Run unit tests in single core (#927)
• sonarqube integration (#935)
• CI: update CI to use matic-cli master branch (#936)

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

1. Provide a new approach to install heimdall binary with a shell script.
2. Remove bridge binary and add it as a subcommand in heimdalld.
3. Remove heimdalld-rest-server.service and heimdalld-bridge.service, and move heimdalld.service file from /etc/systemd/system to /lib/systemd/system.
4. Change default heimdall home from ~/.heimdalld to /var/lib/heimdall.
5. A new user named heimdall will be created during package installation if it doesn’t exist. This user will be running heimdall service.
6. Heimdall packaging installation is now simplified to sudo dpkg -i heimdalld-$version-$arch.deb
7. 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 and bridge are two separate binaries. In v0.3.0, bridge will become a subcommand of heimdalld.
• In v0.2.x, heimdalld, bridge, and rest-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:
  Before I[2022-09-22|19:11:42.896] Served RPC HTTP response
  After INFO [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 param logs_type = "json"
   in the heimdall-config.toml file.
• Change TaskDelayBetweenEachVal from 24s to 10s to reduce StateSynced 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

1. Provide a new approach to install heimdall binary with a shell script.
2. Remove bridge binary and add it as a subcommand in heimdalld.
3. Remove heimdalld-rest-server.service and heimdalld-bridge.service, and move heimdalld.service file from /etc/systemd/system to /lib/systemd/system.
4. Change default heimdall home from ~/.heimdalld to /var/lib/heimdall.
5. A new user named heimdall will be created during package installation if it doesn’t exist. This user will be running heimdall service.
6. Heimdall packaging installation is now simplified to sudo dpkg -i heimdalld-$version-$arch.deb
7. 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 and bridge are two separate binaries. In v0.3.0, bridge will become a subcommand of heimdalld.
• In v0.2.x, heimdalld, bridge, and rest-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:
  Before I[2022-09-22|19:11:42.896] Served RPC HTTP response
  After INFO [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 param logs_type = "json"
   in the heimdall-config.toml file.
• Change TaskDelayBetweenEachVal from 24s to 10s to reduce StateSynced 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.2.12

This release includes changes required for RPC calls happening to main chain (ethereum / goerli) from heimdall to be EIP-155 compliant. It also uses the latest bor client module and includes related changes.

Full Changelog: v0.2.11...v0.2.12

v0.3.0-beta2

Changelog

• 6d9e5aa Remove dependency on mainnet.toml and mumbai.toml
• 57375b9 Add linter to CI pipeline (#844)
• 57fd500 Fixed helper.UnpackLog function call in the self-healing process (#853)
• 8467363 Add 'heimdall' user during package installation
• a4d5d67 Set default max number of open files for heimdall service
• 7f7e9bf Merge pull request #854 from maticnetwork/v0.3.0-candidate-2
• 31cac53 merge v0.2.11
• d8855c1 add testcase
• fab8d5f remove cli checks
• a4afbc2 add checks in clu
• 30bf8f4 fix
• bcec282 Merge pull request #846 from maticnetwork/mardizzone/fix-nodeflag-name
• 4ee2300 fix: dev: change NodeFlag to TendermintNodeFlag
• e9f27d1 Merge pull request #845 from maticnetwork/mardizzone/pos-493-fix
• ce3f53f new: dev: pos-493 init NQuerier when AccountRetriever is initialised
• 78be6fe Merge pull request #838 from maticnetwork/mardizzone/pos-493
• 7087cdd Merge pull request #842 from cffls/develop
• 230340f Merge remote-tracking branch 'upstream/develop' into develop
• 6b06017 new: dev: pos-493 add missing dependencies
• 4686fcb new: dev: pos-493 solve dependencies
• 9889a67 Merge branch 'develop' into mardizzone/pos-493
• ff9a223 new: dev: pos-493 fix import
• 8919460 Merge branch 'mardizzone/pos-493' of https://github.com/maticnetwork/heimdall into mardizzone/pos-493
• 0064ef4 new: dev: pos-493 solve issue due to conflicts with develop
• fefd149 Added metrics to self-healing logic (#841)
• 5bc4d3e Merge branch 'develop' into mardizzone/pos-493
• 9ed581d Fallback to self-healing defaults (#843)
• f7de1e7 Merge branch 'v0.3.0-dev' into develop
• 78f3de5 Add integration tests to CI
• 879659a Merge branch 'develop' into mardizzone/pos-493
• d896799 Added self-healing defaults to the config tmpl (#840)
• 5029400 new: dev: pos-493 solve conflicts / 2
• d84c86d new: dev: pos-493 solve conflicts
• a00443a Merge branch 'develop' into mardizzone/pos-493
• 3f2d53c Merge pull request #835 from maticnetwork/vaibhav/Go1.18.1Compatiblity
• 2324802 Added a logic to self-heal StateSynced and StakeUpdate events (#837)
• e8a56da new: dev: pos-493 fix close client and listener
• 5d1edb3 new: dev: pos-493 use func to defer finish on mockCtrl / check and close listeners
• a0659c9 new: dev: pos-493 use simulation for tests
• 42850d8 new: dev: pos-493 use default config also for other tests
• 3e0e499 new: dev: pos-493 new mock ctrl for each iteration
• b7e3a75 new: dev: pos-493 fix tests
• 7393173 new: dev: pos-493 remove pleonastic base processor initialiser
• 92f09c1 new: dev: pos-493 remove path for init heimdall config
• 7c2adaa new: dev: pos-493 test GetUnconfirmedTxnCount
• 4fba38f new: dev: pos-493 use dummy url / remove todo
• aa97686 new: dev: pos-493 complete test for SendTaskWithDelay
• 794e970 new: dev: pos-493 complete test for isOldTx and CalculateTaskDelay
• ec3a35d new: dev: pos-493 complete test for SendStateSyncedToHeimdall / Update sys package
• 3ea20e1 Update the golang.org/x/sys version
• e36a3b9 new: dev: pos-493 add tests setup
• 6de25b2 new: dev: pos-493 benchmark test for SendStateSyncedToHeimdall
• 87ca16f task delay change
• 81722d2 Merge pull request #834 from maticnetwork/mardizzone/pos-463
• 06811f0 fix: dev: pos-463 set TaskDelayBetweenEachVal to 10s
• 43aceff Merge pull request #828 from maticnetwork/vaibhav/POS-325
• aaed399 fix: update minor comments
• e269bde Update handler.go
• 0a617a1 Update side_handler.go
• 40975e7 Delete .golangci.yml
• 88f8574 Merge pull request #833 from maticnetwork/mardizzone/pos-494-add-flag-to-use-json-logger
• bf13a58 .
• 920df0d Merge pull request #832 from maticnetwork/stale-workflow
• 9543d23 .
• 3fce630 Merge branch 'develop' into vaibhav/POS-325
• 43ad99f new: dev: pos-494 use equal instead of strings comparator
• 3860543 new: dev: pos-494 fix imports
• b85af50 new: dev: pos-494 add comment for json logger in cosmos-sdk
• 045b3e3 new: dev: pos-494 restore default logger in tests
• 24b0cc4 new: dev: pos-494 minor fixes
• 9985814 new: dev: pos-494 use helper logger everywhere
• 835c649 new: dev: pos-494 use helper logger also in utils
• 4020bbe new: dev: pos-494 fix default logger in init
• bbc492d new: dev: pos-494 fix
• c1801c9 new: dev: pos-494 fix
• 82fa111 new: dev: pos-494 lazy init logger
• 09d236b new: dev: pos-494 check for default value
• a8ff865 new: dev: pos-494 apply default value
• d9d1f0e new: dev: pos-494 use bool
• c7b1b71 new: dev: pos-494 fix flag
• 79d5bae Create stale.yml
• 551c22b new: dev: pos-494 add json logger for heimdall bridge
• 6b5c861 Merge pull request #830 from maticnetwork/mardizzone/pos-452-add-logging-in-datadog-for-state-sync
• dc38dd6 Revert "fix: dev: pos-452 test json logger"
• 3d00dc5 fix: dev: pos-452 test json logger
• a5c9690 fix: dev: pos-452 log time for unconfirmed txs count
• 406c3d2 Improvement in logs
• 4758d3d Improvement in logs
• 5e8cf12 fix: dev: pos-452 simplify LogElapsedTimeForStateSyncedEvent function
• 14b4528 fix: dev: pos-452 add typecast check on stateSynced events
• 27c148d fix: dev: pos-452 test-5 consider event type and its pointer
• 1e1b873 fix: dev: pos-452 test-4 fix type
• b1c3522 fix: dev: pos-452 test-3 log event type
• 77ac5f0 fix: dev: pos-452 test-2 log event type
• 5642ddb fix: dev: pos-452 test log event type
• 4bd6eac fix: dev: pos-452 implement logging util
• eaca771 fix: dev: pos-452 use defer to log regardless early return
• 9a5a46a fix: dev: pos-452 fix loggs based on keyValues maps
• cc43b70 fix: dev: pos-452 remove useless log
• c76e047 fix: dev: pos-452 unpack and then log eventId
• d7b66a9 fix: dev: pos-452 use logInfo instead of logDebug
• 03e5a7d fix: dev: pos-452 debug log in isOldTx when tx is old
• 7494442 fix: dev: pos-452 use UnixNano for retrocompatibility
• 267566a fix: dev: pos-452 move import
• 82f8c00 fix: dev: pos-452 remove useless log
• a14480e fix: dev: pos-452 add logs for stateSyncedEvents to bridge
• ff7aa42 Set ubuntu as default user in service file
• fc18f55 Merge pull request #826 from maticnetwork/jc/v0.3.0-dev
• e08928c .
• f87188f Docker changes for v0.3.0
• 5d2d573 Improved clerk logging
• 20b94b3 Improved the checkpoint logging
• 6f1c2d1 Merge pull request #825 from maticnetwork/jc/v0.3.0-dev
• 69c0156 Merge branch 'master' into v0.3.0-dev
• 9cc10a6 Change default heimdall home to /var/lib/heimdall
• 1c3bb09 Merge pull request #822 from maticnetwork/0xkrishna/pos-348
• f94c988 Minor refactor
• c283e30 update logging
• 60a7746 Update retry delay time and calculation
• 2df6929 Merge pull request #820 from maticnetwork/jc/v0.3.0-dev
• 47d99e5 Bump Go version to v1.18.1
• 7d806b1 Merge pull request #811 from maticnetwork/vcastellm/pos-296-bump-go-version-in-bor-and-heimdall
• ca33cc5 [Bug fix] Add --all flag to bridge
• b3ca506 Add Checkpoint ID in REST APIs Result (#806)
• 76d2e14 bridge/setu: check state sync tx against mempool while broadcast (#805)
• f81b981 Correction to help info for "-n" flag on create-testnet (#809)
• 13ef8de helper: fix typo of displaying bor rpc timeout instead of eth (#818)
• 56f25e6 feat: add context on rpc calls for timeout (#815)
• 67af597 Bump Go version to v1.18.1
• 8889642 Fixed Height Bug (#799)
• 7d44d45 Modify Bridge Params (#800)
• 5ded296 mumbai upgrade for v0.2.8 (#795)
• 3cdebf1 Adding Spans in Heimdall (#791)
• 52dfc0f Merge pull request #779 from moonce-tech/ngotchac/fix-version
• c03aa4f Merge pull request #787 from maticnetwork/releases/v0.2.x
• dc9ba46 Merge pull request #788 from maticnetwork/vcastellm/fix-version
• cc87b3a Properly set the version on all binaries build
• 5114e0d Fix halt-height issue (#782)
• c1d14af 50000 size (#781)
• 5ca1c1b bridge: Add version command
• 96b70b7 Pass BUILD_FLAGS to build and ensure version command runs
• 6569fcd Merge pull request #775 from maticnetwork/feat--tendermint-scripts
• e2b228f Added json2wal and wal2json scripts
• abea0f1 Merge pull request #774 from maticnetwork/fix-cli-checkpoint-count
• 5bc1e98 fixed: cli-checkpoint-count
• 34fdea5 Merge pull request #770 from maticnetwork/krishna/validator-topup-fix
• 3d0e899 Remove validator id check

v0.2.11

Bug Fixes