Unexport SlabID fields to prevent misuse
#323
Merged
Conversation
This file contains 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
fxamacker
added
improvement
breaking change
Codecov Report
@@ Coverage Diff @@
## fxamacker/rename-id-and-related-functions-and-types #323 +/- ##
=======================================================================================
- Coverage 64.74% 64.64% -0.10%
=======================================================================================
Files 14 14
Lines 8046 8050 +4
=======================================================================================
- Hits 5209 5204 -5
- Misses 2160 2168 +8
- Partials 677 678 +1
|
Currently, in order to create StorableSlab, user needs to: - generate SlabID from storage - create new StorableSlab - store created StorableSlab in storage This commit unexports StorableSlab fields and adds NewStorableSlab(). With this change, user can simply call NewStorableSlab().
ValueID identifies atree Array and OrderedMap while SlabID identifies slab in storage. SlabID should only be used to retrieve, store, and remove slab in storage.
Rename ID to ValueID
Refactor creating new StorableSlab
fxamacker
merged commit 251b774
into
fxamacker/rename-id-and-related-functions-and-types
fxamacker
added a commit
to onflow/cadence
that referenced
this pull request
Jul 7, 2023
This commit updates Cadence to use new Atree API - Array.SlabID() - OrderedMap.SlabID() - SlabID - SlabIndex - etc. For more info, see Atree PRs: - onflow/atree#322 - onflow/atree#323 - onflow/atree#324
fxamacker
added a commit
to onflow/cadence
that referenced
this pull request
Jul 7, 2023
This commit updates Cadence to use new Atree API - Array.SlabID() - OrderedMap.SlabID() - SlabID - SlabIndex - etc. For more info, see Atree PRs: - onflow/atree#322 - onflow/atree#323 - onflow/atree#324
6 tasks
turbolent
pushed a commit
to onflow/cadence
that referenced
this pull request
Jan 26, 2024
This commit updates Cadence to use new Atree API - Array.SlabID() - OrderedMap.SlabID() - SlabID - SlabIndex - etc. For more info, see Atree PRs: - onflow/atree#322 - onflow/atree#323 - onflow/atree#324
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.
Updates #296 #292 onflow/flow-go#1744
Updates onflow/cadence#2622 and more context at onflow/cadence#2622 (comment).
Description
Previously
SlabIDhad two exported fieldsAddressandIndex.Addressfield was used in Cadence repo to obtain storage address.We want clients to obtain storage address by calling
Array.Address()orOrderedMap.Address(). This PR unexportsAddressfield to prevent misuse.mainbranchFiles changedin the Github PR explorer