mirror of
https://gitlab.com/pulsechaincom/erigon-pulse.git
synced 2024-12-26 05:27:19 +00:00
23 lines
898 B
Markdown
23 lines
898 B
Markdown
|
# Interfaces
|
||
|
|
Interfaces for turbo-geth components. Currently it is a collection of `.proto` files describing gRPC interfaces between components, but later documentation about each interface, its components, as well as required version of gRPC will be added
|
||
|
|
|
||
|
|
<img src="turbo-geth-architecture.png">
|
||
|
|
|
||
|
|
# What's in this repo
|
||
|
|
- Protobuf definitions
|
||
|
|
- Wrappers:
|
||
|
|
- Rust crate with autogenerated client and server based on [Tonic](https://github.com/hyperium/tonic)
|
||
|
|
|
||
|
|
NOTE: You are free to ignore provided wrappers and use the .proto files directly
|
||
|
|
|
||
|
|
# Suggested integration into other repositories
|
||
|
|
```
|
||
|
|
git subtree add --prefix interfaces --squash https://github.com/ledgerwatch/interfaces master
|
||
|
|
```
|
||
|
|
|
||
|
|
When you need to update the subtree to a specific commit or tag, you can use this command:
|
||
|
|
|
||
|
|
```
|
||
|
|
git subtree pull --prefix interfaces --squash https://github.com/ledgerwatch/interfaces <tag_or_commit>
|
||
|
|
```
|