@api3/contracts
Version:
Contracts through which API3 services are delivered
271 lines • 15.8 kB
TypeScript
import type { BaseContract, BigNumberish, BytesLike, FunctionFragment, Result, Interface, EventFragment, AddressLike, ContractRunner, ContractMethod, Listener } from "ethers";
import type { TypedContractEvent, TypedDeferredTopicFilter, TypedEventLog, TypedLogDescription, TypedListener, TypedContractMethod } from "../../common";
export interface Api3ReaderProxyV1Interface extends Interface {
getFunction(nameOrSignature: "UPGRADE_INTERFACE_VERSION" | "api3ServerV1" | "api3ServerV1OevExtension" | "dapiName" | "dappId" | "decimals" | "description" | "getAnswer" | "getRoundData" | "getTimestamp" | "initialize" | "latestAnswer" | "latestRound" | "latestRoundData" | "latestTimestamp" | "owner" | "proxiableUUID" | "read" | "renounceOwnership" | "transferOwnership" | "upgradeToAndCall" | "version"): FunctionFragment;
getEvent(nameOrSignatureOrTopic: "AnswerUpdated" | "Initialized" | "NewRound" | "OwnershipTransferred" | "Upgraded"): EventFragment;
encodeFunctionData(functionFragment: "UPGRADE_INTERFACE_VERSION", values?: undefined): string;
encodeFunctionData(functionFragment: "api3ServerV1", values?: undefined): string;
encodeFunctionData(functionFragment: "api3ServerV1OevExtension", values?: undefined): string;
encodeFunctionData(functionFragment: "dapiName", values?: undefined): string;
encodeFunctionData(functionFragment: "dappId", values?: undefined): string;
encodeFunctionData(functionFragment: "decimals", values?: undefined): string;
encodeFunctionData(functionFragment: "description", values?: undefined): string;
encodeFunctionData(functionFragment: "getAnswer", values: [BigNumberish]): string;
encodeFunctionData(functionFragment: "getRoundData", values: [BigNumberish]): string;
encodeFunctionData(functionFragment: "getTimestamp", values: [BigNumberish]): string;
encodeFunctionData(functionFragment: "initialize", values: [AddressLike]): string;
encodeFunctionData(functionFragment: "latestAnswer", values?: undefined): string;
encodeFunctionData(functionFragment: "latestRound", values?: undefined): string;
encodeFunctionData(functionFragment: "latestRoundData", values?: undefined): string;
encodeFunctionData(functionFragment: "latestTimestamp", values?: undefined): string;
encodeFunctionData(functionFragment: "owner", values?: undefined): string;
encodeFunctionData(functionFragment: "proxiableUUID", values?: undefined): string;
encodeFunctionData(functionFragment: "read", values?: undefined): string;
encodeFunctionData(functionFragment: "renounceOwnership", values?: undefined): string;
encodeFunctionData(functionFragment: "transferOwnership", values: [AddressLike]): string;
encodeFunctionData(functionFragment: "upgradeToAndCall", values: [AddressLike, BytesLike]): string;
encodeFunctionData(functionFragment: "version", values?: undefined): string;
decodeFunctionResult(functionFragment: "UPGRADE_INTERFACE_VERSION", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "api3ServerV1", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "api3ServerV1OevExtension", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "dapiName", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "dappId", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "decimals", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "description", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getAnswer", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getRoundData", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getTimestamp", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "initialize", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "latestAnswer", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "latestRound", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "latestRoundData", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "latestTimestamp", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "owner", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "proxiableUUID", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "read", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "renounceOwnership", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "transferOwnership", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "upgradeToAndCall", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "version", data: BytesLike): Result;
}
export declare namespace AnswerUpdatedEvent {
type InputTuple = [
current: BigNumberish,
roundId: BigNumberish,
updatedAt: BigNumberish
];
type OutputTuple = [
current: bigint,
roundId: bigint,
updatedAt: bigint
];
interface OutputObject {
current: bigint;
roundId: bigint;
updatedAt: bigint;
}
type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
type Filter = TypedDeferredTopicFilter<Event>;
type Log = TypedEventLog<Event>;
type LogDescription = TypedLogDescription<Event>;
}
export declare namespace InitializedEvent {
type InputTuple = [version: BigNumberish];
type OutputTuple = [version: bigint];
interface OutputObject {
version: bigint;
}
type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
type Filter = TypedDeferredTopicFilter<Event>;
type Log = TypedEventLog<Event>;
type LogDescription = TypedLogDescription<Event>;
}
export declare namespace NewRoundEvent {
type InputTuple = [
roundId: BigNumberish,
startedBy: AddressLike,
startedAt: BigNumberish
];
type OutputTuple = [
roundId: bigint,
startedBy: string,
startedAt: bigint
];
interface OutputObject {
roundId: bigint;
startedBy: string;
startedAt: bigint;
}
type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
type Filter = TypedDeferredTopicFilter<Event>;
type Log = TypedEventLog<Event>;
type LogDescription = TypedLogDescription<Event>;
}
export declare namespace OwnershipTransferredEvent {
type InputTuple = [previousOwner: AddressLike, newOwner: AddressLike];
type OutputTuple = [previousOwner: string, newOwner: string];
interface OutputObject {
previousOwner: string;
newOwner: string;
}
type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
type Filter = TypedDeferredTopicFilter<Event>;
type Log = TypedEventLog<Event>;
type LogDescription = TypedLogDescription<Event>;
}
export declare namespace UpgradedEvent {
type InputTuple = [implementation: AddressLike];
type OutputTuple = [implementation: string];
interface OutputObject {
implementation: string;
}
type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
type Filter = TypedDeferredTopicFilter<Event>;
type Log = TypedEventLog<Event>;
type LogDescription = TypedLogDescription<Event>;
}
export interface Api3ReaderProxyV1 extends BaseContract {
connect(runner?: ContractRunner | null): Api3ReaderProxyV1;
waitForDeployment(): Promise<this>;
interface: Api3ReaderProxyV1Interface;
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>;
UPGRADE_INTERFACE_VERSION: TypedContractMethod<[], [string], "view">;
api3ServerV1: TypedContractMethod<[], [string], "view">;
api3ServerV1OevExtension: TypedContractMethod<[], [string], "view">;
dapiName: TypedContractMethod<[], [string], "view">;
dappId: TypedContractMethod<[], [bigint], "view">;
decimals: TypedContractMethod<[], [bigint], "view">;
description: TypedContractMethod<[], [string], "view">;
getAnswer: TypedContractMethod<[arg0: BigNumberish], [bigint], "view">;
getRoundData: TypedContractMethod<[
arg0: BigNumberish
], [
[bigint, bigint, bigint, bigint, bigint]
], "view">;
getTimestamp: TypedContractMethod<[arg0: BigNumberish], [bigint], "view">;
initialize: TypedContractMethod<[
initialOwner: AddressLike
], [
void
], "nonpayable">;
latestAnswer: TypedContractMethod<[], [bigint], "view">;
latestRound: TypedContractMethod<[], [bigint], "view">;
latestRoundData: TypedContractMethod<[
], [
[
bigint,
bigint,
bigint,
bigint,
bigint
] & {
roundId: bigint;
answer: bigint;
startedAt: bigint;
updatedAt: bigint;
answeredInRound: bigint;
}
], "view">;
latestTimestamp: TypedContractMethod<[], [bigint], "view">;
owner: TypedContractMethod<[], [string], "view">;
proxiableUUID: TypedContractMethod<[], [string], "view">;
read: TypedContractMethod<[
], [
[bigint, bigint] & {
value: bigint;
timestamp: bigint;
}
], "view">;
renounceOwnership: TypedContractMethod<[], [void], "nonpayable">;
transferOwnership: TypedContractMethod<[
newOwner: AddressLike
], [
void
], "nonpayable">;
upgradeToAndCall: TypedContractMethod<[
newImplementation: AddressLike,
data: BytesLike
], [
void
], "payable">;
version: TypedContractMethod<[], [bigint], "view">;
getFunction<T extends ContractMethod = ContractMethod>(key: string | FunctionFragment): T;
getFunction(nameOrSignature: "UPGRADE_INTERFACE_VERSION"): TypedContractMethod<[], [string], "view">;
getFunction(nameOrSignature: "api3ServerV1"): TypedContractMethod<[], [string], "view">;
getFunction(nameOrSignature: "api3ServerV1OevExtension"): TypedContractMethod<[], [string], "view">;
getFunction(nameOrSignature: "dapiName"): TypedContractMethod<[], [string], "view">;
getFunction(nameOrSignature: "dappId"): TypedContractMethod<[], [bigint], "view">;
getFunction(nameOrSignature: "decimals"): TypedContractMethod<[], [bigint], "view">;
getFunction(nameOrSignature: "description"): TypedContractMethod<[], [string], "view">;
getFunction(nameOrSignature: "getAnswer"): TypedContractMethod<[arg0: BigNumberish], [bigint], "view">;
getFunction(nameOrSignature: "getRoundData"): TypedContractMethod<[
arg0: BigNumberish
], [
[bigint, bigint, bigint, bigint, bigint]
], "view">;
getFunction(nameOrSignature: "getTimestamp"): TypedContractMethod<[arg0: BigNumberish], [bigint], "view">;
getFunction(nameOrSignature: "initialize"): TypedContractMethod<[initialOwner: AddressLike], [void], "nonpayable">;
getFunction(nameOrSignature: "latestAnswer"): TypedContractMethod<[], [bigint], "view">;
getFunction(nameOrSignature: "latestRound"): TypedContractMethod<[], [bigint], "view">;
getFunction(nameOrSignature: "latestRoundData"): TypedContractMethod<[
], [
[
bigint,
bigint,
bigint,
bigint,
bigint
] & {
roundId: bigint;
answer: bigint;
startedAt: bigint;
updatedAt: bigint;
answeredInRound: bigint;
}
], "view">;
getFunction(nameOrSignature: "latestTimestamp"): TypedContractMethod<[], [bigint], "view">;
getFunction(nameOrSignature: "owner"): TypedContractMethod<[], [string], "view">;
getFunction(nameOrSignature: "proxiableUUID"): TypedContractMethod<[], [string], "view">;
getFunction(nameOrSignature: "read"): TypedContractMethod<[
], [
[bigint, bigint] & {
value: bigint;
timestamp: bigint;
}
], "view">;
getFunction(nameOrSignature: "renounceOwnership"): TypedContractMethod<[], [void], "nonpayable">;
getFunction(nameOrSignature: "transferOwnership"): TypedContractMethod<[newOwner: AddressLike], [void], "nonpayable">;
getFunction(nameOrSignature: "upgradeToAndCall"): TypedContractMethod<[
newImplementation: AddressLike,
data: BytesLike
], [
void
], "payable">;
getFunction(nameOrSignature: "version"): TypedContractMethod<[], [bigint], "view">;
getEvent(key: "AnswerUpdated"): TypedContractEvent<AnswerUpdatedEvent.InputTuple, AnswerUpdatedEvent.OutputTuple, AnswerUpdatedEvent.OutputObject>;
getEvent(key: "Initialized"): TypedContractEvent<InitializedEvent.InputTuple, InitializedEvent.OutputTuple, InitializedEvent.OutputObject>;
getEvent(key: "NewRound"): TypedContractEvent<NewRoundEvent.InputTuple, NewRoundEvent.OutputTuple, NewRoundEvent.OutputObject>;
getEvent(key: "OwnershipTransferred"): TypedContractEvent<OwnershipTransferredEvent.InputTuple, OwnershipTransferredEvent.OutputTuple, OwnershipTransferredEvent.OutputObject>;
getEvent(key: "Upgraded"): TypedContractEvent<UpgradedEvent.InputTuple, UpgradedEvent.OutputTuple, UpgradedEvent.OutputObject>;
filters: {
"AnswerUpdated(int256,uint256,uint256)": TypedContractEvent<AnswerUpdatedEvent.InputTuple, AnswerUpdatedEvent.OutputTuple, AnswerUpdatedEvent.OutputObject>;
AnswerUpdated: TypedContractEvent<AnswerUpdatedEvent.InputTuple, AnswerUpdatedEvent.OutputTuple, AnswerUpdatedEvent.OutputObject>;
"Initialized(uint64)": TypedContractEvent<InitializedEvent.InputTuple, InitializedEvent.OutputTuple, InitializedEvent.OutputObject>;
Initialized: TypedContractEvent<InitializedEvent.InputTuple, InitializedEvent.OutputTuple, InitializedEvent.OutputObject>;
"NewRound(uint256,address,uint256)": TypedContractEvent<NewRoundEvent.InputTuple, NewRoundEvent.OutputTuple, NewRoundEvent.OutputObject>;
NewRound: TypedContractEvent<NewRoundEvent.InputTuple, NewRoundEvent.OutputTuple, NewRoundEvent.OutputObject>;
"OwnershipTransferred(address,address)": TypedContractEvent<OwnershipTransferredEvent.InputTuple, OwnershipTransferredEvent.OutputTuple, OwnershipTransferredEvent.OutputObject>;
OwnershipTransferred: TypedContractEvent<OwnershipTransferredEvent.InputTuple, OwnershipTransferredEvent.OutputTuple, OwnershipTransferredEvent.OutputObject>;
"Upgraded(address)": TypedContractEvent<UpgradedEvent.InputTuple, UpgradedEvent.OutputTuple, UpgradedEvent.OutputObject>;
Upgraded: TypedContractEvent<UpgradedEvent.InputTuple, UpgradedEvent.OutputTuple, UpgradedEvent.OutputObject>;
};
}
//# sourceMappingURL=Api3ReaderProxyV1.d.ts.map