realloc/frostfs-contract
1
0
Fork 0
forked from TrueCloudLab/frostfs-contract
Code Issues Pull requests Projects Releases Packages Wiki Activity

[#105] audit: Add docs

Browse source 
Signed-off-by: Alex Vanin <alexey@nspcc.ru>
This commit is contained in:
Alex Vanin 2021-07-05 19:25:29 +03:00 • committed by Alex Vanin
parent 2a6a46d462
commit f21c439e9c
2 changed files with 41 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

22
audit/doc.go
View file

@ -1,2 +1,22 @@
// Audit contract description.
/*
Audit contract is a contract deployed in NeoFS side chain.
Inner Ring nodes perform an audit of the registered containers in every epoch.
If container contains StorageGroup objects, then the Inner Ring node initializes
a series of audit checks. Based on the results of these checks, the Inner Ring
node creates a DataAuditResult structure for the container. The content of this
structure makes it possible to determine which storage nodes were examined and
the status of these checks. Based on this information, container owner is
charged for data storage.
Audit contract is used as reliable and verifiable storage for all
DataAuditResult structures. At the end of the data audit routine, the Inner Ring
nodes send a stable marshaled version of the DataAuditResult structure to the
contract. When Alphabet nodes of the Inner Ring perform settlement operations,
they list and get these AuditResultStructures from the audit contract.
Contract notifications
Alphabet contract does not produce notifications to process.
*/
package audit