Skip to content

Commit

Permalink
Update config examples in README (wormhole-foundation#2637)
Browse files Browse the repository at this point in the history
* update config examples

* shill the SDK
  • Loading branch information
artursapek authored Sep 18, 2024
1 parent cdd5802 commit 8e6e388
Showing 1 changed file with 48 additions and 45 deletions.
93 changes: 48 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Wormhole Connect
[![Documentation](https://img.shields.io/badge/Documentation-2a67c9)](https://docs.wormhole.com/wormhole/wormhole-connect/overview) [![npm version](https://img.shields.io/npm/v/@wormhole-foundation/wormhole-connect.svg)](https://www.npmjs.com/package/@wormhole-foundation/wormhole-connect) ![CI build](https://github.com/wormhole-foundation/wormhole-connect/actions/workflows/build.yml/badge.svg)
# Wormhole Connect[![Documentation](https://img.shields.io/badge/Documentation-2a67c9)](https://docs.wormhole.com/wormhole/wormhole-connect/overview) [![npm version](https://img.shields.io/npm/v/@wormhole-foundation/wormhole-connect.svg)](https://www.npmjs.com/package/@wormhole-foundation/wormhole-connect) ![CI build](https://github.com/wormhole-foundation/wormhole-connect/actions/workflows/build.yml/badge.svg)

Wormhole Connect is a customizable React widget for cross-chain asset transfers powered by Wormhole.

[![Wormhole Connect running on Portal Bridge](https://i.imgur.com/sZJKw8e.png)](https://portalbridge.com/)

Connect is powered by the [Wormhole TypeScript SDK](https://github.com/wormhole-foundation/wormhole-sdk-ts). Developers interested in building their
own interface for Wormhole bridging functionality are encouraged to explore the SDK!

## Demo

Wormhole Connect is deployed live in several production apps. Here are a few:
Expand Down Expand Up @@ -66,7 +68,7 @@ import WormholeConnect, {
} from '@wormhole-foundation/wormhole-connect';

const config: WormholeConnectConfig = {
networks: ['Ethereum', 'Solana']
chains: ['Ethereum', 'Solana']
};

const theme: WormholeConnectPartialTheme = {
Expand All @@ -92,16 +94,56 @@ Below are some of the more commonly used config options. See
[the full Connect docs](https://docs.wormhole.com/wormhole/wormhole-connect/overview) for more complete
documentation and examples of the different config options.

### Environment (`env`):
### Network (`network`):

Values: `Mainnet` | `Testnet` | `Devnet`

Connect renders in Mainnet mode by default, but you can switch it to testnet by setting `network` to `Testnet`:

```ts
const config: WormholeConnectConfig = {
network: 'Testnet'
}
```

### Choosing Chains (`chains`):

Connect renders in mainnet mode by default, but you can switch it to testnet by setting `env` to `testnet`.
You can provide a whitelist of chains to limit which ones Connect offers.

```ts
const config: WormholeConnectConfig = {
env: 'testnet'
chains: ['Ethereum', 'Solana']
}
```

See [`chains.ts`](https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/core/base/src/constants/chains.ts) in the SDK. By default, Connect offers its full built-in list for both `mainnet` and `testnet`:

| `mainnet` | `testnet` |
| ---------- | ------------- |
| Ethereum | Sepolia |
| Polygon | |
| Bsc | Bsc |
| Avalanche | Avalanche |
| Celo | Celo |
| Moonbeam | Moonbeam |
| Solana | Solana |
| Sui | Sui |
| Aptos | Aptos |
| Base | BaseSepolia |
| Osmosis | Osmosis |
| Evmos | Evmos |
| Kujira | Kujira |
| Injective | Injective |
| Klaytn | Klaytn |
| Arbitrum | ArbitrumSepolia |
| Optimism | OptimismSepolia |
| Scroll | Scroll |
| Blast | Blast |
| Xlayer | Xlayer |
| Mantle | Mantle |

> Osmosis support is in beta, reach out to a Wormhole contributor for early access.
### RPC Endpoints (`rpcs`):

We strongly recommend that you configure your own custom RPC endpoints for each network your application needs. The default public RPCs may be throttled or rate limited.
Expand Down Expand Up @@ -176,45 +218,6 @@ switches from light to dark mode.

See the definitions of `WormholeConnectTheme` and `dark` in [theme.ts](https://github.com/wormhole-foundation/wormhole-connect/blob/development/wormhole-connect/src/theme.ts) for type definitions.

### Choosing Networks (`networks`):

You can provide a whitelist of networks to limit which ones Connect offers.


```ts
const config: WormholeConnectConfig = {
networks: ['Ethereum', 'Solana']
}
```

By default, it offers its full built-in list for both `mainnet` and `testnet`:

| `mainnet` | `testnet` |
| ---------- | ------------- |
| Ethereum | Sepolia |
| Polygon | |
| Bsc | Bsc |
| Avalanche | Avalanche |
| Celo | Celo |
| Moonbeam | Moonbeam |
| Solana | Solana |
| Sui | Sui |
| Aptos | Aptos |
| Base | BaseSepolia |
| Osmosis | Osmosis |
| Evmos | Evmos |
| Kujira | Kujira |
| Injective | Injective |
| Klaytn | Klaytn |
| Arbitrum | ArbitrumSepolia |
| Optimism | OptimismSepolia |
| Scroll | Scroll |
| Blast | Blast |
| Xlayer | Xlayer |
| Mantle | Mantle |

> Osmosis support is in beta, reach out to a Wormhole contributor for early access.
### Learn More

Please read [the full Connect documentation](https://docs.wormhole.com/wormhole/wormhole-connect/overview) to see what else is possible!
Expand Down

0 comments on commit 8e6e388

Please sign in to comment.