Class ContractMetaMethod<C, M, Data>

constructor

• new ContractMetaMethod<C, M, Data>(contract, methodName, callback, data): ContractMetaMethod<C, M, Data>

• Type Parameters

  • C extends Contract

  • M extends string | number | symbol

  • Data extends MetaMethodExtraParams<any>

  Parameters

  • contract: WrappedContract<C>

  • methodName: M

  • callback: ContractMetaMethodCallback

  • data: Data

  Returns ContractMetaMethod<C, M, Data>

Readonly callback

Readonly contract

Readonly data

Readonly methodName

Static calcBufferedGas

Static utils

attachExtraData

• attachExtraData<ExtraData>(extraData): ContractMetaMethod<C, M, Data & ExtraData>

• Type Parameters

  • ExtraData extends object

  Parameters

  • extraData: ExtraData

  Returns ContractMetaMethod<C, M, Data & ExtraData>

callStatic

• callStatic(dataOverrides?): MetaMethodReturnType<"callStatic", C, M, Data>

• Parameters

  • Optional dataOverrides: MetaMethodExtraParams<"callStatic">

  Returns MetaMethodReturnType<"callStatic", C, M, Data>

connect

• connect(signerOrProvider): ContractMetaMethod<C, M, Data>

• Parameters

  • signerOrProvider: Provider | Signer

  Returns ContractMetaMethod<C, M, Data>

estimateGas

• estimateGas(dataOverrides?): MetaMethodReturnType<"estimateGas", C, M, Data>

• Parameters

  • Optional dataOverrides: MetaMethodExtraParams<"estimateGas">

  Returns MetaMethodReturnType<"estimateGas", C, M, Data>

executeWithMethod

• executeWithMethod<T>(params?): MetaMethodReturnType<T, C, M, Data & {
      method: T;
  }>

• Type Parameters

  • T extends MetaMethodType

  Parameters

  • Optional params: {
        method?: T;
    }

    • Optional method?: T

  Returns MetaMethodReturnType<T, C, M, Data & {
      method: T;
  }>

extractParams

• extractParams(dataOverrides?): MetaMethodReturnType<"extractParams", C, M, Data>

• Parameters

  • Optional dataOverrides: MetaMethodExtraParams<"extractParams">

  Returns MetaMethodReturnType<"extractParams", C, M, Data>

multicallStatic

• multicallStatic(multicallStaticParams?): MetaMethodReturnType<"multicallStatic", C, M, Data>

• Note: When the overrides has only blockTag property (that is, when Multicall.isMulticallOverrides(overrides) is true), multicall is used. Otherwise callStatic is used.

  Parameters

  • multicallStaticParams: MulticallStaticParams = {}

  Returns MetaMethodReturnType<"multicallStatic", C, M, Data>

populateTransaction

• populateTransaction(dataOverrides?): MetaMethodReturnType<"populateTransaction", C, M, Data>

• Parameters

  • Optional dataOverrides: MetaMethodExtraParams<"populateTransaction">

  Returns MetaMethodReturnType<"populateTransaction", C, M, Data>

send

• send(dataOverrides?): MetaMethodReturnType<"send", C, M, Data>

• Parameters

  • Optional dataOverrides: MetaMethodExtraParams<"send">

  Returns MetaMethodReturnType<"send", C, M, Data>

withContract

• withContract(newContract): ContractMetaMethod<C, M, Data>

• Parameters

  • newContract: WrappedContract<C>

  Returns ContractMetaMethod<C, M, Data>

withData

• withData<NewData>(newData): ContractMetaMethod<C, M, NewData>

• Type Parameters

  • NewData extends MetaMethodExtraParams<any>

  Parameters

  • newData: NewData

  Returns ContractMetaMethod<C, M, NewData>

Static attachExtraData

• attachExtraData<T, C, MethodName, Data, ExtraData>(obj, extraData): Awaited<MetaMethodType extends T
      ? AsyncOrSyncType<ReturnType<GetField<C["functions"], MethodName, never>>>
      : T extends "meta-method"
          ? ContractMetaMethod<C, MethodName, Data & ExtraData>
          : T extends "extractParams"
              ? Parameters<GetField<C["callStatic"], MethodName, never>>
              : AsyncOrSyncType<ReturnType<EthersContractMethod<C, T, MethodName>>>>

• Type Parameters

  • T extends MetaMethodType

  • C extends Contract

  • MethodName extends string | number | symbol

  • Data extends MetaMethodExtraParams<T>

  • ExtraData extends object

  Parameters

  • obj: Awaited<MetaMethodType extends T
        ? AsyncOrSyncType<ReturnType<GetField<C["functions"], MethodName, never>>>
        : T extends "meta-method"
            ? ContractMetaMethod<C, MethodName, Data>
            : T extends "extractParams"
                ? Parameters<GetField<C["callStatic"], MethodName, never>>
                : AsyncOrSyncType<ReturnType<EthersContractMethod<C, T, MethodName>>>>

  • extraData: ExtraData

  Returns Awaited<MetaMethodType extends T
      ? AsyncOrSyncType<ReturnType<GetField<C["functions"], MethodName, never>>>
      : T extends "meta-method"
          ? ContractMetaMethod<C, MethodName, Data & ExtraData>
          : T extends "extractParams"
              ? Parameters<GetField<C["callStatic"], MethodName, never>>
              : AsyncOrSyncType<ReturnType<EthersContractMethod<C, T, MethodName>>>>

Static attachExtraDataAsync

• attachExtraDataAsync<T, C, MethodName, Data, ExtraData>(obj, extraData): MetaMethodReturnType<T, C, MethodName, Data & ExtraData>

• Type Parameters

  • T extends MetaMethodType

  • C extends Contract

  • MethodName extends string | number | symbol

  • Data extends MetaMethodExtraParams<T>

  • ExtraData extends object

  Parameters

  • obj: MetaMethodReturnType<T, C, MethodName, Data>

  • extraData: ExtraData

  Returns MetaMethodReturnType<T, C, MethodName, Data & ExtraData>

  Remarks

  This function tries to keeps the obj of type MetaMethodReturnType as generic as possible. If a variable of type MetaMethodReturnType is being awaited, the generic type will be collapsed, hence the type checking might failed.