@ardier16/q-js-sdk/lib/web3-contracts/GSNPaymaster.d.ts

Typescript Library to interact with Q System Contracts

/* Autogenerated file. Do not edit manually. */
/* tslint:disable */
/* eslint-disable */

import BN from "bn.js";
import { ContractOptions } from "web3-eth-contract";
import { EventLog } from "web3-core";
import { EventEmitter } from "events";
import {
  Callback,
  PayableTransactionObject,
  NonPayableTransactionObject,
  BlockType,
  ContractEventLog,
  BaseContract,
} from "./types";

interface EventOptions {
  filter?: object;
  fromBlock?: BlockType;
  topics?: string[];
}

export type AddressAddedToWhitelist = ContractEventLog<{
  client: string;
  0: string;
}>;
export type AddressDroppedFromWhitelist = ContractEventLog<{
  client: string;
  0: string;
}>;
export type OwnershipTransferred = ContractEventLog<{
  previousOwner: string;
  newOwner: string;
  0: string;
  1: string;
}>;
export type PostRelayed = ContractEventLog<{
  0: [string];
}>;
export type PreRelayed = ContractEventLog<{
  0: [string];
}>;

export interface GSNPaymaster extends BaseContract {
  constructor(
    jsonInterface: any[],
    address?: string,
    options?: ContractOptions
  ): GSNPaymaster;
  clone(): GSNPaymaster;
  methods: {
    CALLDATA_SIZE_LIMIT(): NonPayableTransactionObject<string>;

    FORWARDER_HUB_OVERHEAD(): NonPayableTransactionObject<string>;

    PAYMASTER_ACCEPTANCE_BUDGET(): NonPayableTransactionObject<string>;

    POST_RELAYED_CALL_GAS_LIMIT(): NonPayableTransactionObject<string>;

    PRE_RELAYED_CALL_GAS_LIMIT(): NonPayableTransactionObject<string>;

    _verifyForwarder(
      relayRequest: [
        [
          string,
          string,
          number | string | BN,
          number | string | BN,
          number | string | BN,
          string | number[],
          number | string | BN
        ],
        [
          number | string | BN,
          number | string | BN,
          number | string | BN,
          string,
          string,
          string,
          string | number[],
          number | string | BN
        ]
      ]
    ): NonPayableTransactionObject<void>;

    clients(arg0: string): NonPayableTransactionObject<boolean>;

    getGasAndDataLimits(): NonPayableTransactionObject<
      [string, string, string, string]
    >;

    getHubAddr(): NonPayableTransactionObject<string>;

    getRelayHubDeposit(): NonPayableTransactionObject<string>;

    owner(): NonPayableTransactionObject<string>;

    renounceOwnership(): NonPayableTransactionObject<void>;

    setRelayHub(hub: string): NonPayableTransactionObject<void>;

    setTrustedForwarder(forwarder: string): NonPayableTransactionObject<void>;

    stc(): NonPayableTransactionObject<string>;

    transferOwnership(newOwner: string): NonPayableTransactionObject<void>;

    trustedForwarder(): NonPayableTransactionObject<string>;

    withdrawRelayHubDepositTo(
      amount: number | string | BN,
      target: string
    ): NonPayableTransactionObject<void>;

    preRelayedCall(
      relayRequest: [
        [
          string,
          string,
          number | string | BN,
          number | string | BN,
          number | string | BN,
          string | number[],
          number | string | BN
        ],
        [
          number | string | BN,
          number | string | BN,
          number | string | BN,
          string,
          string,
          string,
          string | number[],
          number | string | BN
        ]
      ],
      signature: string | number[],
      approvalData: string | number[],
      maxPossibleGas: number | string | BN
    ): NonPayableTransactionObject<{
      context: string;
      0: string;
      1: boolean;
    }>;

    postRelayedCall(
      context: string | number[],
      success: boolean,
      gasUseWithoutPost: number | string | BN,
      relayData: [
        number | string | BN,
        number | string | BN,
        number | string | BN,
        string,
        string,
        string,
        string | number[],
        number | string | BN
      ]
    ): NonPayableTransactionObject<void>;

    versionPaymaster(): NonPayableTransactionObject<string>;

    addToWhitelist(_clients: string[]): NonPayableTransactionObject<void>;

    dropFromWhitelist(_clients: string[]): NonPayableTransactionObject<void>;
  };
  events: {
    AddressAddedToWhitelist(
      cb?: Callback<AddressAddedToWhitelist>
    ): EventEmitter;
    AddressAddedToWhitelist(
      options?: EventOptions,
      cb?: Callback<AddressAddedToWhitelist>
    ): EventEmitter;

    AddressDroppedFromWhitelist(
      cb?: Callback<AddressDroppedFromWhitelist>
    ): EventEmitter;
    AddressDroppedFromWhitelist(
      options?: EventOptions,
      cb?: Callback<AddressDroppedFromWhitelist>
    ): EventEmitter;

    OwnershipTransferred(cb?: Callback<OwnershipTransferred>): EventEmitter;
    OwnershipTransferred(
      options?: EventOptions,
      cb?: Callback<OwnershipTransferred>
    ): EventEmitter;

    PostRelayed(cb?: Callback<PostRelayed>): EventEmitter;
    PostRelayed(
      options?: EventOptions,
      cb?: Callback<PostRelayed>
    ): EventEmitter;

    PreRelayed(cb?: Callback<PreRelayed>): EventEmitter;
    PreRelayed(options?: EventOptions, cb?: Callback<PreRelayed>): EventEmitter;

    allEvents(options?: EventOptions, cb?: Callback<EventLog>): EventEmitter;
  };

  once(
    event: "AddressAddedToWhitelist",
    cb: Callback<AddressAddedToWhitelist>
  ): void;
  once(
    event: "AddressAddedToWhitelist",
    options: EventOptions,
    cb: Callback<AddressAddedToWhitelist>
  ): void;

  once(
    event: "AddressDroppedFromWhitelist",
    cb: Callback<AddressDroppedFromWhitelist>
  ): void;
  once(
    event: "AddressDroppedFromWhitelist",
    options: EventOptions,
    cb: Callback<AddressDroppedFromWhitelist>
  ): void;

  once(event: "OwnershipTransferred", cb: Callback<OwnershipTransferred>): void;
  once(
    event: "OwnershipTransferred",
    options: EventOptions,
    cb: Callback<OwnershipTransferred>
  ): void;

  once(event: "PostRelayed", cb: Callback<PostRelayed>): void;
  once(
    event: "PostRelayed",
    options: EventOptions,
    cb: Callback<PostRelayed>
  ): void;

  once(event: "PreRelayed", cb: Callback<PreRelayed>): void;
  once(
    event: "PreRelayed",
    options: EventOptions,
    cb: Callback<PreRelayed>
  ): void;
}