Interface IPoolFactory

Hierarchy

BaseContract
- IPoolFactory

Properties

`Readonly` [internal]

[internal]: any

@_ignore:

deployPool

deployPool: TypedContractMethod<[k: PoolKeyStruct], [string], "payable">

`Readonly` fallback

fallback: null | WrappedFallback

The fallback or receive function if any.

filters

filters: {
    PoolDeployed: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    PoolDeployed(address,address,address,uint256,uint256,bool,address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    PricingPath: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    PricingPath(address,address[][],uint8[],uint8,address[][],uint8[],uint8): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
}

Type declaration

PoolDeployed: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
PoolDeployed(address,address,address,uint256,uint256,bool,address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
PricingPath: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
PricingPath(address,address[][],uint8[],uint8,address[][],uint8[],uint8): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

getPoolAddress

getPoolAddress: TypedContractMethod<[k: PoolKeyStruct], [[string, boolean] & {
isDeployed: boolean;
pool: string;
}], "view">

initializationFee

initializationFee: TypedContractMethod<[k: PoolKeyStruct], [bigint], "view">

interface

interface: IPoolFactoryInterface

isPool

isPool: TypedContractMethod<[contractAddress: AddressLike], [boolean], "view">

`Readonly` runner

runner: null | ContractRunner

The connected runner. This is generally a [[Provider]] or a [[Signer]], which dictates what operations are supported.

For example, a Contract connected to a [[Provider]] may only execute read-only operations.

`Readonly` target

target: string | Addressable

The target to connect to.

This can be an address, ENS name or any [[Addressable]], such as another contract. To get the resovled address, use the getAddress method.

Methods

addListener

addListener(event, listener): Promise<IPoolFactory>
Alias for [on].
Parameters
- event: ContractEventName
- listener: Listener
Returns Promise<IPoolFactory>
Inherited from BaseContract.addListener
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:147

attach

attach(target): BaseContract
Return a new Contract instance with the same ABI and runner, but a different %%target%%.
Parameters
- target: string | Addressable
Returns BaseContract
Inherited from BaseContract.attach
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:66

connect

connect(runner?): IPoolFactory
Parameters
- Optional runner: null | ContractRunner
Returns IPoolFactory
Overrides BaseContract.connect
- Defined in node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:107

deploymentTransaction

deploymentTransaction(): null | ContractTransactionResponse
Return the transaction used to deploy this contract.

This is only available if this instance was returned from a [[ContractFactory]].

Returns null | ContractTransactionResponse
Inherited from BaseContract.deploymentTransaction
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:86

emit

emit(event, ...args): Promise<boolean>
Emit an %%event%% calling all listeners with %%args%%.

Resolves to true if any listeners were called.
Parameters
- event: ContractEventName
- Rest ...args: any[]
Returns Promise<boolean>
Inherited from BaseContract.emit
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:123

getAddress

getAddress(): Promise<string>
Return the resolved address of this Contract.

Returns Promise<string>
Inherited from BaseContract.getAddress
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:70

getDeployedCode

getDeployedCode(): Promise<null | string>
Return the deployed bytecode or null if no bytecode is found.

Returns Promise<null | string>
Inherited from BaseContract.getDeployedCode
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:74

getEvent

getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "PoolDeployed"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:154
getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "PricingPath"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:155

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 node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:142
getFunction(nameOrSignature): TypedContractMethod<[k: PoolKeyStruct], [string], "payable">
Parameters
- nameOrSignature: "deployPool"
Returns TypedContractMethod<[k: PoolKeyStruct], [string], "payable">
Overrides BaseContract.getFunction
- Defined in node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:143
getFunction(nameOrSignature): TypedContractMethod<[k: PoolKeyStruct], [[string, boolean] & {
isDeployed: boolean;
pool: string;
}], "view">
Parameters
- nameOrSignature: "getPoolAddress"
Returns TypedContractMethod<[k: PoolKeyStruct], [[string, boolean] & {
isDeployed: boolean;
pool: string;
}], "view">
Overrides BaseContract.getFunction
- Defined in node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:144
getFunction(nameOrSignature): TypedContractMethod<[k: PoolKeyStruct], [bigint], "view">
Parameters
- nameOrSignature: "initializationFee"
Returns TypedContractMethod<[k: PoolKeyStruct], [bigint], "view">
Overrides BaseContract.getFunction
- Defined in node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:152
getFunction(nameOrSignature): TypedContractMethod<[contractAddress: AddressLike], [boolean], "view">
Parameters
- nameOrSignature: "isPool"
Returns TypedContractMethod<[contractAddress: AddressLike], [boolean], "view">
Overrides BaseContract.getFunction
- Defined in node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:153

listenerCount

listenerCount(event?): Promise<number>
Resolves to the number of listeners of %%event%% or the total number of listeners if unspecified.
Parameters
- Optional event: ContractEventName
Returns Promise<number>
Inherited from BaseContract.listenerCount
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:128

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 node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:116
listeners(eventName?): Promise<Listener[]>
Parameters
- Optional eventName: string
Returns Promise<Listener[]>
Overrides BaseContract.listeners
- Defined in node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:117

off

off(event, listener?): Promise<IPoolFactory>
Remove the %%listener%% from the listeners for %%event%% or remove all listeners if unspecified.
Parameters
- event: ContractEventName
- Optional listener: Listener
Returns Promise<IPoolFactory>
Inherited from BaseContract.off
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:138

on

on<TCEvent>(event, listener): Promise<IPoolFactory>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
- listener: TypedListener<TCEvent>
Returns Promise<IPoolFactory>
Overrides BaseContract.on
- Defined in node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:112
on<TCEvent>(filter, listener): Promise<IPoolFactory>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- filter: TypedDeferredTopicFilter<TCEvent>
- listener: TypedListener<TCEvent>
Returns Promise<IPoolFactory>
Overrides BaseContract.on
- Defined in node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:113

once

once<TCEvent>(event, listener): Promise<IPoolFactory>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
- listener: TypedListener<TCEvent>
Returns Promise<IPoolFactory>
Overrides BaseContract.once
- Defined in node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:114
once<TCEvent>(filter, listener): Promise<IPoolFactory>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- filter: TypedDeferredTopicFilter<TCEvent>
- listener: TypedListener<TCEvent>
Returns Promise<IPoolFactory>
Overrides BaseContract.once
- Defined in node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:115

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 node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:110
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 node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:111

queryTransaction

queryTransaction(hash): Promise<EventLog[]>
@_ignore:
Parameters
- hash: string
Returns Promise<EventLog[]>
Inherited from BaseContract.queryTransaction
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:102

removeAllListeners

removeAllListeners<TCEvent>(event?): Promise<IPoolFactory>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- Optional event: TCEvent
Returns Promise<IPoolFactory>
Overrides BaseContract.removeAllListeners
- Defined in node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:118

removeListener

removeListener(event, listener): Promise<IPoolFactory>
Alias for [off].
Parameters
- event: ContractEventName
- listener: Listener
Returns Promise<IPoolFactory>
Inherited from BaseContract.removeListener
- Defined in node_modules/ethers/lib.commonjs/contract/contract.d.ts:151

waitForDeployment

waitForDeployment(): Promise<IPoolFactory>
Returns Promise<IPoolFactory>
Overrides BaseContract.waitForDeployment
- Defined in node_modules/@premia/v3-abi/typechain/IPoolFactory.d.ts:108

Interface IPoolFactory

Hierarchy

Index

Properties

Methods

Properties

Readonly [internal]

deployPool

Readonly fallback

filters

Type declaration

PoolDeployed: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

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

PricingPath: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

PricingPath(address,address[][],uint8[],uint8,address[][],uint8[],uint8): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

getPoolAddress

initializationFee

interface

isPool

Readonly runner

Readonly target

Methods

addListener

Parameters

event: ContractEventName

listener: Listener

Returns Promise<IPoolFactory>

attach

Parameters

target: string | Addressable

Returns BaseContract

connect

Parameters

Optional runner: null | ContractRunner

Returns IPoolFactory

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

Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

Parameters

key: "PricingPath"

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

Returns TypedContractMethod<[k: PoolKeyStruct], [string], "payable">

Parameters

nameOrSignature: "getPoolAddress"

Returns TypedContractMethod<[k: PoolKeyStruct], [[string, boolean] & { isDeployed: boolean; pool: string; }], "view">

Parameters

nameOrSignature: "initializationFee"

Returns TypedContractMethod<[k: PoolKeyStruct], [bigint], "view">

Parameters

nameOrSignature: "isPool"

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

listenerCount

Parameters

Optional event: ContractEventName

Returns Promise<number>

listeners

Type Parameters

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

Parameters

event: TCEvent

`Readonly` [internal]

`Readonly` fallback

`Readonly` runner

`Readonly` target

`Optional` runner: null | ContractRunner

`Rest` ...args: any[]

Returns TypedContractMethod<[k: PoolKeyStruct], [[string, boolean] & {
isDeployed: boolean;
pool: string;
}], "view">

`Optional` event: ContractEventName

`Optional` eventName: string

`Optional` listener: Listener

`Optional` fromBlockOrBlockhash: string | number

`Optional` toBlock: string | number

`Optional` fromBlockOrBlockhash: string | number

`Optional` toBlock: string | number

`Optional` event: TCEvent