aggkit

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:

1. build the aggkit binary

make build-aggkit

1. run the aggkit binary

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

Running with Kurtosis

1. Run your kurtosis environment
2. build cdk-erigon and make it available in your system's PATH
3. 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

Copyright (c) 2024 PT Services DMCC

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) String() string

Variables

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) String

func (f FullVersion) String() string