Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/umbracle/go-eth-consensus
Lightweight Golang SDK for Ethereum consensus
https://github.com/umbracle/go-eth-consensus
api consensus ethereum golang sdk
Last synced: 4 days ago
JSON representation
Lightweight Golang SDK for Ethereum consensus
- Host: GitHub
- URL: https://github.com/umbracle/go-eth-consensus
- Owner: umbracle
- License: mpl-2.0
- Created: 2022-07-29T14:16:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-15T14:31:21.000Z (over 1 year ago)
- Last Synced: 2023-07-30T14:09:39.646Z (over 1 year ago)
- Topics: api, consensus, ethereum, golang, sdk
- Language: Go
- Homepage:
- Size: 188 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Go-eth-consensus [](https://godoc.org/github.com/umbracle/go-eth-consensus) [![Chat Badge]][chat link]
[chat badge]: https://img.shields.io/badge/chat-discord-%237289da
[chat link]: https://discord.gg/yCqYxwZNYD
Go-eth-consensus is a suite of Go utilities to interact with the Ethereum consensus layer.
The core of this library was initially part of [eth2-validator](https://github.com/umbracle/eth2-validator). However, as [other](https://github.com/umbracle/viewpoint) projects started to mature, it became necessary to create a unified library to reduce code duplication and increase consistency.
## Features
**Consensus data types**. Full set of data types (up to Bellatrix) in `structs.go` at root. It includes the SSZ encoding for each one using [`fastssz`](https://github.com/ferranbt/fastssz). Each type is end-to-end tested with the official consensus spec tests.
**Http client**. Lightweight implementation for the [Beacon](https://ethereum.github.io/beacon-APIs) and [Builder](https://ethereum.github.io/builder-specs) OpenAPI spec. For usage and examples see the [Godoc](https://pkg.go.dev/github.com/umbracle/go-eth-consensus/http). The endpoints are tested against a real server that mocks the OpenAPI spec.
**Chaintime**. Simple utilities to interact with slot times and epochs.
**BLS**. Abstraction to sign, recover and store (with keystore format) BLS keys. It includes two implementations: [blst](https://github.com/supranational/blst) with cgo and [kilic/bls12-381](https://github.com/kilic/bls12-381) with pure Go. The build flag `CGO_ENABLED` determines which library is used.
## Installation
```
$ go get github.com/umbracle/go-eth-consensus
```
## Bls benchmark
Benchmark for both BLS implementations:
```
$ CGO_ENABLED=0 go test -v ./bls/... -run=XXX -bench=.
goos: linux
goarch: amd64
pkg: github.com/umbracle/go-eth-consensus/bls
cpu: Intel(R) Core(TM) i7-8550U CPU @ 1.80GHz
BenchmarkBLS_Sign
BenchmarkBLS_Sign-4 2330 515495 ns/op 30192 B/op 282 allocs/op
BenchmarkBLS_Verify
BenchmarkBLS_Verify-4 814 1646769 ns/op 74048 B/op 190 allocs/op
PASS
ok github.com/umbracle/go-eth-consensus/bls 3.739s
$ CGO_ENABLED=1 go test -v ./bls/... -run=XXX -bench=.
goos: linux
goarch: amd64
pkg: github.com/umbracle/go-eth-consensus/bls
cpu: Intel(R) Core(TM) i7-8550U CPU @ 1.80GHz
BenchmarkBLS_Sign
BenchmarkBLS_Sign-4 2833 431271 ns/op 480 B/op 2 allocs/op
BenchmarkBLS_Verify
BenchmarkBLS_Verify-4 1282 903174 ns/op 4545 B/op 15 allocs/op
PASS
ok github.com/umbracle/go-eth-consensus/bls 2.525s
```