aggkit

package module

v0.3.0-beta8-tmp-bridge Latest Latest Go to latest Published: May 23, 2025 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
agglayer
grpc
mocks
types
aggoracle
chaingerreader
chaingersender
mocks
types
aggsender
config
db
db/migrations
flows
grpc
metrics
mocks
prover
query
rpc
rpcclient
statuschecker
types
bridgeservice
docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
mocks
types
bridgesync
migrations
mocks
claimsponsor
migrations
cmd
common
config
types
db
compatibility
compatibility/mocks
compatibility/types
migrations
types
etherman
config
contracts
mocks
healthcheck
hex
l1infotreesync
migrations
mocks
lastgersync
migrations
log
merkletree
opnode
pprof
prometheus
reorgdetector
migrations
scripts
state
sync
test
contracts/claimmock
contracts/claimmockcaller
contracts/claimmocktest
contracts/erc1967proxy
contracts/transparentupgradableproxy
contracts/verifybatchesmock
helpers
testutils
vectors
tools
aggsender_find_imported_bridge command
translator
tree
migrations
testvectors
types
types
mocks

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