Skip to content
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.

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

Fix the StorageVec type by excluding the len_cached field from its type info #2052

Merged
merged 4 commits into from
Jan 10, 2024

Conversation

smiasojed
Copy link
Collaborator

@smiasojed smiasojed commented Jan 9, 2024

Summary

  • [n] y/n | Does it introduce breaking changes?
  • [n y/n | Is it dependant on the specific version of cargo-contract or pallet-contracts?

Fix the StorageVec type by excluding the len_cached field from its type info

Description

There is an issue with the len_cached field of the StorageVec type. It is not stored in the storage but is defined in the StorageVec as TypeInfo Option<u32>. This is causing a decoding error when the StorageVec type is decoded from storage.

Checklist before requesting a review

  • My code follows the style guidelines of this project
  • I have added an entry to CHANGELOG.md
  • I have commented my code, particularly in hard-to-understand areas
  • I have added tests that prove my fix is effective or that my feature works
  • Any dependent changes have been merged and published in downstream modules

Copy link
Collaborator

@ascjones ascjones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've just thought of an alternative way to do it: add #[codec(skip)] to the len_cached field. Then CachedLen should not require its own TypeInfo implementation.

@codecov-commenter
Copy link

codecov-commenter commented Jan 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (db5600e) 53.47% compared to head (48675b8) 53.46%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2052      +/-   ##
==========================================
- Coverage   53.47%   53.46%   -0.02%     
==========================================
  Files         221      221              
  Lines        6984     6982       -2     
  Branches     3082     3082              
==========================================
- Hits         3735     3733       -2     
  Misses       3249     3249              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@smiasojed smiasojed changed the title Fix TypeInfo for the len_cached field of the StorageVec type Fix the StorageVec type by excluding the len_cached field from its type info Jan 9, 2024
Copy link

github-actions bot commented Jan 9, 2024

🦑 📈 ink! Example Contracts ‒ Changes Report 📉 🦑

These are the results when building the integration-tests/* contracts from this branch with cargo-contract and comparing them to ink! master:

Contract Upstream Size (kB) PR Size (kB) Diff (kB) Diff (%) Change
basic-contract-caller 3.207 3.207 0 0
basic-contract-caller/other-contract 1.581 1.581 0 0
call-builder-return-value 8.904 8.904 0 0
call-runtime 2.013 2.013 0 0
conditional-compilation 1.453 1.453 0 0
contract-storage 7.336 7.336 0 0
contract-terminate 1.336 1.336 0 0
contract-transfer 1.693 1.693 0 0
custom-allocator 7.652 7.652 0 0
dns 7.321 7.321 0 0
e2e-call-runtime 1.302 1.302 0 0
e2e-runtime-only-backend 1.879 1.879 0 0
erc1155 14.123 14.129 0.006 0.0424839 📈
erc20 6.918 6.918 0 0
erc721 9.816 9.816 0 0
events 5.006 5.006 0 0
flipper 1.637 1.637 0 0
incrementer 1.504 1.504 0 0
lang-err-integration-tests/call-builder-delegate 2.561 2.561 0 0
lang-err-integration-tests/call-builder 5.087 5.087 0 0
lang-err-integration-tests/constructors-return-value 1.987 1.987 0 0
lang-err-integration-tests/contract-ref 4.568 4.568 0 0
lang-err-integration-tests/integration-flipper 1.815 1.815 0 0
lazyvec-integration-test 4.553 4.553 0 0
mapping-integration-tests 7.919 7.919 0 0
mother 12.756 12.756 0 0
multi-contract-caller 6.155 6.155 0 0
multi-contract-caller/accumulator 1.378 1.378 0 0
multi-contract-caller/adder 1.908 1.908 0 0
multi-contract-caller/subber 1.928 1.928 0 0
multisig 21.621 21.621 0 0
payment-channel 5.653 5.653 0 0
sr25519-verification 1.148 1.148 0 0
static-buffer 1.649 1.649 0 0
trait-dyn-cross-contract-calls 2.706 2.706 0 0
trait-dyn-cross-contract-calls/contracts/incrementer 1.549 1.549 0 0
trait-erc20 7.294 7.294 0 0
trait-flipper 1.453 1.453 0 0
trait-incrementer 1.614 1.614 0 0
upgradeable-contracts/delegator 3.152 3.152 0 0
upgradeable-contracts/delegator/delegatee 1.613 1.613 0 0
upgradeable-contracts/set-code-hash 1.747 1.747 0 0
upgradeable-contracts/set-code-hash/updated-incrementer 1.726 1.726 0 0
wildcard-selector 2.852 2.852 0 0

Link to the run | Last update: Tue Jan 9 17:40:53 CET 2024

@xermicus
Copy link
Contributor

xermicus commented Jan 9, 2024

Good catch

@ascjones ascjones merged commit 54e0177 into master Jan 10, 2024
22 checks passed
@ascjones ascjones deleted the sm/storagevec-fix branch January 10, 2024 11:23
@SkymanOne SkymanOne mentioned this pull request Jan 15, 2024
@SkymanOne SkymanOne mentioned this pull request Feb 8, 2024
@SkymanOne SkymanOne mentioned this pull request Mar 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants