useContractRead

Returns a function to execute a view function on a contract.

Usage

import {useContract, useContractRead} from '@incirlabs/react-ethooks';

export default function MyComponent() {
  const MyContract = useContract('0x00', MyContractABI);
  const readBalanceOf = useContractRead(MyContract, 'balanceOf');

  const onSomeAction = async () => {
    const result = await readBalanceOf(['0x123']);

    if (result.status) {
      console.log(`Balance: ${result.data}`);
    } else {
      console.log(`Error: ${result.error.message}`);
    }
  };
}

Parameters

contract

Contract instance returned from useContract or ethers.Contract

Type	Default
ethers.Contract	Required

method

View Function name to call on the contract instance.

Type	Default
string	Required

defaultArgs

Default arguments to pass to the view function.

Type	Default
(string | number)[]	undefined

Returns

Function to execute the view function on the contract instance.

Type
(args: (string | number)[]) => Promise<ContractResult>