Provider Guide

The Chainflip Provider

interface ChainflipProviderProps {
  children: ReactNode;
  useTestnet?: boolean; // optional prop to switch between testnet and mainnet
  brokerUrl?: string; // optional prop to set the broker url
  backendServiceUrl?: string; // optional prop to set the backend service url
  network?: ChainflipNetwork;
  signer?: Signer;
  commisionBps?: number;
  rpcUrl?: string;
  thirdwebSecretKey?:string;
  mobulaAPIKey?:string;
}

The Props object accepts the following properties below are the common ones from chainflip:

NOTE: The below table is a copy from the chainflip docs all credit to their team. Check out here

ParamDescriptionData type

network(optional)

The Chainflip network to interact with. Defaults to perseverance. See Supported Chains & Assets.

'sisyphos' | 'perseverance' | 'mainnet'

backendServiceUrl(optional)

The URL of the backend service. Defaults to the backend service run by Chainflip for the given network.

string

signer(optional)

An instance of an ethers signer. Only needed for calls that use smart contracts.

Signer

broker(optional)

Optional configuration to use a different broker than provided by Chainflip.

Object

rpcUrl(optional)

The URL of the state chain rpc node. Defaults to the public rpc node operated by Chainflip for the given network.

String

Last updated