Create a demo repository for an NTT transfer using the Wormhole TS SDK

Author: evgeniko

.gitignore

@@ -0,0 +1 @@
+/node_modules

LICENCE

@@ -0,0 +1,13 @@
+Copyright 2022 Wormhole Project Contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -1 +1,86 @@
-# demo-ntt-ts-sdk
+
+# NTT deployment testing with Wormhole TS-SDK
+
+## Overview
+
+This project demonstrates the use of the Wormhole TS-SDK to facilitate token transfers between different blockchain networks, after performing a deployment of the [Native Token Transfer](https://docs.wormhole.com/wormhole/native-token-transfers/overview) framework. Before running the script, you need to set up the necessary configurations and provide your deployment details.
+
+## Prerequisites
+
+Ensure you have the following installed on your system:
+
+- Node.js & TypeScript
+- npm or yarn 
+
+## Setup
+
+1. **Clone the Repository:**
+
+   ```bash
+   git clone https://github.com/wormhole-foundation/demo-ntt-ts-sdk.git
+   cd /demo-ntt-ts-sdk
+   ```
+
+2. **Install Dependencies:**
+
+   ```bash
+   npm install
+   ```
+
+   or
+
+   ```bash
+   yarn 
+   ```
+
+3. **Update Configuration:**
+
+   - **Reference `deployment.json`:**
+
+     The `example-deployment.json` file contains an example deployment file for your blockchain networks. You should have a similar file in your project after going through the an NTT [deployment](https://docs.wormhole.com/wormhole/native-token-transfers/deployment/installation)
+
+   - **Update `const.ts`:**
+
+     Update the `TEST_NTT_TOKENS` object in the `const.ts` file with your token, manager, and transceiver details from the `deployment.json` file:
+
+     ```typescript
+     export const TEST_NTT_SPL22_TOKENS: NttContracts = {
+       Solana: {
+         token: "NTTSolanaTokenAddress",
+         manager: "NTTSolanaManagerAddress",
+         transceiver: {
+           wormhole: "NTTSolanaTransceiverAddress",
+         },
+       },
+       BaseSepolia: {
+         token: "NTTBaseSepoliaTokenAddress",
+         manager: "NTTBaseSepoliaManagerAddress",
+         transceiver: { wormhole: "NTTBaseSepoliaTransceiverAddress" },
+       },
+     };
+     ```
+
+   - **Set Private Keys:**
+
+     You need to set your Ethereum and Solana private keys for this example. You can either set the env variables `ETH_PRIVATE_KEY` and `SOL_PRIVATE_KEY` OR replace this constants:
+
+     ```typescript
+     export const DEVNET_SOL_PRIVATE_KEY = encoding.b58.encode(
+       new Uint8Array(
+         [218, 95 /* ... rest of the key */]
+       )
+     );
+
+     export const DEVNET_ETH_PRIVATE_KEY =
+       "0xYourEthereumPrivateKey";
+     ```
+
+## Running the Script
+
+   ```bash
+   npx ts-node index.ts
+   ```
+
+ **Finality delay:**
+
+   When executing the script, you may see log messages like *Retrying Wormholescan:GetVaaByTxHash, attempt 100/750*. This is expected due to the time required for the source blockchain, like Ethereum, to reach finality, which can take up to 15 minutes. The Wormhole guardian network needs this time to produce a valid attestation (VAA). The retry attempts ensure the transaction is fully confirmed and secure before proceeding.

SECURITY.md

@@ -0,0 +1,29 @@
+import { Ntt } from "@wormhole-foundation/sdk-definitions-ntt";
+import { Chain, encoding } from "@wormhole-foundation/sdk";
+
+export type NttContracts = {
+  [key in Chain]?: Ntt.Contracts;
+};
+
+export const DEVNET_SOL_PRIVATE_KEY = encoding.b58.encode(
+  new Uint8Array(
+    [218,95 //.. rest of the key
+    ])
+);
+export const DEVNET_ETH_PRIVATE_KEY =
+  "0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d"; // Ganache default private key
+
+export const TEST_NTT_TOKENS: NttContracts = {
+  Solana: {
+    token: "5trJHKSB7M6w1sC74YkxZb5D7GxA9bL6WzP4ht8FDs5V",
+    manager: "NTueGPu3ckEwiQXprSjAfHC7YybrJNAG39X2AKEG9So",
+    transceiver: {
+      wormhole: "NTueGPu3ckEwiQXprSjAfHC7YybrJNAG39X2AKEG9So",
+    },
+  },
+  BaseSepolia: {
+    token: "0xaBc1234567890fDb48D63F11dFdc364201C9DE67",
+    manager: "0xD456789a1230Cc48fDb48D63F11dFdc364201C9DE",
+    transceiver: { wormhole: "0x9876aBcDeF01234567890Fdb48D63F11dFdc3642" },
+  },
+};

const.ts

@@ -0,0 +1,47 @@
+{
+  "network": "Testnet",
+  "chains": {
+    "BaseSepolia": {
+      "version": "1.1.0",
+      "mode": "burning",
+      "paused": false,
+      "owner": "0xAB12CD34EF56GH78IJ90KL12MN34OP56QR78ST90",
+      "manager": "0x98BA7C65F43210EDCB8765F4A3E9876C12AB56CD",
+      "token": "0x1234567890abcdef1234567890abcdef12345678",
+      "transceivers": {
+        "threshold": 1,
+        "wormhole": {
+          "address": "0xabcdef1234567890abcdef1234567890abcdef12",
+          "pauser": "0xAB12CD34EF56GH78IJ90KL12MN34OP56QR78ST90"
+        }
+      },
+      "limits": {
+        "outbound": "184467440737.095516150000000000",
+        "inbound": {
+          "Solana": "1000.000000000000000000"
+        }
+      },
+      "pauser": "0xAB12CD34EF56GH78IJ90KL12MN34OP56QR78ST90"
+    },
+    "Solana": {
+      "version": "2.0.0",
+      "mode": "burning",
+      "paused": false,
+      "owner": "4d6f2E8F3d7F1e2Cd7c67D36fE4c1A678C8e8E3F",
+      "manager": "7gHdE5F2w3D5e67F4C5f3eE9d1eD8C7eA2f9cD7F",
+      "token": "6f7gH4D5f6c3D2e6a7e4F8G3d2e7c4F5d3F6b5eC",
+      "transceivers": {
+        "threshold": 1,
+        "wormhole": {
+          "address": "B3Cd6eF7G4c2E8d7A5f6F4C3eD7F4B6cE8d3f6G7"
+        }
+      },
+      "limits": {
+        "outbound": "1000.100000000",
+        "inbound": {
+          "BaseSepolia": "1000.000000000"
+        }
+      }
+    }
+  }
+}

example-deployment.json

@@ -0,0 +1,86 @@
+import {
+    Chain,
+    ChainAddress,
+    ChainContext,
+    Network,
+    Signer,
+    Wormhole,
+    chainToPlatform,
+    
+  } from "@wormhole-foundation/sdk";
+  
+  import evm from "@wormhole-foundation/sdk/platforms/evm";
+  import solana from "@wormhole-foundation/sdk/platforms/solana";
+import { NttContracts, DEVNET_SOL_PRIVATE_KEY, DEVNET_ETH_PRIVATE_KEY, TEST_NTT_TOKENS} from "./const";
+import { NttRoute } from "@wormhole-foundation/sdk-route-ntt";
+  
+  export interface SignerStuff<N extends Network, C extends Chain> {
+    chain: ChainContext<N, C>;
+    signer: Signer<N, C>;
+    address: ChainAddress<C>;
+  }
+  
+  export async function getSigner<N extends Network, C extends Chain>(
+    chain: ChainContext<N, C>
+  ): Promise<SignerStuff<N, C>> {
+    // Read in from `.env`
+    (await import("dotenv")).config();
+  
+    let signer: Signer;
+    const platform = chainToPlatform(chain.chain);
+    switch (platform) {
+      case "Solana":
+        signer = await solana.getSigner(
+          await chain.getRpc(),
+          getEnv("OTHER_SOL_PRIVATE_KEY", DEVNET_SOL_PRIVATE_KEY),
+          { debug: false }
+        );
+        break;
+      case "Evm":
+        signer = await evm.getSigner(
+          await chain.getRpc(),
+          getEnv("ETH_PRIVATE_KEY", DEVNET_ETH_PRIVATE_KEY)
+        );
+        break;
+      default:
+        throw new Error("Unrecognized platform: " + platform);
+    }
+  
+    return {
+      chain,
+      signer: signer as Signer<N, C>,
+      address: Wormhole.chainAddress(chain.chain, signer.address()),
+    };
+  }
+  
+  // Use .env.example as a template for your .env file and populate it with secrets
+  // for funded accounts on the relevant chain+network combos to run the example
+  function getEnv(key: string, dev?: string): string {
+    // If we're in the browser, return empty string
+    if (typeof process === undefined) return "";
+    // Otherwise, return the env var or error
+    const val = process.env[key];
+    if (!val) {
+      if (dev) return dev;
+      throw new Error(
+        `Missing env var ${key}, did you forget to set values in '.env'?`
+      );
+    }
+  
+    return val;
+  }
+
+  // Reformat NTT contracts to fit TokenConfig for Route
+function reformat(contracts: NttContracts) {
+  return Object.entries(TEST_NTT_TOKENS).map(([chain, contracts]) => {
+    const { token, manager, transceiver: xcvrs } = contracts!;
+    const transceiver = Object.entries(xcvrs).map(([k, v]) => {
+      return { type: k as NttRoute.TransceiverType, address: v };
+    });
+    return { chain: chain as Chain, token, manager, transceiver };
+  });
+}
+
+export const NttTokens = {
+  Test: reformat(TEST_NTT_TOKENS),
+};

helpers.ts

@@ -0,0 +1,60 @@
+import {
+    TransactionId,
+    Wormhole,
+    amount,
+    signSendWait,
+  } from "@wormhole-foundation/sdk";
+  import evm from "@wormhole-foundation/sdk/platforms/evm";
+  import solana from "@wormhole-foundation/sdk/platforms/solana";
+  
+  // register protocol implementations
+  import "@wormhole-foundation/sdk-evm-ntt";
+  import "@wormhole-foundation/sdk-solana-ntt";
+import { TEST_NTT_TOKENS } from "./const";
+import { getSigner } from "./helpers";
+    
+
+  (async function () {
+    const wh = new Wormhole("Testnet", [solana.Platform, evm.Platform]);
+    const src = wh.getChain("BaseSepolia");
+    const dst = wh.getChain("Solana");
+
+    const srcSigner = await getSigner(src);
+    const dstSigner = await getSigner(dst);
+  
+    const srcNtt = await src.getProtocol("Ntt", {
+      ntt: TEST_NTT_TOKENS[src.chain],
+    });
+    const dstNtt = await dst.getProtocol("Ntt", {
+      ntt: TEST_NTT_TOKENS[dst.chain],
+    });
+  
+    const amt = amount.units(
+      amount.parse("0.01", await srcNtt.getTokenDecimals())
+    );
+  
+    const xfer = () =>
+      srcNtt.transfer(srcSigner.address.address, amt, dstSigner.address, {
+        queue: false,
+        automatic: false,
+        gasDropoff: 0n,
+      });
+  
+    // Initiate the transfer (or set to recoverTxids to complete transfer)
+    const txids: TransactionId[] = await signSendWait(src, xfer(), srcSigner.signer);
+    console.log("Source txs", txids);
+  
+    const vaa = await wh.getVaa(
+      txids[txids.length - 1]!.txid,
+      "Ntt:WormholeTransfer",
+      25 * 60 * 1000
+    );
+    console.log(vaa);
+  
+    const dstTxids = await signSendWait(
+      dst,
+      dstNtt.redeem([vaa!], dstSigner.address.address),
+      dstSigner.signer
+    );
+    console.log("dstTxids", dstTxids);
+  })();