WhiteLabelBridge Docs
Setup Wizard Input Reference
Use this while completing setup to avoid retries. If any required field is invalid, save is blocked and backend validation returns explicit errors.
Step 1: Brand
| Field | Required | Format / Notes |
|---|---|---|
| Project Name | Yes | Non-empty text shown in UI and metadata. |
| Domain | Recommended | Hostname only, no path. Used for nginx finalize automation. |
| Support Email | No | Valid email address. |
| Bridge Fee (%) | Yes | Number in [0,100). Example 0.1 means 0.1%. |
| Logo URL | No | Full http(s) URL with image file. Wizard should preview and fail gracefully on bad URL. |
| Primary / Secondary / Background Color | Yes | Hex colors like #3b82f6. |
| Website / Docs / Support / Twitter Links | No | Full http(s) URLs. |
| Primary Token Symbol | Yes | 1-16 uppercase letters/numbers, maps to primary lane. |
| Secondary Token Symbol | Yes | 1-16 uppercase letters/numbers, maps to secondary lane. |
Step 2: Chains and Modes
| Field | Required | Format / Notes |
|---|---|---|
| External Chain Preset | Yes | Ethereum | BSC | Polygon | Arbitrum | Optimism | Solana | Custom EVM. |
| External Chain Type | Yes | Auto-calculated: evm or solana. |
| External Chain Name/Key | Yes | Text name + short uppercase key (ETH, BSC, SOL, etc.). |
| External Chain ID | EVM only | Positive integer, for example 1 on Ethereum. |
| External RPC URL | EVM only | Full http(s) RPC endpoint. |
| External Explorer URL | No | Full http(s) URL. |
| Home Side Mode | Yes |
vault or mint. Choose based on external chain contract capability.
|
| BESC RPC URL / Chain ID / Name | Yes | Required for all setups. BESC side is always part of the bridge. |
| BESC Explorer URL | No | Full http(s) URL. |
| BESC Side Mode | Yes |
vault or mint, independent from home side mode.
|
Gas behavior: BESC queue releases are fixed at
1000 gwei. External EVM uses native gas
estimation. Solana uses native Solana fees.
Step 3: Contracts and Decimals
| Field | Required | Format / Notes |
|---|---|---|
| External Wrapped Primary/Secondary Tokens | EVM only | 0x + 40 hex chars. |
| Primary/Secondary External Decimals | EVM only | Integer 0..30, must match deployed token exactly. |
| BESC Primary/Secondary Token | Yes | 0x + 40 hex chars. |
| BESC Primary/Secondary Signer | Yes | Signer addresses. If BESC mode is vault, must match signer private key wallet. |
| Primary/Secondary BESC Decimals | Yes | Integer 0..30, must match BESC token contracts exactly. |
| Mint Controller Address | No | Optional EVM address for legacy/native fallback paths. |
Critical rule: if conversion between source and destination decimals is non-exact, the bridge rejects the
transfer to prevent accidental over-mint or under-mint.
Step 4: Backend and Infrastructure
| Field | Required | Format / Notes |
|---|---|---|
| Frontend Backend URL | Yes | Full http(s) URL for API base. |
| Public API Key | Yes | Auto-generated by installer; can be rotated before save. |
| CORS Origins | Recommended | Comma-separated http(s) origins. |
| Backend Port | No | Integer 1..65535. |
| Signer Private Key | Yes | 0x + 64 hex chars. Keep private at all times. |
| Postgres Connection String | Recommended | postgres:// or postgresql://. |
| Redis URL | Required for production reliability | redis:// or rediss://. |
Step 5: Solana and ABI
| Field | Required | Format / Notes |
|---|---|---|
| Enable Solana Route | Context | Forced on when external preset is Solana. |
| Solana RPC URL | If Solana route enabled | Full http(s) RPC endpoint. |
| Solana Primary/Secondary Mint | If Solana route enabled | Valid Solana addresses. |
| Primary/Secondary Solana Decimals | If Solana route enabled | Integer 0..30, exact on-chain match required. |
| Solana Bridge Wallet + Private Key | If Solana route enabled | Wallet address with matching secret (base58, JSON keypair, or 0x hex). |
| ABI Override Fields | No | Optional JSON ABI arrays for custom contract behavior. |
Pre-Wizard Data Pack
- Branding details: name, domain, links, logo URL, colors.
- External chain details: preset, RPC, explorer, chain ID, mode.
- BESC details: RPC, chain ID, explorer, mode.
- Token addresses and exact decimals for both lanes on both sides.
- Execution signer private key and signer addresses.
- Infrastructure URLs: Postgres and Redis.
- Solana wallet and mints if Solana route is enabled.