opensea-js
Version:
TypeScript SDK for the OpenSea marketplace helps developers build new experiences using NFTs and our marketplace data
214 lines (213 loc) • 10.7 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 ERC721Interface extends Interface {
getFunction(nameOrSignature: "approve" | "mint" | "safeTransferFrom(address,address,uint256)" | "safeTransferFrom(address,address,uint256,bytes)" | "setApprovalForAll" | "transferFrom" | "balanceOf" | "getApproved" | "isApprovedForAll" | "ownerOf" | "supportsInterface"): FunctionFragment;
getEvent(nameOrSignatureOrTopic: "Transfer" | "Approval" | "ApprovalForAll"): EventFragment;
encodeFunctionData(functionFragment: "approve", values: [AddressLike, BigNumberish]): string;
encodeFunctionData(functionFragment: "mint", values: [AddressLike, BigNumberish]): string;
encodeFunctionData(functionFragment: "safeTransferFrom(address,address,uint256)", values: [AddressLike, AddressLike, BigNumberish]): string;
encodeFunctionData(functionFragment: "safeTransferFrom(address,address,uint256,bytes)", values: [AddressLike, AddressLike, BigNumberish, BytesLike]): string;
encodeFunctionData(functionFragment: "setApprovalForAll", values: [AddressLike, boolean]): string;
encodeFunctionData(functionFragment: "transferFrom", values: [AddressLike, AddressLike, BigNumberish]): string;
encodeFunctionData(functionFragment: "balanceOf", values: [AddressLike]): string;
encodeFunctionData(functionFragment: "getApproved", values: [BigNumberish]): string;
encodeFunctionData(functionFragment: "isApprovedForAll", values: [AddressLike, AddressLike]): string;
encodeFunctionData(functionFragment: "ownerOf", values: [BigNumberish]): string;
encodeFunctionData(functionFragment: "supportsInterface", values: [BytesLike]): string;
decodeFunctionResult(functionFragment: "approve", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "mint", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "safeTransferFrom(address,address,uint256)", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "safeTransferFrom(address,address,uint256,bytes)", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "setApprovalForAll", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "transferFrom", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "balanceOf", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getApproved", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "isApprovedForAll", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "ownerOf", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "supportsInterface", data: BytesLike): Result;
}
export declare namespace TransferEvent {
type InputTuple = [
from: AddressLike,
to: AddressLike,
tokenId: BigNumberish
];
type OutputTuple = [from: string, to: string, tokenId: bigint];
interface OutputObject {
from: string;
to: string;
tokenId: bigint;
}
type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
type Filter = TypedDeferredTopicFilter<Event>;
type Log = TypedEventLog<Event>;
type LogDescription = TypedLogDescription<Event>;
}
export declare namespace ApprovalEvent {
type InputTuple = [
owner: AddressLike,
approved: AddressLike,
tokenId: BigNumberish
];
type OutputTuple = [owner: string, approved: string, tokenId: bigint];
interface OutputObject {
owner: string;
approved: string;
tokenId: bigint;
}
type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
type Filter = TypedDeferredTopicFilter<Event>;
type Log = TypedEventLog<Event>;
type LogDescription = TypedLogDescription<Event>;
}
export declare namespace ApprovalForAllEvent {
type InputTuple = [
owner: AddressLike,
operator: AddressLike,
approved: boolean
];
type OutputTuple = [
owner: string,
operator: string,
approved: boolean
];
interface OutputObject {
owner: string;
operator: string;
approved: boolean;
}
type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
type Filter = TypedDeferredTopicFilter<Event>;
type Log = TypedEventLog<Event>;
type LogDescription = TypedLogDescription<Event>;
}
export interface ERC721 extends BaseContract {
connect(runner?: ContractRunner | null): ERC721;
waitForDeployment(): Promise<this>;
interface: ERC721Interface;
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>;
approve: TypedContractMethod<[
to: AddressLike,
tokenId: BigNumberish
], [
void
], "nonpayable">;
mint: TypedContractMethod<[
to: AddressLike,
tokenId: BigNumberish
], [
void
], "nonpayable">;
"safeTransferFrom(address,address,uint256)": TypedContractMethod<[
from: AddressLike,
to: AddressLike,
tokenId: BigNumberish
], [
void
], "nonpayable">;
"safeTransferFrom(address,address,uint256,bytes)": TypedContractMethod<[
from: AddressLike,
to: AddressLike,
tokenId: BigNumberish,
_data: BytesLike
], [
void
], "nonpayable">;
setApprovalForAll: TypedContractMethod<[
to: AddressLike,
approved: boolean
], [
void
], "nonpayable">;
transferFrom: TypedContractMethod<[
from: AddressLike,
to: AddressLike,
tokenId: BigNumberish
], [
void
], "nonpayable">;
balanceOf: TypedContractMethod<[owner: AddressLike], [bigint], "view">;
getApproved: TypedContractMethod<[tokenId: BigNumberish], [string], "view">;
isApprovedForAll: TypedContractMethod<[
owner: AddressLike,
operator: AddressLike
], [
boolean
], "view">;
ownerOf: TypedContractMethod<[tokenId: BigNumberish], [string], "view">;
supportsInterface: TypedContractMethod<[
interfaceId: BytesLike
], [
boolean
], "view">;
getFunction<T extends ContractMethod = ContractMethod>(key: string | FunctionFragment): T;
getFunction(nameOrSignature: "approve"): TypedContractMethod<[
to: AddressLike,
tokenId: BigNumberish
], [
void
], "nonpayable">;
getFunction(nameOrSignature: "mint"): TypedContractMethod<[
to: AddressLike,
tokenId: BigNumberish
], [
void
], "nonpayable">;
getFunction(nameOrSignature: "safeTransferFrom(address,address,uint256)"): TypedContractMethod<[
from: AddressLike,
to: AddressLike,
tokenId: BigNumberish
], [
void
], "nonpayable">;
getFunction(nameOrSignature: "safeTransferFrom(address,address,uint256,bytes)"): TypedContractMethod<[
from: AddressLike,
to: AddressLike,
tokenId: BigNumberish,
_data: BytesLike
], [
void
], "nonpayable">;
getFunction(nameOrSignature: "setApprovalForAll"): TypedContractMethod<[
to: AddressLike,
approved: boolean
], [
void
], "nonpayable">;
getFunction(nameOrSignature: "transferFrom"): TypedContractMethod<[
from: AddressLike,
to: AddressLike,
tokenId: BigNumberish
], [
void
], "nonpayable">;
getFunction(nameOrSignature: "balanceOf"): TypedContractMethod<[owner: AddressLike], [bigint], "view">;
getFunction(nameOrSignature: "getApproved"): TypedContractMethod<[tokenId: BigNumberish], [string], "view">;
getFunction(nameOrSignature: "isApprovedForAll"): TypedContractMethod<[
owner: AddressLike,
operator: AddressLike
], [
boolean
], "view">;
getFunction(nameOrSignature: "ownerOf"): TypedContractMethod<[tokenId: BigNumberish], [string], "view">;
getFunction(nameOrSignature: "supportsInterface"): TypedContractMethod<[interfaceId: BytesLike], [boolean], "view">;
getEvent(key: "Transfer"): TypedContractEvent<TransferEvent.InputTuple, TransferEvent.OutputTuple, TransferEvent.OutputObject>;
getEvent(key: "Approval"): TypedContractEvent<ApprovalEvent.InputTuple, ApprovalEvent.OutputTuple, ApprovalEvent.OutputObject>;
getEvent(key: "ApprovalForAll"): TypedContractEvent<ApprovalForAllEvent.InputTuple, ApprovalForAllEvent.OutputTuple, ApprovalForAllEvent.OutputObject>;
filters: {
"Transfer(address,address,uint256)": TypedContractEvent<TransferEvent.InputTuple, TransferEvent.OutputTuple, TransferEvent.OutputObject>;
Transfer: TypedContractEvent<TransferEvent.InputTuple, TransferEvent.OutputTuple, TransferEvent.OutputObject>;
"Approval(address,address,uint256)": TypedContractEvent<ApprovalEvent.InputTuple, ApprovalEvent.OutputTuple, ApprovalEvent.OutputObject>;
Approval: TypedContractEvent<ApprovalEvent.InputTuple, ApprovalEvent.OutputTuple, ApprovalEvent.OutputObject>;
"ApprovalForAll(address,address,bool)": TypedContractEvent<ApprovalForAllEvent.InputTuple, ApprovalForAllEvent.OutputTuple, ApprovalForAllEvent.OutputObject>;
ApprovalForAll: TypedContractEvent<ApprovalForAllEvent.InputTuple, ApprovalForAllEvent.OutputTuple, ApprovalForAllEvent.OutputObject>;
};
}