@orionprotocol/contracts
Version:
Orion Protocol contracts typings
201 lines (200 loc) • 9.54 kB
TypeScript
/// <reference types="node" />
import type BN from "bn.js";
import type { ContractOptions } from "web3-eth-contract";
import type { EventLog } from "web3-core";
import type { EventEmitter } from "events";
import type { Callback, PayableTransactionObject, NonPayableTransactionObject, BlockType, ContractEventLog, BaseContract } from "./types";
export interface EventOptions {
filter?: object;
fromBlock?: BlockType;
topics?: string[];
}
export type Approval = ContractEventLog<{
owner: string;
approved: string;
tokenId: string;
0: string;
1: string;
2: string;
}>;
export type ApprovalForAll = ContractEventLog<{
owner: string;
operator: string;
approved: boolean;
0: string;
1: string;
2: boolean;
}>;
export type Collect = ContractEventLog<{
tokenId: string;
recipient: string;
amount0: string;
0: string;
1: string;
2: string;
}>;
export type DecreaseLiquidity = ContractEventLog<{
tokenId: string;
liquidity: string;
amount0: string;
amount1: string;
0: string;
1: string;
2: string;
3: string;
}>;
export type IncreaseLiquidity = ContractEventLog<{
tokenId: string;
liquidity: string;
amount0: string;
amount1: string;
0: string;
1: string;
2: string;
3: string;
}>;
export type Transfer = ContractEventLog<{
from: string;
to: string;
tokenId: string;
0: string;
1: string;
2: string;
}>;
export interface OrionV3NFTManager extends BaseContract {
constructor(jsonInterface: any[], address?: string, options?: ContractOptions): OrionV3NFTManager;
clone(): OrionV3NFTManager;
methods: {
DOMAIN_SEPARATOR(): NonPayableTransactionObject<string>;
PERMIT_TYPEHASH(): NonPayableTransactionObject<string>;
WETH9(): NonPayableTransactionObject<string>;
approve(to: string, tokenId: number | string | BN): NonPayableTransactionObject<void>;
balanceOf(owner: string): NonPayableTransactionObject<string>;
baseTokenURI(): NonPayableTransactionObject<string>;
baseURI(): NonPayableTransactionObject<string>;
burn(tokenId: number | string | BN): NonPayableTransactionObject<void>;
burnByKey(key: number | string | BN): NonPayableTransactionObject<void>;
collect(tokenId: number | string | BN): NonPayableTransactionObject<string>;
collectList(startKey: number | string | BN, counts: number | string | BN): NonPayableTransactionObject<void>;
createAndInitializePoolIfNecessary(token0: string, token1: string, fee: number | string | BN, tickStart: number | string | BN): PayableTransactionObject<string>;
decreaseLiquidity(params: [
number | string | BN,
number | string | BN,
number | string | BN,
number | string | BN,
number | string | BN
]): NonPayableTransactionObject<{
amount0: string;
amount1: string;
0: string;
1: string;
}>;
factory(): NonPayableTransactionObject<string>;
getApproved(tokenId: number | string | BN): NonPayableTransactionObject<string>;
increaseLiquidity(params: [
number | string | BN,
number | string | BN,
number | string | BN,
number | string | BN,
number | string | BN
]): PayableTransactionObject<{
amount0: string;
amount1: string;
0: string;
1: string;
}>;
isApprovedForAll(owner: string, operator: string): NonPayableTransactionObject<boolean>;
listNFT(owner: string, startKey: number | string | BN, counts: number | string | BN): NonPayableTransactionObject<[string, string][]>;
listNFTOrder(owner: string, startKey: number | string | BN, counts: number | string | BN): NonPayableTransactionObject<[
string,
string,
string,
string,
string,
string,
string,
string,
string,
string,
string,
string,
string,
string,
string,
string,
string
][]>;
listPermit(arg0: number | string | BN): NonPayableTransactionObject<{
nonce: string;
operator: string;
0: string;
1: string;
}>;
mint(params: [
string,
string,
number | string | BN,
number | string | BN,
number | string | BN,
number | string | BN,
number | string | BN,
number | string | BN,
number | string | BN
]): PayableTransactionObject<{
tokenId: string;
amount0: string;
amount1: string;
0: string;
1: string;
2: string;
}>;
multicall(data: (string | number[])[]): PayableTransactionObject<string[]>;
name(): NonPayableTransactionObject<string>;
ownerOf(tokenId: number | string | BN): NonPayableTransactionObject<string>;
permit(spender: string, tokenId: number | string | BN, deadline: number | string | BN, v: number | string | BN, r: string | number[], s: string | number[]): PayableTransactionObject<void>;
refundETH(): PayableTransactionObject<void>;
"safeTransferFrom(address,address,uint256)"(from: string, to: string, tokenId: number | string | BN): NonPayableTransactionObject<void>;
"safeTransferFrom(address,address,uint256,bytes)"(from: string, to: string, tokenId: number | string | BN, data: string | number[]): NonPayableTransactionObject<void>;
selfPermit(token: string, value: number | string | BN, deadline: number | string | BN, v: number | string | BN, r: string | number[], s: string | number[]): PayableTransactionObject<void>;
selfPermitAllowed(token: string, nonce: number | string | BN, expiry: number | string | BN, v: number | string | BN, r: string | number[], s: string | number[]): PayableTransactionObject<void>;
selfPermitAllowedIfNecessary(token: string, nonce: number | string | BN, expiry: number | string | BN, v: number | string | BN, r: string | number[], s: string | number[]): PayableTransactionObject<void>;
selfPermitIfNecessary(token: string, value: number | string | BN, deadline: number | string | BN, v: number | string | BN, r: string | number[], s: string | number[]): PayableTransactionObject<void>;
setApprovalForAll(operator: string, approved: boolean): NonPayableTransactionObject<void>;
setNFTDescriptor(_tokenDescriptor: string): NonPayableTransactionObject<void>;
supportsInterface(interfaceId: string | number[]): NonPayableTransactionObject<boolean>;
sweepToken(token: string, amountMinimum: number | string | BN, recipient: string): PayableTransactionObject<void>;
symbol(): NonPayableTransactionObject<string>;
tokenDescriptor(): NonPayableTransactionObject<string>;
tokenURI(tokenId: number | string | BN): NonPayableTransactionObject<string>;
transferFrom(from: string, to: string, tokenId: number | string | BN): NonPayableTransactionObject<void>;
uniswapV3MintCallback(amount0Owed: number | string | BN, amount1Owed: number | string | BN, data: string | number[]): NonPayableTransactionObject<void>;
unwrapWETH9(amountMinimum: number | string | BN, recipient: string): PayableTransactionObject<void>;
};
events: {
Approval(cb?: Callback<Approval>): EventEmitter;
Approval(options?: EventOptions, cb?: Callback<Approval>): EventEmitter;
ApprovalForAll(cb?: Callback<ApprovalForAll>): EventEmitter;
ApprovalForAll(options?: EventOptions, cb?: Callback<ApprovalForAll>): EventEmitter;
Collect(cb?: Callback<Collect>): EventEmitter;
Collect(options?: EventOptions, cb?: Callback<Collect>): EventEmitter;
DecreaseLiquidity(cb?: Callback<DecreaseLiquidity>): EventEmitter;
DecreaseLiquidity(options?: EventOptions, cb?: Callback<DecreaseLiquidity>): EventEmitter;
IncreaseLiquidity(cb?: Callback<IncreaseLiquidity>): EventEmitter;
IncreaseLiquidity(options?: EventOptions, cb?: Callback<IncreaseLiquidity>): EventEmitter;
Transfer(cb?: Callback<Transfer>): EventEmitter;
Transfer(options?: EventOptions, cb?: Callback<Transfer>): EventEmitter;
allEvents(options?: EventOptions, cb?: Callback<EventLog>): EventEmitter;
};
once(event: "Approval", cb: Callback<Approval>): void;
once(event: "Approval", options: EventOptions, cb: Callback<Approval>): void;
once(event: "ApprovalForAll", cb: Callback<ApprovalForAll>): void;
once(event: "ApprovalForAll", options: EventOptions, cb: Callback<ApprovalForAll>): void;
once(event: "Collect", cb: Callback<Collect>): void;
once(event: "Collect", options: EventOptions, cb: Callback<Collect>): void;
once(event: "DecreaseLiquidity", cb: Callback<DecreaseLiquidity>): void;
once(event: "DecreaseLiquidity", options: EventOptions, cb: Callback<DecreaseLiquidity>): void;
once(event: "IncreaseLiquidity", cb: Callback<IncreaseLiquidity>): void;
once(event: "IncreaseLiquidity", options: EventOptions, cb: Callback<IncreaseLiquidity>): void;
once(event: "Transfer", cb: Callback<Transfer>): void;
once(event: "Transfer", options: EventOptions, cb: Callback<Transfer>): void;
}