netmap: Document memory model #276
Conversation
cthulhu-rider
force-pushed
the
doc/netmap-storage-model
branch
2 times, most recently
from
724bd7e to
2886587
Compare
cthulhu-rider
requested review from
alexvanin,
AnnaShaleva,
carpawell and
fyrchik
There was a problem hiding this comment.
The config of netmap contract must be updated wrt the same comments, notifications specified in the config must exactly match the ones used in the contract, because we have neo-project/neo#2810.
netmap/doc.go
Outdated
| type: Integer | ||
| - name: publicKey | ||
| type: PublicKey | ||
| UpdateState |
There was a problem hiding this comment.
It's not UpdateState, it's UpdateStateSuccess:
neofs-contract/netmap/netmap_contract.go
Line 309 in f276e24
netmap/doc.go
Outdated
| - name: publicKey | ||
| type: PublicKey | ||
| UpdateState | ||
| - name: state |
There was a problem hiding this comment.
First parameter is public key:
neofs-contract/netmap/netmap_contract.go
Line 309 in f276e24
netmap/doc.go
Outdated
| AddPeer | ||
| - name: nodeInfo | ||
| type: ByteArray | ||
| AddPeer |
There was a problem hiding this comment.
Ditto, AddPeerSuccess:
neofs-contract/netmap/netmap_contract.go
Line 710 in f276e24
netmap/doc.go
Outdated
| type: ByteArray | ||
| AddPeer | ||
| - name: nodeInfo | ||
| type: ByteArray |
There was a problem hiding this comment.
Type is PublicKey:
neofs-contract/netmap/netmap_contract.go
Line 710 in f276e24
netmap/doc.go
Outdated
| type: ByteArray | ||
| AddPeer | ||
| - name: nodeInfo | ||
| type: ByteArray | ||
|
|
||
| UpdateState notification. This notification is produced when a Storage node wants | ||
| to change its state (go offline) by invoking UpdateState method. Supported | ||
| states: (2) -- offline. |
There was a problem hiding this comment.
There are three states now, we need to fix the doc.
|
@AnnaShaleva thanks for your comments, they are relevant but outside the scope of this PR. I've created a bug #279. |
netmap/doc.go
Outdated
| Contract records set of network parties representing the network map. Current | ||
| network map is updated on each epoch tick. Contract also holds limited number | ||
| of previous network maps (SNAPSHOT_LIMIT). Timestamped network maps are | ||
| called snapshots. Snapshots are identified by the numerical ring [0:SNAPSHOT_LIMIT). |
There was a problem hiding this comment.
Circular list.
netmap/doc.go
Outdated
| called snapshots. Snapshots are identified by the numerical ring [0:SNAPSHOT_LIMIT). | ||
|
|
||
| # Network map candidates | ||
| Contract stores information about the network parties which were requested |
There was a problem hiding this comment.
| Contract stores information about the network parties which were requested | |
| Contract stores information about the network parties which were accepted |
sounds more accurate IMO
There was a problem hiding this comment.
They are not accepted to the network map since they are candidates.
cthulhu-rider
force-pushed
the
doc/netmap-storage-model
branch
2 times, most recently
from
2712f11 to
8da09e2
Compare
Start package docs with commonly used format `Package netmap ...`. Signed-off-by: Leonard Lyubich <[email protected]>
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
force-pushed
the
doc/netmap-storage-model
branch
from
8da09e2 to
20c01b9
Compare
Actualize storage node's structure type and clarify this is a type not to cause misunderstanding. Signed-off-by: Leonard Lyubich <[email protected]>
I hope this will help us to carefully migrate contract data on update in future. Format suggestions are welcome. I thought about
.md.