Interface WhirlpoolClient

Helper class to help interact with Whirlpool Accounts with a simpler interface.

Hierarchy

WhirlpoolClient

Index

Methods

Methods

getFetcher

getFetcher(): AccountFetcher

- Defined in whirlpool-client.ts:26
Get an AccountFetcher to fetch Whirlpool accounts

Returns AccountFetcher
an AccountFetcher instance

getPool

getPool(poolAddress: Address, refresh?: boolean): Promise<Whirlpool>

- Defined in whirlpool-client.ts:33
Get a Whirlpool object to interact with the Whirlpool account at the given address.

Parameters
- poolAddress: Address
  
  the address of the Whirlpool account
- Optional refresh: boolean
Returns Promise<Whirlpool>
a Whirlpool object to interact with

getPosition

getPosition(positionAddress: Address, refresh?: boolean): Promise<Position>

- Defined in whirlpool-client.ts:40
Get a Position object to interact with the Position account at the given address.

Parameters
- positionAddress: Address
  
  the address of the Position account
- Optional refresh: boolean
Returns Promise<Position>
a Position object to interact with

Generated using TypeDoc