Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PoolStateHelper

PoolStateHelper class for interacting with on chain PoolStateHelper contracts The constructor is private so must be instantiated with PoolStateHelper.Create

Hierarchy

  • PoolStateHelper

Index

Constructors

Properties

Constructors

Private constructor

Properties

Optional _contract

_contract?: PoolStateHelper

address

address: string

committerAddress

committerAddress: string

connect

connect: (provider: Provider | Signer) => void = ...

Type declaration

    • (provider: Provider | Signer): void

    • Replaces the provider and connects the contract instance

      Parameters

      • provider: Provider | Signer

        The new provider to connect to

      Returns void

fullCommitPeriod

fullCommitPeriod: number

getCommitQueue

getCommitQueue: (args: { periods: number }) => Promise<TotalPoolCommitmentsBN[]> = ...

Type declaration

getExpectedPoolState

getExpectedPoolState: (args: { periods: number }) => Promise<ExpectedPoolState> = ...

Type declaration

    • (args: { periods: number }): Promise<ExpectedPoolState>

    • Parameters

      • args: { periods: number }
        • periods: number

      Returns Promise<ExpectedPoolState>

Private init

init: (config: IPoolStateHelper) => Promise<void> = ...

Type declaration

multicallProvider

multicallProvider: undefined | Signer | MulticallProvider

poolAddress

poolAddress: string

provider

provider: undefined | Provider | Signer

Static Create

Create: (config: IPoolStateHelper) => Promise<PoolStateHelper> = ...

Type declaration

Static CreateDefault

CreateDefault: () => PoolStateHelper = ...

Type declaration

Generated using TypeDoc