From e9d5e57caf0e285b9d4420ad3618c2410e1992a4 Mon Sep 17 00:00:00 2001 From: Pavel Karpy Date: Wed, 24 Nov 2021 20:26:54 +0300 Subject: [PATCH] [#174] subnet: Add docs Signed-off-by: Pavel Karpy --- subnet/doc.go | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 subnet/doc.go diff --git a/subnet/doc.go b/subnet/doc.go new file mode 100644 index 0000000..315f3ce --- /dev/null +++ b/subnet/doc.go @@ -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