@rastaracoon/web3-context
TypeScript icon, indicating that this package has built-in type declarations

1.3.1 • Public • Published

Web3-Context

A React Context wrapper for Blocknative OnbardJS

How to use

Wrap you application in a

<Web3Provider networkIds={[1]}>
    {YOUR APP CODE}
</Web3Provider>

The following props can be passed in to configure the Web3 Provider:

  onboardConfig?: OnboardConfig; // The OnboardJS Configuration object - See [here](https://docs.blocknative.com/onboard#built-in-modules)
  networkIds?: number[]; // Defaults to 1 if nothing is provided
  ethGasStationApiKey?: string;
  gasPricePollingInterval?: number; //Seconds between gas price polls. Defaults to 0 - Disabled
  gasPriceSetting?: EthGasStationSettings | EtherchainGasSettings;
  tokensToWatch?: TokensToWatch; // Network-keyed collection of token addresses to watch
  spenderAddress?: string;
  cacheWalletSelection?: boolean;
  checkNetwork?: boolean; // Defaults to true if networkIds are provided
  children: React.ReactNode;

Anywhere further down the component tree, use:

  const {address} = useWeb3();

Take a look at the example folder for a basic implementation of the components.

Happy Building ♡

Package Sidebar

Install

npm i @rastaracoon/web3-context

Weekly Downloads

0

Version

1.3.1

License

GPL-3.0

Unpacked Size

805 kB

Total Files

10

Last publish

Collaborators

  • julien__