DOCS


useContractRead

Defined in react-core/src/evm/hooks/async/contracts.ts#L520

Get data from a contract read-function call

function useContractRead<
  TContractAddress extends string,
  TContract extends ValidContractInstance,
  TContractInstance extends ValidContractInstance,
  TFunctionName extends string,
  TArgs extends unknown[],
  TReturnType extends any,
>(
  contract: TContractInstance extends ValidContractInstance
    ? RequiredParam<TContractInstance>
    : TContractAddress extends never
    ? RequiredParam<
        SmartContract<BaseContractForAddress<TContractAddress>>
      >
    : RequiredParam<SmartContract<BaseContract>>,
  functionName: RequiredParam<TFunctionName & string>,
  args?: TArgs,
  overrides?: CallOverrides,
): UseQueryResult<TReturnType, unknown>;

Parameters


Returns

a response object that includes the data returned by the function call

type ReturnType = UseQueryResult<TReturnType, unknown>;

Example

const { contract } = useContract("{{contract_address}}");
const { data, isLoading, error } = useContractRead(
  contract,
  "functionName",
  ...args,
);