feat: Packable trait + using it for public storage

[benesjan]

Fixes #11285
Fixes #7728

Notes for reviewer

• Created an issue for implementation of #[derive(Packable)] macro. Didn't include that in this PR to keep the scope smaller.
• This does not yet pack note content (resulting in a large DA cost for the UintNote). This will be done in a follow-up PR. Issue here.
• Didn't run CI on latest commit as it's just migration notes and the ci-rest task in the previous commit didn't pass because of unrelated flake.

[benesjan]

• refactor: using UintNote in crowdfunding and claim #11270
• feat: packing note content #11376
• feat: Packable trait + using it for public storage #11136 👈 (View in Graphite)
• refactor: Serialize trait impls for U128 following intrinsic Noir serialization #11142
• master

This stack of pull requests is managed by Graphite. Learn more about stacking.

[olehmisar]

Would this require users to implement Serialize, Deserialize and Packable traits for custom structs that will be used as function parameters and can be stored in the storage?

Does it make sense to add this blanket implementation, so users are not forced to impl Packable if the storage size is irrelevant or is not more efficient than Serialize?

impl<let N: u32> Packable<N> for T 
where 
    T: Serialize<N> + Deserialize<N> 
{
    fn pack(self) -> [Field; N] {
        self.serialize()
    }

    fn unpack(packed: [Field; N]) -> Self {
        Self::deserialize(packed)
    }
}

[benesjan]

Would this require users to implement Serialize, Deserialize and Packable traits for custom structs that will be used as function parameters and can be stored in the storage?

@olehmisar Yes, it would.

Does it make sense to add this blanket implementation, so users are not forced to impl Packable if the storage size is irrelevant or is not more efficient than Serialize?

Great idea. I think I will add it in a follow-up PR or alternatively I will implement an alternative to #[derive(Serialize, Deserialize)] macro.

[github-actions]

Changes to public function bytecode sizes

Generated at commit: 2fb989bf495b7e6accfd64a1d0d2e61eebbcdce3, compared to commit: 01510f45aa5d385a08584df674d9caf9522e6be2

🧾 Summary (100% most significant diffs)

Program	Bytecode size in bytes (+/-)	%
Token::total_supply	+76 ❌	+28.68%
TokenBlacklist::total_supply	+51 ❌	+17.35%
TokenBlacklist::_reduce_total_supply	+78 ❌	+16.96%
Token::_reduce_total_supply	+55 ❌	+14.32%
Spam::public_spam	+160 ❌	+7.87%
Spam::public_dispatch	+160 ❌	+5.69%
PriceFeed::get_price	+84 ❌	+5.28%
FeeJuice::balance_of_public	+72 ❌	+4.49%
FeeJuice::check_balance	+82 ❌	+4.35%
Token::balance_of_public	+72 ❌	+4.34%
PriceFeed::public_dispatch	+91 ❌	+3.50%
TokenBlacklist::balance_of_public	+55 ❌	+3.28%
TokenBlacklist::_increase_public_balance	+68 ❌	+3.10%
FeeJuice::_increase_public_balance	+50 ❌	+2.69%
Lending::_deposit	+55 ❌	+2.25%
TokenBlacklist::mint_private	+78 ❌	+2.16%
Token::_increase_public_balance	+45 ❌	+2.12%
Token::burn_public	+86 ❌	+2.04%
Token::mint_to_public	+36 ❌	+1.62%
Token::transfer_in_public	+65 ❌	+1.51%
Token::complete_refund	+83 ❌	+1.46%
TokenBlacklist::shield	+73 ❌	+1.31%
PriceFeed::set_price	+20 ❌	+1.30%
Token::finalize_mint_to_private	+55 ❌	+1.14%
Token::_finalize_mint_to_private_unsafe	+55 ❌	+1.13%
Token::finalize_transfer_to_private	+50 ❌	+0.96%
Token::_finalize_transfer_to_private_unsafe	+50 ❌	+0.95%
AppSubscription::constructor	+16 ❌	+0.53%
Lending::_repay	+24 ❌	+0.45%
NFT::public_dispatch	+96 ❌	+0.42%
Lending::public_dispatch	+44 ❌	+0.17%
Token::public_dispatch	+44 ❌	+0.14%
Uniswap::public_dispatch	+27 ❌	+0.11%
TokenBlacklist::public_dispatch	+14 ❌	+0.06%
TokenBlacklist::mint_public	-5 ✅	-0.14%
FeeJuice::public_dispatch	-8 ✅	-0.17%
AvmTest::public_dispatch	-196 ✅	-0.32%
Lending::_withdraw	-102 ✅	-1.20%
Lending::_borrow	-102 ✅	-1.22%
Lending::get_position	-64 ✅	-1.48%
Benchmarking::public_dispatch	-90 ✅	-2.55%
AppSubscription::public_dispatch	-135 ✅	-3.21%
AuthRegistry::public_dispatch	-264 ✅	-3.71%

---

Full diff report 👇

Program	Bytecode size in bytes (+/-)	%
Token::total_supply	341 (+76)	+28.68%
TokenBlacklist::total_supply	345 (+51)	+17.35%
TokenBlacklist::_reduce_total_supply	538 (+78)	+16.96%
Token::_reduce_total_supply	439 (+55)	+14.32%
Spam::public_spam	2,193 (+160)	+7.87%
Spam::public_dispatch	2,974 (+160)	+5.69%
PriceFeed::get_price	1,676 (+84)	+5.28%
FeeJuice::balance_of_public	1,676 (+72)	+4.49%
FeeJuice::check_balance	1,965 (+82)	+4.35%
Token::balance_of_public	1,730 (+72)	+4.34%
PriceFeed::public_dispatch	2,688 (+91)	+3.50%
TokenBlacklist::balance_of_public	1,734 (+55)	+3.28%
TokenBlacklist::_increase_public_balance	2,265 (+68)	+3.10%
FeeJuice::_increase_public_balance	1,907 (+50)	+2.69%
Lending::_deposit	2,495 (+55)	+2.25%
TokenBlacklist::mint_private	3,682 (+78)	+2.16%
Token::_increase_public_balance	2,166 (+45)	+2.12%
Token::burn_public	4,299 (+86)	+2.04%
Token::mint_to_public	2,263 (+36)	+1.62%
Token::transfer_in_public	4,374 (+65)	+1.51%
Token::complete_refund	5,771 (+83)	+1.46%
TokenBlacklist::shield	5,642 (+73)	+1.31%
PriceFeed::set_price	1,559 (+20)	+1.30%
Token::finalize_mint_to_private	4,895 (+55)	+1.14%
Token::_finalize_mint_to_private_unsafe	4,942 (+55)	+1.13%
Token::finalize_transfer_to_private	5,247 (+50)	+0.96%
Token::_finalize_transfer_to_private_unsafe	5,294 (+50)	+0.95%
AppSubscription::constructor	3,023 (+16)	+0.53%
Lending::_repay	5,378 (+24)	+0.45%
NFT::public_dispatch	22,732 (+96)	+0.42%
Lending::public_dispatch	25,980 (+44)	+0.17%
Token::public_dispatch	31,145 (+44)	+0.14%
Uniswap::public_dispatch	24,954 (+27)	+0.11%
TokenBlacklist::public_dispatch	23,507 (+14)	+0.06%
TokenBlacklist::mint_public	3,529 (-5)	-0.14%
FeeJuice::public_dispatch	4,577 (-8)	-0.17%
AvmTest::public_dispatch	61,944 (-196)	-0.32%
Lending::_withdraw	8,420 (-102)	-1.20%
Lending::_borrow	8,254 (-102)	-1.22%
Lending::get_position	4,253 (-64)	-1.48%
Benchmarking::public_dispatch	3,444 (-90)	-2.55%
AppSubscription::public_dispatch	4,065 (-135)	-3.21%
AuthRegistry::public_dispatch	6,843 (-264)	-3.71%

[sklppy88]

The lack of continuity between Packable and Serialize / Deserialize (vs Serializable) hurts my head a bit.

Otherwise it looks great, thanks for the in-depth comments on when to use Packable vs Serialize / Deserialize.

[nventuro]

Lovely thanks!

[AztecBot]

Docs Preview

Hey there! 👋 You can check your preview at https://679161f444f0091ef098bc20--aztec-docs-dev.netlify.app