Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 2.1 KB

README.md

File metadata and controls

83 lines (52 loc) · 2.1 KB
Raw

build

forta-node

Forta node CLI is a Docker container supervisor that runs and manages multiple services and detection bots (agents) to scan a blockchain network and produce alerts.

Running a Node

For information about running a node, see the Scan Node Quickstart Documentation

Scan Node Development

Dependencies

  1. Install Docker and start Docker service
  2. Install Go

Dependencies for local development

Tools

Install Protobuf Compiler.

Go libraries

$ go install google.golang.org/grpc/cmd/protoc-gen-go-grpc 
$ go install github.com/golang/mock/[email protected]

Build and install

Full build & install using local version of Go

$ make install

For a faster iteration in local development, it is sufficient to build the common service container only if it has changed. The CLI requires forta-network/forta-node:latest containers to be available by default and uses the local ones if other Docker image references were not specified at the compile time.

CLI-only build using the local version of Go

$ go build -o forta .

CLI-only build using a specific version of Go

Edit Go image version at build stage inside Dockerfile.cli and then:

$ make main

Run the node

Run

$ forta init # if you haven't initialized and configured your Forta directory yet
$ forta run

View logs

CLI logs are made available via stdout. Logs for the rest of the node services and agents can be inspected by doing:

$ docker ps # see the running containers from here
$ docker logs -f <container_id>

Stop

CTRL-C

Bug Bounty

We have a bug bounty program on Immunefi. Please report any security issues you find through the Immunefi dashboard, or reach out to [email protected]