@zkp2p/contracts-v2/types/contracts/ProtocolViewer.ts

ZKP2P V2 smart contract interfaces and utilities

/* Autogenerated file. Do not edit manually. */
/* tslint:disable */
/* eslint-disable */
import type {
  BaseContract,
  BigNumber,
  BigNumberish,
  BytesLike,
  CallOverrides,
  PopulatedTransaction,
  Signer,
  utils,
} from "ethers";
import type { FunctionFragment, Result } from "@ethersproject/abi";
import type { Listener, Provider } from "@ethersproject/providers";
import type {
  TypedEventFilter,
  TypedEvent,
  TypedListener,
  OnEvent,
  PromiseOrValue,
} from "../common";

export declare namespace IEscrow {
  export type RangeStruct = {
    min: PromiseOrValue<BigNumberish>;
    max: PromiseOrValue<BigNumberish>;
  };

  export type RangeStructOutput = [BigNumber, BigNumber] & {
    min: BigNumber;
    max: BigNumber;
  };

  export type DepositStruct = {
    depositor: PromiseOrValue<string>;
    delegate: PromiseOrValue<string>;
    token: PromiseOrValue<string>;
    intentAmountRange: IEscrow.RangeStruct;
    acceptingIntents: PromiseOrValue<boolean>;
    remainingDeposits: PromiseOrValue<BigNumberish>;
    outstandingIntentAmount: PromiseOrValue<BigNumberish>;
    intentGuardian: PromiseOrValue<string>;
    retainOnEmpty: PromiseOrValue<boolean>;
  };

  export type DepositStructOutput = [
    string,
    string,
    string,
    IEscrow.RangeStructOutput,
    boolean,
    BigNumber,
    BigNumber,
    string,
    boolean
  ] & {
    depositor: string;
    delegate: string;
    token: string;
    intentAmountRange: IEscrow.RangeStructOutput;
    acceptingIntents: boolean;
    remainingDeposits: BigNumber;
    outstandingIntentAmount: BigNumber;
    intentGuardian: string;
    retainOnEmpty: boolean;
  };

  export type DepositPaymentMethodDataStruct = {
    intentGatingService: PromiseOrValue<string>;
    payeeDetails: PromiseOrValue<BytesLike>;
    data: PromiseOrValue<BytesLike>;
  };

  export type DepositPaymentMethodDataStructOutput = [
    string,
    string,
    string
  ] & { intentGatingService: string; payeeDetails: string; data: string };

  export type CurrencyStruct = {
    code: PromiseOrValue<BytesLike>;
    minConversionRate: PromiseOrValue<BigNumberish>;
  };

  export type CurrencyStructOutput = [string, BigNumber] & {
    code: string;
    minConversionRate: BigNumber;
  };
}

export declare namespace IProtocolViewer {
  export type PaymentMethodDataViewStruct = {
    paymentMethod: PromiseOrValue<BytesLike>;
    verificationData: IEscrow.DepositPaymentMethodDataStruct;
    currencies: IEscrow.CurrencyStruct[];
  };

  export type PaymentMethodDataViewStructOutput = [
    string,
    IEscrow.DepositPaymentMethodDataStructOutput,
    IEscrow.CurrencyStructOutput[]
  ] & {
    paymentMethod: string;
    verificationData: IEscrow.DepositPaymentMethodDataStructOutput;
    currencies: IEscrow.CurrencyStructOutput[];
  };

  export type DepositViewStruct = {
    depositId: PromiseOrValue<BigNumberish>;
    deposit: IEscrow.DepositStruct;
    availableLiquidity: PromiseOrValue<BigNumberish>;
    paymentMethods: IProtocolViewer.PaymentMethodDataViewStruct[];
    intentHashes: PromiseOrValue<BytesLike>[];
  };

  export type DepositViewStructOutput = [
    BigNumber,
    IEscrow.DepositStructOutput,
    BigNumber,
    IProtocolViewer.PaymentMethodDataViewStructOutput[],
    string[]
  ] & {
    depositId: BigNumber;
    deposit: IEscrow.DepositStructOutput;
    availableLiquidity: BigNumber;
    paymentMethods: IProtocolViewer.PaymentMethodDataViewStructOutput[];
    intentHashes: string[];
  };

  export type IntentViewStruct = {
    intentHash: PromiseOrValue<BytesLike>;
    intent: IOrchestrator.IntentStruct;
    deposit: IProtocolViewer.DepositViewStruct;
  };

  export type IntentViewStructOutput = [
    string,
    IOrchestrator.IntentStructOutput,
    IProtocolViewer.DepositViewStructOutput
  ] & {
    intentHash: string;
    intent: IOrchestrator.IntentStructOutput;
    deposit: IProtocolViewer.DepositViewStructOutput;
  };
}

export declare namespace IOrchestrator {
  export type IntentStruct = {
    owner: PromiseOrValue<string>;
    to: PromiseOrValue<string>;
    escrow: PromiseOrValue<string>;
    depositId: PromiseOrValue<BigNumberish>;
    amount: PromiseOrValue<BigNumberish>;
    timestamp: PromiseOrValue<BigNumberish>;
    paymentMethod: PromiseOrValue<BytesLike>;
    fiatCurrency: PromiseOrValue<BytesLike>;
    conversionRate: PromiseOrValue<BigNumberish>;
    payeeId: PromiseOrValue<BytesLike>;
    referrer: PromiseOrValue<string>;
    referrerFee: PromiseOrValue<BigNumberish>;
    postIntentHook: PromiseOrValue<string>;
    data: PromiseOrValue<BytesLike>;
  };

  export type IntentStructOutput = [
    string,
    string,
    string,
    BigNumber,
    BigNumber,
    BigNumber,
    string,
    string,
    BigNumber,
    string,
    string,
    BigNumber,
    string,
    string
  ] & {
    owner: string;
    to: string;
    escrow: string;
    depositId: BigNumber;
    amount: BigNumber;
    timestamp: BigNumber;
    paymentMethod: string;
    fiatCurrency: string;
    conversionRate: BigNumber;
    payeeId: string;
    referrer: string;
    referrerFee: BigNumber;
    postIntentHook: string;
    data: string;
  };
}

export interface ProtocolViewerInterface extends utils.Interface {
  functions: {
    "escrowContract()": FunctionFragment;
    "getAccountDeposits(address)": FunctionFragment;
    "getAccountIntents(address)": FunctionFragment;
    "getDeposit(uint256)": FunctionFragment;
    "getDepositFromIds(uint256[])": FunctionFragment;
    "getIntent(bytes32)": FunctionFragment;
    "getIntents(bytes32[])": FunctionFragment;
    "orchestrator()": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "escrowContract"
      | "getAccountDeposits"
      | "getAccountIntents"
      | "getDeposit"
      | "getDepositFromIds"
      | "getIntent"
      | "getIntents"
      | "orchestrator"
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: "escrowContract",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "getAccountDeposits",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "getAccountIntents",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "getDeposit",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "getDepositFromIds",
    values: [PromiseOrValue<BigNumberish>[]]
  ): string;
  encodeFunctionData(
    functionFragment: "getIntent",
    values: [PromiseOrValue<BytesLike>]
  ): string;
  encodeFunctionData(
    functionFragment: "getIntents",
    values: [PromiseOrValue<BytesLike>[]]
  ): string;
  encodeFunctionData(
    functionFragment: "orchestrator",
    values?: undefined
  ): string;

  decodeFunctionResult(
    functionFragment: "escrowContract",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getAccountDeposits",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getAccountIntents",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "getDeposit", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "getDepositFromIds",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "getIntent", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "getIntents", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "orchestrator",
    data: BytesLike
  ): Result;

  events: {};
}

export interface ProtocolViewer extends BaseContract {
  connect(signerOrProvider: Signer | Provider | string): this;
  attach(addressOrName: string): this;
  deployed(): Promise<this>;

  interface: ProtocolViewerInterface;

  queryFilter<TEvent extends TypedEvent>(
    event: TypedEventFilter<TEvent>,
    fromBlockOrBlockhash?: string | number | undefined,
    toBlock?: string | number | undefined
  ): Promise<Array<TEvent>>;

  listeners<TEvent extends TypedEvent>(
    eventFilter?: TypedEventFilter<TEvent>
  ): Array<TypedListener<TEvent>>;
  listeners(eventName?: string): Array<Listener>;
  removeAllListeners<TEvent extends TypedEvent>(
    eventFilter: TypedEventFilter<TEvent>
  ): this;
  removeAllListeners(eventName?: string): this;
  off: OnEvent<this>;
  on: OnEvent<this>;
  once: OnEvent<this>;
  removeListener: OnEvent<this>;

  functions: {
    escrowContract(overrides?: CallOverrides): Promise<[string]>;

    getAccountDeposits(
      _account: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<
      [IProtocolViewer.DepositViewStructOutput[]] & {
        depositArray: IProtocolViewer.DepositViewStructOutput[];
      }
    >;

    getAccountIntents(
      _account: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<
      [IProtocolViewer.IntentViewStructOutput[]] & {
        intentViews: IProtocolViewer.IntentViewStructOutput[];
      }
    >;

    getDeposit(
      _depositId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<
      [IProtocolViewer.DepositViewStructOutput] & {
        depositView: IProtocolViewer.DepositViewStructOutput;
      }
    >;

    getDepositFromIds(
      _depositIds: PromiseOrValue<BigNumberish>[],
      overrides?: CallOverrides
    ): Promise<
      [IProtocolViewer.DepositViewStructOutput[]] & {
        depositArray: IProtocolViewer.DepositViewStructOutput[];
      }
    >;

    getIntent(
      _intentHash: PromiseOrValue<BytesLike>,
      overrides?: CallOverrides
    ): Promise<
      [IProtocolViewer.IntentViewStructOutput] & {
        intentView: IProtocolViewer.IntentViewStructOutput;
      }
    >;

    getIntents(
      _intentHashes: PromiseOrValue<BytesLike>[],
      overrides?: CallOverrides
    ): Promise<
      [IProtocolViewer.IntentViewStructOutput[]] & {
        intentArray: IProtocolViewer.IntentViewStructOutput[];
      }
    >;

    orchestrator(overrides?: CallOverrides): Promise<[string]>;
  };

  escrowContract(overrides?: CallOverrides): Promise<string>;

  getAccountDeposits(
    _account: PromiseOrValue<string>,
    overrides?: CallOverrides
  ): Promise<IProtocolViewer.DepositViewStructOutput[]>;

  getAccountIntents(
    _account: PromiseOrValue<string>,
    overrides?: CallOverrides
  ): Promise<IProtocolViewer.IntentViewStructOutput[]>;

  getDeposit(
    _depositId: PromiseOrValue<BigNumberish>,
    overrides?: CallOverrides
  ): Promise<IProtocolViewer.DepositViewStructOutput>;

  getDepositFromIds(
    _depositIds: PromiseOrValue<BigNumberish>[],
    overrides?: CallOverrides
  ): Promise<IProtocolViewer.DepositViewStructOutput[]>;

  getIntent(
    _intentHash: PromiseOrValue<BytesLike>,
    overrides?: CallOverrides
  ): Promise<IProtocolViewer.IntentViewStructOutput>;

  getIntents(
    _intentHashes: PromiseOrValue<BytesLike>[],
    overrides?: CallOverrides
  ): Promise<IProtocolViewer.IntentViewStructOutput[]>;

  orchestrator(overrides?: CallOverrides): Promise<string>;

  callStatic: {
    escrowContract(overrides?: CallOverrides): Promise<string>;

    getAccountDeposits(
      _account: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<IProtocolViewer.DepositViewStructOutput[]>;

    getAccountIntents(
      _account: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<IProtocolViewer.IntentViewStructOutput[]>;

    getDeposit(
      _depositId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<IProtocolViewer.DepositViewStructOutput>;

    getDepositFromIds(
      _depositIds: PromiseOrValue<BigNumberish>[],
      overrides?: CallOverrides
    ): Promise<IProtocolViewer.DepositViewStructOutput[]>;

    getIntent(
      _intentHash: PromiseOrValue<BytesLike>,
      overrides?: CallOverrides
    ): Promise<IProtocolViewer.IntentViewStructOutput>;

    getIntents(
      _intentHashes: PromiseOrValue<BytesLike>[],
      overrides?: CallOverrides
    ): Promise<IProtocolViewer.IntentViewStructOutput[]>;

    orchestrator(overrides?: CallOverrides): Promise<string>;
  };

  filters: {};

  estimateGas: {
    escrowContract(overrides?: CallOverrides): Promise<BigNumber>;

    getAccountDeposits(
      _account: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getAccountIntents(
      _account: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getDeposit(
      _depositId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getDepositFromIds(
      _depositIds: PromiseOrValue<BigNumberish>[],
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getIntent(
      _intentHash: PromiseOrValue<BytesLike>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getIntents(
      _intentHashes: PromiseOrValue<BytesLike>[],
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    orchestrator(overrides?: CallOverrides): Promise<BigNumber>;
  };

  populateTransaction: {
    escrowContract(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    getAccountDeposits(
      _account: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    getAccountIntents(
      _account: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    getDeposit(
      _depositId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    getDepositFromIds(
      _depositIds: PromiseOrValue<BigNumberish>[],
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    getIntent(
      _intentHash: PromiseOrValue<BytesLike>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    getIntents(
      _intentHashes: PromiseOrValue<BytesLike>[],
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    orchestrator(overrides?: CallOverrides): Promise<PopulatedTransaction>;
  };
}