ovote-node

module
v0.0.0-...-5757dfe Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 15, 2022 License: AGPL-3.0

README

ovote-node GoDoc Go Report Card Test

Research project.

OVOTE: Offchain Voting with Onchain Trustless Execution.

This repo contains the OVOTE node implementation, compatible with the ovote circuits & contracts. All code is in early stages.

More details on the ovote-node behaviour can be found at the OVOTE document.

Usage

In the cmd/ovote-node build the binarh: go build

Which then can be used:

> ./ovote-node --help
Usage of ovote-node:
  -d, --dir string        storage data directory (default "~/.ovote-node")
  -l, --logLevel string   log level (info, debug, warn, error) (default "info")
  -p, --port string       network port for the HTTP API (default "8080")
  -c, --censusbuilder     CensusBuilder active
  -v, --votesaggregator   VotesAggregator active
      --eth string        web3 provider url
      --addr string       OVOTE contract address
      --block uint        Start scanning block (usually the block where the OVOTE contract was deployed)

So for example, running the node as a CensusBuilder and VotesAggregator for the ChainID=1 would be:

./ovote-node -c -v --chainid=1 \
--eth=wss://yourweb3url.com --addr=0xTheOVOTEContractAddress --block=6678912

Test

  • Tests: go test ./... (need go installed)
  • Linters: golangci-lint run --timeout=5m -c .golangci.yml (need golangci-lint installed)

Directories

Path Synopsis
cmd
Package prover implements the prover client to interact with the prover-server
Package prover implements the prover client to interact with the prover-server

Jump to

Keyboard shortcuts

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