TrueCloudLab/frostfs-sdk-go
32
0
Fork 21
Code Issues 33 Pull requests 3 Releases Activity Actions

user: Refactor user.ID structure #323

Merged
fyrchik merged 2 commits from elebedeva/frostfs-sdk-go:fix/user-id-scripthash into master 2025-01-29 10:36:03 +00:00
Conversation 0 Commits 2 Files changed 2 +37 -43
elebedeva commented 2025-01-27 16:34:48 +00:00
Member
Copy link

Close #302, #303

Changed user.ID.w field type to util.Uint160. util.Uint160 is a byte array of size 20.

Signed-off-by: Ekaterina Lebedeva ekaterina.lebedeva@yadro.com

Close #302, #303 Changed `user.ID.w` field type to `util.Uint160`. `util.Uint160` is a byte array of size 20. Signed-off-by: Ekaterina Lebedeva <ekaterina.lebedeva@yadro.com>
elebedeva added the
refactoring
internal
 labels 2025-01-27 16:34:48 +00:00
elebedeva added 2 commits 2025-01-27 16:34:49 +00:00 
Signed-off-by: Ekaterina Lebedeva <ekaterina.lebedeva@yadro.com>
[#303] user: Make user.ID a [20]byte array
All checks were successful
DCO / DCO (pull_request) Successful in 27s
Details
Code generation / Generate proto (pull_request) Successful in 33s
Details
Tests and linters / Tests (pull_request) Successful in 49s
Details
Tests and linters / Lint (pull_request) Successful in 2m7s
Details
873f0896ca 
Signed-off-by: Ekaterina Lebedeva <ekaterina.lebedeva@yadro.com>
elebedeva force-pushed fix/user-id-scripthash from 873f0896ca to 81c3d4a86f 2025-01-28 08:05:34 +00:00 Compare
elebedeva changed title from WIP: user: Refactor user.ID structure to user: Refactor user.ID structure 2025-01-28 08:09:17 +00:00
elebedeva requested review from storage-services-committers 2025-01-28 08:09:17 +00:00
elebedeva requested review from storage-services-developers 2025-01-28 08:09:17 +00:00
elebedeva requested review from storage-core-committers 2025-01-28 08:09:18 +00:00
elebedeva requested review from storage-core-developers 2025-01-28 08:09:18 +00:00
a-savchuk approved these changes 2025-01-28 09:54:11 +00:00
Dismissed
achuprov approved these changes 2025-01-28 09:55:56 +00:00
Dismissed
fyrchik reviewed 2025-01-28 10:27:11 +00:00
user/id.go Outdated
@ -76,2 +59,2 @@
func (x *ID) ScriptHash() (util.Uint160, error) {
return util.Uint160DecodeBytesBE(x.w[1:21])
func (x *ID) ScriptHash() util.Uint160 {
res, _ := util.Uint160DecodeBytesBE(x.w[:])
fyrchik commented 2025-01-28 10:27:11 +00:00
Owner
Copy link

Doesn't simple util.Uint160(x.w) work?

Doesn't simple `util.Uint160(x.w)` work?
fyrchik commented 2025-01-28 10:27:40 +00:00
Owner
Copy link

I would argue we can even make const idSize = util.Uint160Size and struct { w util.Uint160 }

I would argue we can even make `const idSize = util.Uint160Size` and `struct { w util.Uint160 }`
elebedeva commented 2025-01-28 15:09:54 +00:00
Author
Member
Copy link

It does, thanks! Fixed.

It does, thanks! Fixed.
fyrchik marked this conversation as resolved
fyrchik reviewed 2025-01-28 10:28:18 +00:00
user/id.go Outdated
@ -127,3 +112,3 @@
// IsEmpty returns True, if ID is empty value.
func (x ID) IsEmpty() bool {
return bytes.Equal(zeroSlice, x.w)
return bytes.Equal(zeroSlice, x.w[:])
fyrchik commented 2025-01-28 10:28:17 +00:00
Owner
Copy link

Doesn't x.w == util.Uint160{} work?

Doesn't `x.w == util.Uint160{}` work?
elebedeva commented 2025-01-28 15:10:22 +00:00
Author
Member
Copy link

Fixed.

Fixed.
fyrchik marked this conversation as resolved
elebedeva force-pushed fix/user-id-scripthash from 81c3d4a86f to 00cebd297f 2025-01-28 15:02:49 +00:00 Compare
elebedeva dismissed a-savchuk's review 2025-01-28 15:02:52 +00:00
Reason:

New commits pushed, approval review dismissed automatically according to repository settings

elebedeva dismissed achuprov's review 2025-01-28 15:02:52 +00:00
Reason:

New commits pushed, approval review dismissed automatically according to repository settings

fyrchik approved these changes 2025-01-29 10:24:05 +00:00
user/id.go
@ -84,3 +60,3 @@
// See also Neo3 wallet docs.
func (x ID) WalletBytes() []byte {
return x.w
v := make([]byte, idFullSize)
fyrchik commented 2025-01-29 10:19:48 +00:00
Owner
Copy link

The comment about MUST NOT be mutated can be removed now.

The comment about `MUST NOT be mutated` can be removed now.
user/id.go
@ -91,3 +71,3 @@
// See also DecodeString.
func (x ID) EncodeToString() string {
return base58.Encode(x.w)
return base58.Encode(x.WalletBytes())
fyrchik commented 2025-01-29 10:22:50 +00:00
Owner
Copy link

EncodeToString() makes 3 allocations. One of them (inside WalletBytes()) can be avoided with little cost.

$ go build -gcflags "-m -l" ./user
...
user/id.go:62:11: make([]byte, 25) escapes to heap

One way to achieve this is to move encoding to a function (ID).encode([]byte).
Both WalletBytes() and EncodeToString() methods will create new slice and encode to it.

`EncodeToString()` makes 3 allocations. One of them (inside `WalletBytes()`) can be avoided with little cost. ``` $ go build -gcflags "-m -l" ./user ... user/id.go:62:11: make([]byte, 25) escapes to heap ``` One way to achieve this is to move encoding to a function `(ID).encode([]byte)`. Both `WalletBytes()` and `EncodeToString()` methods will create new slice and `encode` to it.
fyrchik commented 2025-01-29 10:24:01 +00:00
Owner
Copy link

We can do this in another PR, though.

We can do this in another PR, though.
fyrchik merged commit 00cebd297f into master 2025-01-29 10:36:03 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
fyrchik
TrueCloudLab/storage-services-committers
TrueCloudLab/storage-services-developers
Labels
Clear labels   
P0

Highest

  
P1

High

  
P2

Medium

  
P3

Low

  
good first issue

Good for newcomers

  
pool

Tasks related to client pool

  
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 labels
P0
P1
P2
P3
good first issue
pool
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
Projects
Clear projects
No items
No project
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-sdk-go#323
No description provided.
Delete branch "elebedeva/frostfs-sdk-go:fix/user-id-scripthash"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?