Add methods description and update code metadata #587
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
src/core/address.ts
Outdated
| } | ||
|
|
||
| /** | ||
| * Note that the first input parameter is received as an interface, but the return value is a concrete type (see guidelines). |
Contributor
There was a problem hiding this comment.
Stale comment (no interface).
src/core/address.ts
Outdated
|
|
||
| /** | ||
| * The number of shards (necessary for computing the shard ID) would be received as a constructor parameter - constructor is not captured by specs. | ||
| */ |
Contributor
There was a problem hiding this comment.
Comment refers to specs, should be adjusted.
src/core/codeMetadata.ts
Outdated
| /** | ||
| * Named constructor | ||
| * Creates a metadata object from a buffer. | ||
| * Should check that data has correct length (2 bytes) |
Contributor
There was a problem hiding this comment.
"checks" (in the implementation) vs. "should check" (in the specs).
Comment on lines
50
to
62
| if (bytes.length != CodeMetadataLength) { | ||
| throw new Error(`code metadata buffer has length ${bytes.length}, expected ${CodeMetadataLength}`); | ||
| } | ||
|
|
||
| const byteZero = bytes[0]; | ||
| const byteOne = bytes[1]; | ||
|
|
||
| const upgradeable = (byteZero & CodeMetadata.ByteZero.Upgradeable) !== 0; | ||
| const readable = (byteZero & CodeMetadata.ByteZero.Readable) !== 0; | ||
| const payable = (byteOne & CodeMetadata.ByteOne.Payable) !== 0; | ||
| const payableBySc = (byteOne & CodeMetadata.ByteOne.PayableBySc) !== 0; | ||
|
|
||
| return new CodeMetadata(upgradeable, readable, payable, payableBySc); |
Contributor
There was a problem hiding this comment.
Somehow duplicated code. Maybe call this in the old newFromBuffer?
popenta
approved these changes
Mar 13, 2025
andreibancioiu
approved these changes
Mar 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.