feat: Token standard by LHerskind · Pull Request #2069 · AztecProtocol/aztec-packages

LHerskind · 2023-09-06T16:42:00Z

See #2199 for extensions that is required with generators etc to not collide with payloads.

Checklist:

Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge.

If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag.
I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code.
Every change is related to the PR description.
I have linked this pull request to relevant issues (if any exist).

iAmMichaelConnor · 2023-09-07T22:08:21Z

We decided to get rid of storage.nr files and bring Storage declarations into the main.nr file - Leila updated the rest of the contract examples today

spalladino

Love it

spalladino · 2023-09-08T12:15:48Z

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

+        if (from.address != context.msg_sender()) {
+            let selector = compute_selector("transfer_public((Field),(Field),Field,Field)");
+            let message_field = compute_message_hash([context.msg_sender(), selector, from.address, to.address, amount, nonce]);
+            assert(AccountContract::at(from.address).is_valid(Option::none(), Option::some(context), message_field) == 0xe86ab4ff, "invalid call");


FYI I had added a helper for this here: https://github.com/AztecProtocol/aztec-packages/blob/master/yarn-project/noir-libs/noir-aztec/src/auth.nr. Maybe we can include it in your account contract interface and remove it as a separate util?

Ah ok, seems nice. Will update to use that one instead.

Reviewed, and think I prefer the combined is_valid that handles both the private and public flows with same interface more 🤔

Agree, but I think there's value in a helper that removes the need for hardcoding the 0xe86ab4ff selector in your app logic. Maybe add that check to the account interface?

spalladino · 2023-09-08T12:24:20Z

yarn-project/noir-contracts/src/contracts/schnorr_auth_witness_account_contract/src/main.nr

+    }
+
+    #[aztec(private)]
+    fn set_is_valid_storage(


We haven't even launched and have already found a use case for transient storage

spalladino · 2023-09-08T12:26:44Z

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

+    #[aztec(public)]
+    fn mint_priv(
+        amount: Field,
+        secret_hash: Field,
+    ) -> Field {


I understand that the only thing that prevents us from having a private mint method is being able to access the list of minters from private-land, and for that we'd need the slow-updates tree, right?

Yes, but even if in private I would want it to do a public call to update the total_supply such that it is up to date. But yes you could mint directly into a specific user if we got slow-updates tree.

spalladino · 2023-09-08T12:29:07Z

yarn-project/noir-contracts/src/contracts/schnorr_auth_witness_account_contract/src/main.nr

+        let storage = Storage::init(Option::none(), Option::some(&mut context));
+        let value = storage.approved_action.at(message_hash).read();


Going back to transient storage: I believe that if we write zero again to this slot when "consuming" the approval, then the public kernel circuit should "squash" those updates and not impact the public data tree. I may be mistaken though.

Yep, ideally, I think I have a note somewhere about sandwiching your own tx with a set and unset such that it is just a transient "approval".

spalladino · 2023-09-08T12:29:19Z

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

+            assert(AccountContract::at(from.address).is_valid(Option::none(), Option::some(context), message_field) == 0xe86ab4ff, "invalid call");
+            context.push_new_nullifier(message_field, 0);
+        } else {
+            assert(nonce == 0, "invalid nonce");


Curious why this check

Mainly because I did not like a value that could be whatever when not used, so making it 0 made it pretty clear as well if doing a direct transfer or the transfer from.

rahul-kothari

Looks great - one major nit - a function that should be internal is not

rahul-kothari · 2023-09-11T10:30:19Z

yarn-project/aztec.js/src/account/entrypoint/entrypoint_collection.ts

+  }
+
+  createTxExecutionRequest(_executions: FunctionCall[], _opts?: CreateTxRequestOpts): Promise<TxExecutionRequest> {
+    throw new Error('Method not implemented.');


should this be a TODO with an issue to either completely remove or implement it?

The interface for Entrypoints include it, but it is error-prone if used with the Auth wallet.

rahul-kothari · 2023-09-11T10:37:20Z

yarn-project/noir-contracts/src/contracts/schnorr_auth_witness_account_contract/src/main.nr

+    ) -> pub bool{
        let witness = get_auth_witness(message_hash);
        assert(recover_address(message_hash, witness) == address);
+        true


I see internal keyword is missing for this function? Is this intentional? If so shouldn't this too return fn selector

Should not be callable since it is not using #[aztec(private)] nr #[aztec(public)]. But can see that the abi is read as if it is. Will try executing it to see what actually happens.

rahul-kothari · 2023-09-11T10:39:44Z

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

+// The designated caller is ALWAYS used here, and not based on a flag as cross-chain.
+// message hash = H([caller, selector, , ...args])
+// To be read as `caller` calls function defined by `selector` with `args`
+// Including a nonce in the message hash ensures that the message can only be used once.


<3 this is clean!!

rahul-kothari · 2023-09-11T10:45:50Z

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

+    }
+
+    #[aztec(public)]
+    fn mint_priv(


public function but called mint_priv aaaah. I am out of ideas on a better name though :(

Yep. The name gets a little funky.

rahul-kothari · 2023-09-11T10:50:22Z

yarn-project/noir-contracts/src/contracts/token_contract/src/account_interface.nr

+    } else if public_context.is_some() {
+      public_context.unwrap().call_public_function(
+        self.address,
+        0xf3661153,


can you add a comment here that this calls is_valid_public which still returns 0xe86ab4ff (same as is_valid from private land).
For some reason, I expected this to return 0xf3661153 because I see that this is the selector lol

Ah, ye ok, that would probably have made somewhat sense to do. Just used the same selector return as the only reason it got the public one was that we can't have functions that have both a public and private flow hehe

rahul-kothari · 2023-09-11T10:56:14Z

yarn-project/noir-contracts/src/contracts/token_contract/src/util.nr

+use dep::aztec::constants_gen::GENERATOR_INDEX__SIGNATURE_PAYLOAD;
+
+fn compute_message_hash<N>(args: [Field; N]) -> Field {
+  // @todo @lherskind We should probably use a separate generator for this, 


does this require a new issue?

Should become part of fixes to #2199

rahul-kothari · 2023-09-11T10:58:57Z

yarn-project/sequencer-client/src/publisher/viem-tx-sender.ts


+      if (extendedContractData.bytecode.length > 131072) {
+        this.log(
+          `Bytecode is too large ethereum transactions: ${extendedContractData.bytecode.length} ${


Do you mean to say how many eth transactions it would take to deploy the contract? Maybe make the message clearer?

Were partly for debugging and making it clear when large code is generated. But will make it more clear.

rahul-kothari · 2023-09-11T11:20:19Z

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

+            let selector = compute_selector("transfer_public((Field),(Field),Field,Field)");
+            let message_field = compute_message_hash([context.msg_sender(), selector, from.address, to.address, amount, nonce]);
+            assert(AccountContract::at(from.address).is_valid(Option::none(), Option::some(context), message_field) == 0xe86ab4ff, "invalid call");
+            context.push_new_nullifier(message_field, 0);


maybe add a comment here on why adding the nullifier is very very important?

Should become part of fixes to #2199

rahul-kothari

legend!

Maddiaa0

Some minor things id like changed, also seem to have spotted some aztec noir bugs :(

Maddiaa0 · 2023-09-11T21:03:04Z

yarn-project/acir-simulator/src/client/private_execution.ts

+        const selector = frToAztecAddress(fromACVMField(acvmContractAddress));
        const enqueuedRequest = await this.enqueuePublicFunctionCall(
-          frToAztecAddress(fromACVMField(acvmContractAddress)),
+          selector,


This takes in the targetContractAddress, why is it called selector?

In executor this name is used again but with different fields

Think I copied it a round because the 32byte strings tilted me on some error codes. Will fix it.

Maddiaa0 · 2023-09-11T21:12:12Z

yarn-project/sequencer-client/src/publisher/viem-tx-sender.ts

      ] as const;

+      const codeSize = extendedContractData.bytecode.length;
+      const blobSize = 31 * 4096;


I think blobSize should be part of constants.ts

Maddiaa0 · 2023-09-11T21:23:20Z

yarn-project/sequencer-client/src/sequencer/sequencer.ts

+      const [block] = await this.blockBuilder.buildL2Block(globalVariables, allTxs, newL1ToL2Messages);
+      return block;
+    } catch (err) {
+      const hashes = txs.map(tx => tx.hash);


this is dropping all transactions, even if only one of them is offending?

Currently we were only building blocks of 1 tx for the e2e, so should not be an issue. But I'm looking at it now because It gave other issues for the race in p2p test.
Figured that the emission of same nullifier was not caught before the block building by the sequencer so it was unclear exactly what was offending, but adding a check earlier on.

Maddiaa0 · 2023-09-11T21:24:01Z

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

+        storage.public_balances.at(owner.address).read()
+    }
+
+    // Below this point is the stuff of nightmares.


haha do we want this comment in our token contract?

I have done worse 🤷 We need to fix the issue down there as well though.

Yeah, let's reword this comment to explain some tangible TODOs.

Maddiaa0 · 2023-09-11T21:26:28Z

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

+    }
+
+    #[aztec(public)]
+    fn mint_pub(


Lets use non abbreviated terms in the method names

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

Maddiaa0

Some minor things id like changed, also seem to have spotted some aztec noir bugs :(

Maddiaa0

Gave it a second pass, sorry ive a bit more

yarn-project/sequencer-client/src/sequencer/sequencer.ts

yarn-project/end-to-end/src/e2e_lending_contract.test.ts

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

yarn-project/noir-contracts/src/contracts/schnorr_auth_witness_account_contract/src/main.nr

Maddiaa0

lully stuff my man

… lh/token-standard

This reverts commit e225689.

iAmMichaelConnor

I've added some belated comments to the token contract :)

iAmMichaelConnor · 2023-09-14T06:01:44Z

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

+        from: AztecAddress,
+        to: AztecAddress,
+        amount: Field,
+        nonce: Field,


I know this has been merged, but I'll add some Q's / comments, now I've found time to take a look :)
What's the nonce for? Could it be given a more descriptive name?

The nonce is used in the message to make it possible to emit the message as nullifier to avoid replays without wreaking same action later.

message_nonce, perhaps?
authwit_nonce?
auth_message_nonce?

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

iAmMichaelConnor · 2023-09-14T06:16:03Z

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

+        }
+
+        let amount = SafeU120::new(amount);
+        let from_balance = SafeU120::new(storage.public_balances.at(from.address).read()).sub(amount);


Could maybe do let mut public_balances = storage.public_balances; at the beginning of the function, to reduce storage.__ later.

Meh. I kinda like it being very explicit that it is storage.

iAmMichaelConnor · 2023-09-14T06:16:45Z

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

+
+        if (from.address != context.msg_sender()) {
+            let selector = compute_selector("burn_public((Field),Field,Field)");
+            let message_field = compute_message_hash([context.msg_sender(), context.this_address(), selector, from.address, amount, nonce]);


I'd maybe call it message_hash given the name of the function is compute_message_hash.

iAmMichaelConnor · 2023-09-14T08:06:51Z

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

+    fn transfer(
+        from: AztecAddress,
+        to: AztecAddress,
+        amount: Field,


Should the amounts in all functions eventually be a safer type than Field, i.e. some kind of uint (once Noir is changed to prevent under/overflows?)

Eventually. But for now that is not safe.

iAmMichaelConnor · 2023-09-14T08:12:04Z

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

+    // Below this point is the stuff of nightmares.
+    // This should ideally not be required. What do we do if vastly different types of preimages?


Since we'll likely need to define many 'sizes' of compute_note_hash_and_nullifier, there should be a way for the note processor to distinguish between different note types. The ciphertexts probably need to contain some identifier for the note type.

This should ideally not be required

I'm not sure I agree with this. Having the Noir Contract express how the private state database should be populated (as is done here) gives lots of control to developers. It took a lot of discussions to get to this pattern :')

iAmMichaelConnor · 2023-09-14T08:13:52Z

yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr

+        storage.public_balances.at(owner.address).read()
+    }
+
+    // Below this point is the stuff of nightmares.


Yeah, let's reword this comment to explain some tangible TODOs.

iAmMichaelConnor · 2023-09-14T08:15:01Z

yarn-project/noir-contracts/src/contracts/token_contract/src/types.nr

+struct AztecAddress {
+  address: Field
+}
+
+impl AztecAddress {
+  fn new(address: Field) -> Self {
+    Self {
+      address
+    }
+  }
+
+  fn serialize(self: Self) -> [Field; 1] {
+    [self.address]
+  }
+
+  fn deserialize(fields: [Field; 1]) -> Self {
+    Self {
+      address: fields[0]
+    }
+  }
+}
+
+struct EthereumAddress {
+  address: Field
+}
+
+impl EthereumAddress {
+  fn new(address: Field) -> Self {
+    Self {
+      address
+    }
+  }


AztecAddress and EthereumAddress should be added to aztec-nr/ instead, since they're widely applicable types.

#2293 (comment)

iAmMichaelConnor · 2023-09-14T08:16:12Z

yarn-project/noir-contracts/src/contracts/token_contract/src/types.nr

+        pedersen_with_separator([secret], GENERATOR_INDEX__L1_TO_L2_MESSAGE_SECRET)[0]
+    }
+
+    fn knows_secret(self, secret: Field) {


Maybe add a comment to say that this is a custom method that's not enforced by the NoteInterface

🤖 I have created a release *beep* *boop* --- <details><summary>aztec-packages: 0.7.1</summary> ## [0.7.1](aztec-packages-v0.7.0...aztec-packages-v0.7.1) (2023-09-14) ### Features * Build system handles dynamic deps first class. ([#2283](#2283)) ([f66077a](f66077a)) * Build_manifest default tweaks. ([#2287](#2287)) ([c8a5cfb](c8a5cfb)) * **build:** Build multi-architecture docker images for aztec-sandbox ([#2305](#2305)) ([8ee61b8](8ee61b8)) * Cli "unbox" command ([#2029](#2029)) ([26ab88f](26ab88f)) * Creating an SMT verification module ([#1932](#1932)) ([4642b61](4642b61)) * Token standard ([#2069](#2069)) ([5e8fbf2](5e8fbf2)) ### Bug Fixes * Ensure_note_hash_exists ([#2256](#2256)) ([271b060](271b060)) * Msgpack stack blowups on schema gen ([#2259](#2259)) ([1afc566](1afc566)) * Noir bootstrap ([#2274](#2274)) ([f85db49](f85db49)) * Workaround sequencer timeout ([#2269](#2269)) ([9fc3f3d](9fc3f3d)) ### Miscellaneous * Bump nargo to 0.11.1-aztec.0 ([#2298](#2298)) ([8b76a12](8b76a12)) * **ci:** Mirror Aztec-nr ([#2270](#2270)) ([c57f027](c57f027)) * **circuits:** Base rollup cbind msgpack ([#2263](#2263)) ([0d4c707](0d4c707)) * **circuits:** Clean up of some superfluous header includes ([#2302](#2302)) ([5e53345](5e53345)) * **circuits:** Removing assertMemberLength on Tuple objects ([#2296](#2296)) ([0247b85](0247b85)) * Consolidate mirror repos on a nightly schedule ([#1994](#1994)) ([1a586c4](1a586c4)) * **docs:** Rename to aztec.nr ([#1943](#1943)) ([a91db48](a91db48)) * Move barretenberg to top of repo. Make circuits build off barretenberg build. ([#2221](#2221)) ([404ec34](404ec34)) * Replace native token in lending contract ([#2276](#2276)) ([c46b3c8](c46b3c8)) * **subrepo:** Push aztec-nr, update default branches ([#2300](#2300)) ([80c9b77](80c9b77)) * Updated `acvm_js` ([#2272](#2272)) ([9f1a3a5](9f1a3a5)) </details> <details><summary>barretenberg.js: 0.7.1</summary> ## [0.7.1](barretenberg.js-v0.7.0...barretenberg.js-v0.7.1) (2023-09-14) ### Miscellaneous * Move barretenberg to top of repo. Make circuits build off barretenberg build. ([#2221](#2221)) ([404ec34](404ec34)) </details> <details><summary>barretenberg: 0.7.1</summary> ## [0.7.1](barretenberg-v0.7.0...barretenberg-v0.7.1) (2023-09-14) ### Miscellaneous * Move barretenberg to top of repo. Make circuits build off barretenberg build. ([#2221](#2221)) ([404ec34](404ec34)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

LHerskind added the S-blocked Status: Blocked label Sep 7, 2023

LHerskind force-pushed the lh/token-standard branch 2 times, most recently from 9c06dd5 to de9ec7f Compare September 8, 2023 08:56

spalladino reviewed Sep 8, 2023

View reviewed changes

LHerskind mentioned this pull request Sep 11, 2023

Write token portal for Standard token. #2170

Closed

LHerskind force-pushed the lh/token-standard branch from bb0e5ed to d048423 Compare September 11, 2023 10:57

LHerskind removed the S-blocked Status: Blocked label Sep 11, 2023

rahul-kothari reviewed Sep 11, 2023

View reviewed changes

LHerskind mentioned this pull request Sep 11, 2023

Token standard replace valuenotes #2198

Closed

LHerskind force-pushed the lh/token-standard branch from 71c9e85 to 83257f1 Compare September 11, 2023 15:49

LHerskind marked this pull request as ready for review September 11, 2023 15:50

LHerskind requested review from Maddiaa0 and rahul-kothari September 11, 2023 15:51

rahul-kothari approved these changes Sep 11, 2023

View reviewed changes

Maddiaa0 requested changes Sep 11, 2023

View reviewed changes

Maddiaa0 reviewed Sep 11, 2023

View reviewed changes

LHerskind force-pushed the lh/token-standard branch from e0c414a to 268494c Compare September 12, 2023 12:49

Maddiaa0 reviewed Sep 12, 2023

View reviewed changes

Maddiaa0 mentioned this pull request Sep 12, 2023

bug(AztecMacro): Should fail if a return value is defined but not given #2247

Closed

LHerskind force-pushed the lh/token-standard branch from 4cba4e4 to b2c8bef Compare September 12, 2023 16:03

LHerskind added 8 commits September 12, 2023 18:52

feat: add auth entrypoint collection

91a5516

feat: initial token standard ideas

16637ed

fix: minor fix on contract

3ee72ab

fix: work around no public functions from constructor

582cfd1

test: add tests and minor fixes

de7f1d9

feat: add designated caller

642308e

chore: add to ci

9e7bdd7

chore: rebase + rebuild noir

b05032f

LHerskind added 15 commits September 12, 2023 18:52

feat: add nonces

3b7d28a

refactor: Extend simulator to make checks concise

d36a526

chore: rebase goodies

90a1823

fix: Update code size log on deployment

2811d45

refactor: shared context and check response in account_interface

2d52f0f

refactor: account contract cleanup for less code duplication

889669d

feat: add burn function + tests

6bd380b

feat: Include contract address in message hash

64f7e1f

chore: rebase

37ac39a

chore: update cli_docs list

4221061

fix: catch public nullifier double-spends early in sequencer

d0a97a7

chore: address comments

5dafcab

chore: fixing some rebase issues

e368494

chore: address api changes

3a70678

chore: fix maddia comments

256d284

LHerskind force-pushed the lh/token-standard branch from b2c8bef to 256d284 Compare September 12, 2023 17:53

fix: remove builder stages from ypb

e225689

Maddiaa0 approved these changes Sep 13, 2023

View reviewed changes

Maddiaa0 added 3 commits September 13, 2023 10:53

chore: bump contracts

c337f89

Merge branch 'master' into lh/token-standard

0249c80

Merge branch 'master' of github.com:AztecProtocol/aztec-packages into…

d5c8fd0

… lh/token-standard

Maddiaa0 enabled auto-merge (squash) September 13, 2023 10:55

Maddiaa0 added 2 commits September 13, 2023 12:17

Revert "fix: remove builder stages from ypb"

40dda48

This reverts commit e225689.

fix: add token contract to workspace

fe1e059

Maddiaa0 merged commit 5e8fbf2 into master Sep 13, 2023

Maddiaa0 deleted the lh/token-standard branch September 13, 2023 12:57

AztecBot mentioned this pull request Sep 13, 2023

chore(master): Release 0.7.1 #2268

Merged

iAmMichaelConnor reviewed Sep 14, 2023

View reviewed changes

LHerskind mentioned this pull request Sep 18, 2023

Unprovable transactions not dropped #2112

Closed

		let storage = Storage::init(Option::none(), Option::some(&mut context));
		let value = storage.approved_action.at(message_hash).read();

		// Below this point is the stuff of nightmares.
		// This should ideally not be required. What do we do if vastly different types of preimages?

Conversation

LHerskind commented Sep 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist:

Uh oh!

iAmMichaelConnor commented Sep 7, 2023

Uh oh!

spalladino left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rahul-kothari left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rahul-kothari Sep 11, 2023 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rahul-kothari left a comment

Choose a reason for hiding this comment

Uh oh!

Maddiaa0 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

LHerskind commented Sep 6, 2023 •

edited

Loading

rahul-kothari Sep 11, 2023 •

edited

Loading