[#174] subnet: Add docs

Signed-off-by: Pavel Karpy <carpawell@nspcc.ru>
This commit is contained in:
Pavel Karpy 2021-11-24 20:26:54 +03:00 committed by LeL
parent c2b7e638fa
commit e9d5e57caf

37
subnet/doc.go Normal file
View file

@ -0,0 +1,37 @@
/*
Subnet contract is a contract deployed in NeoFS side chain.
Subnet contract stores and manages NeoFS subnetwork states. It allows registering
and deleting subnetworks, limiting access to them and defining a list of the Storage
Nodes that can be included in them.
Contract notifications
Put notification. This notification is produced when new subnetwork is
registered by invoking Put method.
Put
- name: id
type: ByteArray
- name: ownerKey
type: PublicKey
- name: info
type: ByteArray
Delete notification. This notification is produced when some subnetwork is
deleted by invoking Delete method.
Delete
- name: id
type: ByteArray
RemoveNode notification. This notification is produced when some node is deleted
by invoking RemoveNode method.
RemoveNode
- name: subnetID
type: ByteArray
- name: node
type: PublicKey
*/
package subnet