Skip to content

docs: align README network config with bundled deployments #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mehmetkr-31 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: align README network config with bundled deployments #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ main().catch(console.error);

## Network Configuration

The SDK ships with hardcoded **mainnet** deployment addresses. To target
additional networks (e.g. Solana devnet, Base Sepolia) or use custom contract
deployments, pass `deployments` overrides to `createBridgeClient()`.
The SDK ships with built-in deployment addresses for **mainnet and testnet/devnet**
(`solana:mainnet`, `solana:devnet`, `eip155:8453`, `eip155:84532`). To use custom
contract deployments, pass `deployments` overrides to `createBridgeClient()`.

### Default deployment addresses

Expand All @@ -89,8 +89,8 @@ deployments, pass `deployments` overrides to `createBridgeClient()`.

### Devnet / testnet configuration example

The SDK exports `solanaDevnet` and `baseSepolia` chain objects you can use
alongside your own deployment addresses:
The SDK exports `solanaDevnet` and `baseSepolia` chain objects, and those chain IDs
already have bundled defaults. You can still provide overrides when needed:

```ts
import { address } from "@solana/kit";
Expand Down Expand Up @@ -134,15 +134,15 @@ const client = createBridgeClient({

### Merge behavior

Overrides are **merged** with the built-in mainnet defaults, not replaced:
Overrides are **merged** with the built-in defaults, not replaced:

- **Existing chain IDs** — individual fields are overridden; unspecified fields
keep their defaults.
- **New chain IDs** (e.g. `solana:devnet`) — all required fields must be
provided or the entry is ignored.

This means you can override a single mainnet address without losing the others,
or add devnet/testnet entries while keeping the mainnet defaults intact.
or add new entries while keeping the bundled defaults intact.

## Examples

Expand Down