Skip to content

Token Bridge Feedback #448

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

Open
wants to merge 59 commits into
base: main
Choose a base branch
from
Open

Conversation

albertov19
Copy link
Collaborator

Description

Suggestions to the Token Bridge section

Checklist

  • Required - I have added a label to this PR 🏷️
  • Required - I have run my changes through Grammarly
  • If pages have been moved, I have created redirects in the wormhole-mkdocs repo

eshaben and others added 30 commits April 22, 2025 23:23
* initial draft for queries

* initial queries draft

* grammarly check

* update file name

* add metadata

* add full script

* short description to steps

* rename title

* update script

* update based on feedback

* create snippet for queries

* move code to snippet

* rename sections

* Update products/queries/get-started.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* update snippets path

* update title

* update intro

* link to queries package

* context of what Query Proxy is

* update style

* lowercase constants

* update expected output

* update links

* update titles

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* update page based on feedback

---------

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
* first draft of ntt setup

* update left hand menu order

* add file context

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* update based on feedback

* grammarly check

* update links

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>

* update metadata title

* update description metadata

* update metadata description

* update intro based on feedback

* remove update ntt cli section

* convert steps into ordered list

* update config file based on feedback

* update based on feedback

* update based on feedback

* Update products/native-token-transfers/get-started.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* update based on feedback

* add erc20 token deployment steps

---------

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
* adds draft markdown

* updates based on feedback, handles snippet and image

* grammarly pass

* updates after seeing Martin's awesome draft!

* updated to use Sui --> Fuji repo from WH

* format snippet with prettier, updates to content per review feedback
* wip messaging get started

* wip it, wip it good!

* updates guide to complete steps, add terminal elements, and image

* adds TODOs to update with final repo addy when avail

* updates per feedback review and some resolved TODO items

* updates to use --privatekey option for Foundry keystore

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Martin Hofmann <martin@papermoon.io>

* Update products/messaging/get-started.md

Co-authored-by: Martin Hofmann <martin@papermoon.io>

---------

Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Martin Hofmann <martin@papermoon.io>
* page structure

* page content

* content

* Queries overview content

* add get started to timeline

* Update products/queries/overview.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* Update products/queries/overview.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* ccq server mention

---------

Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
* Messaging verview

* use cases

* use cases

* use cases

* Update products/messaging/overview.md

Co-authored-by: Martin Hofmann <martin@papermoon.io>

* meta description

* Update products/messaging/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/messaging/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/messaging/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/messaging/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* feedback

* timelines

* typo fix

* Remove .DS_Store from tracking

* Update products/messaging/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* timeline

* Update products/messaging/overview.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* Update products/messaging/overview.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* Update products/messaging/overview.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* Update products/messaging/overview.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* Update products/messaging/overview.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* next steps

* turn timeline into list

* Update products/messaging/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

---------

Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
Co-authored-by: Martin Hofmann <martin@papermoon.io>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
* first draft multigov get started

* grammarly check

* add metadate description

* add tally links

* link to next sections

* update title and metadata

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* reorg

* rewording

* rewording

* multigov overview page

* multigov overview page

* multigov overview page

* multigov timeline

* small fix

* Update .snippets/text/products/multigov/multigov-timeline.json

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Apply feedback

* move diagram to architecture page

* update timeline

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

---------

Co-authored-by: martin0995 <martin@papermoon.io>
Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
* update sdk to the latest version (#374)

* Add gitignore step (#372)

* add instructions for including .gitignore when starting fresh projects

* update llms

---------

Co-authored-by: Martin Hofmann <martin@papermoon.io>

* update sdk to latest version (#386)

* multiple ntt cli feedback adjustments (#389)

* multiple ntt cli feedback adjustments

* generate llms

* Update build/transfers/native-token-transfers/deployment-process/deploy-to-solana.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update build/transfers/native-token-transfers/deployment-process/deploy-to-solana.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* re-generate llms files

---------

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Martinh/faq link in ntt (#384)

* add faws link to solana deployment page

* llms check

* update notes

* llm check

* Update build/transfers/native-token-transfers/deployment-process/deploy-to-solana.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* update based on feedback

* llm check

* action orientated link

* llm check

---------

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Martinh/settlement grammar fix (#391)

* fix(docs): fix grammar in unified liquidity paragraph (#390)

* grammarly check

* llm check

---------

Co-authored-by: Suhas A <113137561+suhasamaresh@users.noreply.github.com>

* remove Connect from product comparison table (#396)

* remove Connect from product comparison table

* llms check

---------

Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>

* Staked rpc comment & feature matrix adjustment (#402)

* staked rpc comment for ntt solana deploy

* adjust comment

* adjust feature support matrix for sui & aptos cctp

* re-generate llms files

---------

Co-authored-by: Martin Hofmann <martin@papermoon.io>
Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: evgeniko <97796468+evgeniko@users.noreply.github.com>
Co-authored-by: Suhas A <113137561+suhasamaresh@users.noreply.github.com>
Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
* first draft multigov get started

* grammarly check

* add metadate description

* add tally links

* link to next sections

* update title and metadata

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* reorg

* rewording

* rewording

* multigov overview page

* multigov overview page

* multigov overview page

* Update products/multigov/get-started.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* update metadata categories

* update intro and wording

* future proof update

* remove prerequisite

* update prerequisites

* multigov timeline

* remove step and update style

* small fix

* update supported chains

* update next steps

* add reference to token deployment

* add token specifications

* add link to overview

* Update .snippets/text/products/multigov/multigov-timeline.json

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Apply feedback

* move diagram to architecture page

* add deploymment flow

* unfinished timeline

* update timeline

* Update products/multigov/get-started.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/multigov/get-started.md

* updated timeline

* fix capitalization

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update .snippets/text/products/multigov/deployment-flow-timeline.json

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* update timeline

---------

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
* sdk first draft

* grammarly check

* adding description

* grammarly check

* update snippets

* update links

* update snippets

* updae introduction

* update title and metadata

* updates snippets to match new example

* prettier

* applies feedback per review. Next Steps is still TODO

* updates conclusion and next steps

* adds NTT Get Started to Next Steps

* mention advanced implementations in the introduction

* generalize for all types of users

* Apply suggestions from code review

Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>

* changed admonitions to "example" type r/t styling and look

---------

Co-authored-by: DAWN KELLY <dawnkelly09@gmail.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
* initial commit

* create intro

* add Prerequisites

* project setup steps

* update link

* script to perform transaction

* next steps section

* grammarly check

* add wormholescan link

* Update products/token-bridge/get-started.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* update wording

* update metadata description

* update introduction

* focus intro on token bridge

* update tone for guide

* turn sections into steps

* update link with todo

* reduce time to 5 minutes

* update next step description

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update .snippets/code/products/token-bridge/get-started/snippet-1.ts

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* add keystore management note

* add step for key management

* specify networks

* generalize prerequisites

* add details to step

* lower transfer amount

* generalize function

* adapt page to automatic transfers

* update private key

* update section introduction

* update step

* update step

* remove item based on feedback

* update env references

* Update products/token-bridge/get-started.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* update comment

* update intro

* add description to step

* Update .snippets/code/products/token-bridge/get-started/snippet-1.ts

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* update comments on snippets

* update link

* update metadata

* llm check

---------

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
* update diagrams

* rename images

* rename diagrams

---------

Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
* token bridge payloads

* add summary table

* grammarly check

* Update products/token-bridge/concepts/payload-structure.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/token-bridge/concepts/payload-structure.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* apply feedback

---------

Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
* update sdk to the latest version (#374)

* Add gitignore step (#372)

* add instructions for including .gitignore when starting fresh projects

* update llms

---------

Co-authored-by: Martin Hofmann <martin@papermoon.io>

* update sdk to latest version (#386)

* Added cctp-bridge overview.md (#393)

* added cctp-bridge overview.md

* Revisions/added timeline

* fixed list issues

* added links

* fixed wording for use cases

* Update products/cctp-bridge/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/cctp-bridge/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/cctp-bridge/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/cctp-bridge/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/cctp-bridge/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* revisions

* Apply suggestions from code review

Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>

---------

Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>

* revision

* Issue check

* Apply suggestions from code review

Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>

* revisions

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* revision/diagram

* remove file

* Update products/token-bridge/overview.md

* Update products/token-bridge/overview.md

* Update products/token-bridge/overview.md

* Update products/token-bridge/overview.md

* Update products/token-bridge/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/token-bridge/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/token-bridge/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/token-bridge/overview.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/token-bridge/overview.md

---------

Co-authored-by: Martin Hofmann <martin@papermoon.io>
Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: Taylor Lucero <telucero@gmail.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
* first commit

* created cctp get started page

* add metadata description

* add file name to snippets

* add next step

* add metadata description

* add usdc requirement

* Update products/cctp-bridge/get-started.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* Update products/cctp-bridge/get-started.md

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

* Update products/cctp-bridge/get-started.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/cctp-bridge/get-started.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Update products/cctp-bridge/get-started.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>

---------

Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
* Added connect overview page. (#394)

* added connect/overview.md

* revisions/added timeline

* remove checklist

* updated timeline path

* fix key features

* fix key features

* updated use cases

* icon fix

* timeline correction

* update use cases

* Update products/connect/overview.md

* Update products/connect/overview.md

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

---------

Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>

* revisions

* revisions

* revisions

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* some adjustments

---------

Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Ilaria Enache <ilaria@Mac.homenet.telecomitalia.it>
* added supported methods

* Grammarly fixes

* nitpicking

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

* revisions

* meta update

* Apply suggestions from code review

Co-authored-by: Erin Shaben <eshaben@icloud.com>

---------

Co-authored-by: Erin Shaben <eshaben@icloud.com>
* add token bridge architecture overview

* add flow of a transfer page

* llms

* update example and wording of native assets

* clean up diagrams

* Update products/token-bridge/concepts/transfer-flow.md

Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>

---------

Co-authored-by: Ilaria <43253244+ilariae@users.noreply.github.com>
@albertov19 albertov19 added the A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.) label Jun 4, 2025
@albertov19 albertov19 changed the base branch from main to staging-new-ia June 4, 2025 14:22
@albertov19 albertov19 requested a review from Copilot June 4, 2025 14:22
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR provides feedback and updates to the Token Bridge documentation and code examples, with a focus on clarifying secure key management practices and improving guide instructions for token transfers and attestations.

  • Revised tutorial text for a more precise description of multichain transfers
  • Updated guides for transferring tokens (with and without payload) and token attestation
  • Modified code snippet in the getSigner helper to illustrate secure key loading practices

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
products/token-bridge/tutorials/transfer-workflow.md Updated guide text to enhance clarity on wallet access and secure key management.
products/token-bridge/tutorials/multichain-token.md Revised token registration steps with minor spelling corrections needed.
products/token-bridge/tutorials/.pages Updated navigation to include the new SDK-based token transfer page.
products/token-bridge/overview.md Refined overview steps with clearer language regarding token attestation and locking.
products/token-bridge/guides/transfer-tokens.md Added comprehensive guide for transferring tokens via the Token Bridge contract.
products/token-bridge/guides/transfer-tokens-payload.md Introduced guide for transferring tokens with payload, covering additional chain interactions.
products/token-bridge/guides/attest-tokens.md Added guide for attesting tokens, detailing the cross-chain registration process.
products/token-bridge/guides/.pages Updated guide navigation to reflect newly added token transfer and attestation pages.
.snippets/code/products/token-bridge/tutorials/transfer-workflow/token-bridge-1.ts Revised code examples for getSigner to demonstrate secure key retrieval practices.
Comments suppressed due to low confidence (2)

products/token-bridge/tutorials/multichain-token.md:52

  • Typo detected: 'cahins' should be corrected to 'chains'.
In the [Portal Bridge](https://portalbridge.com/advanced-tools/#/register){target=_blank} token registration tool, with the token already registered in both source and target cahins, take the following steps:

products/token-bridge/tutorials/multichain-token.md:67

  • Typo detected: 'cahins' should be corrected to 'chains'.
In the [Portal Bridge](https://portalbridge.com/advanced-tools/#/register){target=_blank} token registration tool, with the token already registered in both source and target cahins, and the attestation sent, take the following steps:

Copy link
Collaborator

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Sweeet. Thanks for slicing and dicing this and cleaning it up!

@dawnkelly09 dawnkelly09 self-assigned this Jun 5, 2025
@kapetan3sid kapetan3sid requested review from ilariae and removed request for dawnkelly09 June 9, 2025 10:38
Base automatically changed from staging-new-ia to main June 10, 2025 16:01
@dawnkelly09 dawnkelly09 marked this pull request as draft June 17, 2025 15:13
martin0995 and others added 9 commits June 18, 2025 12:03
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
@martin0995 martin0995 marked this pull request as ready for review June 18, 2025 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants