Properties Optional _contract_contract?: LeveragedPool
Defined in src/entities/pool.ts:75 Optional _keeper_keeper?: PoolKeeper
Defined in src/entities/pool.ts:76 address address: string
Defined in src/entities/pool.ts:70 chain chain: undefined | number
Defined in src/entities/pool.ts:73 committer Defined in src/entities/pool.ts:84 connect connect: ( provider: Provider | Signer ) => void = ...
Defined in src/entities/pool.ts:649 Type declaration ( provider: Provider | Signer ) : void Parameters provider: Provider | Signer Returns void fee fee: BigNumber
Defined in src/entities/pool.ts:82 fetch fetch: ( ) => Promise < BigNumber > = ...
Defined in src/entities/pool.ts:429 Type declaration Returns Promise < BigNumber > fetch fetch: ( ) => Promise < BigNumber > = ...
Defined in src/entities/pool.ts:445 Type declaration Returns Promise < BigNumber > fetch fetch: ( ) => Promise < BigNumber > = ...
Defined in src/entities/pool.ts:413 Type declaration Returns Promise < BigNumber > fetch fetch: ( ) => Promise < { longBalance: BigNumber ; shortBalance: BigNumber } > = ...
Defined in src/entities/pool.ts:381 Type declaration ( ) : Promise < { longBalance: BigNumber ; shortBalance: BigNumber } > Returns Promise < { longBalance: BigNumber ; shortBalance: BigNumber } > the fetched long and short balances
front front: BigNumber
Defined in src/entities/pool.ts:80 get get: ( ) => BigNumber = ...
Defined in src/entities/pool.ts:664 get get
Expected
Pool
State
: ( atEndOf
: "frontRunningInterval" | "updateInterval" , forceRefreshInputs
?: boolean ) => Promise < PoolStatePreview > = ... Defined in src/entities/pool.ts:581 Type declaration ( atEndOf: "frontRunningInterval" | "updateInterval" , forceRefreshInputs?: boolean ) : Promise < PoolStatePreview > Parameters atEndOf: "frontRunningInterval" | "updateInterval" Optional forceRefreshInputs: boolean
get get
Fee
And
Leverage
: ( poolInfo
: IPool , chainId
: number , name
: string , provider
: Provider , contract
: LeveragedPool ) => Promise < [ string | BigNumber , number | BigNumber ] > = ... Defined in src/entities/pool.ts:297 Type declaration ( poolInfo: IPool , chainId: number , name: string , provider: Provider , contract: LeveragedPool ) : Promise < [ string | BigNumber , number | BigNumber ] > Parameters chainId: number name: string provider: Provider contract: LeveragedPool Returns Promise < [ string | BigNumber , number | BigNumber ] > the fee and leverage amounts
get get: ( ) => BigNumber = ...
Defined in src/entities/pool.ts:288 Type declaration Returns BigNumber the long token price in quote token units (eg USD)
get get: ( ) => BigNumber = ...
Defined in src/entities/pool.ts:347 Type declaration Returns BigNumber the long token price in quote token units (eg USD)
get get: ( ) => BigNumber = ...
Defined in src/entities/pool.ts:361 Type declaration Returns BigNumber the long token price in quote token units (eg USD)
get get: ( ) => { longValueTransfer: BigNumber ; shortValueTransfer: BigNumber } = ...
Defined in src/entities/pool.ts:274 Type declaration ( ) : { longValueTransfer: BigNumber ; shortValueTransfer: BigNumber } Returns { longValueTransfer: BigNumber ; shortValueTransfer: BigNumber } and object containing short and long value transfer.
The values will be a negation of eachother but this way reads better than
returning a winning side as well as a value
long: BigNumber short: BigNumber get Defined in src/entities/pool.ts:462 Type declaration promise resolving to an array of TotalPoolCommitmentsBNs
get Defined in src/entities/pool.ts:498 Type declaration promise resolving to a TotalPoolCommitmentsBN object
get get
Pool
State
Preview
: ( atEndOf
: "frontRunningInterval" | "updateInterval" , forceRefreshInputs
?: boolean ) => Promise < PoolStatePreview > = ... Defined in src/entities/pool.ts:520 Type declaration ( atEndOf: "frontRunningInterval" | "updateInterval" , forceRefreshInputs?: boolean ) : Promise < PoolStatePreview > Parameters atEndOf: "frontRunningInterval" | "updateInterval" Optional forceRefreshInputs: boolean
get get: ( ) => BigNumber = ...
Defined in src/entities/pool.ts:338 Type declaration Returns BigNumber the long token price in quote token units (eg USD)
get get: ( ) => BigNumber = ...
Defined in src/entities/pool.ts:375 Private initinit
: ( poolInfo
: IPool ) => Promise < void > = ... Defined in src/entities/pool.ts:164 Type declaration ( poolInfo: IPool ) : Promise < void > Parameters Returns Promise < void > keeper keeper: string
Defined in src/entities/pool.ts:83 last last: BigNumber
Defined in src/entities/pool.ts:91 last last: BigNumber
Defined in src/entities/pool.ts:90 leverage leverage: number
Defined in src/entities/pool.ts:81 long long: BigNumber
Defined in src/entities/pool.ts:93 long Defined in src/entities/pool.ts:88 multicall multicall: undefined | Signer | MulticallProvider
Defined in src/entities/pool.ts:72 name name: string
Defined in src/entities/pool.ts:78 oracle Defined in src/entities/pool.ts:86 oracle oracle: BigNumber
Defined in src/entities/pool.ts:94 oracle Defined in src/entities/pool.ts:95 pool Defined in src/entities/pool.ts:85 provider provider: undefined | Provider | Signer
Defined in src/entities/pool.ts:71 set set: ( price: BigNumber ) => void = ...
Defined in src/entities/pool.ts:699 set set: ( timestamp: BigNumber ) => void = ...
Defined in src/entities/pool.ts:706 Type declaration ( timestamp: BigNumber ) : void set set: ( longBalance: BigNumber ) => void = ...
Defined in src/entities/pool.ts:675 Type declaration ( longBalance: BigNumber ) : void set set: ( price: BigNumber ) => void = ...
Defined in src/entities/pool.ts:691 set set: ( shortbalance: BigNumber ) => void = ...
Defined in src/entities/pool.ts:683 Type declaration ( shortbalance: BigNumber ) : void settlement Defined in src/entities/pool.ts:89 short short: BigNumber
Defined in src/entities/pool.ts:92 short Defined in src/entities/pool.ts:87 update update: BigNumber
Defined in src/entities/pool.ts:79 Static CreateCreate
: ( poolInfo
: IPool ) => Promise < Pool > = ... Defined in src/entities/pool.ts:139 Type declaration Parameters Returns Promise < Pool > a Promise containing an initialised Pool class ready to be used
Static CreateCreate
Default
: ( ) => Pool = ... Defined in src/entities/pool.ts:148 Static DeployDeploy: ( ) => void
Defined in src/entities/pool.ts:157
LeveragedPool class initiated with an an
addressand anrpcURL. Stores relevant LeveragedPool information. It is optional for the user to provide additional pool information, reducing the number of RPC calls. This optional info is static information of the pool, such as names and addresses The constructor is private so must be instantiated withPool.Create