New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document contracts' storage model #275

Closed

cthulhu-rider opened this issue Sep 30, 2022 · 4 comments

Assignees

Labels

documentation good first issue netmap

Milestone

Contributor

cthulhu-rider commented Sep 30, 2022

The memory of contracts has a structural organization, which can change during the update process. When changing the memory model, it is required to write a migration data routine from the previous model. To do this, I propose to document the organization of memory for developers in contracts. It is proposed to start with Netmap contract.

The text was updated successfully, but these errors were encountered:

cthulhu-rider added documentation good first issue netmap triage labels

cthulhu-rider self-assigned this

Contributor Author

cthulhu-rider commented Sep 30, 2022

I'm gonna draft the proposal within netmap: Return same type from reading methods #273

Contributor

fyrchik commented Sep 30, 2022

See also nspcc-dev/neo-go#2561

cthulhu-rider added a commit to cthulhu-rider/neofs-contract that referenced this issue


          [nspcc-dev#275] netmap: Re-format the package docs

69eb1af

Start package docs with commonly used format `Package netmap ...`. Also
make `gofmt` do the job.

Signed-off-by: Leonard Lyubich <[email protected]>

cthulhu-rider added a commit to cthulhu-rider/neofs-contract that referenced this issue


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

ff69879

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 mentioned this issue

netmap: Document memory model #276

Merged

cthulhu-rider changed the title ~~netmap: Document contract storage model~~ Document contracts' storage model

cthulhu-rider added a commit to cthulhu-rider/neofs-contract that referenced this issue


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

724bd7e

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 added a commit to cthulhu-rider/neofs-contract that referenced this issue


          [nspcc-dev#275] netmap: 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 added a commit to cthulhu-rider/neofs-contract that referenced this issue


          [nspcc-dev#275] netmap: Re-format the package docs

36304dc

Start package docs with commonly used format `Package netmap ...`. Also
make `gofmt` do the job.

Signed-off-by: Leonard Lyubich <[email protected]>

cthulhu-rider added a commit to cthulhu-rider/neofs-contract that referenced this issue


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

2712f11

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 added a commit to cthulhu-rider/neofs-contract that referenced this issue


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

8da09e2

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 added a commit to cthulhu-rider/neofs-contract that referenced this issue


          [nspcc-dev#275] netmap: Re-format the package docs

9ea73e8

Start package docs with commonly used format `Package netmap ...`.

Signed-off-by: Leonard Lyubich <[email protected]>

cthulhu-rider added a commit to cthulhu-rider/neofs-contract that referenced this issue


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

20c01b9

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 added a commit to cthulhu-rider/neofs-contract that referenced this issue


          [nspcc-dev#275] netmap: Fix storage model docs

e02da0e

Actualize storage node's structure type and clarify this is a type not
to cause misunderstanding.

Signed-off-by: Leonard Lyubich <[email protected]>

roman-khimov pushed a commit that referenced this issue


          [#275] netmap: Re-format the package docs

337c56a

Start package docs with commonly used format `Package netmap ...`.

Signed-off-by: Leonard Lyubich <[email protected]>

roman-khimov pushed a commit that referenced this issue


          [#275] netmap: Document contract storage model

39604be

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]>

roman-khimov pushed a commit that referenced this issue


          [#275] netmap: Fix storage model docs

f5fbf2e

Actualize storage node's structure type and clarify this is a type not
to cause misunderstanding.

Signed-off-by: Leonard Lyubich <[email protected]>

cthulhu-rider removed their assignment

Contributor Author

cthulhu-rider commented Jan 31, 2023

In demand in the context of updates. Lets do this for other contracts.

cthulhu-rider added a commit to cthulhu-rider/neofs-contract that referenced this issue


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

2be6de0

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 added a commit to cthulhu-rider/neofs-contract that referenced this issue


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

d48613d

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 added a commit to cthulhu-rider/neofs-contract that referenced this issue


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

171e1df

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 added a commit to cthulhu-rider/neofs-contract that referenced this issue


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

5f66e92

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 added a commit to cthulhu-rider/neofs-contract that referenced this issue


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

31294b3

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 added a commit to cthulhu-rider/neofs-contract that referenced this issue


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

6bebb81

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 added a commit to cthulhu-rider/neofs-contract that referenced this issue


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

43e3e7e

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 added a commit to cthulhu-rider/neofs-contract that referenced this issue


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

bbe1162

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 self-assigned this

roman-khimov modified the milestones: v0.16.1, v0.17.0, v0.18.0

cthulhu-rider added a commit to cthulhu-rider/neofs-contract that referenced this issue


          [nspcc-dev#275] *: Describe storage model of contracts

4b91063

Add comments (outside godoc) with key-value storage scheme and
some explanations. The memory model will allow to more precisely
understand and migrate the contract storage.

Signed-off-by: Leonard Lyubich <[email protected]>

cthulhu-rider added a commit to cthulhu-rider/neofs-contract that referenced this issue


          [nspcc-dev#275] *: Describe storage model of contracts

f244a84

Add comments (outside godoc) with key-value storage scheme and
some explanations. The memory model will allow to more precisely
understand and migrate the contract storage.

Signed-off-by: Leonard Lyubich <[email protected]>

cthulhu-rider added a commit to cthulhu-rider/neofs-contract that referenced this issue


          *: Describe storage model of contracts

bebca75

Add comments (outside godoc) with key-value storage scheme and
some explanations. The memory model will allow to more precisely
understand and migrate the contract storage.

Refs nspcc-dev#275

Signed-off-by: Leonard Lyubich <[email protected]>

cthulhu-rider added a commit to cthulhu-rider/neofs-contract that referenced this issue


          *: Describe storage model of contracts

115d52b

Add comments (outside godoc) with key-value storage scheme and
some explanations. The memory model will allow to more precisely
understand and migrate the contract storage.

Refs nspcc-dev#275

Signed-off-by: Leonard Lyubich <[email protected]>

cthulhu-rider added a commit to cthulhu-rider/neofs-contract that referenced this issue


          *: Describe storage model of contracts

686927d

Add comments (outside godoc) with key-value storage scheme and
some explanations. The memory model will allow to more precisely
understand and migrate the contract storage.

Refs nspcc-dev#275

Signed-off-by: Leonard Lyubich <[email protected]>

roman-khimov mentioned this issue

NNS storage schema documentation #362

Closed

Member

roman-khimov commented Sep 26, 2023

Closing this one, because #320 was merged quite some time ago. The only thing left is NNS, that'd be #362.

roman-khimov closed this as completed

roman-khimov removed the triage label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment