From 2e51c7af57115a54d31d4bb40f6efff037598473 Mon Sep 17 00:00:00 2001 From: Ilaria Enache Date: Thu, 12 Jun 2025 15:09:22 +0200 Subject: [PATCH 1/6] add prerequisites --- .../guides/install-ntt-project.md | 4 -- .../guides/deploy-to-evm.md | 44 ++++++++++++++++--- 2 files changed, 38 insertions(+), 10 deletions(-) diff --git a/.snippets/text/products/native-token-transfers/guides/install-ntt-project.md b/.snippets/text/products/native-token-transfers/guides/install-ntt-project.md index b048f4504..8fcddf1df 100644 --- a/.snippets/text/products/native-token-transfers/guides/install-ntt-project.md +++ b/.snippets/text/products/native-token-transfers/guides/install-ntt-project.md @@ -1,7 +1,3 @@ -Before proceeding, make sure you have the NTT CLI installed and a project initialized. - -Follow these steps (or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}): - 1. Install the NTT CLI: ```bash diff --git a/products/native-token-transfers/guides/deploy-to-evm.md b/products/native-token-transfers/guides/deploy-to-evm.md index b1527c0b6..4503ecc7d 100644 --- a/products/native-token-transfers/guides/deploy-to-evm.md +++ b/products/native-token-transfers/guides/deploy-to-evm.md @@ -10,6 +10,23 @@ categories: NTT, Transfer This guide walks you through deploying NTT on EVM chains, including setting up dependencies, configuring token compatibility, and using the NTT CLI to deploy in hub-and-spoke or burn-and-mint mode. +## Prerequisites + +Before you begin, ensure you have the following: + +- You've completed the [Get Started with NTT](/docs/products/native-token-transfers/get-started/){target=\_blank} guide +- You have an existing ERC-20 token deployed to the EVM chains you plan to use + +!!! note "Don't have a token yet?" + + Before proceeding, make sure you have the NTT CLI installed and a project initialized. + Follow the below steps or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}: + + ???- interface "Install the NTT CLI and Scaffold a New Project" + + --8<-- 'text/products/native-token-transfers/guides/install-ntt-project.md' + + ## Deploy Your Token and Ensure Compatibility If you still need to do so, deploy the token contract to the destination or spoke chains. @@ -65,15 +82,30 @@ This table compares the configuration parameters available when deploying the NT ## Deploy NTT -Before deploying NTT contracts on EVM chains, you need to scaffold a project and initialize your deployment configuration. +Once you have the NTT CLI installed and a project initialized, proceed with adding your EVM chains and deploying contracts. -???- interface "Install the NTT CLI and Scaffold a New Project" - - --8<-- 'text/products/native-token-transfers/guides/install-ntt-project.md' +Ensure your wallet is set up using Foundry's encrypted keystore. + +!!! info "Use Foundry's Encrypted Keystore" + + Instead of setting your private key as a raw environment variable, use Foundry's keystore: + + 1. Generate a new encrypted key: + ```bash + cast wallet new + ``` + + 2. Or import an existing private key: + ```bash + cast wallet import + ``` + + 3. You’ll be prompted to set a password. Use this keystore file when interacting with contracts, like this: + ```bash + cast send --keystore /path/to/keystore.json --password <(echo "YOUR_PASSWORD") ... + ``` -Once you've completed those steps, return here to proceed with adding your EVM chains and deploying contracts. -Ensure you have set up your environment correctly: ```bash export ETH_PRIVATE_KEY=INSERT_PRIVATE_KEY From e3c48cf8fa5b927ca3c584245de2ea8919a0c3af Mon Sep 17 00:00:00 2001 From: Ilaria Enache Date: Thu, 12 Jun 2025 15:34:39 +0200 Subject: [PATCH 2/6] clean up ntt evm --- .../native-token-transfers/guides/deploy-to-evm.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/products/native-token-transfers/guides/deploy-to-evm.md b/products/native-token-transfers/guides/deploy-to-evm.md index 4503ecc7d..92a4d566a 100644 --- a/products/native-token-transfers/guides/deploy-to-evm.md +++ b/products/native-token-transfers/guides/deploy-to-evm.md @@ -100,17 +100,11 @@ Ensure your wallet is set up using Foundry's encrypted keystore. cast wallet import ``` - 3. You’ll be prompted to set a password. Use this keystore file when interacting with contracts, like this: + 3. You’ll be prompted to set a password. Use this keystore file when interacting with contracts: ```bash cast send --keystore /path/to/keystore.json --password <(echo "YOUR_PASSWORD") ... ``` - - -```bash -export ETH_PRIVATE_KEY=INSERT_PRIVATE_KEY -``` - Add each chain you'll be deploying to. The following example demonstrates configuring NTT in burn-and-mint mode on Ethereum Sepolia and Arbitrum Sepolia: ```bash @@ -164,7 +158,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 ``` - If you have a custom process to manage token minters, you should now follow that process to add the corresponding NTT Manager as a minter From 9a5439f0554c9b21686fc7dec271a993ae032155 Mon Sep 17 00:00:00 2001 From: Ilaria Enache Date: Thu, 12 Jun 2025 15:35:50 +0200 Subject: [PATCH 3/6] llms --- llms-files/llms-ntt.txt | 110 ++++++++++++++++++++--------------- llms-files/llms-transfer.txt | 110 ++++++++++++++++++++--------------- llms-full.txt | 110 ++++++++++++++++++++--------------- 3 files changed, 192 insertions(+), 138 deletions(-) diff --git a/llms-files/llms-ntt.txt b/llms-files/llms-ntt.txt index 26d298285..02cd0ebe8 100644 --- a/llms-files/llms-ntt.txt +++ b/llms-files/llms-ntt.txt @@ -705,6 +705,56 @@ categories: NTT, Transfer This guide walks you through deploying NTT on EVM chains, including setting up dependencies, configuring token compatibility, and using the NTT CLI to deploy in hub-and-spoke or burn-and-mint mode. +## Prerequisites + +Before you begin, ensure you have the following: + +- You've completed the [Get Started with NTT](/docs/products/native-token-transfers/get-started/){target=\_blank} guide +- You have an existing ERC-20 token deployed to the EVM chains you plan to use + +!!! note "Don't have a token yet?" + + Before proceeding, make sure you have the NTT CLI installed and a project initialized. + Follow the below steps or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}: + + ???- interface "Install the NTT CLI and Scaffold a New Project" + + 1. Install the NTT CLI: + + ```bash + curl -fsSL https://raw.githubusercontent.com/wormhole-foundation/native-token-transfers/main/cli/install.sh | bash + ``` + + Verify installation: + + ```bash + ntt --version + ``` + +2. Initialize a new NTT project: + + ```bash + ntt new my-ntt-project + cd my-ntt-project + ``` + +3. Create the deployment config**: + + === "Mainnet" + + ```bash + ntt init Mainnet + ``` + + === "Testnet" + + ```bash + ntt init Testnet + ``` + + This generates a `deployment.json` file where your deployment settings will be stored. + + ## Deploy Your Token and Ensure Compatibility If you still need to do so, deploy the token contract to the destination or spoke chains. @@ -795,56 +845,28 @@ This table compares the configuration parameters available when deploying the NT ## Deploy NTT -Before deploying NTT contracts on EVM chains, you need to scaffold a project and initialize your deployment configuration. - -???- interface "Install the NTT CLI and Scaffold a New Project" - - Before proceeding, make sure you have the NTT CLI installed and a project initialized. +Once you have the NTT CLI installed and a project initialized, proceed with adding your EVM chains and deploying contracts. -Follow these steps (or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}): +Ensure your wallet is set up using Foundry's encrypted keystore. -1. Install the NTT CLI: +!!! info "Use Foundry's Encrypted Keystore" - ```bash - curl -fsSL https://raw.githubusercontent.com/wormhole-foundation/native-token-transfers/main/cli/install.sh | bash - ``` - - Verify installation: - - ```bash - ntt --version - ``` - -2. Initialize a new NTT project: - - ```bash - ntt new my-ntt-project - cd my-ntt-project - ``` - -3. Create the deployment config**: - - === "Mainnet" + Instead of setting your private key as a raw environment variable, use Foundry's keystore: + 1. Generate a new encrypted key: ```bash - ntt init Mainnet + cast wallet new ``` - === "Testnet" - + 2. Or import an existing private key: ```bash - ntt init Testnet + cast wallet import ``` - This generates a `deployment.json` file where your deployment settings will be stored. - -Once you've completed those steps, return here to proceed with adding your EVM chains and deploying contracts. - -Ensure you have set up your environment correctly: - -```bash -export ETH_PRIVATE_KEY=INSERT_PRIVATE_KEY -``` + 3. You’ll be prompted to set a password. Use this keystore file when interacting with contracts: + ```bash + cast send --keystore /path/to/keystore.json --password <(echo "YOUR_PASSWORD") ... + ``` Add each chain you'll be deploying to. The following example demonstrates configuring NTT in burn-and-mint mode on Ethereum Sepolia and Arbitrum Sepolia: @@ -906,7 +928,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 ``` - If you have a custom process to manage token minters, you should now follow that process to add the corresponding NTT Manager as a minter @@ -1037,11 +1059,7 @@ The [NTT CLI](/docs/products/native-token-transfers/reference/cli-commands/){tar ???- interface "Install the NTT CLI and Scaffold a New Project" - Before proceeding, make sure you have the NTT CLI installed and a project initialized. - -Follow these steps (or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}): - -1. Install the NTT CLI: + 1. Install the NTT CLI: ```bash curl -fsSL https://raw.githubusercontent.com/wormhole-foundation/native-token-transfers/main/cli/install.sh | bash diff --git a/llms-files/llms-transfer.txt b/llms-files/llms-transfer.txt index 2eb19a8ca..c26960299 100644 --- a/llms-files/llms-transfer.txt +++ b/llms-files/llms-transfer.txt @@ -5398,6 +5398,56 @@ categories: NTT, Transfer This guide walks you through deploying NTT on EVM chains, including setting up dependencies, configuring token compatibility, and using the NTT CLI to deploy in hub-and-spoke or burn-and-mint mode. +## Prerequisites + +Before you begin, ensure you have the following: + +- You've completed the [Get Started with NTT](/docs/products/native-token-transfers/get-started/){target=\_blank} guide +- You have an existing ERC-20 token deployed to the EVM chains you plan to use + +!!! note "Don't have a token yet?" + + Before proceeding, make sure you have the NTT CLI installed and a project initialized. + Follow the below steps or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}: + + ???- interface "Install the NTT CLI and Scaffold a New Project" + + 1. Install the NTT CLI: + + ```bash + curl -fsSL https://raw.githubusercontent.com/wormhole-foundation/native-token-transfers/main/cli/install.sh | bash + ``` + + Verify installation: + + ```bash + ntt --version + ``` + +2. Initialize a new NTT project: + + ```bash + ntt new my-ntt-project + cd my-ntt-project + ``` + +3. Create the deployment config**: + + === "Mainnet" + + ```bash + ntt init Mainnet + ``` + + === "Testnet" + + ```bash + ntt init Testnet + ``` + + This generates a `deployment.json` file where your deployment settings will be stored. + + ## Deploy Your Token and Ensure Compatibility If you still need to do so, deploy the token contract to the destination or spoke chains. @@ -5488,56 +5538,28 @@ This table compares the configuration parameters available when deploying the NT ## Deploy NTT -Before deploying NTT contracts on EVM chains, you need to scaffold a project and initialize your deployment configuration. - -???- interface "Install the NTT CLI and Scaffold a New Project" - - Before proceeding, make sure you have the NTT CLI installed and a project initialized. +Once you have the NTT CLI installed and a project initialized, proceed with adding your EVM chains and deploying contracts. -Follow these steps (or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}): +Ensure your wallet is set up using Foundry's encrypted keystore. -1. Install the NTT CLI: +!!! info "Use Foundry's Encrypted Keystore" - ```bash - curl -fsSL https://raw.githubusercontent.com/wormhole-foundation/native-token-transfers/main/cli/install.sh | bash - ``` - - Verify installation: - - ```bash - ntt --version - ``` - -2. Initialize a new NTT project: - - ```bash - ntt new my-ntt-project - cd my-ntt-project - ``` - -3. Create the deployment config**: - - === "Mainnet" + Instead of setting your private key as a raw environment variable, use Foundry's keystore: + 1. Generate a new encrypted key: ```bash - ntt init Mainnet + cast wallet new ``` - === "Testnet" - + 2. Or import an existing private key: ```bash - ntt init Testnet + cast wallet import ``` - This generates a `deployment.json` file where your deployment settings will be stored. - -Once you've completed those steps, return here to proceed with adding your EVM chains and deploying contracts. - -Ensure you have set up your environment correctly: - -```bash -export ETH_PRIVATE_KEY=INSERT_PRIVATE_KEY -``` + 3. You’ll be prompted to set a password. Use this keystore file when interacting with contracts: + ```bash + cast send --keystore /path/to/keystore.json --password <(echo "YOUR_PASSWORD") ... + ``` Add each chain you'll be deploying to. The following example demonstrates configuring NTT in burn-and-mint mode on Ethereum Sepolia and Arbitrum Sepolia: @@ -5599,7 +5621,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 ``` - If you have a custom process to manage token minters, you should now follow that process to add the corresponding NTT Manager as a minter @@ -5730,11 +5752,7 @@ The [NTT CLI](/docs/products/native-token-transfers/reference/cli-commands/){tar ???- interface "Install the NTT CLI and Scaffold a New Project" - Before proceeding, make sure you have the NTT CLI installed and a project initialized. - -Follow these steps (or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}): - -1. Install the NTT CLI: + 1. Install the NTT CLI: ```bash curl -fsSL https://raw.githubusercontent.com/wormhole-foundation/native-token-transfers/main/cli/install.sh | bash diff --git a/llms-full.txt b/llms-full.txt index 1f7af2f22..db7d17338 100644 --- a/llms-full.txt +++ b/llms-full.txt @@ -12335,6 +12335,56 @@ categories: NTT, Transfer This guide walks you through deploying NTT on EVM chains, including setting up dependencies, configuring token compatibility, and using the NTT CLI to deploy in hub-and-spoke or burn-and-mint mode. +## Prerequisites + +Before you begin, ensure you have the following: + +- You've completed the [Get Started with NTT](/docs/products/native-token-transfers/get-started/){target=\_blank} guide +- You have an existing ERC-20 token deployed to the EVM chains you plan to use + +!!! note "Don't have a token yet?" + + Before proceeding, make sure you have the NTT CLI installed and a project initialized. + Follow the below steps or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}: + + ???- interface "Install the NTT CLI and Scaffold a New Project" + + 1. Install the NTT CLI: + + ```bash + curl -fsSL https://raw.githubusercontent.com/wormhole-foundation/native-token-transfers/main/cli/install.sh | bash + ``` + + Verify installation: + + ```bash + ntt --version + ``` + +2. Initialize a new NTT project: + + ```bash + ntt new my-ntt-project + cd my-ntt-project + ``` + +3. Create the deployment config**: + + === "Mainnet" + + ```bash + ntt init Mainnet + ``` + + === "Testnet" + + ```bash + ntt init Testnet + ``` + + This generates a `deployment.json` file where your deployment settings will be stored. + + ## Deploy Your Token and Ensure Compatibility If you still need to do so, deploy the token contract to the destination or spoke chains. @@ -12425,56 +12475,28 @@ This table compares the configuration parameters available when deploying the NT ## Deploy NTT -Before deploying NTT contracts on EVM chains, you need to scaffold a project and initialize your deployment configuration. - -???- interface "Install the NTT CLI and Scaffold a New Project" - - Before proceeding, make sure you have the NTT CLI installed and a project initialized. +Once you have the NTT CLI installed and a project initialized, proceed with adding your EVM chains and deploying contracts. -Follow these steps (or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}): +Ensure your wallet is set up using Foundry's encrypted keystore. -1. Install the NTT CLI: +!!! info "Use Foundry's Encrypted Keystore" - ```bash - curl -fsSL https://raw.githubusercontent.com/wormhole-foundation/native-token-transfers/main/cli/install.sh | bash - ``` - - Verify installation: - - ```bash - ntt --version - ``` - -2. Initialize a new NTT project: - - ```bash - ntt new my-ntt-project - cd my-ntt-project - ``` - -3. Create the deployment config**: - - === "Mainnet" + Instead of setting your private key as a raw environment variable, use Foundry's keystore: + 1. Generate a new encrypted key: ```bash - ntt init Mainnet + cast wallet new ``` - === "Testnet" - + 2. Or import an existing private key: ```bash - ntt init Testnet + cast wallet import ``` - This generates a `deployment.json` file where your deployment settings will be stored. - -Once you've completed those steps, return here to proceed with adding your EVM chains and deploying contracts. - -Ensure you have set up your environment correctly: - -```bash -export ETH_PRIVATE_KEY=INSERT_PRIVATE_KEY -``` + 3. You’ll be prompted to set a password. Use this keystore file when interacting with contracts: + ```bash + cast send --keystore /path/to/keystore.json --password <(echo "YOUR_PASSWORD") ... + ``` Add each chain you'll be deploying to. The following example demonstrates configuring NTT in burn-and-mint mode on Ethereum Sepolia and Arbitrum Sepolia: @@ -12536,7 +12558,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 ``` - If you have a custom process to manage token minters, you should now follow that process to add the corresponding NTT Manager as a minter @@ -12667,11 +12689,7 @@ The [NTT CLI](/docs/products/native-token-transfers/reference/cli-commands/){tar ???- interface "Install the NTT CLI and Scaffold a New Project" - Before proceeding, make sure you have the NTT CLI installed and a project initialized. - -Follow these steps (or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}): - -1. Install the NTT CLI: + 1. Install the NTT CLI: ```bash curl -fsSL https://raw.githubusercontent.com/wormhole-foundation/native-token-transfers/main/cli/install.sh | bash From 033742135c7234ea1da2fd3654e2f8d87872069f Mon Sep 17 00:00:00 2001 From: Ilaria <43253244+ilariae@users.noreply.github.com> Date: Tue, 17 Jun 2025 16:39:22 +0200 Subject: [PATCH 4/6] Update products/native-token-transfers/guides/deploy-to-evm.md Co-authored-by: Erin Shaben --- products/native-token-transfers/guides/deploy-to-evm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/products/native-token-transfers/guides/deploy-to-evm.md b/products/native-token-transfers/guides/deploy-to-evm.md index 92a4d566a..3eb76314c 100644 --- a/products/native-token-transfers/guides/deploy-to-evm.md +++ b/products/native-token-transfers/guides/deploy-to-evm.md @@ -15,7 +15,7 @@ This guide walks you through deploying NTT on EVM chains, including setting up d Before you begin, ensure you have the following: - You've completed the [Get Started with NTT](/docs/products/native-token-transfers/get-started/){target=\_blank} guide -- You have an existing ERC-20 token deployed to the EVM chains you plan to use +- An existing ERC-20 token deployed to the EVM chains you plan to use !!! note "Don't have a token yet?" From 74b73145bc6268ea95f063f8babfb3b0b2764d3c Mon Sep 17 00:00:00 2001 From: Ilaria Enache Date: Tue, 17 Jun 2025 17:00:33 +0200 Subject: [PATCH 5/6] apply feedbacl --- .../guides/deploy-to-evm.md | 68 ++++++++++++------- 1 file changed, 42 insertions(+), 26 deletions(-) diff --git a/products/native-token-transfers/guides/deploy-to-evm.md b/products/native-token-transfers/guides/deploy-to-evm.md index 3eb76314c..18e5dd588 100644 --- a/products/native-token-transfers/guides/deploy-to-evm.md +++ b/products/native-token-transfers/guides/deploy-to-evm.md @@ -14,13 +14,8 @@ This guide walks you through deploying NTT on EVM chains, including setting up d Before you begin, ensure you have the following: -- You've completed the [Get Started with NTT](/docs/products/native-token-transfers/get-started/){target=\_blank} guide -- An existing ERC-20 token deployed to the EVM chains you plan to use - -!!! note "Don't have a token yet?" - - Before proceeding, make sure you have the NTT CLI installed and a project initialized. - Follow the below steps or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}: +- An existing ERC-20 token deployed to the [EVM chains](/docs/products/reference/supported-networks/#ntt){target=\_blank} you plan to use +- Make sure you have the NTT CLI installed and a project initialized. Follow the below steps or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}: ???- interface "Install the NTT CLI and Scaffold a New Project" @@ -31,6 +26,43 @@ Before you begin, ensure you have the following: If you still need to do so, deploy the token contract to the destination or spoke chains. +???- interface "Deploy an ERC-20 Token on EVM" + Use the [example NTT token repository](https://github.com/wormhole-foundation/example-ntt-token){target=\_blank} to deploy a basic ERC-20 token contract on testnet. + + 1. **Install Foundry** - install the [Forge CLI](https://book.getfoundry.sh/getting-started/installation){target=\_blank} + + 2. **Clone the repository** – fetch the example contract repository + + ```bash + git clone https://github.com/wormhole-foundation/example-ntt-token.git + cd example-ntt-token + ``` + + 3. **Deploy the token contract** – deploy to testnet with your preferred name, symbol, minter, and owner addresses + + ```bash + forge create --broadcast \ + --rpc-url INSERT_RPC_URL \ + --private-key INSERT_YOUR_PRIVATE_KEY \ + src/PeerToken.sol:PeerToken \ + --constructor-args "INSERT_TOKEN_NAME" "INSERT_TOKEN_SYMBOL" INSERT_MINTER_ADDRESS INSERT_OWNER_ADDRESS + ``` + + 4. **Mint tokens** – send tokens to your address + + ```bash + cast send INSERT_TOKEN_ADDRESS \ + "mint(address,uint256)" \ + INSERT_RECIPIENT_ADDRESS \ + INSERT_AMOUNT_IN_WEI \ + --private-key INSERT_YOUR_PRIVATE_KEY \ + --rpc-url INSERT_RPC_URL + ``` + + !!! note + This token uses 18 decimals by default. All minting values must be specified in `wei` (1 token = 10^18). + + ### Requirements for Token Deployment Wormhole’s NTT framework supports two [deployment models](/docs/products/native-token-transfers/overview#deployment-models){target=\_blank}: burn-and-mint and hub-and-spoke. **Both require an ERC-20 token (new or existing).** @@ -84,26 +116,10 @@ This table compares the configuration parameters available when deploying the NT Once you have the NTT CLI installed and a project initialized, proceed with adding your EVM chains and deploying contracts. -Ensure your wallet is set up using Foundry's encrypted keystore. - -!!! info "Use Foundry's Encrypted Keystore" - - Instead of setting your private key as a raw environment variable, use Foundry's keystore: - - 1. Generate a new encrypted key: - ```bash - cast wallet new - ``` +Ensure your wallet is properly configured and that sensitive information such as private keys is handled securely. - 2. Or import an existing private key: - ```bash - cast wallet import - ``` - - 3. You’ll be prompted to set a password. Use this keystore file when interacting with contracts: - ```bash - cast send --keystore /path/to/keystore.json --password <(echo "YOUR_PASSWORD") ... - ``` +!!! info "Secure Key Management Recommended" + Avoid exposing your private key directly in scripts or environment variables. Use a secure key management method like encrypted keystores. Add each chain you'll be deploying to. The following example demonstrates configuring NTT in burn-and-mint mode on Ethereum Sepolia and Arbitrum Sepolia: From 3c6a3ec6589b68ead8d41965c0b6d63ed166014d Mon Sep 17 00:00:00 2001 From: Ilaria Enache Date: Tue, 17 Jun 2025 17:01:01 +0200 Subject: [PATCH 6/6] llms --- llms-files/llms-ntt.txt | 68 ++++++++++++++++++++++-------------- llms-files/llms-transfer.txt | 68 ++++++++++++++++++++++-------------- llms-full.txt | 68 ++++++++++++++++++++++-------------- 3 files changed, 126 insertions(+), 78 deletions(-) diff --git a/llms-files/llms-ntt.txt b/llms-files/llms-ntt.txt index 02cd0ebe8..635bb6d52 100644 --- a/llms-files/llms-ntt.txt +++ b/llms-files/llms-ntt.txt @@ -709,13 +709,8 @@ This guide walks you through deploying NTT on EVM chains, including setting up d Before you begin, ensure you have the following: -- You've completed the [Get Started with NTT](/docs/products/native-token-transfers/get-started/){target=\_blank} guide -- You have an existing ERC-20 token deployed to the EVM chains you plan to use - -!!! note "Don't have a token yet?" - - Before proceeding, make sure you have the NTT CLI installed and a project initialized. - Follow the below steps or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}: +- An existing ERC-20 token deployed to the [EVM chains](/docs/products/reference/supported-networks/#ntt){target=\_blank} you plan to use +- Make sure you have the NTT CLI installed and a project initialized. Follow the below steps or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}: ???- interface "Install the NTT CLI and Scaffold a New Project" @@ -759,6 +754,43 @@ Before you begin, ensure you have the following: If you still need to do so, deploy the token contract to the destination or spoke chains. +???- interface "Deploy an ERC-20 Token on EVM" + Use the [example NTT token repository](https://github.com/wormhole-foundation/example-ntt-token){target=\_blank} to deploy a basic ERC-20 token contract on testnet. + + 1. **Install Foundry** - install the [Forge CLI](https://book.getfoundry.sh/getting-started/installation){target=\_blank} + + 2. **Clone the repository** – fetch the example contract repository + + ```bash + git clone https://github.com/wormhole-foundation/example-ntt-token.git + cd example-ntt-token + ``` + + 3. **Deploy the token contract** – deploy to testnet with your preferred name, symbol, minter, and owner addresses + + ```bash + forge create --broadcast \ + --rpc-url INSERT_RPC_URL \ + --private-key INSERT_YOUR_PRIVATE_KEY \ + src/PeerToken.sol:PeerToken \ + --constructor-args "INSERT_TOKEN_NAME" "INSERT_TOKEN_SYMBOL" INSERT_MINTER_ADDRESS INSERT_OWNER_ADDRESS + ``` + + 4. **Mint tokens** – send tokens to your address + + ```bash + cast send INSERT_TOKEN_ADDRESS \ + "mint(address,uint256)" \ + INSERT_RECIPIENT_ADDRESS \ + INSERT_AMOUNT_IN_WEI \ + --private-key INSERT_YOUR_PRIVATE_KEY \ + --rpc-url INSERT_RPC_URL + ``` + + !!! note + This token uses 18 decimals by default. All minting values must be specified in `wei` (1 token = 10^18). + + ### Requirements for Token Deployment Wormhole’s NTT framework supports two [deployment models](/docs/products/native-token-transfers/overview#deployment-models){target=\_blank}: burn-and-mint and hub-and-spoke. **Both require an ERC-20 token (new or existing).** @@ -847,26 +879,10 @@ This table compares the configuration parameters available when deploying the NT Once you have the NTT CLI installed and a project initialized, proceed with adding your EVM chains and deploying contracts. -Ensure your wallet is set up using Foundry's encrypted keystore. - -!!! info "Use Foundry's Encrypted Keystore" - - Instead of setting your private key as a raw environment variable, use Foundry's keystore: - - 1. Generate a new encrypted key: - ```bash - cast wallet new - ``` - - 2. Or import an existing private key: - ```bash - cast wallet import - ``` +Ensure your wallet is properly configured and that sensitive information such as private keys is handled securely. - 3. You’ll be prompted to set a password. Use this keystore file when interacting with contracts: - ```bash - cast send --keystore /path/to/keystore.json --password <(echo "YOUR_PASSWORD") ... - ``` +!!! info "Secure Key Management Recommended" + Avoid exposing your private key directly in scripts or environment variables. Use a secure key management method like encrypted keystores. Add each chain you'll be deploying to. The following example demonstrates configuring NTT in burn-and-mint mode on Ethereum Sepolia and Arbitrum Sepolia: diff --git a/llms-files/llms-transfer.txt b/llms-files/llms-transfer.txt index c26960299..5b76df4c2 100644 --- a/llms-files/llms-transfer.txt +++ b/llms-files/llms-transfer.txt @@ -5402,13 +5402,8 @@ This guide walks you through deploying NTT on EVM chains, including setting up d Before you begin, ensure you have the following: -- You've completed the [Get Started with NTT](/docs/products/native-token-transfers/get-started/){target=\_blank} guide -- You have an existing ERC-20 token deployed to the EVM chains you plan to use - -!!! note "Don't have a token yet?" - - Before proceeding, make sure you have the NTT CLI installed and a project initialized. - Follow the below steps or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}: +- An existing ERC-20 token deployed to the [EVM chains](/docs/products/reference/supported-networks/#ntt){target=\_blank} you plan to use +- Make sure you have the NTT CLI installed and a project initialized. Follow the below steps or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}: ???- interface "Install the NTT CLI and Scaffold a New Project" @@ -5452,6 +5447,43 @@ Before you begin, ensure you have the following: If you still need to do so, deploy the token contract to the destination or spoke chains. +???- interface "Deploy an ERC-20 Token on EVM" + Use the [example NTT token repository](https://github.com/wormhole-foundation/example-ntt-token){target=\_blank} to deploy a basic ERC-20 token contract on testnet. + + 1. **Install Foundry** - install the [Forge CLI](https://book.getfoundry.sh/getting-started/installation){target=\_blank} + + 2. **Clone the repository** – fetch the example contract repository + + ```bash + git clone https://github.com/wormhole-foundation/example-ntt-token.git + cd example-ntt-token + ``` + + 3. **Deploy the token contract** – deploy to testnet with your preferred name, symbol, minter, and owner addresses + + ```bash + forge create --broadcast \ + --rpc-url INSERT_RPC_URL \ + --private-key INSERT_YOUR_PRIVATE_KEY \ + src/PeerToken.sol:PeerToken \ + --constructor-args "INSERT_TOKEN_NAME" "INSERT_TOKEN_SYMBOL" INSERT_MINTER_ADDRESS INSERT_OWNER_ADDRESS + ``` + + 4. **Mint tokens** – send tokens to your address + + ```bash + cast send INSERT_TOKEN_ADDRESS \ + "mint(address,uint256)" \ + INSERT_RECIPIENT_ADDRESS \ + INSERT_AMOUNT_IN_WEI \ + --private-key INSERT_YOUR_PRIVATE_KEY \ + --rpc-url INSERT_RPC_URL + ``` + + !!! note + This token uses 18 decimals by default. All minting values must be specified in `wei` (1 token = 10^18). + + ### Requirements for Token Deployment Wormhole’s NTT framework supports two [deployment models](/docs/products/native-token-transfers/overview#deployment-models){target=\_blank}: burn-and-mint and hub-and-spoke. **Both require an ERC-20 token (new or existing).** @@ -5540,26 +5572,10 @@ This table compares the configuration parameters available when deploying the NT Once you have the NTT CLI installed and a project initialized, proceed with adding your EVM chains and deploying contracts. -Ensure your wallet is set up using Foundry's encrypted keystore. - -!!! info "Use Foundry's Encrypted Keystore" - - Instead of setting your private key as a raw environment variable, use Foundry's keystore: - - 1. Generate a new encrypted key: - ```bash - cast wallet new - ``` - - 2. Or import an existing private key: - ```bash - cast wallet import - ``` +Ensure your wallet is properly configured and that sensitive information such as private keys is handled securely. - 3. You’ll be prompted to set a password. Use this keystore file when interacting with contracts: - ```bash - cast send --keystore /path/to/keystore.json --password <(echo "YOUR_PASSWORD") ... - ``` +!!! info "Secure Key Management Recommended" + Avoid exposing your private key directly in scripts or environment variables. Use a secure key management method like encrypted keystores. Add each chain you'll be deploying to. The following example demonstrates configuring NTT in burn-and-mint mode on Ethereum Sepolia and Arbitrum Sepolia: diff --git a/llms-full.txt b/llms-full.txt index db7d17338..7803a57a7 100644 --- a/llms-full.txt +++ b/llms-full.txt @@ -12339,13 +12339,8 @@ This guide walks you through deploying NTT on EVM chains, including setting up d Before you begin, ensure you have the following: -- You've completed the [Get Started with NTT](/docs/products/native-token-transfers/get-started/){target=\_blank} guide -- You have an existing ERC-20 token deployed to the EVM chains you plan to use - -!!! note "Don't have a token yet?" - - Before proceeding, make sure you have the NTT CLI installed and a project initialized. - Follow the below steps or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}: +- An existing ERC-20 token deployed to the [EVM chains](/docs/products/reference/supported-networks/#ntt){target=\_blank} you plan to use +- Make sure you have the NTT CLI installed and a project initialized. Follow the below steps or see the [Get Started guide](/docs/products/native-token-transfers/get-started/#install-ntt-cli){target=\_blank}: ???- interface "Install the NTT CLI and Scaffold a New Project" @@ -12389,6 +12384,43 @@ Before you begin, ensure you have the following: If you still need to do so, deploy the token contract to the destination or spoke chains. +???- interface "Deploy an ERC-20 Token on EVM" + Use the [example NTT token repository](https://github.com/wormhole-foundation/example-ntt-token){target=\_blank} to deploy a basic ERC-20 token contract on testnet. + + 1. **Install Foundry** - install the [Forge CLI](https://book.getfoundry.sh/getting-started/installation){target=\_blank} + + 2. **Clone the repository** – fetch the example contract repository + + ```bash + git clone https://github.com/wormhole-foundation/example-ntt-token.git + cd example-ntt-token + ``` + + 3. **Deploy the token contract** – deploy to testnet with your preferred name, symbol, minter, and owner addresses + + ```bash + forge create --broadcast \ + --rpc-url INSERT_RPC_URL \ + --private-key INSERT_YOUR_PRIVATE_KEY \ + src/PeerToken.sol:PeerToken \ + --constructor-args "INSERT_TOKEN_NAME" "INSERT_TOKEN_SYMBOL" INSERT_MINTER_ADDRESS INSERT_OWNER_ADDRESS + ``` + + 4. **Mint tokens** – send tokens to your address + + ```bash + cast send INSERT_TOKEN_ADDRESS \ + "mint(address,uint256)" \ + INSERT_RECIPIENT_ADDRESS \ + INSERT_AMOUNT_IN_WEI \ + --private-key INSERT_YOUR_PRIVATE_KEY \ + --rpc-url INSERT_RPC_URL + ``` + + !!! note + This token uses 18 decimals by default. All minting values must be specified in `wei` (1 token = 10^18). + + ### Requirements for Token Deployment Wormhole’s NTT framework supports two [deployment models](/docs/products/native-token-transfers/overview#deployment-models){target=\_blank}: burn-and-mint and hub-and-spoke. **Both require an ERC-20 token (new or existing).** @@ -12477,26 +12509,10 @@ This table compares the configuration parameters available when deploying the NT Once you have the NTT CLI installed and a project initialized, proceed with adding your EVM chains and deploying contracts. -Ensure your wallet is set up using Foundry's encrypted keystore. - -!!! info "Use Foundry's Encrypted Keystore" - - Instead of setting your private key as a raw environment variable, use Foundry's keystore: - - 1. Generate a new encrypted key: - ```bash - cast wallet new - ``` - - 2. Or import an existing private key: - ```bash - cast wallet import - ``` +Ensure your wallet is properly configured and that sensitive information such as private keys is handled securely. - 3. You’ll be prompted to set a password. Use this keystore file when interacting with contracts: - ```bash - cast send --keystore /path/to/keystore.json --password <(echo "YOUR_PASSWORD") ... - ``` +!!! info "Secure Key Management Recommended" + Avoid exposing your private key directly in scripts or environment variables. Use a secure key management method like encrypted keystores. Add each chain you'll be deploying to. The following example demonstrates configuring NTT in burn-and-mint mode on Ethereum Sepolia and Arbitrum Sepolia: