Class Contract<ContractAbi>

constructor

• new Contract<ContractAbi>(config, address): Contract<ContractAbi>

• Creates an instance of Contract.

  Type Parameters

  • ContractAbi extends Abi

  Parameters

  • config: Config
  • address: undefined | `0x${string}`

  Returns Contract<ContractAbi>

Readonlyabi

address

• get address(): undefined | `0x${string}`

• A getter returning this contract's deployed address, if it exists.

  Returns undefined | `0x${string}`

config

• get config(): Config

• A getter returning this contract's Wagmi configuration.

  Returns Config

at

• at(address): Contract<ContractAbi>

• Will set this contract's address and return the instance for chaining. Does not verify that provided address is valid.

  Parameters

  • address: `0x${string}`

  Returns Contract<ContractAbi>

withConfig

• withConfig(config): Contract<ContractAbi>

• Will set this contract's internal Wagmi Configuration and return the instance for chaining.

  Parameters

  • config: Config

  Returns Contract<ContractAbi>

assertValidAddress

• assertValidAddress(): `0x${string}`

• Utility function to validate the existence of an address on this Contract.

  Returns `0x${string}`

  Throws

  ContractAddressRequiredError if no address exists on this Contract instance

getLogs

• getLogs<event, const abiEvent>(params?): Promise<GetLogsReturnType<abiEvent, abiEvent[]>>

• A typed wrapper for (viem.getLogs)[https://viem.sh/docs/actions/public/getLogs#getlogs]. Accepts eventName and eventNames as optional parameters to narrow the returned log types.

  Type Parameters

  • event extends string
  • const abiEvent extends {
        name: event;
    } & AbiEvent = ExtractAbiEvent<ContractAbi, event>

  Parameters

  • Optionalparams: Omit<GetLogsParams<ContractAbi, event, abiEvent, abiEvent[]>, "event" | "events"> & {
        eventName?: event;
        eventNames?: event[];
    }

  Returns Promise<GetLogsReturnType<abiEvent, abiEvent[]>>

  Example

  const logs = contract.getLogs({ eventName: 'EventName' })
  const logs = contract.getLogs({ eventNames: ['EventName'] })
  
  @public
  @async
  @template {ContractEvent} event
  @template {ExtractAbiEvent<
        ContractAbi,
        event
      >} [abiEvent=ExtractAbiEvent<ContractAbi, event>]
  @param {?Omit<
        GetLogsParams<ContractAbi, event, abiEvent, abiEvent[]>,
        'event' | 'events'
      > & {
        eventName?: event;
        eventNames?: event[];
      }} [params]
  @returns {Promise<GetLogsReturnType<abiEvent, abiEvent
  Copy

subscribe

• subscribe<event>(cb, params?): (() => void)

• A typed wrapper for wagmi.watchContractEvent

  Type Parameters

  • event extends string

  Parameters

  • cb: ((log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number]) => unknown)
    • • (log): unknown

      • Parameters

        • log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number]

        Returns unknown

  • Optionalparams: Partial<Omit<UnionCompute<WatchContractEventParameters<ContractAbi, event, undefined, WebSocketTransport> & ChainIdParameter<Config, number> & SyncConnectedChainParameter>, "address" | "abi">> & {
        eventName?: event;
    }

  Returns (() => void)

  • • (): void

    • Returns void