Interface IVault

Hierarchy

BaseContract
- IVault

Properties

`Readonly` [internal]

[internal]: any

`Readonly` fallback

fallback: null | WrappedFallback

filters

filters: {
    Approval: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Approval(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Borrow: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Borrow(bytes32,address,address,address,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    BorrowLiquidated: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    BorrowLiquidated(bytes32,address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Deposit: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Deposit(address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    ManagementFeePaid: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    ManagementFeePaid(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    PerformanceFeePaid: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    PerformanceFeePaid(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    RepayBorrow: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    RepayBorrow(bytes32,address,address,address,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Swap: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Swap(address,address,address,address,uint256,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Trade: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Trade(address,address,uint256,bool,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Transfer: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Transfer(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    UpdateQuotes: TypedContractEvent<[], [], OutputObject>;
    UpdateQuotes(): TypedContractEvent<[], [], OutputObject>;
    Withdraw: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Withdraw(address,address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
}

Type declaration

Approval: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Approval(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Borrow: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Borrow(bytes32,address,address,address,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
BorrowLiquidated: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
BorrowLiquidated(bytes32,address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Deposit: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Deposit(address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
ManagementFeePaid: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
ManagementFeePaid(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
PerformanceFeePaid: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
PerformanceFeePaid(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
RepayBorrow: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
RepayBorrow(bytes32,address,address,address,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Swap: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Swap(address,address,address,address,uint256,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Trade: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Trade(address,address,uint256,bool,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Transfer: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Transfer(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
UpdateQuotes: TypedContractEvent<[], [], OutputObject>
UpdateQuotes(): TypedContractEvent<[], [], OutputObject>
Withdraw: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Withdraw(address,address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

getQuote

getQuote: TypedContractMethod<[poolKey: PoolKeyStruct, size: BigNumberish, isBuy: boolean, taker: AddressLike], [bigint], "view">

interface

interface: IVaultInterface

`Readonly` runner

runner: null | ContractRunner

`Readonly` target

target: string | Addressable

trade

trade: TypedContractMethod<[poolKey: PoolKeyStruct, size: BigNumberish, isBuy: boolean, premiumLimit: BigNumberish, referrer: AddressLike], [void], "nonpayable">

updateSettings

updateSettings: TypedContractMethod<[settings: BytesLike], [void], "nonpayable">

Methods

addListener

addListener(event, listener): Promise<IVault>
Parameters
- event: ContractEventName
- listener: Listener
Returns Promise<IVault>
Inherited from BaseContract.addListener
- Defined in node_modules/ethers/types/contract/contract.d.ts:42

attach

attach(addressOrName): IVault
Parameters
- addressOrName: AddressLike
Returns IVault
- Defined in src/typechain/IVault.ts:404

connect

connect(runner?): BaseContract
Parameters
- Optional runner: null | ContractRunner
Returns BaseContract
Overrides BaseContract.connect
- Defined in src/typechain/IVault.ts:403

deployed

deployed(): Promise<IVault>
Returns Promise<IVault>
- Defined in src/typechain/IVault.ts:405

deploymentTransaction

deploymentTransaction(): null | ContractTransactionResponse
Returns null | ContractTransactionResponse
Inherited from BaseContract.deploymentTransaction
- Defined in node_modules/ethers/types/contract/contract.d.ts:30

emit

emit(event, ...args): Promise<boolean>
Parameters
- event: ContractEventName
- Rest ...args: any[]
Returns Promise<boolean>
Inherited from BaseContract.emit
- Defined in node_modules/ethers/types/contract/contract.d.ts:37

getAddress

getAddress(): Promise<string>
Returns Promise<string>
Inherited from BaseContract.getAddress
- Defined in node_modules/ethers/types/contract/contract.d.ts:27

getDeployedCode

getDeployedCode(): Promise<null | string>
Returns Promise<null | string>
Inherited from BaseContract.getDeployedCode
- Defined in node_modules/ethers/types/contract/contract.d.ts:28

getEvent

getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "Approval"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IVault.ts:508
getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "Borrow"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IVault.ts:515
getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "BorrowLiquidated"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IVault.ts:522
getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "Deposit"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IVault.ts:529
getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "ManagementFeePaid"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IVault.ts:536
getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "PerformanceFeePaid"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IVault.ts:543
getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "RepayBorrow"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IVault.ts:550
getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "Swap"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IVault.ts:557
getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "Trade"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IVault.ts:564
getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "Transfer"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IVault.ts:571
getEvent(key): TypedContractEvent<[], [], OutputObject>
Parameters
- key: "UpdateQuotes"
Returns TypedContractEvent<[], [], OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IVault.ts:578
getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "Withdraw"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/IVault.ts:585

getFunction

getFunction<T>(key): T
Type Parameters
- T extends ContractMethod<any[], any, any, T> = ContractMethod<any[], any, any>
Parameters
- key: string | FunctionFragment
Returns T
Overrides BaseContract.getFunction
- Defined in src/typechain/IVault.ts:475
getFunction(nameOrSignature): TypedContractMethod<[poolKey: PoolKeyStruct, size: BigNumberish, isBuy: boolean, taker: AddressLike], [bigint], "view">
Parameters
- nameOrSignature: "getQuote"
Returns TypedContractMethod<[poolKey: PoolKeyStruct, size: BigNumberish, isBuy: boolean, taker: AddressLike], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in src/typechain/IVault.ts:479
getFunction(nameOrSignature): TypedContractMethod<[poolKey: PoolKeyStruct, size: BigNumberish, isBuy: boolean, premiumLimit: BigNumberish, referrer: AddressLike], [void], "nonpayable">
Parameters
- nameOrSignature: "trade"
Returns TypedContractMethod<[poolKey: PoolKeyStruct, size: BigNumberish, isBuy: boolean, premiumLimit: BigNumberish, referrer: AddressLike], [void], "nonpayable">
Overrides BaseContract.getFunction
- Defined in src/typechain/IVault.ts:491
getFunction(nameOrSignature): TypedContractMethod<[settings: BytesLike], [void], "nonpayable">
Parameters
- nameOrSignature: "updateSettings"
Returns TypedContractMethod<[settings: BytesLike], [void], "nonpayable">
Overrides BaseContract.getFunction
- Defined in src/typechain/IVault.ts:504

listenerCount

listenerCount(event?): Promise<number>
Parameters
- Optional event: ContractEventName
Returns Promise<number>
Inherited from BaseContract.listenerCount
- Defined in node_modules/ethers/types/contract/contract.d.ts:38

listeners

listeners<TCEvent>(event): Promise<TypedListener<TCEvent>[]>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
Returns Promise<TypedListener<TCEvent>[]>
Overrides BaseContract.listeners
- Defined in src/typechain/IVault.ts:438
listeners(eventName?): Promise<Listener[]>
Parameters
- Optional eventName: string
Returns Promise<Listener[]>
Overrides BaseContract.listeners
- Defined in src/typechain/IVault.ts:441

off

off(event, listener?): Promise<IVault>
Parameters
- event: ContractEventName
- Optional listener: Listener
Returns Promise<IVault>
Inherited from BaseContract.off
- Defined in node_modules/ethers/types/contract/contract.d.ts:40

on

on<TCEvent>(event, listener): Promise<IVault>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
- listener: TypedListener<TCEvent>
Returns Promise<IVault>
Overrides BaseContract.on
- Defined in src/typechain/IVault.ts:420
on<TCEvent>(filter, listener): Promise<IVault>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- filter: TypedDeferredTopicFilter<TCEvent>
- listener: TypedListener<TCEvent>
Returns Promise<IVault>
Overrides BaseContract.on
- Defined in src/typechain/IVault.ts:424

once

once<TCEvent>(event, listener): Promise<IVault>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
- listener: TypedListener<TCEvent>
Returns Promise<IVault>
Overrides BaseContract.once
- Defined in src/typechain/IVault.ts:429
once<TCEvent>(filter, listener): Promise<IVault>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- filter: TypedDeferredTopicFilter<TCEvent>
- listener: TypedListener<TCEvent>
Returns Promise<IVault>
Overrides BaseContract.once
- Defined in src/typechain/IVault.ts:433

queryFilter

queryFilter<TCEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TypedEventLog<TCEvent>[]>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
- Optional fromBlockOrBlockhash: string | number
- Optional toBlock: string | number
Returns Promise<TypedEventLog<TCEvent>[]>
Overrides BaseContract.queryFilter
- Defined in src/typechain/IVault.ts:409
queryFilter<TCEvent>(filter, fromBlockOrBlockhash?, toBlock?): 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>[]>
Overrides BaseContract.queryFilter
- Defined in src/typechain/IVault.ts:414

queryTransaction

queryTransaction(hash): Promise<EventLog[]>
Parameters
- hash: string
Returns Promise<EventLog[]>
Inherited from BaseContract.queryTransaction
- Defined in node_modules/ethers/types/contract/contract.d.ts:33

removeAllListeners

removeAllListeners<TCEvent>(event?): Promise<IVault>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- Optional event: TCEvent
Returns Promise<IVault>
Overrides BaseContract.removeAllListeners
- Defined in src/typechain/IVault.ts:442

removeListener

removeListener(event, listener): Promise<IVault>
Parameters
- event: ContractEventName
- listener: Listener
Returns Promise<IVault>
Inherited from BaseContract.removeListener
- Defined in node_modules/ethers/types/contract/contract.d.ts:43

waitForDeployment

waitForDeployment(): Promise<IVault>
Returns Promise<IVault>
Inherited from BaseContract.waitForDeployment
- Defined in node_modules/ethers/types/contract/contract.d.ts:29

Interface IVault

Hierarchy

Index

Properties

Methods

Properties

Readonly [internal]

Readonly fallback

filters

Type declaration

Approval: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Approval(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Borrow: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Borrow(bytes32,address,address,address,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

BorrowLiquidated: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

BorrowLiquidated(bytes32,address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Deposit: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Deposit(address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

ManagementFeePaid: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

ManagementFeePaid(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

PerformanceFeePaid: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

PerformanceFeePaid(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

RepayBorrow: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

RepayBorrow(bytes32,address,address,address,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Swap: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Swap(address,address,address,address,uint256,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Trade: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Trade(address,address,uint256,bool,uint256,uint256,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Transfer: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Transfer(address,address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

UpdateQuotes: TypedContractEvent<[], [], OutputObject>

UpdateQuotes(): TypedContractEvent<[], [], OutputObject>

Withdraw: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Withdraw(address,address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

getQuote

interface

Readonly runner

Readonly target

trade

updateSettings

Methods

addListener

Parameters

event: ContractEventName

listener: Listener

Returns Promise<IVault>

attach

Parameters

addressOrName: AddressLike

Returns IVault

connect

Parameters

Optional runner: null | ContractRunner

Returns BaseContract

deployed

Returns Promise<IVault>

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: "Approval"

Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Parameters

key: "Borrow"

Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Parameters

key: "BorrowLiquidated"

Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Parameters

key: "Deposit"

Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

`Readonly` [internal]

`Readonly` fallback

`Readonly` runner

`Readonly` target

`Optional` runner: null | ContractRunner

`Rest` ...args: any[]

`Optional` event: ContractEventName

`Optional` eventName: string

`Optional` listener: Listener