Skip to content

Ilariae/clean ntt #466

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 6 commits into
base: main
Choose a base branch
from
Open

Ilariae/clean ntt #466

wants to merge 6 commits into from

Conversation

ilariae
Copy link
Collaborator

@ilariae ilariae commented Jun 12, 2025

Description

Clean up ntt evm deployment guide

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

@ilariae ilariae added the A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.) label Jun 12, 2025
@ilariae ilariae requested review from 0xlukem and Telucero as code owners June 12, 2025 13:35
@ilariae ilariae added the B0 - Needs Review Pull request is ready for review label Jun 12, 2025
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.

I think this page needs to be more closely aligned to the Solana page

ilariae and others added 3 commits June 17, 2025 16:39
Copy link
Collaborator

@dawnkelly09 dawnkelly09 left a comment

Choose a reason for hiding this comment

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

I think Erin was going to suggest some changes but, this is what stuck out to me


--8<-- 'text/products/native-token-transfers/guides/install-ntt-project.md'


Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm noticing the Solana deployment guide has an "Overview of the Deployment Process" included and this one does not. I know we have Deployment Process steps in the NTT/Overview so I'm not saying they should also go here, just that this is one of the things that should be decided on and be consistent between the two deployment guides.

@@ -132,7 +174,7 @@ The final step in the deployment process is to set the NTT Manager as a minter o

- If you followed the [`INttToken`](https://github.com/wormhole-foundation/native-token-transfers/blob/main/evm/src/interfaces/INttToken.sol){target=\_blank} interface, you can execute the `setMinter(address newMinter)` function
```json
cast send $TOKEN_ADDRESS "setMinter(address)" $NTT_MANAGER_ADDRESS --private-key $ETH_PRIVATE_KEY --rpc-url $YOUR_RPC_URL
cast send $TOKEN_ADDRESS "setMinter(address)" $NTT_MANAGER_ADDRESS --keystore /path/to/keystore.json --password <(echo "YOUR_PASSWORD") --rpc-url $YOUR_RPC_URL
Copy link
Collaborator

Choose a reason for hiding this comment

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

I can't get to it down below here but, that "!!! important" should be updated to be a Next Steps section instead

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.

I think there's still room for improvement in aligning this with the Solana guide. Let's take a look at the Solana structure:

# Deploy Native Token Transfers on Solana
## Prerequisites
## Overview of the Deployment Process
## Set Up NTT
### Generate an NTT Program Key Pair
### Set Mint Authority
## Deploy and Configure NTT
### Recovering Rent for Failed Solana Deployments
## Where to Go Next

Versus this one:

# Deploy Native Token Transfers (NTT) to EVM Chains 
## Prerequisites
## Deploy Your Token and Ensure Compatibility
### Requirements for Token Deployment
## NTT Manager Deployment Parameters
## Deploy NTT
## Configure NTT
## Set Token Minter to NTT Manager

Some of the differences I see:

  • Slightly different H1s
  • Prerequisites in EVM guide includes two items which are both covered later in the guide, so wdyt about having these as prereqs even though we include instructions on how to do these things in the guide?
  • No Deployment Overview in EVM guide. This could actually be where some of the token requirements and deployment instructions can go (similar to how we have Create and Mint SPL Tokens in Solana guide)
  • No Set Up NTT section in EVM guide. We can add install instructions there instead
  • Solana combines Deploy and Configure NTT. Not sure what the best approach is, but don't be afraid to change the Solana guide as needed if you think they should be separate
  • Set Token Minter to NTT Manager versus Set Mint Authority titles
  • No Where to Go Next section in EVM guide

In terms of the actual content, the Solana guide was updated to be action-oriented with steps for the user to follow. I'd like to see a similar thing with the EVM guide. For example, check out the differences in the Deploy, Configure, and setting authority sections in the two guides.

Also made some improvements to keep things direct and concise. So let's double-check to see if there's anything we need to do on that front with the EVM guide.

@eshaben eshaben self-assigned this Jun 19, 2025
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.) B0 - Needs Review Pull request is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants