juztamau5/grpc-interfaces

Cartesi gRPC Interfaces

⚠️ The Cartesi team keeps working internally on the next version of this repository, following its regular development roadmap. Whenever there's a new version ready or important fix, these are published to the public source tree as new releases.

Cartesi gRPC Interfaces

The Cartesi gRPC Interfaces repository contains all gRPC and Protobuf definitions used in the gRPC interfaces of the Cartesi Project modules. Currently these comprehend:

• cartesi-machine.proto: contains the services exported by the cartesi machine that are consumed by the machine manager and also the definition of the lowest level messages used in multiple interfaces
• machine-manager.proto: services and higher level message types used to interact with the machine manager sessions
• rollup-machine-manager.proto: services and higher level message types used to interact with the rollup machine manager sessions
• logger.proto: services and higher level message types used to interact with the logger-managed files

Getting Started

This repository is not intended for standalone usage. Every repository that makes use of a gRPC interface, either serving or consuming a certain API, includes this repository as submodule and builds the language specific auto-generated code that implements the desired services and messages. Specifics on those can be checked in the individual repositories that include this as a submodule.

Contributing

Thank you for your interest in Cartesi! Head over to our Contributing Guidelines for instructions on how to sign our Contributors Agreement and get started with Cartesi!

Please note we have a Code of Conduct, please follow it in all your interactions with the project.

Authors

• Diego Nehab
• Carlo Fragni
• Augusto Teixeira

License

The grpc-interfaces repository and all contributions are licensed under APACHE 2.0. Please review our LICENSE file.

Acknowledgments

• Original work