Skip to content
NeoFS Proto repository contains implementation of core NeoFS structures that can be used for integration with NeoFS.
Go Shell Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
accounting
bootstrap
chain
container
decimal docs: regenerate proto files Nov 20, 2019
docs proto: publish sg lib, rewrite object Dec 2, 2019
hash
internal
object proto: publish sg lib, rewrite object Dec 2, 2019
query
refs
service service: get rid of proto.Message in Maintainable/Verifiable requests Dec 5, 2019
session proto: regenerate proto files Nov 21, 2019
state proto: regenerate proto files Nov 21, 2019
storagegroup
.gitattributes
.gitignore
CHANGELOG.md
LICENSE.md initial Nov 18, 2019
Makefile
README.md docs: generate documentation for proto files Nov 20, 2019
go.mod service: get rid of bytefmt Nov 26, 2019
go.sum service: get rid of bytefmt Nov 26, 2019

README.md

NeoFS-proto

NeoFS-proto repository contains implementation of core NeoFS structures that can be used for integration with NeoFS.

Description

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

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.

API

Accounting package defines:

Bootstrap

Bootstrap package defines bootstrap service which is used by storage nodes to connect to the storage network.

API

Bootstrap package defines:

Chain

Chain package contains util functions for operations with NEO Blockchain types: wallet addresses, script-hashes.

Container

Container package defines service and structures for operations with containers. Objects in NeoFS are stored in containers. Container defines storage policy for the objects.

API

Bootstrap package defines:

Decimal

Decimal defines custom decimal implementation which is used in accounting operations.

Hash

Hash package defines homomorphic hash type.

Internal

Internal package defines constant error type and proto interface for custom protobuf structures.

Object

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.

API

Object package defines:

Query

Query package defines structure for object search requests.

Refs

Refs package defines core identity types: Object ID, Container ID, etc.

Service

Service package defines util structure and functions for all NeoFS services operations: TTL and request signature management, node roles, epoch retriever.

Session

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.

API

Session package defines:

State

State package defines service and structures for metrics gathering.

API

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

Contributing

At this moment, we do not accept contributions.

License

This project is licensed under the GPLv3 License - see the LICENSE.md file for details

You can’t perform that action at this time.