aggkit

package module

v0.12.0-rc2 Latest Latest Go to latest Published: Oct 28, 2026 License: Apache-2.0, MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/agglayer/aggkit

Links

Open Source Insights

README ¶

AggKit

AggKit is a modular framework that developers can use to connect networks to the AggLayer

Getting Started

Pre-requisites

Setup Kurtosis following these instructions: Kurtosis CDK Getting Started

Local Testing

You can run locally against kurtosis-cdk environment using: docs/local_debug.md

Build locally

You can locally build a production release of AggKit CLI + AggKit with:

make build

Run locally

You can build and run a debug binary locally using:

build the aggkit binary

make build-aggkit

run the aggkit binary

cd target/
aggkit run --cfg <CONFIG_FILE> --components <COMPONENTS_TO_RUN>

Running with Kurtosis

Run your kurtosis environment
build cdk-erigon and make it available in your system's PATH
Run scripts/local_config

Contributing

Contributions are very welcomed, the guidelines are currently not available (WIP)

Support

Feel free to open an issue if you have any feature request or bug report.

License

Licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

The SPDX license identifier for this project is MIT OR Apache-2.0.

Documentation ¶

Index ¶

Variables
func PrintVersion(w io.Writer)
type FullVersion
- func GetVersion() FullVersion
- func (f FullVersion) Brief() string
- func (f FullVersion) String() string

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Version   = "v0.1.0"
	GitRev    = "undefined"
	GitBranch = "undefined"
	BuildDate = "Fri, 17 Jun 1988 01:58:00 +0200"
)

Populated during build, don't touch!

Functions ¶

func PrintVersion ¶

func PrintVersion(w io.Writer)

PrintVersion prints version info into the provided io.Writer.

Types ¶

type FullVersion ¶

type FullVersion struct {
	Version   string
	GitRev    string
	GitBranch string
	BuildDate string
	GoVersion string
	OS        string
	Arch      string
}

func GetVersion ¶

func GetVersion() FullVersion

func (FullVersion) Brief ¶ added in v0.1.0

func (f FullVersion) Brief() string

func (FullVersion) String ¶

func (f FullVersion) String() string

Source Files ¶

View all Source files

version.go

Directories ¶

Path	Synopsis
abi
agglayer
grpc
mocks
types
aggoracle
chaingersender
metrics
mocks
types
aggsender
aggchainproofclient
config
converters
db
db/migrations
flows
metrics
mocks
optimistic
optimistic/mocks
optimistic/optimistichash
prover
query
rpc
rpcclient
statuschecker
trigger
trigger/types
trigger/types/mocks
types
validator
validator/mocks
validator/proto/v1
bridgeservice
client
docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
feeestimate Package feeestimate holds the fee-estimation API contract shared by the claim and bridge fee estimate endpoints: the response types, the string enums they use, the sentinel errors the HTTP layer maps to status codes, and the FeeEstimator interface the bridge service calls with one instance per network.	Package feeestimate holds the fee-estimation API contract shared by the claim and bridge fee estimate endpoints: the response types, the string enums they use, the sentinel errors the HTTP layer maps to status codes, and the FeeEstimator interface the bridge service calls with one instance per network.
metrics
mocks
types
bridgeservicefinder Package bridgeservicefinder resolves and serves the bridge service REST URL and the JSON-RPC endpoint for every network attached to a given rollup manager.	Package bridgeservicefinder resolves and serves the bridge service REST URL and the JSON-RPC endpoint for every network attached to a given rollup manager.
mocks
bridgesync
migrations
mocks
types
bridgetracker
api
api/docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
db Package db holds everything SQLite-related for the bridge tracker: the sqliteRegistry adapter of domain.SupervisedRegistry and its migrations (see migrations/), mirroring how aggsender/db holds its own component's SQLite storage.	Package db holds everything SQLite-related for the bridge tracker: the sqliteRegistry adapter of domain.SupervisedRegistry and its migrations (see migrations/), mirroring how aggsender/db holds its own component's SQLite storage.
db/migrations Package migrations holds the bridge tracker's own SQLite migrations (see bridgetracker's sqliteRegistry), following the same //go:embed + db.RunMigrations pattern as reorgdetector/migrations.	Package migrations holds the bridge tracker's own SQLite migrations (see bridgetracker's sqliteRegistry), following the same //go:embed + db.RunMigrations pattern as reorgdetector/migrations.
domain Package domain holds the pure business rules of the bridge tracker: decisions that depend only on bridge facts, with no I/O and no dependency on the ports or adapters.	Package domain holds the pure business rules of the bridge tracker: decisions that depend only on bridge facts, with no I/O and no dependency on the ports or adapters.
metrics
mocks
sources Package sources implements the driven fact ports of the bridge tracker engine (bridgetracker.BridgeEventSource, GERSource, LERSource, ClaimSource, CertificateSource) over the real backends: the per-network JSON-RPC endpoints and the aggkit bridge service REST API, both resolved per network through the bridgeservicefinder.	Package sources implements the driven fact ports of the bridge tracker engine (bridgetracker.BridgeEventSource, GERSource, LERSource, ClaimSource, CertificateSource) over the real backends: the per-network JSON-RPC endpoints and the aggkit bridge service REST API, both resolved per network through the bridgeservicefinder.
types
claimsync
mocks
storage
storage/migrations
types
types/mocks
cmd
common
mocks
types
types/mocks
config
types
db
compatibility
compatibility/mocks
compatibility/types
migrations
migrations/testutils
mocks
types
etherman
block_notifier
config
mocks
querier
querier/mocks
types
types/mocks
grpc
healthcheck
l1infotreesync
migrations
mocks
l2gersync
migrations
mocks
log
metrics
multidownloader
storage
storage/migrations
sync
sync/agglayer/mocks
sync/aggsender/mocks
sync/types
sync/types/mocks
types
types/mocks
opnode
pprof
prometheus
proxy Package proxy implements the bridge-service reverse proxy component: it exposes the aggkit bridge service REST API on the shared HTTP server and forwards every request to the bridge service of the network selected by the request's network_id query parameter, resolved (and kept fresh) through the bridgeservicefinder.	Package proxy implements the bridge-service reverse proxy component: it exposes the aggkit bridge service REST API on the shared HTTP server and forwards every request to the bridge service of the network selected by the request's network_id query parameter, resolved (and kept fresh) through the bridgeservicefinder.
cmd command
config
types
reorgdetector
migrations
scripts
sync
test
contracts/aggchainrollupmock
contracts/bridgeeventimpostor
contracts/claimmock
contracts/claimmockcaller
contracts/claimmocktest
contracts/erc1967proxy
contracts/logemitter
contracts/mintableerc20
contracts/proxy
contracts/rollupmanagermock
contracts/verifybatchesmock
e2e
e2e/envs
helpers
tools
aggsender_find_imported_bridge command
backward_forward_let
backward_forward_let/cmd command
config_render Package configrender composes and resolves an aggkit configuration file using the same pipeline as the aggkit binary (config.ConfigRender), but allowing each default layer to be overridden or skipped.	Package configrender composes and resolves an aggkit configuration file using the same pipeline as the aggkit binary (config.ConfigRender), but allowing each default layer to be overridden or skipped.
config_render/cmd command
exit_certificate
exit_certificate/bridgesyncerlite
exit_certificate/cmd command
exit_certificate/scripts/agglayer_status command Command agglayer_status prints the status and height of the latest agglayer certificate for an L2 network, using the same agglayer gRPC client as the exit_certificate tool.	Command agglayer_status prints the status and height of the latest agglayer certificate for an L2 network, using the same agglayer gRPC client as the exit_certificate tool.
exit_certificate_claimer/service
exit_certificate_claimer/service/cmd command
force_ger_update
force_ger_update/cmd command
get_initial_ler/cmd command
remove_ger
remove_ger/cmd command
tree
migrations
testvectors
types
types/mocks
types
mocks

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL