Web3Modal

A single Web3 / Ethereum provider solution for all Wallets

Introduction

Web3Modal is an easy-to-use library to help developers add support for multiple providers in their apps with a simple customizable configuration.

By default Web3Modal Library supports injected providers like (Metamask, Dapper, Gnosis Safe, Web3 Browsers, etc) and WalletConnect, You can also easily configure the library to support Portis, Fortmatic, Squarelink, Torus, Authereum and Arkane.

Preview

You can test the library on: https://web3modal.com/

Projects using web3modal

Open a PR to add your project to the list!

• DAO Stack
• Gnosis Safe
• 3Box Hub
• KnownOrigin
• Clovers Network
• Affogato
• Linkdrop
• Dapparatus
• Totle Swap

Related Efforts

• web3-react

Usage

1. Install Web3Modal NPM package

npm install --save web3modal

# OR

yarn add web3modal

2. Install Provider packages

/* See Provider Options Section */

3. Then you can add Web3Modal to your Dapp as follows

import Web3 from "web3";
import Web3Modal from "web3modal";

const providerOptions = {
  /* See Provider Options Section */
};

const web3Modal = new Web3Modal({
  network: "mainnet", // optional
  cacheProvider: true, // optional
  providerOptions // required
});

const provider = await web3Modal.connect();

const web = new Web3(provider);

Provider Options

These are all the providers available with Web3Modal and how to configure their provider options

WalletConnect

1. Install Provider Package

npm install --save @walletconnect/web3-provider

# OR

yarn add @walletconnect/web3-provider

2. Set Provider Options

import WalletConnectProvider from "@walletconnect/web3-provider";

const providerOptions = {
  walletconnect: {
    package: WalletConnectProvider, // required
    options: {
      infuraId: "INFURA_ID" // required
    }
  }
};

Note: A WalletConnect instance is available on the provider as provider.wc

Portis

1. Install Provider Package

npm install --save @portis/web3

# OR

yarn add @portis/web3

2. Set Provider Options

import Portis from "@portis/web3";

const providerOptions = {
  portis: {
    package: Portis, // required
    options: {
      id: "PORTIS_ID" // required
    }
  }
};

Note: A Portis instance is available on the provider as provider._portis

Fortmatic

1. Install Provider Package

npm install --save fortmatic

# OR

yarn add fortmatic

2. Set Provider Options

import Fortmatic from "fortmatic";

const providerOptions = {
  fortmatic: {
    package: Fortmatic, // required
    options: {
      key: "FORTMATIC_KEY" // required
    }
  }
};

Note: A Fortmatic instance is available on the provider as provider.fm

Squarelink

1. Install Provider Package

npm install --save squarelink

# OR

yarn add squarelink

2. Set Provider Options

import Squarelink from "squarelink";

const providerOptions = {
  squarelink: {
    package: Squarelink, // required
    options: {
      id: "SQUARELINK_ID" // required
    }
  }
};

Note: A Squarelink instance is available on the provider as provider.sqlk

Torus

For more info please refer to Torus documentation

1. Install Provider Package

npm install --save @toruslabs/torus-embed

# OR

yarn add @toruslabs/torus-embed

2. Set Provider Options

import Torus from "@toruslabs/torus-embed";

const providerOptions = {
  torus: {
    package: Torus, // required
    options: {
      enableLogging: false, // optional
      buttonPosition: "bottom-left", // optional
      buildEnv: "production", // optional
      showTorusButton: true, // optional
      enabledVerifiers: {
        // optional
        google: false // optional
      }
    }
  }
};

Note: A Torus instance is available on the provider as provider.torus

Arkane

1. Install Provider Package

npm install --save @arkane-network/web3-arkane-provide

# OR

yarn add @arkane-network/web3-arkane-provide

2. Set Provider Options

import Arkane from "@arkane-network/web3-arkane-provider";

const providerOptions = {
  arkane: {
    package: Arkane, // required
    options: {
      clientId: "ARKANE_CLIENT_ID" // required, replace
    }
  }
};

Authereum

1. Install Provider Package

npm install --save authereum

# OR

yarn add authereum

2. Set Provider Options

import Authereum from "authereum";

const providerOptions = {
  authereum: {
    package: Authereum, // required
    options: {}
  }
};

Note: An Authereum instance is available on the provider as provider.authereum

BurnerConnect

1. Install Provider Package

npm install --save @burner-wallet/burner-connect-provider

# OR

yarn add @burner-wallet/burner-connect-provider

2. Set Provider Options

import BurnerConnectProvider from "@burner-wallet/burner-connect-provider";

const providerOptions = {
  burnerconnect: {
    package: BurnerConnectProvider, // required
    options: {}
  }
};

Utils

function checkInjectedProviders(): IInjectedProvidersMap;
function verifyInjectedProvider(check: string): boolean;
function getInjectedProviderName(): string | null;
function getProviderInfoByName(name: string | null): IProviderInfo;
function getProviderInfo(provider: any): IProviderInfo;
function isMobile(): boolean;

Types

interface IInjectedProvidersMap {
  injectedAvailable: boolean;
  [isProviderName: string]: boolean;
}

interface IProviderInfo {
  id: string;
  name: string;
  type: string;
  logo: string;
  check: string;
  package: IProviderPackageOptions;
  styled: IProviderStyledOptions;
}

interface IProviderPackageOptions {
  required: string[];
}

interface IProviderStyledOptions {
  [prop: string]: any;
}

interface IProviderOptions {
  [id: string]: {
    package: any;
    options: any;
  };
}

interface IProviderMappingEntry {
  id: string;
  name: string;
  connector: any;
  package: IProviderPackageOptions;
}

Connect to specific provider

In case you want to connect a specific provider, you can use the method connectTo and use the specific id. Example:

import Web3 from "web3";
import Web3Modal from "web3modal";

const providerOptions = {
  /* See Provider Options Section */
};

const web3Modal = new Web3Modal({
  network: "mainnet", // optional
  cacheProvider: true, // optional
  providerOptions // required
});

const provider = await web3Modal.connectTo("walletconnect");

const web = new Web3(provider);

Optional Flags

Disable Injected Provider

By default is set to false and Web3Modal always displays InjectedProvider as an option to the user if available. However you can disable it as an optional flag if you desire:

const web3Modal = new Web3Modal({ disableInjectedProvider: true });

Cache Provider

By default is set to false and Web3Modal will always require the user to choose a provider option before triggering the onConnect event. However you can enable caching the last chosen provider. Example:

const web3Modal = new Web3Modal({ cacheProvider: true });

If you wish to reset the cached provider you can call the following method:

web3Modal.clearCachedProvider();

If you wish to connect to the cachedProvider you can simply do the following:

if (web3Modal.cachedProvider) {
  await web3Modal.connect();
}

Adding a new provider

Do you want to add your provider to Web3Modal? All logic for supported providers lives inside the src/providers directory. To add a new follow the following steps here

Migrating from Web3Connect

If you were using Web3Connect before you can check the migration instructions for how to use Web3Modal and handle breaking changes here

Collaboration

Code contributions are welcome ❤️❤️❤️!

If you wish to support a new provider submit a issue to the repo or fork this repo and create a pull request.

You can join to our discord to further discuss https://discordapp.com/invite/YGnSX9y