@q-dev/q-js-sdk/lib/ethers-contracts/SystemSurplusAuction.d.ts

Typescript Library to interact with Q System Contracts

import type { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, PayableOverrides, PopulatedTransaction, Signer, utils } from "ethers";
import type { FunctionFragment, Result, EventFragment } from "@ethersproject/abi";
import type { Listener, Provider } from "@ethersproject/providers";
import type { TypedEventFilter, TypedEvent, TypedListener, OnEvent, PromiseOrValue } from "./common";
export declare namespace SystemSurplusAuction {
    type AuctionInfoStruct = {
        isExecuted: PromiseOrValue<boolean>;
        bidder: PromiseOrValue<string>;
        highestBid: PromiseOrValue<BigNumberish>;
        lot: PromiseOrValue<BigNumberish>;
        endTime: PromiseOrValue<BigNumberish>;
    };
    type AuctionInfoStructOutput = [
        boolean,
        string,
        BigNumber,
        BigNumber,
        BigNumber
    ] & {
        isExecuted: boolean;
        bidder: string;
        highestBid: BigNumber;
        lot: BigNumber;
        endTime: BigNumber;
    };
}
export interface SystemSurplusAuctionInterface extends utils.Interface {
    functions: {
        "auctions(uint256)": FunctionFragment;
        "auctionsCount()": FunctionFragment;
        "initialize(address,string)": FunctionFragment;
        "startAuction()": FunctionFragment;
        "bid(uint256)": FunctionFragment;
        "execute(uint256)": FunctionFragment;
        "getRaisingBid(uint256)": FunctionFragment;
    };
    getFunction(nameOrSignatureOrTopic: "auctions" | "auctionsCount" | "initialize" | "startAuction" | "bid" | "execute" | "getRaisingBid"): FunctionFragment;
    encodeFunctionData(functionFragment: "auctions", values: [PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "auctionsCount", values?: undefined): string;
    encodeFunctionData(functionFragment: "initialize", values: [PromiseOrValue<string>, PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "startAuction", values?: undefined): string;
    encodeFunctionData(functionFragment: "bid", values: [PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "execute", values: [PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "getRaisingBid", values: [PromiseOrValue<BigNumberish>]): string;
    decodeFunctionResult(functionFragment: "auctions", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "auctionsCount", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "initialize", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "startAuction", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "bid", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "execute", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "getRaisingBid", data: BytesLike): Result;
    events: {
        "AuctionStarted(uint256,address,uint256)": EventFragment;
        "Bid(uint256,address,uint256)": EventFragment;
        "Executed(uint256,address,tuple)": EventFragment;
    };
    getEvent(nameOrSignatureOrTopic: "AuctionStarted"): EventFragment;
    getEvent(nameOrSignatureOrTopic: "Bid"): EventFragment;
    getEvent(nameOrSignatureOrTopic: "Executed"): EventFragment;
}
export interface AuctionStartedEventObject {
    _auctionId: BigNumber;
    _bidder: string;
    _bid: BigNumber;
}
export declare type AuctionStartedEvent = TypedEvent<[
    BigNumber,
    string,
    BigNumber
], AuctionStartedEventObject>;
export declare type AuctionStartedEventFilter = TypedEventFilter<AuctionStartedEvent>;
export interface BidEventObject {
    _auctionId: BigNumber;
    _bidder: string;
    _bid: BigNumber;
}
export declare type BidEvent = TypedEvent<[
    BigNumber,
    string,
    BigNumber
], BidEventObject>;
export declare type BidEventFilter = TypedEventFilter<BidEvent>;
export interface ExecutedEventObject {
    _auctionId: BigNumber;
    _bidder: string;
    _info: SystemSurplusAuction.AuctionInfoStructOutput;
}
export declare type ExecutedEvent = TypedEvent<[
    BigNumber,
    string,
    SystemSurplusAuction.AuctionInfoStructOutput
], ExecutedEventObject>;
export declare type ExecutedEventFilter = TypedEventFilter<ExecutedEvent>;
export interface SystemSurplusAuction extends BaseContract {
    connect(signerOrProvider: Signer | Provider | string): this;
    attach(addressOrName: string): this;
    deployed(): Promise<this>;
    interface: SystemSurplusAuctionInterface;
    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: {
        auctions(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[
            boolean,
            string,
            BigNumber,
            BigNumber,
            BigNumber
        ] & {
            isExecuted: boolean;
            bidder: string;
            highestBid: BigNumber;
            lot: BigNumber;
            endTime: BigNumber;
        }>;
        auctionsCount(overrides?: CallOverrides): Promise<[BigNumber]>;
        initialize(_registry: PromiseOrValue<string>, _stc: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        startAuction(overrides?: PayableOverrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        bid(_auctionId: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        execute(_auctionId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        getRaisingBid(_auctionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[BigNumber]>;
    };
    auctions(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[
        boolean,
        string,
        BigNumber,
        BigNumber,
        BigNumber
    ] & {
        isExecuted: boolean;
        bidder: string;
        highestBid: BigNumber;
        lot: BigNumber;
        endTime: BigNumber;
    }>;
    auctionsCount(overrides?: CallOverrides): Promise<BigNumber>;
    initialize(_registry: PromiseOrValue<string>, _stc: PromiseOrValue<string>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    startAuction(overrides?: PayableOverrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    bid(_auctionId: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    execute(_auctionId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    getRaisingBid(_auctionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
    callStatic: {
        auctions(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[
            boolean,
            string,
            BigNumber,
            BigNumber,
            BigNumber
        ] & {
            isExecuted: boolean;
            bidder: string;
            highestBid: BigNumber;
            lot: BigNumber;
            endTime: BigNumber;
        }>;
        auctionsCount(overrides?: CallOverrides): Promise<BigNumber>;
        initialize(_registry: PromiseOrValue<string>, _stc: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>;
        startAuction(overrides?: CallOverrides): Promise<BigNumber>;
        bid(_auctionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<boolean>;
        execute(_auctionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<boolean>;
        getRaisingBid(_auctionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
    };
    filters: {
        "AuctionStarted(uint256,address,uint256)"(_auctionId?: null, _bidder?: PromiseOrValue<string> | null, _bid?: null): AuctionStartedEventFilter;
        AuctionStarted(_auctionId?: null, _bidder?: PromiseOrValue<string> | null, _bid?: null): AuctionStartedEventFilter;
        "Bid(uint256,address,uint256)"(_auctionId?: PromiseOrValue<BigNumberish> | null, _bidder?: PromiseOrValue<string> | null, _bid?: null): BidEventFilter;
        Bid(_auctionId?: PromiseOrValue<BigNumberish> | null, _bidder?: PromiseOrValue<string> | null, _bid?: null): BidEventFilter;
        "Executed(uint256,address,tuple)"(_auctionId?: null, _bidder?: PromiseOrValue<string> | null, _info?: null): ExecutedEventFilter;
        Executed(_auctionId?: null, _bidder?: PromiseOrValue<string> | null, _info?: null): ExecutedEventFilter;
    };
    estimateGas: {
        auctions(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
        auctionsCount(overrides?: CallOverrides): Promise<BigNumber>;
        initialize(_registry: PromiseOrValue<string>, _stc: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        startAuction(overrides?: PayableOverrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        bid(_auctionId: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        execute(_auctionId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        getRaisingBid(_auctionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
    };
    populateTransaction: {
        auctions(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        auctionsCount(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        initialize(_registry: PromiseOrValue<string>, _stc: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        startAuction(overrides?: PayableOverrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        bid(_auctionId: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        execute(_auctionId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        getRaisingBid(_auctionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
    };
}