Interface IPool

Hierarchy

  • BaseContract
    • IPool

Properties

[internal] _takerFeeLowLevel accountsByToken annihilate annihilateFor balanceOf balanceOfBatch cancelQuotesOB claim deposit((address,address,uint256,uint256,uint8),uint256,uint256,uint256,uint256,uint256) deposit((address,address,uint256,uint256,uint8),uint256,uint256,uint256,uint256,uint256,bool) exercise exerciseFor fallback fillQuoteOB filters flashFee flashLoan getClaimableFees getNearestTicksBelow getPoolSettings getQuoteAMM getQuoteOBFilledAmount getSettlementPrice getStrandedArea getTokenIds interface isApprovedForAll isQuoteOBValid marketPrice maxFlashLoan multicall name runner safeBatchTransferFrom safeTransferFrom setApprovalForAll settle settleFor settlePosition settlePositionFor supportsInterface takerFee target ticks tokensByAccount totalHolders totalSupply trade transferPosition withdraw writeFrom

Methods

addListener attach connect deployed deploymentTransaction emit getAddress getDeployedCode getEvent getFunction listenerCount listeners off on once queryFilter queryTransaction removeAllListeners removeListener waitForDeployment

Properties

Readonly [internal]

[internal]: any

_takerFeeLowLevel

_takerFeeLowLevel: TypedContractMethod<[taker: AddressLike, size: BigNumberish, premium: BigNumberish, isPremiumNormalized: boolean, strike: BigNumberish, isCallPool: boolean], [bigint], "view">

accountsByToken

accountsByToken: TypedContractMethod<[id: BigNumberish], [string[]], "view">

annihilate

annihilate: TypedContractMethod<[size: BigNumberish], [void], "nonpayable">

annihilateFor

annihilateFor: TypedContractMethod<[owner: AddressLike, size: BigNumberish], [void], "nonpayable">

balanceOf

balanceOf: TypedContractMethod<[account: AddressLike, id: BigNumberish], [bigint], "view">

balanceOfBatch

balanceOfBatch: TypedContractMethod<[accounts: AddressLike[], ids: BigNumberish[]], [bigint[]], "view">

cancelQuotesOB

cancelQuotesOB: TypedContractMethod<[hashes: BytesLike[]], [void], "nonpayable">

claim

claim: TypedContractMethod<[p: KeyStruct], [bigint], "nonpayable">

deposit((address,address,uint256,uint256,uint8),uint256,uint256,uint256,uint256,uint256)

deposit((address,address,uint256,uint256,uint8),uint256,uint256,uint256,uint256,uint256): TypedContractMethod<[p: KeyStruct, belowLower: BigNumberish, belowUpper: BigNumberish, size: BigNumberish, minMarketPrice: BigNumberish, maxMarketPrice: BigNumberish], [DeltaStructOutput], "nonpayable">

deposit((address,address,uint256,uint256,uint8),uint256,uint256,uint256,uint256,uint256,bool)

deposit((address,address,uint256,uint256,uint8),uint256,uint256,uint256,uint256,uint256,bool): TypedContractMethod<[p: KeyStruct, belowLower: BigNumberish, belowUpper: BigNumberish, size: BigNumberish, minMarketPrice: BigNumberish, maxMarketPrice: BigNumberish, isBidIfStrandedMarketPrice: boolean], [DeltaStructOutput], "nonpayable">

exercise

exercise: TypedContractMethod<[], [[bigint, bigint] & {
    exerciseFee: bigint;
    exerciseValue: bigint;
}], "nonpayable">

exerciseFor

exerciseFor: TypedContractMethod<[holders: AddressLike[], costPerHolder: BigNumberish], [[bigint[], bigint[]] & {
    exerciseFees: bigint[];
    exerciseValues: bigint[];
}], "nonpayable">

Readonly fallback

fallback: null | WrappedFallback

fillQuoteOB

fillQuoteOB: TypedContractMethod<[quoteOB: QuoteOBStruct, size: BigNumberish, signature: SignatureStruct, referrer: AddressLike], [[bigint, DeltaStructOutput] & {
    delta: DeltaStructOutput;
    premiumTaker: bigint;
}], "nonpayable">

filters

filters: {
    Annihilate: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Annihilate(address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    ApprovalForAll: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    ApprovalForAll(address,address,bool): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    CancelQuoteOB: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    CancelQuoteOB(address,bytes32): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    ClaimFees: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    ClaimFees(address,uint256,uint256,int256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    ClaimProtocolFees: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    ClaimProtocolFees(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Deposit: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Deposit(address,uint256,uint256,uint256,uint256,int256,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Exercise: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Exercise(address,address,uint256,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    FillQuoteOB: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    FillQuoteOB(bytes32,address,address,uint256,tuple,tuple,uint256,uint256,uint256,bool): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    FlashLoan: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    FlashLoan(address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Settle: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Settle(address,address,uint256,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    SettlePosition: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    SettlePosition(address,address,uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Trade: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Trade(address,uint256,tuple,uint256,uint256,uint256,uint256,uint256,uint256,uint256,bool): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    TransferBatch: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    TransferBatch(address,address,address,uint256[],uint256[]): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    TransferPosition: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    TransferPosition(address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    TransferSingle: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    TransferSingle(address,address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    UpdateTick: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    UpdateTick(uint256,uint256,uint256,int256,uint256,int256,int256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Withdrawal: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Withdrawal(address,uint256,uint256,uint256,uint256,int256,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    WriteFrom: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    WriteFrom(address,address,address,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
}

Type declaration

  • Annihilate: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Annihilate(address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • ApprovalForAll: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • ApprovalForAll(address,address,bool): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • CancelQuoteOB: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • CancelQuoteOB(address,bytes32): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • ClaimFees: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • ClaimFees(address,uint256,uint256,int256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • ClaimProtocolFees: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • ClaimProtocolFees(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Deposit: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Deposit(address,uint256,uint256,uint256,uint256,int256,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Exercise: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Exercise(address,address,uint256,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • FillQuoteOB: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • FillQuoteOB(bytes32,address,address,uint256,tuple,tuple,uint256,uint256,uint256,bool): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • FlashLoan: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • FlashLoan(address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Settle: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Settle(address,address,uint256,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • SettlePosition: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • SettlePosition(address,address,uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Trade: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Trade(address,uint256,tuple,uint256,uint256,uint256,uint256,uint256,uint256,uint256,bool): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • TransferBatch: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • TransferBatch(address,address,address,uint256[],uint256[]): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • TransferPosition: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • TransferPosition(address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • TransferSingle: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • TransferSingle(address,address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • UpdateTick: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • UpdateTick(uint256,uint256,uint256,int256,uint256,int256,int256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Withdrawal: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Withdrawal(address,uint256,uint256,uint256,uint256,int256,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • WriteFrom: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • WriteFrom(address,address,address,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

flashFee

flashFee: TypedContractMethod<[token: AddressLike, amount: BigNumberish], [bigint], "view">

flashLoan

flashLoan: TypedContractMethod<[receiver: AddressLike, token: AddressLike, amount: BigNumberish, data: BytesLike], [boolean], "nonpayable">

getClaimableFees

getClaimableFees: TypedContractMethod<[p: KeyStruct], [bigint], "view">

getNearestTicksBelow

getNearestTicksBelow: TypedContractMethod<[lower: BigNumberish, upper: BigNumberish], [[bigint, bigint] & {
    nearestBelowLower: bigint;
    nearestBelowUpper: bigint;
}], "view">

getPoolSettings

getPoolSettings: TypedContractMethod<[], [[string, string, string, bigint, bigint, boolean] & {
    base: string;
    isCallPool: boolean;
    maturity: bigint;
    oracleAdapter: string;
    quote: string;
    strike: bigint;
}], "view">

getQuoteAMM

getQuoteAMM: TypedContractMethod<[taker: AddressLike, size: BigNumberish, isBuy: boolean], [[bigint, bigint] & {
    premiumNet: bigint;
    takerFee: bigint;
}], "view">

getQuoteOBFilledAmount

getQuoteOBFilledAmount: TypedContractMethod<[provider: AddressLike, quoteOBHash: BytesLike], [bigint], "view">

getSettlementPrice

getSettlementPrice: TypedContractMethod<[], [bigint], "view">

getStrandedArea

getStrandedArea: TypedContractMethod<[], [[bigint, bigint] & {
    lower: bigint;
    upper: bigint;
}], "view">

getTokenIds

getTokenIds: TypedContractMethod<[], [bigint[]], "view">

interface

interface: IPoolInterface

isApprovedForAll

isApprovedForAll: TypedContractMethod<[account: AddressLike, operator: AddressLike], [boolean], "view">

isQuoteOBValid

isQuoteOBValid: TypedContractMethod<[quoteOB: QuoteOBStruct, size: BigNumberish, sig: SignatureStruct], [[boolean, bigint]], "view">

marketPrice

marketPrice: TypedContractMethod<[], [bigint], "view">

maxFlashLoan

maxFlashLoan: TypedContractMethod<[token: AddressLike], [bigint], "view">

multicall

multicall: TypedContractMethod<[data: BytesLike[]], [string[]], "nonpayable">

name

name: TypedContractMethod<[], [string], "view">

Readonly runner

runner: null | ContractRunner

safeBatchTransferFrom

safeBatchTransferFrom: TypedContractMethod<[from: AddressLike, to: AddressLike, ids: BigNumberish[], amounts: BigNumberish[], data: BytesLike], [void], "nonpayable">

safeTransferFrom

safeTransferFrom: TypedContractMethod<[from: AddressLike, to: AddressLike, id: BigNumberish, amount: BigNumberish, data: BytesLike], [void], "nonpayable">

setApprovalForAll

setApprovalForAll: TypedContractMethod<[operator: AddressLike, status: boolean], [void], "nonpayable">

settle

settle: TypedContractMethod<[], [bigint], "nonpayable">

settleFor

settleFor: TypedContractMethod<[holders: AddressLike[], costPerHolder: BigNumberish], [bigint[]], "nonpayable">

settlePosition

settlePosition: TypedContractMethod<[p: KeyStruct], [bigint], "nonpayable">

settlePositionFor

settlePositionFor: TypedContractMethod<[p: KeyStruct[], costPerHolder: BigNumberish], [bigint[]], "nonpayable">

supportsInterface

supportsInterface: TypedContractMethod<[interfaceId: BytesLike], [boolean], "view">

takerFee

takerFee: TypedContractMethod<[taker: AddressLike, size: BigNumberish, premium: BigNumberish, isPremiumNormalized: boolean], [bigint], "view">

Readonly target

target: string | Addressable

ticks

ticks: TypedContractMethod<[], [TickWithRatesStructOutput[]], "view">

tokensByAccount

tokensByAccount: TypedContractMethod<[account: AddressLike], [bigint[]], "view">

totalHolders

totalHolders: TypedContractMethod<[id: BigNumberish], [bigint], "view">

totalSupply

totalSupply: TypedContractMethod<[id: BigNumberish], [bigint], "view">

trade

trade: TypedContractMethod<[size: BigNumberish, isBuy: boolean, premiumLimit: BigNumberish, referrer: AddressLike], [[bigint, DeltaStructOutput] & {
    delta: DeltaStructOutput;
    totalPremium: bigint;
}], "nonpayable">

transferPosition

transferPosition: TypedContractMethod<[srcP: KeyStruct, newOwner: AddressLike, newOperator: AddressLike, size: BigNumberish], [void], "nonpayable">

withdraw

withdraw: TypedContractMethod<[p: KeyStruct, size: BigNumberish, minMarketPrice: BigNumberish, maxMarketPrice: BigNumberish], [DeltaStructOutput], "nonpayable">

writeFrom

writeFrom: TypedContractMethod<[underwriter: AddressLike, longReceiver: AddressLike, size: BigNumberish, referrer: AddressLike], [void], "nonpayable">

Methods

addListener

  • Parameters

    • event: ContractEventName
    • listener: Listener

    Returns Promise<IPool>

attach

  • Parameters

    • addressOrName: AddressLike

    Returns IPool

connect

  • Parameters

    • Optional runner: null | ContractRunner

    Returns BaseContract

deployed

  • Returns Promise<IPool>

deploymentTransaction

  • Returns null | ContractTransactionResponse

emit

  • Parameters

    • event: ContractEventName
    • Rest ...args: any[]

    Returns Promise<boolean>

getAddress

  • Returns Promise<string>

getDeployedCode

  • Returns Promise<null | string>

getEvent

  • Parameters

    • key: "Annihilate"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "ApprovalForAll"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "CancelQuoteOB"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "ClaimFees"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "ClaimProtocolFees"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "Deposit"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "Exercise"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "FillQuoteOB"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "FlashLoan"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "Settle"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "SettlePosition"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "Trade"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "TransferBatch"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "TransferPosition"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "TransferSingle"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "UpdateTick"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "Withdrawal"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "WriteFrom"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

getFunction

  • Type Parameters

    • T extends ContractMethod<any[], any, any, T> = ContractMethod<any[], any, any>

    Parameters

    • key: string | FunctionFragment

    Returns T

  • Parameters

    • nameOrSignature: "_takerFeeLowLevel"

    Returns TypedContractMethod<[taker: AddressLike, size: BigNumberish, premium: BigNumberish, isPremiumNormalized: boolean, strike: BigNumberish, isCallPool: boolean], [bigint], "view">

  • Parameters

    • nameOrSignature: "accountsByToken"

    Returns TypedContractMethod<[id: BigNumberish], [string[]], "view">

  • Parameters

    • nameOrSignature: "annihilate"

    Returns TypedContractMethod<[size: BigNumberish], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "annihilateFor"

    Returns TypedContractMethod<[owner: AddressLike, size: BigNumberish], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "balanceOf"

    Returns TypedContractMethod<[account: AddressLike, id: BigNumberish], [bigint], "view">

  • Parameters

    • nameOrSignature: "balanceOfBatch"

    Returns TypedContractMethod<[accounts: AddressLike[], ids: BigNumberish[]], [bigint[]], "view">

  • Parameters

    • nameOrSignature: "cancelQuotesOB"

    Returns TypedContractMethod<[hashes: BytesLike[]], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "claim"

    Returns TypedContractMethod<[p: KeyStruct], [bigint], "nonpayable">

  • Parameters

    • nameOrSignature: "deposit((address,address,uint256,uint256,uint8),uint256,uint256,uint256,uint256,uint256)"

    Returns TypedContractMethod<[p: KeyStruct, belowLower: BigNumberish, belowUpper: BigNumberish, size: BigNumberish, minMarketPrice: BigNumberish, maxMarketPrice: BigNumberish], [DeltaStructOutput], "nonpayable">

  • Parameters

    • nameOrSignature: "deposit((address,address,uint256,uint256,uint8),uint256,uint256,uint256,uint256,uint256,bool)"

    Returns TypedContractMethod<[p: KeyStruct, belowLower: BigNumberish, belowUpper: BigNumberish, size: BigNumberish, minMarketPrice: BigNumberish, maxMarketPrice: BigNumberish, isBidIfStrandedMarketPrice: boolean], [DeltaStructOutput], "nonpayable">

  • Parameters

    • nameOrSignature: "exercise"

    Returns TypedContractMethod<[], [[bigint, bigint] & {
        exerciseFee: bigint;
        exerciseValue: bigint;
    }], "nonpayable">

  • Parameters

    • nameOrSignature: "exerciseFor"

    Returns TypedContractMethod<[holders: AddressLike[], costPerHolder: BigNumberish], [[bigint[], bigint[]] & {
        exerciseFees: bigint[];
        exerciseValues: bigint[];
    }], "nonpayable">

  • Parameters

    • nameOrSignature: "fillQuoteOB"

    Returns TypedContractMethod<[quoteOB: QuoteOBStruct, size: BigNumberish, signature: SignatureStruct, referrer: AddressLike], [[bigint, DeltaStructOutput] & {
        delta: DeltaStructOutput;
        premiumTaker: bigint;
    }], "nonpayable">

  • Parameters

    • nameOrSignature: "flashFee"

    Returns TypedContractMethod<[token: AddressLike, amount: BigNumberish], [bigint], "view">

  • Parameters

    • nameOrSignature: "flashLoan"

    Returns TypedContractMethod<[receiver: AddressLike, token: AddressLike, amount: BigNumberish, data: BytesLike], [boolean], "nonpayable">

  • Parameters

    • nameOrSignature: "getClaimableFees"

    Returns TypedContractMethod<[p: KeyStruct], [bigint], "view">

  • Parameters

    • nameOrSignature: "getNearestTicksBelow"

    Returns TypedContractMethod<[lower: BigNumberish, upper: BigNumberish], [[bigint, bigint] & {
        nearestBelowLower: bigint;
        nearestBelowUpper: bigint;
    }], "view">

  • Parameters

    • nameOrSignature: "getPoolSettings"

    Returns TypedContractMethod<[], [[string, string, string, bigint, bigint, boolean] & {
        base: string;
        isCallPool: boolean;
        maturity: bigint;
        oracleAdapter: string;
        quote: string;
        strike: bigint;
    }], "view">

  • Parameters

    • nameOrSignature: "getQuoteAMM"

    Returns TypedContractMethod<[taker: AddressLike, size: BigNumberish, isBuy: boolean], [[bigint, bigint] & {
        premiumNet: bigint;
        takerFee: bigint;
    }], "view">

  • Parameters

    • nameOrSignature: "getQuoteOBFilledAmount"

    Returns TypedContractMethod<[provider: AddressLike, quoteOBHash: BytesLike], [bigint], "view">

  • Parameters

    • nameOrSignature: "getSettlementPrice"

    Returns TypedContractMethod<[], [bigint], "view">

  • Parameters

    • nameOrSignature: "getStrandedArea"

    Returns TypedContractMethod<[], [[bigint, bigint] & {
        lower: bigint;
        upper: bigint;
    }], "view">

  • Parameters

    • nameOrSignature: "getTokenIds"

    Returns TypedContractMethod<[], [bigint[]], "view">

  • Parameters

    • nameOrSignature: "isApprovedForAll"

    Returns TypedContractMethod<[account: AddressLike, operator: AddressLike], [boolean], "view">

  • Parameters

    • nameOrSignature: "isQuoteOBValid"

    Returns TypedContractMethod<[quoteOB: QuoteOBStruct, size: BigNumberish, sig: SignatureStruct], [[boolean, bigint]], "view">

  • Parameters

    • nameOrSignature: "marketPrice"

    Returns TypedContractMethod<[], [bigint], "view">

  • Parameters

    • nameOrSignature: "maxFlashLoan"

    Returns TypedContractMethod<[token: AddressLike], [bigint], "view">

  • Parameters

    • nameOrSignature: "multicall"

    Returns TypedContractMethod<[data: BytesLike[]], [string[]], "nonpayable">

  • Parameters

    • nameOrSignature: "name"

    Returns TypedContractMethod<[], [string], "view">

  • Parameters

    • nameOrSignature: "safeBatchTransferFrom"

    Returns TypedContractMethod<[from: AddressLike, to: AddressLike, ids: BigNumberish[], amounts: BigNumberish[], data: BytesLike], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "safeTransferFrom"

    Returns TypedContractMethod<[from: AddressLike, to: AddressLike, id: BigNumberish, amount: BigNumberish, data: BytesLike], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "setApprovalForAll"

    Returns TypedContractMethod<[operator: AddressLike, status: boolean], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "settle"

    Returns TypedContractMethod<[], [bigint], "nonpayable">

  • Parameters

    • nameOrSignature: "settleFor"

    Returns TypedContractMethod<[holders: AddressLike[], costPerHolder: BigNumberish], [bigint[]], "nonpayable">

  • Parameters

    • nameOrSignature: "settlePosition"

    Returns TypedContractMethod<[p: KeyStruct], [bigint], "nonpayable">

  • Parameters

    • nameOrSignature: "settlePositionFor"

    Returns TypedContractMethod<[p: KeyStruct[], costPerHolder: BigNumberish], [bigint[]], "nonpayable">

  • Parameters

    • nameOrSignature: "supportsInterface"

    Returns TypedContractMethod<[interfaceId: BytesLike], [boolean], "view">

  • Parameters

    • nameOrSignature: "takerFee"

    Returns TypedContractMethod<[taker: AddressLike, size: BigNumberish, premium: BigNumberish, isPremiumNormalized: boolean], [bigint], "view">

  • Parameters

    • nameOrSignature: "ticks"

    Returns TypedContractMethod<[], [TickWithRatesStructOutput[]], "view">

  • Parameters

    • nameOrSignature: "tokensByAccount"

    Returns TypedContractMethod<[account: AddressLike], [bigint[]], "view">

  • Parameters

    • nameOrSignature: "totalHolders"

    Returns TypedContractMethod<[id: BigNumberish], [bigint], "view">

  • Parameters

    • nameOrSignature: "totalSupply"

    Returns TypedContractMethod<[id: BigNumberish], [bigint], "view">

  • Parameters

    • nameOrSignature: "trade"

    Returns TypedContractMethod<[size: BigNumberish, isBuy: boolean, premiumLimit: BigNumberish, referrer: AddressLike], [[bigint, DeltaStructOutput] & {
        delta: DeltaStructOutput;
        totalPremium: bigint;
    }], "nonpayable">

  • Parameters

    • nameOrSignature: "transferPosition"

    Returns TypedContractMethod<[srcP: KeyStruct, newOwner: AddressLike, newOperator: AddressLike, size: BigNumberish], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "withdraw"

    Returns TypedContractMethod<[p: KeyStruct, size: BigNumberish, minMarketPrice: BigNumberish, maxMarketPrice: BigNumberish], [DeltaStructOutput], "nonpayable">

  • Parameters

    • nameOrSignature: "writeFrom"

    Returns TypedContractMethod<[underwriter: AddressLike, longReceiver: AddressLike, size: BigNumberish, referrer: AddressLike], [void], "nonpayable">

listenerCount

  • Parameters

    • Optional event: ContractEventName

    Returns Promise<number>

listeners

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • event: TCEvent

    Returns Promise<TypedListener<TCEvent>[]>

  • Parameters

    • Optional eventName: string

    Returns Promise<Listener[]>

off

  • Parameters

    • event: ContractEventName
    • Optional listener: Listener

    Returns Promise<IPool>

on

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • event: TCEvent
    • listener: TypedListener<TCEvent>

    Returns Promise<IPool>

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • filter: TypedDeferredTopicFilter<TCEvent>
    • listener: TypedListener<TCEvent>

    Returns Promise<IPool>

once

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • event: TCEvent
    • listener: TypedListener<TCEvent>

    Returns Promise<IPool>

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • filter: TypedDeferredTopicFilter<TCEvent>
    • listener: TypedListener<TCEvent>

    Returns Promise<IPool>

queryFilter

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • event: TCEvent
    • Optional fromBlockOrBlockhash: string | number
    • Optional toBlock: string | number

    Returns Promise<TypedEventLog<TCEvent>[]>

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • filter: TypedDeferredTopicFilter<TCEvent>
    • Optional fromBlockOrBlockhash: string | number
    • Optional toBlock: string | number

    Returns Promise<TypedEventLog<TCEvent>[]>

queryTransaction

  • Parameters

    • hash: string

    Returns Promise<EventLog[]>

removeAllListeners

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any, TCEvent>

    Parameters

    • Optional event: TCEvent

    Returns Promise<IPool>

removeListener

  • Parameters

    • event: ContractEventName
    • listener: Listener

    Returns Promise<IPool>

waitForDeployment

  • Returns Promise<IPool>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc