wbhob / eth-hooks

🖇 React library of commonly used Ethereum hooks

🖇 Hooks

Commonly used Ethereum hooks.

Install

yarn add eth-hooks

API

useOnBlock(provider, fn)

useOnBlock(
  provider,
  () => {
  //do something cool on each new block
  }
);

usePoller(fn, delay, extraWatch)

Runs a function on app load and then on a custom interval.

usePoller(() => {
  //do something cool at start and then every three seconds
}, 3000);

useBalance(provider, address, [pollTime])

Poll for the balance of an address from a provider.

const localBalance = useBalance(localProvider, address);

useBlockNumber(provider, [pollTime])

Get current block number from a provider.

const blockNumber = useBlockNumber(props.provider);

useContractLoader(providerOrSigner, config)

Loads contracts provided in config arg.

const contractsConfig = {
  hardhatContracts: hardhatContractsList,
  externalContracts: externalContractsList
}

const contracts = useContractLoader(provider, contractsConfig);

useContractReader(contracts, contractName, functionName, [args], [pollTime])

Reads a variable from your contract and keeps it in the state.

const balance = useContractReader(contracts, "MyToken", "balanceOf", ["0xde769Dcc704c7Ec4BC2Dd996dfbb997e89995c5a"]);
const owner = useContractReader(contracts, "MyContract", "owner");

useEventListener(contracts, contractName, eventName, provider, startBlock)

Reads all past events from a smart contract and keeps them in the state.

const eventLog = useEventListener(contract, "MyContract", "Event", provider, 0);

useNonce(provider, address)

Reads the current nonce of an account

const nonce = useNonce(props.localprovider, address);

useTimestamp(provider)

Reads the timestamp of the most recent block

const timestamp = useTimestamp(props.localprovider);

useTokenBalance(contract, address)

Reads the ERC20 token balance of an account

const tokenBalance = useTokenBalance(contract, addess);