@beantosser/moneronetworkselector

A basic React UI component for selecting one of the three available Monero networks in any React-based Monero browser application

Usage no npm install needed!

<script type="module">
  import beantosserMoneronetworkselector from 'https://cdn.skypack.dev/@beantosser/moneronetworkselector';
</script>

README

MoneroNetworkSelector

A React UI drop-down menu that allows end users of monero-javascript web applications to select which Monero network to connect the application to

Usage

These instructions only apply to independent use of the NetworkSelector UI component. If you want to use the NetworkSelector in conjunction with the ConnectionManager UI, use the NetworkConnectionCoordinator component

Props

The NetworkSelector component takes two props:

  1. setNetworkType(required): A function to handle the user changing the current network
  2. networkTypes(optional): An array of integer values between 0 and 2. Each integer corresponds to a network type: 0: mainnet 1: stagenet 2: testnet

The array specifies which networks the user should be able to choose from. A valid networkTypes array must contain exactly two or three integer elements between 0 and 2. Some examples of valid networkTypes arrays:

  • [0, 2]
  • [0, 1, 2]
  • [2, 1] Some examples of invalid networkTypes arrays:
  • [0, 0, 1] (repeat values are not allowed)
  • [8, 2] (only the values 0, 1, and 2 are valid)
  • [0] (the array must have at least two elements)
  • [0, 2, 1, 4] (the array must have no more than three elements) Omitting the networkTypes prop will cause the NetworkSelector component to allow the user to choose from among all three Monero networks by default.

Instructions

  1. Place the NetworkSelector.js and NetworkSelector.css files into an appropriate location in your React project. For example: src/components. If your project uses typescript, place the NetworkSelecter.d.ts file in the same directory.
  2. Import the NetworkSelector component into the javascript file that you intend to use the NetworkSelector UI in: import NetworkSelector from "./components/NetworkSelector.js"
  3. Pass the required props to the NetworkSelector component in your JSX implementation:
return(
// Your JSX here
<NetworkSelector 
  setNetworkType = {setNetworkType}
  networkTypeFlags = [0,1]
/>
// Your JSX here
)
  1. Implement the setNetworkType function in your javascript file. The function must accept a monero-javascript MoneroNetworkType value as a parameter. For example:
const setNetworkType = function(networkType) {
  let rpcConnectionUri;
  switch(networkType) {
    case MoneroNetworkType.mainnet:
      rpcConnectionUri = "https://mainnetnode:38081"
      break;
    case MoneroNetworkType.stagenet:
      rpcConnectionUri = "https://stagenetnode:38081"
      break;
    default
      throw("Invalid network type!");
  }
  
  rpcConnection = new MoneroRpcConnection({
    uri: rpcConnectionUri,
    username: username,
    password: password
  });
}