Skip to content

Commit 3a0f39f

Browse files
committed
Added NTT to README
1 parent b045006 commit 3a0f39f

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,21 @@ See the "Arbitrary Token" example in [the config docs](https://docs.wormhole.com
131131

132132
Please note you have to [register a token](https://portalbridge.com/advanced-tools/#/register) with the token bridge before you can use it in Connect.
133133

134+
### Configuring Custom NTT (Native Token Transfer) Groups
135+
To configure custom NTT groups, include an `nttGroups` key in your configuration.
136+
137+
```ts
138+
const config: WormholeConnectConfig = {
139+
nttGroups: {
140+
// Your custom NTT groups go here
141+
}
142+
}
143+
```
144+
145+
For a practical example of how to structure your custom NTT groups, refer to the [nttGroups.ts](https://github.com/wormhole-foundation/wormhole-connect/blob/development/wormhole-connect/src/config/testnet/nttGroups.ts) file.
146+
147+
Please note that the `tokenKey` specified in your custom NTT group must correspond to an existing entry in the tokensConfig, whether it's a built-in or a custom token.
148+
134149
### Custom Theme
135150

136151
You can also customize Connect's color scheme by providing a `WormholeConnectTheme` as the `theme` prop.

0 commit comments

Comments
 (0)