descent-js/src/generated/VaultGetters.ts

A Typescript library for interacting with the Descent Protocol

/* Autogenerated file. Do not edit manually. */
/* tslint:disable */
/* eslint-disable */
import type {
  BaseContract,
  BytesLike,
  FunctionFragment,
  Result,
  Interface,
  AddressLike,
  ContractRunner,
  ContractMethod,
  Listener,
} from 'ethers';
import type {
  TypedContractEvent,
  TypedDeferredTopicFilter,
  TypedEventLog,
  TypedListener,
  TypedContractMethod,
} from './common';

export interface VaultGettersInterface extends Interface {
  getFunction(
    nameOrSignature:
      | 'getCollateralInfo'
      | 'getCollateralRatio'
      | 'getHealthFactor'
      | 'getMaxBorrowable'
      | 'getMaxWithdrawable'
      | 'getVault'
      | 'isReliedUpon',
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: 'getCollateralInfo',
    values: [AddressLike, AddressLike],
  ): string;
  encodeFunctionData(
    functionFragment: 'getCollateralRatio',
    values: [AddressLike, AddressLike, AddressLike],
  ): string;
  encodeFunctionData(
    functionFragment: 'getHealthFactor',
    values: [AddressLike, AddressLike, AddressLike],
  ): string;
  encodeFunctionData(
    functionFragment: 'getMaxBorrowable',
    values: [AddressLike, AddressLike, AddressLike],
  ): string;
  encodeFunctionData(
    functionFragment: 'getMaxWithdrawable',
    values: [AddressLike, AddressLike, AddressLike],
  ): string;
  encodeFunctionData(
    functionFragment: 'getVault',
    values: [AddressLike, AddressLike, AddressLike],
  ): string;
  encodeFunctionData(
    functionFragment: 'isReliedUpon',
    values: [AddressLike, AddressLike, AddressLike],
  ): string;

  decodeFunctionResult(functionFragment: 'getCollateralInfo', data: BytesLike): Result;
  decodeFunctionResult(functionFragment: 'getCollateralRatio', data: BytesLike): Result;
  decodeFunctionResult(functionFragment: 'getHealthFactor', data: BytesLike): Result;
  decodeFunctionResult(functionFragment: 'getMaxBorrowable', data: BytesLike): Result;
  decodeFunctionResult(functionFragment: 'getMaxWithdrawable', data: BytesLike): Result;
  decodeFunctionResult(functionFragment: 'getVault', data: BytesLike): Result;
  decodeFunctionResult(functionFragment: 'isReliedUpon', data: BytesLike): Result;
}

export interface VaultGetters extends BaseContract {
  connect(runner?: ContractRunner | null): VaultGetters;
  waitForDeployment(): Promise<this>;

  interface: VaultGettersInterface;

  queryFilter<TCEvent extends TypedContractEvent>(
    event: TCEvent,
    fromBlockOrBlockhash?: string | number | undefined,
    toBlock?: string | number | undefined,
  ): Promise<Array<TypedEventLog<TCEvent>>>;
  queryFilter<TCEvent extends TypedContractEvent>(
    filter: TypedDeferredTopicFilter<TCEvent>,
    fromBlockOrBlockhash?: string | number | undefined,
    toBlock?: string | number | undefined,
  ): Promise<Array<TypedEventLog<TCEvent>>>;

  on<TCEvent extends TypedContractEvent>(
    event: TCEvent,
    listener: TypedListener<TCEvent>,
  ): Promise<this>;
  on<TCEvent extends TypedContractEvent>(
    filter: TypedDeferredTopicFilter<TCEvent>,
    listener: TypedListener<TCEvent>,
  ): Promise<this>;

  once<TCEvent extends TypedContractEvent>(
    event: TCEvent,
    listener: TypedListener<TCEvent>,
  ): Promise<this>;
  once<TCEvent extends TypedContractEvent>(
    filter: TypedDeferredTopicFilter<TCEvent>,
    listener: TypedListener<TCEvent>,
  ): Promise<this>;

  listeners<TCEvent extends TypedContractEvent>(
    event: TCEvent,
  ): Promise<Array<TypedListener<TCEvent>>>;
  listeners(eventName?: string): Promise<Array<Listener>>;
  removeAllListeners<TCEvent extends TypedContractEvent>(event?: TCEvent): Promise<this>;

  getCollateralInfo: TypedContractMethod<
    [_vaultContract: AddressLike, _collateralToken: AddressLike],
    [[bigint, bigint, bigint, bigint, bigint, bigint, bigint]],
    'view'
  >;

  getCollateralRatio: TypedContractMethod<
    [_vaultContract: AddressLike, _collateralToken: AddressLike, _owner: AddressLike],
    [bigint],
    'view'
  >;

  getHealthFactor: TypedContractMethod<
    [_vaultContract: AddressLike, _collateralToken: AddressLike, _owner: AddressLike],
    [boolean],
    'view'
  >;

  getMaxBorrowable: TypedContractMethod<
    [_vaultContract: AddressLike, _collateralToken: AddressLike, _owner: AddressLike],
    [bigint],
    'view'
  >;

  getMaxWithdrawable: TypedContractMethod<
    [_vaultContract: AddressLike, _collateralToken: AddressLike, _owner: AddressLike],
    [bigint],
    'view'
  >;

  getVault: TypedContractMethod<
    [_vaultContract: AddressLike, _collateralToken: AddressLike, _owner: AddressLike],
    [[bigint, bigint, bigint]],
    'view'
  >;

  isReliedUpon: TypedContractMethod<
    [_vaultContract: AddressLike, _owner: AddressLike, _reliedUpon: AddressLike],
    [boolean],
    'view'
  >;

  getFunction<T extends ContractMethod = ContractMethod>(key: string | FunctionFragment): T;

  getFunction(
    nameOrSignature: 'getCollateralInfo',
  ): TypedContractMethod<
    [_vaultContract: AddressLike, _collateralToken: AddressLike],
    [[bigint, bigint, bigint, bigint, bigint, bigint, bigint]],
    'view'
  >;
  getFunction(
    nameOrSignature: 'getCollateralRatio',
  ): TypedContractMethod<
    [_vaultContract: AddressLike, _collateralToken: AddressLike, _owner: AddressLike],
    [bigint],
    'view'
  >;
  getFunction(
    nameOrSignature: 'getHealthFactor',
  ): TypedContractMethod<
    [_vaultContract: AddressLike, _collateralToken: AddressLike, _owner: AddressLike],
    [boolean],
    'view'
  >;
  getFunction(
    nameOrSignature: 'getMaxBorrowable',
  ): TypedContractMethod<
    [_vaultContract: AddressLike, _collateralToken: AddressLike, _owner: AddressLike],
    [bigint],
    'view'
  >;
  getFunction(
    nameOrSignature: 'getMaxWithdrawable',
  ): TypedContractMethod<
    [_vaultContract: AddressLike, _collateralToken: AddressLike, _owner: AddressLike],
    [bigint],
    'view'
  >;
  getFunction(
    nameOrSignature: 'getVault',
  ): TypedContractMethod<
    [_vaultContract: AddressLike, _collateralToken: AddressLike, _owner: AddressLike],
    [[bigint, bigint, bigint]],
    'view'
  >;
  getFunction(
    nameOrSignature: 'isReliedUpon',
  ): TypedContractMethod<
    [_vaultContract: AddressLike, _owner: AddressLike, _reliedUpon: AddressLike],
    [boolean],
    'view'
  >;

  filters: {};
}