refactor: token naming cleanup by benesjan · Pull Request #9904 · AztecProtocol/aztec-packages

benesjan · 2024-11-12T15:12:52Z

Naming of the token functions was outdated. This PR addresses that.

benesjan · 2024-11-12T15:13:16Z

fix: TXE fixes #9929
refactor: token naming cleanup #9904 👈
refactor: final token cleanup #9864
refactor: token partial notes refactor pt. 2 - bridging #9600
refactor: nuking pay_refund_with_shielded_rebate flow #9639
test: cleaning up token test utils #9633 : 1 other dependent PR (#8644 )
master

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

Join @benesjan and the rest of your teammates on Graphite

AztecBot · 2024-11-12T22:22:25Z

Docs Preview

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

benesjan · 2024-11-13T14:19:54Z

l1-contracts/test/fee_portal/depositToAztecPublic.t.sol

    uint256 expectedIndex = 2 ** Constants.L1_TO_L2_MSG_SUBTREE_HEIGHT;

+    // The purpose of including the function selector is to make the message unique to that specific call. Note that
+    // it has nothing to do with calling the function.


I remember finding the selector on line 89 confusing so I decided to include the comment here.

benesjan · 2024-11-13T14:22:32Z

noir-projects/noir-contracts/contracts/token_contract/src/test/burn_private.nr

@@ -0,0 +1,107 @@
+use crate::test::utils;


I just copied these test cases from burn so does not need to be reviewed.

benesjan · 2024-11-13T14:23:39Z

noir-projects/noir-contracts/contracts/token_contract/src/test/burn_public.nr

@@ -0,0 +1,89 @@
+use crate::test::utils;


I just copied these test cases from burn so does not need to be reviewed.

benesjan · 2024-11-13T14:24:33Z

noir-projects/noir-contracts/contracts/token_contract/src/test/transfer.nr

@@ -0,0 +1,64 @@
+use crate::test::utils;


I just copied these test cases from transfer_private so does not need to be reviewed.

benesjan · 2024-11-13T14:25:00Z

noir-projects/noir-contracts/contracts/token_contract/src/test/transfer_in_private.nr

-use dep::aztec::test::helpers::cheatcodes;
-
-#[test]
-unconstrained fn transfer_private() {


These test cases were moved to transfer.nr

benesjan · 2024-11-13T14:26:10Z

noir-projects/noir-contracts/contracts/token_portal_content_hash_lib/src/lib.nr

        hash_bytes[i + 36] = amount_bytes[i];
    }

-    // Function selector: 0x3e87b9be keccak256('mint_public(bytes32,uint256)')


This hardcoded selector bytes were bad so I replaced it with comptime keccak.

benesjan · 2024-11-13T14:29:09Z

yarn-project/end-to-end/src/e2e_token_contract/transfer.test.ts

@@ -0,0 +1,85 @@
+import { AztecAddress, CompleteAddress } from '@aztec/aztec.js';


I just copied these test cases from transfer_private so does not need to be reviewed.

github-actions · 2024-11-13T14:36:04Z

Changes to circuit sizes

Generated at commit: 6b542ae1a05936bebf4b8a0091542a2fd5f7e815, compared to commit: 3830e2a81cca4ff4782000847aefe011fbb6ee0c

🧾 Summary (100% most significant diffs)

Program	ACIR opcodes (+/-)	%	Circuit size (+/-)	%
private_kernel_init	+23 ❌	+0.11%	+21 ❌	+0.06%
private_kernel_inner	+26 ❌	+0.07%	+22 ❌	+0.04%
private_kernel_tail	+3 ❌	+0.07%	+3 ❌	+0.02%
parity_base	+3 ❌	+0.07%	+3 ❌	+0.01%
private_kernel_tail_to_public	+3 ❌	+0.02%	+3 ❌	+0.01%
private_kernel_reset_4_4_4_4_4_4_4_4_1	+1 ❌	+0.00%	+1 ❌	+0.00%
rollup_base_private	+38 ❌	+0.01%	+38 ❌	+0.00%
rollup_base_public	+38 ❌	+0.01%	+38 ❌	+0.00%
rollup_merge	+4 ❌	+0.12%	+4 ❌	+0.00%
rollup_root	+4 ❌	+0.03%	+4 ❌	+0.00%
rollup_block_merge	+4 ❌	+0.03%	+4 ❌	+0.00%
private_kernel_reset	+1 ❌	+0.00%	+1 ❌	+0.00%
rollup_block_root	+4 ❌	+0.09%	+4 ❌	+0.00%
parity_root	+3 ❌	+0.06%	+3 ❌	+0.00%

Full diff report 👇

Program	ACIR opcodes (+/-)	%	Circuit size (+/-)	%
private_kernel_init	21,726 (+23)	+0.11%	34,887 (+21)	+0.06%
private_kernel_inner	38,093 (+26)	+0.07%	57,530 (+22)	+0.04%
private_kernel_tail	4,493 (+3)	+0.07%	13,045 (+3)	+0.02%
parity_base	4,301 (+3)	+0.07%	30,698 (+3)	+0.01%
private_kernel_tail_to_public	18,852 (+3)	+0.02%	31,300 (+3)	+0.01%
private_kernel_reset_4_4_4_4_4_4_4_4_1	32,455 (+1)	+0.00%	86,600 (+1)	+0.00%
rollup_base_private	332,907 (+38)	+0.01%	3,432,553 (+38)	+0.00%
rollup_base_public	470,092 (+38)	+0.01%	3,770,598 (+38)	+0.00%
rollup_merge	3,419 (+4)	+0.12%	1,909,446 (+4)	+0.00%
rollup_root	11,989 (+4)	+0.03%	1,940,906 (+4)	+0.00%
rollup_block_merge	12,005 (+4)	+0.03%	1,940,920 (+4)	+0.00%
private_kernel_reset	84,097 (+1)	+0.00%	618,117 (+1)	+0.00%
rollup_block_root	4,489 (+4)	+0.09%	2,863,252 (+4)	+0.00%
parity_root	5,034 (+3)	+0.06%	3,801,552 (+3)	+0.00%

sklppy88

LGTM 👍. Probably want devrel to take a pass at the docs to remove any other dangling refs in a follow up PR.

sklppy88 · 2024-11-13T14:53:53Z

docs/docs/guides/developer_guides/smart_contracts/writing_contracts/common_patterns/index.md

@@ -84,8 +84,6 @@ Let's say you have some storage in public and want to move them into the private

 So you have to create a custom note in the public domain that is not encrypted by some owner - we call such notes a "TransparentNote" since it is created in public, anyone can see the amount and the note is not encrypted by some owner.


Pinning for dev rel

noir-projects/noir-contracts/contracts/fee_juice_contract/src/lib.nr

github-actions · 2024-11-13T15:43:30Z

Changes to public function bytecode sizes

Generated at commit: 6b542ae1a05936bebf4b8a0091542a2fd5f7e815, compared to commit: 3830e2a81cca4ff4782000847aefe011fbb6ee0c

🧾 Summary (100% most significant diffs)

Program	Bytecode size in bytes (+/-)	%
TokenBridge::claim_public	+476 ❌	+3.82%
Test::public_dispatch	+461 ❌	+2.33%
TokenBridge::public_dispatch	+201 ❌	+0.92%
TokenBridge::exit_to_l1_public	-230 ✅	-2.80%

Full diff report 👇

Program	Bytecode size in bytes (+/-)	%
TokenBridge::claim_public	12,946 (+476)	+3.82%
Test::public_dispatch	20,276 (+461)	+2.33%
TokenBridge::public_dispatch	22,156 (+201)	+0.92%
TokenBridge::exit_to_l1_public	7,996 (-230)	-2.80%

* master: (245 commits) chore: pull signed bitshifts from sync PR (#9939) chore: pull frontend changes from sync PR (#9935) feat: separate bytecode logs from unencrypted logs (#9891) git subrepo push --branch=master noir-projects/aztec-nr git_subrepo.sh: Fix parent in .gitrepo file. [skip ci] chore: replace relative paths to noir-protocol-circuits git subrepo push --branch=master barretenberg fix: token naming issue (#9950) feat: multiplier oracle (#9902) refactor: token refunds cleanup (#9943) chore: Use stack based recursion instead of function recursion (#9947) feat: parallelize DIE pass (#9933) feat(avm): Simulator enforces integral tag for DIV and field tag for FDIV (#9944) chore(avm): bugfixing witness generation for add, sub, mul for FF (#9938) feat: Google Cloud Kubernetes cluster + AWS Firewall Rules (#9915) chore: nuking ancient redundant test (#9941) fix: include 'master' version for aztec-up scripts (#9940) chore: fixing test contract fixture (#9909) refactor: token naming cleanup (#9904) chore: pull SSA parser from sync PR (#9928) ...

This was referenced Nov 12, 2024

refactor: token partial notes refactor pt. 2 - bridging #9600

Merged

refactor: nuking pay_refund_with_shielded_rebate flow #9639

Merged

benesjan mentioned this pull request Nov 12, 2024

refactor: final token cleanup #9864

Merged

benesjan force-pushed the 11-09-refactor_final_token_cleanup branch from 0b19ee1 to d14b00e Compare November 12, 2024 15:55

benesjan force-pushed the 11-12-refactor_final_token_naming_cleanup branch from a1a49b8 to 9f29ed8 Compare November 12, 2024 15:56

benesjan marked this pull request as ready for review November 12, 2024 15:56

benesjan added the e2e-all label Nov 12, 2024

benesjan force-pushed the 11-09-refactor_final_token_cleanup branch from d14b00e to 955f2e0 Compare November 12, 2024 18:06

benesjan marked this pull request as draft November 12, 2024 18:06

benesjan force-pushed the 11-12-refactor_final_token_naming_cleanup branch 3 times, most recently from 805aed2 to 3e8bffe Compare November 12, 2024 19:07

benesjan marked this pull request as ready for review November 12, 2024 19:13

benesjan changed the title ~~refactor: final token naming cleanup~~ refactor: token naming cleanup Nov 12, 2024

benesjan force-pushed the 11-09-refactor_final_token_cleanup branch from 74ddb10 to b8eb9ce Compare November 12, 2024 20:50

benesjan force-pushed the 11-12-refactor_final_token_naming_cleanup branch from 3e8bffe to 21e94ff Compare November 12, 2024 20:50

Base automatically changed from 11-09-refactor_final_token_cleanup to master November 12, 2024 21:36

benesjan force-pushed the 11-12-refactor_final_token_naming_cleanup branch from 7c683a6 to 19f63ed Compare November 12, 2024 21:48

benesjan force-pushed the 11-12-refactor_final_token_naming_cleanup branch from 19f63ed to e335c48 Compare November 13, 2024 13:18

benesjan mentioned this pull request Nov 13, 2024

fix: TXE fixes #9929

Closed

benesjan force-pushed the 11-12-refactor_final_token_naming_cleanup branch from e335c48 to 1078983 Compare November 13, 2024 14:06

benesjan commented Nov 13, 2024

View reviewed changes

benesjan requested a review from sklppy88 November 13, 2024 14:30

sklppy88 approved these changes Nov 13, 2024

View reviewed changes

benesjan force-pushed the 11-12-refactor_final_token_naming_cleanup branch from 1078983 to ec2eb91 Compare November 13, 2024 15:12

benesjan enabled auto-merge (squash) November 13, 2024 15:20

benesjan added 7 commits November 13, 2024 15:27

refactor: final token naming cleanup

776a730

migration notes

cb6eb63

WIP

80dfa01

fmt

7a6fba0

fmt fix

03f597b

WIP

7bbf62d

making it cuter

f6de81d

benesjan force-pushed the 11-12-refactor_final_token_naming_cleanup branch from ec2eb91 to f6de81d Compare November 13, 2024 15:28

benesjan merged commit d77fc30 into master Nov 13, 2024

benesjan deleted the 11-12-refactor_final_token_naming_cleanup branch November 13, 2024 16:04

AztecBot mentioned this pull request Nov 13, 2024

chore(master): Release 0.63.0 #9651

Merged

stevenplatt pushed a commit that referenced this pull request Nov 13, 2024

refactor: token naming cleanup (#9904)

fb09d4e

		@@ -0,0 +1,85 @@
		import { AztecAddress, CompleteAddress } from '@aztec/aztec.js';

		@@ -84,8 +84,6 @@ Let's say you have some storage in public and want to move them into the private

		So you have to create a custom note in the public domain that is not encrypted by some owner - we call such notes a "TransparentNote" since it is created in public, anyone can see the amount and the note is not encrypted by some owner.

Conversation

benesjan commented Nov 12, 2024

Uh oh!

benesjan commented Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AztecBot commented Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Docs Preview

Uh oh!

benesjan Nov 13, 2024

Choose a reason for hiding this comment

Uh oh!

benesjan Nov 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

benesjan Nov 13, 2024

Choose a reason for hiding this comment

Uh oh!

benesjan Nov 13, 2024

Choose a reason for hiding this comment

Uh oh!

benesjan Nov 13, 2024

Choose a reason for hiding this comment

Uh oh!

benesjan Nov 13, 2024

Choose a reason for hiding this comment

Uh oh!

benesjan Nov 13, 2024

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes to circuit sizes

🧾 Summary (100% most significant diffs)

Uh oh!

sklppy88 left a comment

Choose a reason for hiding this comment

Uh oh!

sklppy88 Nov 13, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Nov 13, 2024

Changes to public function bytecode sizes

🧾 Summary (100% most significant diffs)

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

benesjan commented Nov 12, 2024 •

edited

Loading

AztecBot commented Nov 12, 2024 •

edited

Loading

benesjan Nov 13, 2024 •

edited

Loading

github-actions bot commented Nov 13, 2024 •

edited

Loading