NeoFS-proto repository contains implementation of core NeoFS structures that can be used for integration with NeoFS.
Repository contains 13 packages that implement NeoFS core structures. These packages mostly contain protobuf files with service and structure definitions or NeoFS core types with complemented functions.
There is a auto-generated documentation for protobuf files in docs.
Accounting package defines services and structures for accounting operations:
balance request and
cheque operations for withdraw.
Cheque is a structure
with inner ring signatures, which approve that user can withdraw requested
amount of assets. NeoFS smart contract takes binary formatted
cheque as a
parameter in withdraw call.
Accounting package defines:
Bootstrap package defines bootstrap service which is used by storage nodes to connect to the storage network.
Bootstrap package defines:
Chain package contains util functions for operations with NEO Blockchain types: wallet addresses, script-hashes.
Container package defines service and structures for operations with containers. Objects in NeoFS are stored in containers. Container defines storage policy for the objects.
Bootstrap package defines:
Decimal defines custom decimal implementation which is used in accounting operations.
Hash package defines homomorphic hash type.
Internal package defines constant error type and proto interface for custom protobuf structures.
Object package defines service and structures for object operations. Object is a core storage structure in NeoFS. Package contains detailed information about object internal structure.
Object package defines:
Query package defines structure for object search requests.
Refs package defines core identity types: Object ID, Container ID, etc.
Service package defines util structure and functions for all NeoFS services operations: TTL and request signature management, node roles, epoch retriever.
Session package defines service and structures for session obtain. Object operations require an established session with pair of session keys signed by owner of the object.
Session package defines:
State package defines service and structures for metrics gathering.
State package defines:
How to use
NeoFS-proto packages contain godoc documentation. Examples of using most of these packages can be found in NeoFS-CLI repository. CLI implements and demonstrates all basic interactions with NeoFS: container, object, storage group, and accounting operations.
Protobuf files are recompiled with the command:
$ make protoc
At this moment, we do not accept contributions.
This project is licensed under the GPLv3 License - see the LICENSE.md file for details