status-go/eth-node
Pascal Precht c01ad05525 feat(common): add `ThirdPartyID` to `Message` and `protobuf.WakuMessage`
Usually, message IDs are generated by their payload and signature and
in receiving nodes calculated in based on the same data as well.

There's no ID attached to messages in-flight.

This turns out to be a bit of a problem for messages that are being
imported from third party systems like discord, as the conversion
and saving of such messages and handling of their possible assets and
attachments are done in separate steps, which changes the message
payloads after their IDs have been generated.

Hence, we're introducing a `ThirdPartyID` property to `common.Message`
and `protobuf.WakuMessage` so receiving nodes of such messages (via the
archive protocol primarily) can easily detect third party/imported
messages and give them special treatment.
2022-09-29 11:15:47 +02:00
..
bridge/geth fix: add missing pubsubtopic to store cursor 2022-03-03 08:50:40 -04:00
core/types Fix waku tests & contact ens (#1802) 2020-01-17 13:39:09 +01:00
crypto Remove protocol and eth-node submodules (#1835) 2020-02-10 12:22:37 +01:00
keystore Added payload marshal and unmarshal to/from protobuf 2022-08-22 13:27:59 +01:00
types feat(common): add `ThirdPartyID` to `Message` and `protobuf.WakuMessage` 2022-09-29 11:15:47 +02:00
Makefile Create a home submodule for Eth node bridges- Rename StatusBackend to GethStatusBackend 2019-11-27 17:02:09 +01:00
README.md Update eth-node README (#1916) 2020-04-01 20:13:54 +02:00

README.md

Abstraction for Ethereum node implementation

This package is a collection of interfaces, data types, and functions to make status-go independent from the go-ethereum implementation.

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 or Nimbus. The underlying implementation is selected using Go build tags.

  • 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 or Nimbus in geth and nimbus directories respectively,
  • crypto -- provide cryptographic utilities not depending on go-ethereum,
  • keystore -- provide a keystore implementation not depending on go-ethereum.

Note: crypto and keystore are not finished by either depending on go-ethereum or not providing Nimbus implementation.

How to use it?

If you have a piece of code that depends on go-ethereum, check out this package to see if there is a similar implementation that does not depend on 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. Thanks to this, your code fragment might be built with Nimbus.

License

Mozilla Public License 2.0