https://github.com/harmony-development/protocol

The schemas for the Harmony protocol
https://github.com/harmony-development/protocol

harmony harmony-protocol protobuf

Last synced: about 1 month ago
JSON representation

The schemas for the Harmony protocol

• Host: GitHub
• URL: https://github.com/harmony-development/protocol
• Owner: harmony-development
• License: apache-2.0
• Created: 2020-07-19T02:34:24.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-10-05T02:43:12.000Z (over 1 year ago)
• Last Synced: 2024-11-04T16:44:47.386Z (2 months ago)
• Topics: harmony, harmony-protocol, protobuf
• Language: Go
• Homepage:
• Size: 438 KB
• Stars: 21
• Watchers: 4
• Forks: 2
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - harmony-development/protocol - The schemas for the Harmony protocol (Go)

README

        
# Harmony Protocol

This is the repository containing the Harmony protocol specification and documentation.

Read [here](FAQ.md) for frequently asked questions.

To read about protocol conventions, please read [GUIDELINES](GUIDELINES.md).

If you are looking for:

- a client to communicate with, check out [Tempest](https://github.com/harmony-development/tempest), [Challah](https://github.com/harmony-development/Challah) or [Crust](https://github.com/harmony-development/Crust).

- a server to host, check out [Scherzo](https://github.com/harmony-development/scherzo).

- an SDK to develop bots / clients / servers with, check out [Rust SDK](https://github.com/harmony-development/harmony_rust_sdk), [Web SDK](https://github.com/harmony-development/harmony-web-sdk) and [C++ SDK](https://github.com/harmony-development/Chometz).

# Stable v. Staging

Harmony has two types of protocol components: stable and staging.

Stable protocols are long-lived protocols that are not expected to be

replaced in the near future, and that have wide server and client support.

Staging protocols are protocols that may be replaced in the near future, and they

may not have wide server or client support.

Both stable and staging protocols follow semantic versioning: breaking changes

are only permitted with a corresponding increase in the major version, while

non-breaking changes result in an increase in the minor version.

Heavily in-dev protocols may be found on work branches in the Harmony repository,

and are subject to no compatibility guarantees. They must have at least 1 server and

2 client implementations before becoming staging protocols.