acorus

README

acorus

acorus repo

Acorus is project which can sync l1->l2 deposit, l2->l1 withdraw transactions of all layer2. The back-end service, written in golang, provides http api for upper-layer service docking.

Tips:

• need Go 1.21+
• need Postgresql

Support layer2 as follow

• ✅ Optimism
• ✅ Scroll
• ✅ Linea
• ✅ Base
• ✅ Mantle
• ✅ Metis Andromeda
• ✅ Manta
• ✅ Polygon
• ✅ Zksync
• ✅ Arbitrum
• ✅ ZKFair
• 🏗️ Starknet

If you want support your project, please create pr for us, we will support it.

Install

Install dependencies

go mod tidy

build

cd acorus
make

Config env

• For layer2 chain contracts config, you can config director and refer to exist config do it.
• For toml config, you can acorus.toml file and config your real env value.

start syncer

./acorus syncer

start api

./acorus api

Contribute

TBD

Documentation

Index

• Constants
• type Acorus
  • func NewAcorus(ctx context.Context, cfg *config.Config, shutdown context.CancelCauseFunc) (*Acorus, error)
  • func (as *Acorus) Start(ctx context.Context) error
  • func (as *Acorus) Stop(ctx context.Context) error
  • func (as *Acorus) Stopped() bool
• type RpcServerConfig

Constants

const MaxRecvMessageSize = 1024 * 1024 * 300

Types

type Acorus

type Acorus struct {
	DB *database.DB

	Synchronizer map[uint64]*synchronizer.Synchronizer
	Processor    map[uint64]event2.IEventProcessor
	Worker       map[uint64]worker2.IWorkerProcessor
	Relayer      map[uint64]*relayer.RelayerListener
	// contains filtered or unexported fields
}

func NewAcorus

func NewAcorus(ctx context.Context, cfg *config.Config, shutdown context.CancelCauseFunc) (*Acorus, error)

func (*Acorus) Start

func (as *Acorus) Start(ctx context.Context) error

func (*Acorus) Stop

func (as *Acorus) Stop(ctx context.Context) error

func (*Acorus) Stopped

func (as *Acorus) Stopped() bool

type RpcServerConfig

type RpcServerConfig struct {
	GrpcHostname string
	GrpcPort     int
}