From f86c8cf91e3ca29afd226b0617eaccb25514402b Mon Sep 17 00:00:00 2001 From: Adam Babik Date: Wed, 1 Apr 2020 20:13:54 +0200 Subject: [PATCH] Update eth-node README (#1916) --- eth-node/README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/eth-node/README.md b/eth-node/README.md index 01856727a..f0e156529 100644 --- a/eth-node/README.md +++ b/eth-node/README.md @@ -1,8 +1,19 @@ -# Status abstractions for Ethereum node implementations +# Abstraction for Ethereum node implementation -## What is eth-node? +This package is a collection of interfaces, data types, and functions to make status-go independent from the go-ethereum implementation. -eth-node is a low-level project that implements crypto routines, Ethereum node abstractions and types that are useful for status-go/protocol and status-go +status-go is a wrapper around an Ethereum node. This package was created to have a possibility of selecting the underlying Ethereum node implementation, namely [go-ethereum](https://github.com/ethereum/go-ethereum) or [Nimbus](http://github.com/status-im/nimbus). The underlying implementation is selected using [Go build tags](https://golang.org/pkg/go/build/#hdr-Build_Constraints). + +* `types` and `core/types` -- provide interfaces of node services, common data types, and functions, +* `bridge` -- provide implementation of interfaces declared in `types` using [go-ethereum](https://github.com/ethereum/go-ethereum) or [Nimbus](http://github.com/status-im/nimbus) in `geth` and `nimbus` directories respectively, +* `crypto` -- provide cryptographic utilities not depending on [go-ethereum](https://github.com/ethereum/go-ethereum), +* `keystore` -- provide a keystore implementation not depending on [go-ethereum](https://github.com/ethereum/go-ethereum). + +Note: `crypto` and `keystore` are not finished by either depending on [go-ethereum](https://github.com/ethereum/go-ethereum) or not providing [Nimbus](http://github.com/status-im/nimbus) implementation. + +## How to use it? + +If you have a piece of code that depends on [go-ethereum](https://github.com/ethereum/go-ethereum), check out this package to see if there is a similar implementation that does not depend on [go-ethereum](https://github.com/ethereum/go-ethereum). For example, you want to decode a hex-string into a slice of bytes. You can do that using go-ethereum's `FromHex()` function or use equivalent from this package and avoid importing [go-ethereum](https://github.com/ethereum/go-ethereum). Thanks to this, your code fragment might be built with [Nimbus](http://github.com/status-im/nimbus). ## License