TrueCloudLab
/
frostfs-contract
21
0
Fork 16
Code Issues 9 Pull Requests 1 Actions Releases 2 Activity

[#21] Document contract storage schemes #22

Merged
fyrchik merged 1 commits from aarifullin/frostfs-contract:feature/document_contract_storage_schemes into master 2023-05-12 12:46:53 +00:00
Conversation 0 Commits 1 Files Changed 11
aarifullin commented 2023-05-10 08:35:53 +00:00
Collaborator

Signed-off-by: Airat Arifullin a.arifullin@yadro.com

Signed-off-by: Airat Arifullin a.arifullin@yadro.com
aarifullin added the
documentation
 label 2023-05-10 08:36:39 +00:00
aarifullin force-pushed feature/document_contract_storage_schemes from 5bf7b48bd1 to e9558807d4 2023-05-10 08:42:05 +00:00 Compare
aarifullin requested review from storage-core-developers 2023-05-10 08:42:39 +00:00
aarifullin requested review from storage-services-developers 2023-05-10 08:42:39 +00:00
dstepanov-yadro reviewed 2023-05-10 11:16:24 +00:00
netmap/doc.go Outdated
@ -32,0 +35,4 @@
+-----------------------------+------------+-----------------------------------+
| Key | Value type | Description |
|-----------------------------+------------+-----------------------------------|
| 'snapshotCount' | int | snapshot count |
dstepanov-yadro commented 2023-05-10 11:16:08 +00:00
Collaborator

' should be replaced with ` ?

`'` should be replaced with ` ?
aarifullin commented 2023-05-10 15:40:19 +00:00
Poster
Collaborator

Thanks!

Thanks!
dstepanov-yadro marked this conversation as resolved
aarifullin force-pushed feature/document_contract_storage_schemes from e9558807d4 to 013ae8ffd9 2023-05-10 15:41:54 +00:00 Compare
aarifullin force-pushed feature/document_contract_storage_schemes from 013ae8ffd9 to da81fd7ff6 2023-05-10 15:44:10 +00:00 Compare
fyrchik reviewed 2023-05-11 08:37:44 +00:00
alphabet/doc.go Outdated
@ -20,0 +22,4 @@
+--------------------+------------+-------------------------------------------------+
| Key | Value type | Description |
|--------------------+------------+-------------------------------------------------|
fyrchik commented 2023-05-11 08:37:05 +00:00
Owner

Can we use markdown syntax for tables?

| Key | Value | Desc |
|-----|-------|------|
| a   | b     | c    |
| x   | y     | z    |

It is easier to copy in md doc, takes less space and is somewhat widely accepted.

I've searched a bit -- it seems godoc has no support for tables, so markdown is a safe choice.
Also, pre-formatted text should be indented (goimports does this, but we have no pre-commit here).

Can we use markdown syntax for tables? ``` | Key | Value | Desc | |-----|-------|------| | a | b | c | | x | y | z | ``` It is easier to copy in md doc, takes less space and is somewhat widely accepted. I've searched a bit -- it seems `godoc` has no support for tables, so markdown is a safe choice. Also, pre-formatted text should be indented (goimports does this, but we have no pre-commit here).
👍 1
fyrchik marked this conversation as resolved
nns/doc.go Outdated
@ -0,0 +1,25 @@
package nns
/*
fyrchik commented 2023-05-11 07:03:24 +00:00
Owner

Let's use a package comment everywhere (like in the netmap contract) -- before the package keyword.

Let's use a package comment everywhere (like in the netmap contract) -- before the `package` keyword.
👍 1
fyrchik marked this conversation as resolved
dstepanov-yadro approved these changes 2023-05-12 06:57:56 +00:00
acid-ant approved these changes 2023-05-12 08:03:20 +00:00
aarifullin force-pushed feature/document_contract_storage_schemes from da81fd7ff6 to 46e104102f 2023-05-12 11:46:35 +00:00 Compare
aarifullin force-pushed feature/document_contract_storage_schemes from 46e104102f to 8dd198faa0 2023-05-12 11:50:19 +00:00 Compare
aarifullin force-pushed feature/document_contract_storage_schemes from 8dd198faa0 to a8029c71cd 2023-05-12 11:51:29 +00:00 Compare
aarifullin requested review from dstepanov-yadro 2023-05-12 11:51:42 +00:00
aarifullin requested review from acid-ant 2023-05-12 11:51:45 +00:00
acid-ant approved these changes 2023-05-12 11:55:02 +00:00
fyrchik approved these changes 2023-05-12 12:02:17 +00:00
balance/doc.go
@ -77,0 +81,4 @@
|-----------------------|------------|----------------------------------|
| `netmapScriptHash` | Hash160 | netmap contract hash |
| `containerScriptHash` | Hash160 | container contract hash |
| circulationKey | int | the token circulation key value |
fyrchik commented 2023-05-12 12:01:11 +00:00
Owner

Is it variable length?

Is it variable length?
aarifullin commented 2023-05-12 12:04:43 +00:00
Poster
Collaborator

Right, it's non-const

Right, it's non-`const`
fyrchik marked this conversation as resolved
fyrchik merged commit a8029c71cd into master 2023-05-12 12:46:53 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
dstepanov-yadro
acid-ant
fyrchik
TrueCloudLab/storage-services-developers
Labels
Clear labels   
P0

Highest   
P1

High   
P2

Medium   
P3

Low   
good first issue

Good for newcomers
  
Infrastructure

Infrastructure, Automation, CI/CD or DevOps related stuff   
blocked

The issue or PR is blocked by something   
bug

Something is not working   
config

Configuration format update or breaking change   
discussion

Talking about something in order to reach a decision or to exchange ideas   
documentation

Documentation related   
duplicate

This issue or pull request already exists   
enhancement

New feature   
go

Language features adoption   
help wanted

Extra attention is needed   
internal
   
invalid

Something is wrong   
kludge

This is a kludge and we know it   
observability

Related to metrics, tracing and logs   
perfomance

Perfomance related   
question

More information is needed   
refactoring

Refactoring   
wontfix

This won't be fixed
No Label
P0
P1
P2
P3
good first issue
Infrastructure
blocked
bug
config
discussion
documentation
duplicate
enhancement
go
help wanted
internal
invalid
kludge
observability
perfomance
question
refactoring
wontfix
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
4 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: TrueCloudLab/frostfs-contract#22
There is no content yet.
Delete Branch "aarifullin/frostfs-contract:feature/document_contract_storage_schemes"

Deleting a branch is permanent. Although the deleted branch may exist for a short time before cleaning up, in most cases it CANNOT be undone. Continue?