https://github.com/anyproto/any-block

Protocol describing data structures used in Anytype software
https://github.com/anyproto/any-block

anytype protobuf protocol

Last synced: 10 days ago
JSON representation

Protocol describing data structures used in Anytype software

• Host: GitHub
• URL: https://github.com/anyproto/any-block
• Owner: anyproto
• License: mit
• Created: 2023-05-30T14:18:30.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-18T13:13:19.000Z (16 days ago)
• Last Synced: 2024-12-18T13:30:11.728Z (16 days ago)
• Topics: anytype, protobuf, protocol
• Homepage: https://anytype.io
• Size: 316 KB
• Stars: 48
• Watchers: 9
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: changes.proto
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Any-Block

Protocol describing data structures used in Anytype software.

## Description

We use [Protocol Buffers](https://en.wikipedia.org/wiki/Protocol_Buffers) to efficiently describe structured data in a binary format for network communication and storage. It offers smaller message sizes and faster serialization/deserialization than JSON or XML. 

Protobuf facilitates data exchange between different systems written in different languages, while also providing automatic code generation for various programming languages.

- `models.proto` describes the base data structures used to represent objects and their components. 

- `changes.proto` outlines CRDT-changes of objects and their blocks. Changes related to block updates are linked to events from `events.proto`. 

- `events.proto` describes the events about the changes of objects and blocks. These events are used to notify clients and also serve as CDRT changes to be stored in an object's tree.

JSON Schemas are generated automatically using [protoc-gen-jsonschema](https://github.com/chrusty/protoc-gen-jsonschema).

## Contribution

Thank you for your desire to develop Anytype together!

❤️ This project and everyone involved in it is governed by the [Code of Conduct](https://github.com/anyproto/.github/blob/main/docs/CODE_OF_CONDUCT.md).

🧑‍💻 Check out our [contributing guide](https://github.com/anyproto/.github/blob/main/docs/CONTRIBUTING.md) to learn about asking questions, creating issues, or submitting pull requests.

🫢 For security findings, please email [[email protected]](mailto:[email protected]) and refer to our [security guide](https://github.com/anyproto/.github/blob/main/docs/SECURITY.md) for more information.

🤝 Follow us on [Github](https://github.com/anyproto) and join the [Contributors Community](https://github.com/orgs/anyproto/discussions).

---

Made by Any — a Swiss association 🇨🇭

Licensed under [MIT](./LICENSE.md).