npm.io
0.0.4 • Published 4 years ago

@tracer-protocol/pool-state-helper

Licence
MIT
Version
0.0.4
Deps
0
Size
656 kB
Vulns
0
Weekly
0
Stars
3

Pool State Helper

WIP USE AT YOUR OWN RISK

Helpers to get pool state.

Assumptions & Constraints:

  • An upkeep will happen every UpdateInterval
  • Does not simulate keeper fees that get paid out of the pool
  • Does not simulate dynamic minting fees
Usage:
fullCommitPeriod(address leveragedPool)

leveragedPool - Leveraged Pool Address

Returns number of periods that will be executed during the FrontRunningInterval

getExpectedState(address leveragedPool, uint256 periods)

leveragedPool - Leveraged Pool Address periods - Number of commit periods to simulate

Returns the ExpectedPoolState after the TotalCommitments for periods are applied

    struct ExpectedPoolState {
        uint256 cumulativePendingMintSettlement;
        uint256 longSupply;
        uint256 longBalance;
        uint256 shortSupply;
        uint256 shortBalance;
        uint256 oraclePrice;
    }