Repository navigation
v0.5.0-beta1
Pre-release
Pre-release
·
8 commits
to release/0.5
since this release
🚀 What's New
- New bridge service introduced: Now includes v1 REST APIs, enabling improved interoperability and external integrations. Docs link for new bridge service
- Bats tests migrated: All Bats-based tests have been successfully moved to the e2e repository to centralize end-to-end testing across the ecosystem.
- gRPC Client Retry Mechanism: Added robust retry logic to gRPC clients to improve resilience during transient network or service issues.
- Refactoring of etherman package: Major clean-up and restructuring of the etherman logic to improve maintainability and performance.
- claimSponsor functionality is no longer supported
- General bug fixes and internal refactoring for enhanced code quality and reliability.
⚠️ Breaking Changes
- Deprecated bridge DBs: The old
bridgel1syncandbridgel2syncDBs are not compatible with this release.
❗ Important: A complete resynchronization of the associated databases is required when upgrading.
You must drop thebridgel1syncandbridgel2syncdatabases before starting the upgrade. - The old config file is incompatible with this version. Please refer to https://github.com/agglayer/aggkit/blob/release/0.5/config/default.go for new detailed configuration file
📋 Configuration Updates
DelayBeetweenRetriesconfig parameter is renamed toDelayBetweenRetries[Common.IsValidiumMode],[Common.ContractVersions],[Common.Translator],[Etherman](only top level configuration section, it is still actual for the EthTxManager) are removed[NetworkConfig.L1]renamed to[L1NetworkConfig][NetworkConfig.L1.PolAddr]renamed to[L1NetworkConfig.POLTokenAddr][NetworkConfig.L1.ZkEVMAddr]renamed to[L1NetworkConfig.RollupAddr]- introduced
RollupManagerAddrin aggsender config. It is an address to the RollupManager contract on L1. - introduce
L1GenesisBlockin aggsender config. It is the block number where the polygonZKEVM (rollup) smc was deployed on L1 - introduced
RequireOneBridgeInPPCertificatebool field to the aggsender config which is a flag to force the aggSender to have at least one bridge exit in the Pessimistic Proof certificates. By default it is true. - Introduced
RESTconfiguration - Introduced GRPC client config, that is able to provide the GRPC retry policy
- Latest GER synchronizer has introduced the
SyncModeconfiguration parameter. It denotes whether the last GER synchronizer should track events fired by the sovereign chain contracts (PP mode) or query the global exit root map (FEP mode) - Removed ClaimSponsor configuration as it's no longer part of the bridge service
- Updated L1NetworkConfig references to use Etherman configuration
- Modified block finality handling to use etherman.NewBlockNumberFinality instead of aggkittypes.NewBlockNumberFinality
- Updated network configuration structure to use NetworkConfig.L1Config for L1-specific settings
- Please refer to https://github.com/agglayer/aggkit/blob/release/0.5/config/default.go for new detailed configuration file
✅ Testing & Validation
- All features and changes have been thoroughly validated through:
- Local development testing
- Unit tests
- End-to-end tests (Bats tests, now running from the e2e repo)
What's Changed
- chore(deps): bump modernc.org/sqlite from 1.37.1 to 1.38.0 by @dependabot in #608
- fix: typo in
lastgersync0001.sqlmigration and add unit test by @Stefan-Ethernal in #611 - fix: false warning log by @goran-ethernal in #617
- feat: introduce on-demand Docker image building workflow by @Stefan-Ethernal in #595
- feat: bridge service by @Stefan-Ethernal in #222
- chore(deps): bump golang.org/x/crypto from 0.38.0 to 0.39.0 by @dependabot in #600
- chore(deps): bump golang.org/x/net from 0.40.0 to 0.41.0 by @dependabot in #597
- fix: make bridge exit limitation configurable by @goran-ethernal in #619
- feat: use start LER from contract by @goran-ethernal in #615
- feat: support for use AWS KMS by @joanestebanr in #628
- fix: add where clause to the get latest info until block by @Stefan-Ethernal in #637
- chore: update docs by @temaniarpit27 in #632
- feat: add testcase by @temaniarpit27 in #626
- refactor: declutter etherman logic by @Stefan-Ethernal in #570
- fix: add order by clause by @temaniarpit27 in #658
- fix: issue related to blockpos by @temaniarpit27 in #644
- fix: remove check by @temaniarpit27 in #646
- chore(deps): bump github.com/knadh/koanf/v2 from 2.2.0 to 2.2.1 by @dependabot in #653
- chore(deps): bump github.com/gin-gonic/gin from 1.10.0 to 1.10.1 by @dependabot in #651
- chore(deps): bump github.com/urfave/cli/v2 from 2.27.6 to 2.27.7 by @dependabot in #652
- feat: redirect gin output to debug logger by @Stefan-Ethernal in #645
- feat: cherry-pick - migration 0.2 to 0.3 issue (#661) by @goran-ethernal in #670
- docs: swagger docs by @rachit77 in #669
- ci(release): add release-published workflow by @sebastiendan in #649
- feat: provide option to run kurtosis or tests or both by @temaniarpit27 in #671
- fix: GetEventsByBlockRange retry by @temaniarpit27 in #672
- feat: cherry-pick: add MaxL2BlockNumber config param (#648) by @joanestebanr in #666
- feat: Handle errors in sub-calls by @rachit77 in #656
- fix: check if there are bridge transactions in gap by @goran-ethernal in #647
- feat: use minimal args by @temaniarpit27 in #677
- fix: add lock to loadTrackedHeaders in reorg detector by @Stefan-Ethernal in #682
- chore(deps): bump go.opentelemetry.io/otel from 1.36.0 to 1.37.0 by @dependabot in #689
- chore(deps): bump github.com/go-viper/mapstructure/v2 from 2.2.1 to 2.3.0 by @dependabot in #687
- chore: remove event parsing by @temaniarpit27 in #693
- feat: migration test by @joanestebanr in #678
- test: handle sub calls by @rachit77 in #685
- feat: panic bridge service db when data needs to resynced by @rachit77 in #695
New Contributors
- @sebastiendan made their first contribution in #649
Full Changelog: v0.4.0...v0.5.0-beta1