fix(docs): Update the token bridge tutorial #11578

critesjosh · 2025-01-28T22:04:29Z

This PR updates the token bridge tutorial pages in the docs, and adds an e2e test to ensure that referenced code is always working.

closes #10638

…tocol/aztec-packages into jc/docs-bridge-tutorial

AztecBot · 2025-01-29T18:37:33Z

Docs Preview

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

docs/docs/tutorials/codealong/contract_tutorials/token_bridge.md

catmcgee · 2025-02-04T15:30:50Z

im a bit confused about how to follow this tutorial. the contracts part reads as more of a reference like the uniswap one. would it be better to go step-by-step?

critesjosh · 2025-02-04T17:58:17Z

The top section is more of an overview of the components involved in the token bridge. I didn't write it with the intention that developers would reproduce all of these components locally as they follow along. So the first half of the page is more of an explainer and the second half of the page (starting with "Running with Aztec.js") is really where the tutorial starts. The tutorial is just about interacting with all of the components in TS.

Do you think this a bad idea for the page structure? Or is it okay and should I just make it more clear at the beginning how the page is structured?

catmcgee · 2025-02-05T17:01:36Z

@critesjosh I think that's good but yeah I'd say it needs to be more clear where the dev would start following along. maybe it makes more sense in the dapp tutorial section rather than contracts?

critesjosh · 2025-02-05T17:39:40Z

@critesjosh I think that's good but yeah I'd say it needs to be more clear where the dev would start following along. maybe it makes more sense in the dapp tutorial section rather than contracts?

Ok I added detail to make it more clear when to follow along. I'm not sure that it makes sense to put in dapp tutorial section since its not really a dapp, its just a script that uses all of these contracts. The script is useful in that it helps developers better understand the flow of data between the contracts I think

catmcgee

just some initial comments about structure

docs/docs/developers/tutorials/codealong/contract_tutorials/token_bridge.md

catmcgee · 2025-02-06T15:27:08Z

docs/docs/developers/tutorials/codealong/contract_tutorials/token_bridge.md

+mkdir token-bridge-tutorial
+cd token-bridge-tutorial
+yarn init -y
+yarn add @aztec/aztec.js @aztec/noir-contracts.js @aztec/l1-artifacts @aztec/accounts @aztec/ethereum @aztec/types @types/node typescript@^5.0.4 viem@^2.22.8 tsx


in new aztec sandbox i also had to add tslib and lodash.omit

Suggested change

yarn add @aztec/aztec.js @aztec/noir-contracts.js @aztec/l1-artifacts @aztec/accounts @aztec/ethereum @aztec/types @types/node typescript@^5.0.4 viem@^2.22.8 tsx

yarn add @aztec/aztec.js @aztec/noir-contracts.js @aztec/l1-artifacts @aztec/accounts @aztec/ethereum @aztec/types @types/node typescript@^5.0.4 viem@^2.22.8 tsx tslib lodash.omit

everything works besides this :)

Can you share the error you see without these installed? I just ran through this again and it works for me without these additional packages. Maybe its a mac vs linux thing?

@signorecello was hitting some errors as well, installing node versino 18.19 made it work. I will update the file to specify the node version

this is the version i am using too. the lodash error was Error: @aztec/circuit-types tried to access lodash.omit, but it isn't declared in its dependencies; this makes the require call ambiguous and unsound. and tslib was the usual cannot find

I found the problem. Can you try creating .yarnrc.yml and specify the node linker?

echo "nodeLinker: node-modules" > .yarnrc.yml

catmcgee

approving. but would be good if we can get @jzaki or @saleel to go through and see if they hit errors as @signorecello & i got different ones

jzaki

A few minor comments

docs/docs/developers/tutorials/codealong/contract_tutorials/token_bridge.md

jzaki · 2025-02-11T16:33:13Z

docs/docs/developers/tutorials/codealong/contract_tutorials/token_bridge.md

+
+The Aztec message Inbox expects a recipient Aztec address that can consume the message (the corresponding L2 bridge contract), the Aztec version (similar to Ethereum's `chainId`), the message content hash (which includes the token recipient and amount in this case), and a `secretHash`, where the corresponding `secret` is used to consume the message on the receiving contract.
+
+So in summary, it deposits tokens to the portal, encodes a mint message, hashes it, and sends it to the Aztec rollup via the Inbox. The L2 token contract can then mint the tokens when it processes the message.


This section might benefit from a couple of simple overview diagrams, to frame everything

this took me 3 mins to make with claude.ai. good idea

docs/docs/developers/tutorials/codealong/contract_tutorials/token_bridge.md

signorecello · 2025-02-12T08:59:05Z

approving. but would be good if we can get @jzaki or @saleel to go through and see if they hit errors as @signorecello & i got different ones

the issue was node versions, it worked with 18.10 which although (very) old is the default one for the monorepo

🤖 I have created a release *beep* *boop* --- <details><summary>aztec-package: 0.76.3</summary> ## [0.76.3](aztec-package-v0.76.2...aztec-package-v0.76.3) (2025-02-12) ### Features * Add undici ([#11818](#11818)) ([8503c7a](8503c7a)) * Initial multi-proof test ([#11779](#11779)) ([f54db75](f54db75)) </details> <details><summary>barretenberg.js: 0.76.3</summary> ## [0.76.3](barretenberg.js-v0.76.2...barretenberg.js-v0.76.3) (2025-02-12) ### Features * **perf:** Speed up construction of bbjs Frs & cache zero hashes in ephemeral trees (redo) ([#11894](#11894)) ([e093acf](e093acf)) ### Bug Fixes * Memory fragmentation fixes to cut UltraHonk memory usage by 26% ([#11895](#11895)) ([b4e2264](b4e2264)) </details> <details><summary>aztec-packages: 0.76.3</summary> ## [0.76.3](aztec-packages-v0.76.2...aztec-packages-v0.76.3) (2025-02-12) ### Features * Add undici ([#11818](#11818)) ([8503c7a](8503c7a)) * **avm:** Sequential lookup resolution ([#11769](#11769)) ([3980f6c](3980f6c)) * Enable ws for reth on devnet ([#11922](#11922)) ([7124664](7124664)), closes [#11921](#11921) * Initial multi-proof test ([#11779](#11779)) ([f54db75](f54db75)) * Native world state now supports checkpointing ([#11739](#11739)) ([6464059](6464059)) * **perf:** Speed up construction of bbjs Frs & cache zero hashes in ephemeral trees (redo) ([#11894](#11894)) ([e093acf](e093acf)) ### Bug Fixes * Correctly configure batch queue ([#11934](#11934)) ([4908df8](4908df8)) * De-dup pubkey conversion of cli-wallet param ([#11948](#11948)) ([5529871](5529871)) * **docs:** Update the token bridge tutorial ([#11578](#11578)) ([aaf42a7](aaf42a7)) * Don't restart kind control plane automatically ([#11923](#11923)) ([c23c0f9](c23c0f9)) * Empty blocks can now be unwound ([#11920](#11920)) ([fdc2042](fdc2042)) * Gcloud logs ([#11944](#11944)) ([c53b1c5](c53b1c5)), closes [#11887](#11887) * Lmdb cmake race condition ([#11959](#11959)) ([031200d](031200d)) * Memory fragmentation fixes to cut UltraHonk memory usage by 26% ([#11895](#11895)) ([b4e2264](b4e2264)) * Npm packages noir resolution ([#11946](#11946)) ([d3e3f20](d3e3f20)) * Set resource limits on Loki pods ([#11940](#11940)) ([6999982](6999982)) ### Miscellaneous * Only take FF (and not Flavor) in compute_logderivative_inverse ([#11938](#11938)) ([bbbded3](bbbded3)) * Op queue cleanup ([#11925](#11925)) ([082ed66](082ed66)) * Renaming `pxe_db.nr` as `capsules.nr` ([#11905](#11905)) ([14d873c](14d873c)) * Replace relative paths to noir-protocol-circuits ([9ce401a](9ce401a)) * Use realistic size Client IVC proofs during simulations ([#11692](#11692)) ([90b9fbf](90b9fbf)) * Use RelationChecker in relation correctness tests and add Translator interleaving test ([#11878](#11878)) ([ed215e8](ed215e8)) </details> <details><summary>barretenberg: 0.76.3</summary> ## [0.76.3](barretenberg-v0.76.2...barretenberg-v0.76.3) (2025-02-12) ### Features * **avm:** Sequential lookup resolution ([#11769](#11769)) ([3980f6c](3980f6c)) * Native world state now supports checkpointing ([#11739](#11739)) ([6464059](6464059)) ### Bug Fixes * Empty blocks can now be unwound ([#11920](#11920)) ([fdc2042](fdc2042)) * Lmdb cmake race condition ([#11959](#11959)) ([031200d](031200d)) * Memory fragmentation fixes to cut UltraHonk memory usage by 26% ([#11895](#11895)) ([b4e2264](b4e2264)) ### Miscellaneous * Only take FF (and not Flavor) in compute_logderivative_inverse ([#11938](#11938)) ([bbbded3](bbbded3)) * Op queue cleanup ([#11925](#11925)) ([082ed66](082ed66)) * Use RelationChecker in relation correctness tests and add Translator interleaving test ([#11878](#11878)) ([ed215e8](ed215e8)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

🤖 I have created a release *beep* *boop* --- <details><summary>aztec-package: 0.76.3</summary> ## [0.76.3](AztecProtocol/aztec-packages@aztec-package-v0.76.2...aztec-package-v0.76.3) (2025-02-12) ### Features * Add undici ([#11818](AztecProtocol/aztec-packages#11818)) ([8503c7a](AztecProtocol/aztec-packages@8503c7a)) * Initial multi-proof test ([#11779](AztecProtocol/aztec-packages#11779)) ([f54db75](AztecProtocol/aztec-packages@f54db75)) </details> <details><summary>barretenberg.js: 0.76.3</summary> ## [0.76.3](AztecProtocol/aztec-packages@barretenberg.js-v0.76.2...barretenberg.js-v0.76.3) (2025-02-12) ### Features * **perf:** Speed up construction of bbjs Frs & cache zero hashes in ephemeral trees (redo) ([#11894](AztecProtocol/aztec-packages#11894)) ([e093acf](AztecProtocol/aztec-packages@e093acf)) ### Bug Fixes * Memory fragmentation fixes to cut UltraHonk memory usage by 26% ([#11895](AztecProtocol/aztec-packages#11895)) ([b4e2264](AztecProtocol/aztec-packages@b4e2264)) </details> <details><summary>aztec-packages: 0.76.3</summary> ## [0.76.3](AztecProtocol/aztec-packages@aztec-packages-v0.76.2...aztec-packages-v0.76.3) (2025-02-12) ### Features * Add undici ([#11818](AztecProtocol/aztec-packages#11818)) ([8503c7a](AztecProtocol/aztec-packages@8503c7a)) * **avm:** Sequential lookup resolution ([#11769](AztecProtocol/aztec-packages#11769)) ([3980f6c](AztecProtocol/aztec-packages@3980f6c)) * Enable ws for reth on devnet ([#11922](AztecProtocol/aztec-packages#11922)) ([7124664](AztecProtocol/aztec-packages@7124664)), closes [#11921](AztecProtocol/aztec-packages#11921) * Initial multi-proof test ([#11779](AztecProtocol/aztec-packages#11779)) ([f54db75](AztecProtocol/aztec-packages@f54db75)) * Native world state now supports checkpointing ([#11739](AztecProtocol/aztec-packages#11739)) ([6464059](AztecProtocol/aztec-packages@6464059)) * **perf:** Speed up construction of bbjs Frs & cache zero hashes in ephemeral trees (redo) ([#11894](AztecProtocol/aztec-packages#11894)) ([e093acf](AztecProtocol/aztec-packages@e093acf)) ### Bug Fixes * Correctly configure batch queue ([#11934](AztecProtocol/aztec-packages#11934)) ([4908df8](AztecProtocol/aztec-packages@4908df8)) * De-dup pubkey conversion of cli-wallet param ([#11948](AztecProtocol/aztec-packages#11948)) ([5529871](AztecProtocol/aztec-packages@5529871)) * **docs:** Update the token bridge tutorial ([#11578](AztecProtocol/aztec-packages#11578)) ([aaf42a7](AztecProtocol/aztec-packages@aaf42a7)) * Don't restart kind control plane automatically ([#11923](AztecProtocol/aztec-packages#11923)) ([c23c0f9](AztecProtocol/aztec-packages@c23c0f9)) * Empty blocks can now be unwound ([#11920](AztecProtocol/aztec-packages#11920)) ([fdc2042](AztecProtocol/aztec-packages@fdc2042)) * Gcloud logs ([#11944](AztecProtocol/aztec-packages#11944)) ([c53b1c5](AztecProtocol/aztec-packages@c53b1c5)), closes [#11887](AztecProtocol/aztec-packages#11887) * Lmdb cmake race condition ([#11959](AztecProtocol/aztec-packages#11959)) ([031200d](AztecProtocol/aztec-packages@031200d)) * Memory fragmentation fixes to cut UltraHonk memory usage by 26% ([#11895](AztecProtocol/aztec-packages#11895)) ([b4e2264](AztecProtocol/aztec-packages@b4e2264)) * Npm packages noir resolution ([#11946](AztecProtocol/aztec-packages#11946)) ([d3e3f20](AztecProtocol/aztec-packages@d3e3f20)) * Set resource limits on Loki pods ([#11940](AztecProtocol/aztec-packages#11940)) ([6999982](AztecProtocol/aztec-packages@6999982)) ### Miscellaneous * Only take FF (and not Flavor) in compute_logderivative_inverse ([#11938](AztecProtocol/aztec-packages#11938)) ([bbbded3](AztecProtocol/aztec-packages@bbbded3)) * Op queue cleanup ([#11925](AztecProtocol/aztec-packages#11925)) ([082ed66](AztecProtocol/aztec-packages@082ed66)) * Renaming `pxe_db.nr` as `capsules.nr` ([#11905](AztecProtocol/aztec-packages#11905)) ([14d873c](AztecProtocol/aztec-packages@14d873c)) * Replace relative paths to noir-protocol-circuits ([9ce401a](AztecProtocol/aztec-packages@9ce401a)) * Use realistic size Client IVC proofs during simulations ([#11692](AztecProtocol/aztec-packages#11692)) ([90b9fbf](AztecProtocol/aztec-packages@90b9fbf)) * Use RelationChecker in relation correctness tests and add Translator interleaving test ([#11878](AztecProtocol/aztec-packages#11878)) ([ed215e8](AztecProtocol/aztec-packages@ed215e8)) </details> <details><summary>barretenberg: 0.76.3</summary> ## [0.76.3](AztecProtocol/aztec-packages@barretenberg-v0.76.2...barretenberg-v0.76.3) (2025-02-12) ### Features * **avm:** Sequential lookup resolution ([#11769](AztecProtocol/aztec-packages#11769)) ([3980f6c](AztecProtocol/aztec-packages@3980f6c)) * Native world state now supports checkpointing ([#11739](AztecProtocol/aztec-packages#11739)) ([6464059](AztecProtocol/aztec-packages@6464059)) ### Bug Fixes * Empty blocks can now be unwound ([#11920](AztecProtocol/aztec-packages#11920)) ([fdc2042](AztecProtocol/aztec-packages@fdc2042)) * Lmdb cmake race condition ([#11959](AztecProtocol/aztec-packages#11959)) ([031200d](AztecProtocol/aztec-packages@031200d)) * Memory fragmentation fixes to cut UltraHonk memory usage by 26% ([#11895](AztecProtocol/aztec-packages#11895)) ([b4e2264](AztecProtocol/aztec-packages@b4e2264)) ### Miscellaneous * Only take FF (and not Flavor) in compute_logderivative_inverse ([#11938](AztecProtocol/aztec-packages#11938)) ([bbbded3](AztecProtocol/aztec-packages@bbbded3)) * Op queue cleanup ([#11925](AztecProtocol/aztec-packages#11925)) ([082ed66](AztecProtocol/aztec-packages@082ed66)) * Use RelationChecker in relation correctness tests and add Translator interleaving test ([#11878](AztecProtocol/aztec-packages#11878)) ([ed215e8](AztecProtocol/aztec-packages@ed215e8)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

critesjosh added 6 commits January 28, 2025 16:41

add test

3cc85fe

update

310b3eb

rm old

5d066b1

fix links

546d083

update comments

48536f1

write tutorial

8df63f6

critesjosh marked this pull request as ready for review January 29, 2025 18:12

critesjosh and others added 3 commits January 29, 2025 13:12

Merge branch 'master' into jc/docs-bridge-tutorial

903887a

clarify

7220398

Merge branch 'jc/docs-bridge-tutorial' of https://github.com/AztecPro…

a276228

…tocol/aztec-packages into jc/docs-bridge-tutorial

critesjosh requested review from catmcgee and signorecello January 29, 2025 18:19

critesjosh and others added 14 commits January 30, 2025 11:22

use compose for test

cb2e4c4

fix link to test file

84528d3

fmt

2353b49

run test w/ compose

402a54e

Merge branch 'master' into jc/docs-bridge-tutorial

37a88e4

fmt

cf5cc72

fix filename

c2f8201

add token bridge test to ci

61f46b1

Merge branch 'master' into jc/docs-bridge-tutorial

a4a7cf0

Merge branch 'master' into jc/docs-bridge-tutorial

e884962

passing

d7c93fa

try bump test timeout

9732e5f

Merge branch 'master' into jc/docs-bridge-tutorial

4890cbf

Merge branch 'master' into jc/docs-bridge-tutorial

d742f5a

catmcgee reviewed Feb 4, 2025

View reviewed changes

docs/docs/tutorials/codealong/contract_tutorials/token_bridge.md Show resolved Hide resolved

cats comments

74f107f

critesjosh and others added 4 commits February 5, 2025 17:42

Merge branch 'master' into jc/docs-bridge-tutorial

f8dba2a

Merge branch 'master' into jc/docs-bridge-tutorial

a3855c7

fix links

4ffb66d

Merge branch 'master' into jc/docs-bridge-tutorial

450ac31

critesjosh requested a review from catmcgee February 5, 2025 18:06

Merge branch 'master' into jc/docs-bridge-tutorial

80acf5c

catmcgee reviewed Feb 6, 2025

View reviewed changes

critesjosh and others added 4 commits February 7, 2025 10:47

add cat's suggestions

47036ce

update rootDir

da23343

simp tsconfig, specify node version

685c44f

Merge branch 'master' into jc/docs-bridge-tutorial

531540b

critesjosh requested a review from catmcgee February 7, 2025 17:13

critesjosh added 2 commits February 10, 2025 13:54

Merge branch 'master' into jc/docs-bridge-tutorial

41c5188

Merge branch 'master' into jc/docs-bridge-tutorial

eedceea

catmcgee approved these changes Feb 11, 2025

View reviewed changes

jzaki approved these changes Feb 11, 2025

View reviewed changes

james comments

8037bae

signorecello approved these changes Feb 12, 2025

View reviewed changes

Merge branch 'master' into jc/docs-bridge-tutorial

9ce59b4

critesjosh enabled auto-merge (squash) February 12, 2025 17:01

critesjosh merged commit aaf42a7 into master Feb 12, 2025
52 checks passed

critesjosh deleted the jc/docs-bridge-tutorial branch February 12, 2025 17:32

AztecBot mentioned this pull request Feb 12, 2025

chore(master): Release 0.76.3 #11924

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(docs): Update the token bridge tutorial #11578

fix(docs): Update the token bridge tutorial #11578

critesjosh commented Jan 28, 2025 •

edited

Loading

AztecBot commented Jan 29, 2025 •

edited

Loading

catmcgee commented Feb 4, 2025

critesjosh commented Feb 4, 2025

catmcgee commented Feb 5, 2025

critesjosh commented Feb 5, 2025

catmcgee left a comment

catmcgee Feb 6, 2025 •

edited

Loading

catmcgee Feb 6, 2025

critesjosh Feb 7, 2025

critesjosh Feb 7, 2025

catmcgee Feb 11, 2025

critesjosh Feb 11, 2025 •

edited

Loading

catmcgee Feb 12, 2025

catmcgee left a comment

jzaki left a comment

jzaki Feb 11, 2025

critesjosh Feb 11, 2025

critesjosh Feb 11, 2025

signorecello commented Feb 12, 2025

	yarn add @aztec/aztec.js @aztec/noir-contracts.js @aztec/l1-artifacts @aztec/accounts @aztec/ethereum @aztec/types @types/node typescript@^5.0.4 viem@^2.22.8 tsx
	yarn add @aztec/aztec.js @aztec/noir-contracts.js @aztec/l1-artifacts @aztec/accounts @aztec/ethereum @aztec/types @types/node typescript@^5.0.4 viem@^2.22.8 tsx tslib lodash.omit


		The Aztec message Inbox expects a recipient Aztec address that can consume the message (the corresponding L2 bridge contract), the Aztec version (similar to Ethereum's `chainId`), the message content hash (which includes the token recipient and amount in this case), and a `secretHash`, where the corresponding `secret` is used to consume the message on the receiving contract.

		So in summary, it deposits tokens to the portal, encodes a mint message, hashes it, and sends it to the Aztec rollup via the Inbox. The L2 token contract can then mint the tokens when it processes the message.

fix(docs): Update the token bridge tutorial #11578

fix(docs): Update the token bridge tutorial #11578

Conversation

critesjosh commented Jan 28, 2025 • edited Loading

AztecBot commented Jan 29, 2025 • edited Loading

Docs Preview

catmcgee commented Feb 4, 2025

critesjosh commented Feb 4, 2025

catmcgee commented Feb 5, 2025

critesjosh commented Feb 5, 2025

catmcgee left a comment

Choose a reason for hiding this comment

catmcgee Feb 6, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

critesjosh Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

catmcgee left a comment

Choose a reason for hiding this comment

jzaki left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

signorecello commented Feb 12, 2025

critesjosh commented Jan 28, 2025 •

edited

Loading

AztecBot commented Jan 29, 2025 •

edited

Loading

catmcgee Feb 6, 2025 •

edited

Loading

critesjosh Feb 11, 2025 •

edited

Loading