[nspcc-dev#275] balance: Document contract storage model

Add comments (outside the docs) with key-value storage structure and some explanations. The memory mode will allow to more precisely understand and migrate the contract storage. Signed-off-by: Leonard Lyubich <[email protected]>
cthulhu-rider · Feb 2, 2023 · 43e3e7e · 43e3e7e
1 parent 6bebb81
commit 43e3e7e
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/balance/doc.go b/balance/doc.go
@@ -77,3 +77,23 @@ when NeoFS contract has transferred GAS assets back to the user.
 	    type: Integer
 */
 package balance
+
+/*
+Contract storage model.
+
+# Summary
+Key-value storage format:
+ - 'notary' -> bool
+   is notary mode disabled
+ - 'netmapScriptHash' -> interop.Hash160
+   Netmap contract reference
+ - 'containerScriptHash' -> interop.Hash160
+   Container contract reference
+ - 'MainnetGAS' -> int
+   total amount of Mainchain GAS deployed in the NeoFS network
+
+# Setting
+Contract can be deployed in notary and notary-disabled mode.
+
+To handle some events, the contract refers to other contracts.
+*/