Skip to content

Commit f54b8aa

Browse files
authored
rename index-sr file and add deprecation notice (#83)
1 parent 21e9c02 commit f54b8aa

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
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.
66

7+
> **⚠️ Important:** Standard relaying (SR) is **deprecated**. The `index-sr.ts` example is provided for reference only. For production use, we strongly recommend using the Executor route (`index-executor.ts`) which provides automatic relaying and a better user experience.
8+
79
## Prerequisites
810

911
Ensure you have the following installed on your system:
@@ -104,12 +106,14 @@ executorConfig.referrerFee = {
104106

105107
This project provides two different NTT transfer examples:
106108

107-
### 1. Basic NTT Transfer (`index.ts`)
109+
### 1. Basic NTT Transfer (`index-sr.ts`) ⚠️ DEPRECATED
110+
111+
> **⚠️ Deprecation Notice:** Standard relaying (SR) is deprecated. We strongly recommend using the Executor route instead (see section 2 below) for automatic relaying, which provides a better user experience and is the recommended approach going forward.
108112

109-
Simple NTT transfer between chains:
113+
Simple NTT transfer between chains using standard relaying:
110114

111115
```bash
112-
npx ts-node src/index.ts
116+
npx ts-node src/index-sr.ts
113117
```
114118

115119
### 2. NTT Executor Transfer (`index-executor.ts`)
@@ -133,7 +137,7 @@ const dst = wh.getChain("Sepolia");
133137
```
134138

135139
### Transfer Amount
136-
To modify the amount of tokens being transferred change the following line in the index.ts file:
140+
To modify the amount of tokens being transferred change the following line in the `index-sr.ts` or `index-executor.ts` file:
137141
```typescript
138142
const amt = amount.units(
139143
amount.parse("1", await srcNtt.getTokenDecimals())
File renamed without changes.

0 commit comments

Comments
 (0)