Networks

The networks option defines which Stellar networks your app supports. If a connected wallet is on a network not in this list, Blux will prompt the user to switch.

Available Networks

import { core } from "@bluxcc/core";

// core.networks exposes:
{
  mainnet:    'Public Global Stellar Network ; September 2015',
  testnet:    'Test SDF Network ; September 2015',
  sandbox:    'Local Sandbox Stellar Network ; September 2022',
  futurenet:  'Test SDF Future Network ; October 2022',
  standalone: 'Standalone Network ; February 2017',
}

Usage

<BluxProvider
  config={{
    appName: "MyApp",
    networks: [networks.mainnet, networks.testnet],
    defaultNetwork: networks.mainnet,
  }}
>
  {children}
</BluxProvider>

import { core } from "@bluxcc/core";

createConfig({
  appName: "My App",
  networks: [core.networks.mainnet, core.networks.testnet],
  defaultNetwork: core.networks.mainnet,
});

If you only pass one network, defaultNetwork is optional — Blux will use the first item in the array automatically. You can change the active network later using switchNetwork().

Custom Networks

If you need a network not in the built-in list, define it as a string and pass it to the networks array:

const customNetwork = "Standalone Network ; February 2020";

createConfig({
  appName: "MyApp",
  networks: [customNetwork],
});

Make sure to also define a transport for any custom network. See the Transports page for details.

Auto Sync

Blux periodically checks the connected wallet's active network. By default, it keeps the app's network in sync with the wallet — as long as the wallet's network is one of the supported networks in your config.

If your app calls switchNetwork() directly, Blux treats that as an app-controlled override and disables automatic syncing from that point on to prevent conflicts.

Example

Given this config:

{
  networks: [networks.testnet, networks.futurenet],
}