Class MarketState

constructor

• new MarketState(totalPt, totalSy, totalLp, treasury, scalarRoot, expiry, lnFeeRateRoot, reserveFeePercent, lastLnImpliedRate): MarketState

• Parameters

  • totalPt: bigint

  • totalSy: bigint

  • totalLp: bigint

  • treasury: string

  • scalarRoot: FixedX18

  • expiry: bigint

  • lnFeeRateRoot: FixedX18

  • reserveFeePercent: bigint

  • lastLnImpliedRate: FixedX18

  Returns MarketState

Readonly expiry

lastLnImpliedRate

lnFeeRateRoot

reserveFeePercent

Readonly scalarRoot

totalLp

totalPt

totalSy

treasury

impliedYield

• get impliedYield(): FixedX18

• Returns FixedX18

addLiquidity

• addLiquidity(syDesired, ptDesired, params?): {
      lpToAccount: bigint;
      lpToReserve: bigint;
      ptUsed: bigint;
      syUsed: bigint;
  }

• Parameters

  • syDesired: bigint

  • ptDesired: bigint

  • Optional params: {
        blockTime_s?: bigint;
    }

    • Optional blockTime_s?: bigint

  Returns {
      lpToAccount: bigint;
      lpToReserve: bigint;
      ptUsed: bigint;
      syUsed: bigint;
  }

  • lpToAccount: bigint

  • lpToReserve: bigint

  • ptUsed: bigint

  • syUsed: bigint

calcTrade

• calcTrade(comp, pyIndex, netPtToAccount): {
      netSyFee: bigint;
      netSyToAccount: bigint;
      netSyToReserve: bigint;
  }

• Parameters

  • comp: MarketPrecomputeResult

  • pyIndex: PyIndex

  • netPtToAccount: bigint

  Returns {
      netSyFee: bigint;
      netSyToAccount: bigint;
      netSyToReserve: bigint;
  }

  • netSyFee: bigint

  • netSyToAccount: bigint

  • netSyToReserve: bigint

clone

• clone(): MarketState

• Returns MarketState

executeTradeCore

• executeTradeCore(pyIndex, netPtToAccount, blockTime_s): {
      netSyFee: bigint;
      netSyToAccount: bigint;
      netSyToReserve: bigint;
  }

• Parameters

  • pyIndex: PyIndex

  • netPtToAccount: bigint

  • blockTime_s: bigint

  Returns {
      netSyFee: bigint;
      netSyToAccount: bigint;
      netSyToReserve: bigint;
  }

  • netSyFee: bigint

  • netSyToAccount: bigint

  • netSyToReserve: bigint

getExchangeRate

• getExchangeRate(comp, netPtToAccount): {
      postFeeExchangeRate: MarketExchangeRate;
      preFeeExchangeRate: MarketExchangeRate;
  }

• Parameters

  • comp: MarketPrecomputeResult

  • netPtToAccount: bigint

  Returns {
      postFeeExchangeRate: MarketExchangeRate;
      preFeeExchangeRate: MarketExchangeRate;
  }

  • postFeeExchangeRate: MarketExchangeRate

  • preFeeExchangeRate: MarketExchangeRate

getRateScalar

• getRateScalar(timeToExpiry_s): FixedX18

• Parameters

  • timeToExpiry_s: bigint

  Returns FixedX18

getYieldRange

• getYieldRange(params): undefined | {
      rateMax: FixedX18;
      rateMin: FixedX18;
  }

• Parameters

  • params: {
        now_s?: bigint;
        rateAnchor: FixedX18;
    }

    Contains the rateAnchor. MarketPrecomputeResult can also be passed in.

    • Optional now_s?: bigint

    • rateAnchor: FixedX18

  Returns undefined | {
      rateMax: FixedX18;
      rateMin: FixedX18;
  }

  The rateMin and rateMax of the yield range. undefined if the market is expired.

precompute

• precompute(pyIndex, blockTime_s): MarketPrecomputeResult

• Parameters

  • pyIndex: PyIndex

  • blockTime_s: bigint

  Returns MarketPrecomputeResult

removeLiquidity

• removeLiquidity(lpToRemove): {
      netPtToAccount: bigint;
      netSyToAccount: bigint;
  }

• Parameters

  • lpToRemove: bigint

  Returns {
      netPtToAccount: bigint;
      netSyToAccount: bigint;
  }

  • netPtToAccount: bigint

  • netSyToAccount: bigint

setInitialLnImpliedRate

• setInitialLnImpliedRate(pyIndex, initialAnchor, blockTime_s): void

• Parameters

  • pyIndex: PyIndex

  • initialAnchor: FixedX18

  • blockTime_s: bigint

  Returns void

setNewMarketStateTrade

• setNewMarketStateTrade(params): void

• Parameters

  • params: {
        blockTime_s: bigint;
        netPtToAccount: bigint;
        netSyToAccount: bigint;
        netSyToReserve: bigint;
        precomputeResult: MarketPrecomputeResult;
        pyIndex: PyIndex;
    }

    • blockTime_s: bigint

    • netPtToAccount: bigint

    • netSyToAccount: bigint

    • netSyToReserve: bigint

    • precomputeResult: MarketPrecomputeResult

    • pyIndex: PyIndex

  Returns void

swapExactPtForSy

• swapExactPtForSy(pyIndex, exactPtToMarket, blockTime_s): {
      netSyFee: bigint;
      netSyToAccount: bigint;
      netSyToReserve: bigint;
  }

• Parameters

  • pyIndex: PyIndex

  • exactPtToMarket: bigint

  • blockTime_s: bigint

  Returns {
      netSyFee: bigint;
      netSyToAccount: bigint;
      netSyToReserve: bigint;
  }

  • netSyFee: bigint

  • netSyToAccount: bigint

  • netSyToReserve: bigint

swapSyForExactPt

• swapSyForExactPt(pyIndex, exactPtToAccount, blockTime_s): {
      netSyFee: bigint;
      netSyToMarket: bigint;
      netSyToReserve: bigint;
  }

• Parameters

  • pyIndex: PyIndex

  • exactPtToAccount: bigint

  • blockTime_s: bigint

  Returns {
      netSyFee: bigint;
      netSyToMarket: bigint;
      netSyToReserve: bigint;
  }

  • netSyFee: bigint

  • netSyToMarket: bigint

  • netSyToReserve: bigint

toRaw

• toRaw(): MarketRawState

• Returns MarketRawState

Static fromRaw

• fromRaw(rawState): MarketState

• Parameters

  • rawState: MarketRawState

  Returns MarketState

Static getExchangeRate

• getExchangeRate(this, params): MarketExchangeRate

• Parameters

  • this: void

  • params: {
        netPtToAccount: bigint;
        rateAnchor: FixedX18;
        rateScalar: FixedX18;
        totalAsset: bigint;
        totalPt: bigint;
    }

    • netPtToAccount: bigint

    • rateAnchor: FixedX18

    • rateScalar: FixedX18

    • totalAsset: bigint

    • totalPt: bigint

  Returns MarketExchangeRate

Static getExchangeRateFromImpliedRate

• getExchangeRateFromImpliedRate(this, lnImpliedRate, timeToExpiry_s): MarketExchangeRate

• Parameters

  • this: void

  • lnImpliedRate: FixedX18

  • timeToExpiry_s: bigint

  Returns MarketExchangeRate

  Deprecated

  use MarketExchangeRate.fromLnImpliedRate instead.

Static getLnImpliedRate

• getLnImpliedRate(this, params): FixedX18

• Parameters

  • this: void

  • params: {
        rateAnchor: FixedX18;
        rateScalar: FixedX18;
        timeToExpiry_s: bigint;
        totalAsset: bigint;
        totalPt: bigint;
    }

    • rateAnchor: FixedX18

    • rateScalar: FixedX18

    • timeToExpiry_s: bigint

    • totalAsset: bigint

    • totalPt: bigint

  Returns FixedX18

Static getRateAnchor

• getRateAnchor(this, params): FixedX18

• Parameters

  • this: void

  • params: {
        lastLnImpliedRate: FixedX18;
        rateScalar: FixedX18;
        timeToExpiry_s: bigint;
        totalAsset: bigint;
        totalPt: bigint;
    }

    • lastLnImpliedRate: FixedX18

    • rateScalar: FixedX18

    • timeToExpiry_s: bigint

    • totalAsset: bigint

    • totalPt: bigint

  Returns FixedX18

Static getRateScalar

• getRateScalar(scalarRoot, timeToExpiry_s): FixedX18

• Parameters

  • scalarRoot: FixedX18

  • timeToExpiry_s: bigint

  Returns FixedX18

Static getYieldRange

• getYieldRange(this, params): undefined | {
      rateMax: FixedX18;
      rateMin: FixedX18;
  }

• Parameters

  • this: void

  • params: {
        expiry: bigint;
        now_s: bigint;
        rateAnchor: FixedX18;
        scalarRoot: FixedX18;
    }

    • expiry: bigint

    • now_s: bigint

    • rateAnchor: FixedX18

    • scalarRoot: FixedX18

  Returns undefined | {
      rateMax: FixedX18;
      rateMin: FixedX18;
  }

  The rateMin and rateMax of the yield range. undefined if the market is expired.

Static logProportion

• logProportion(this, proportion): FixedX18

• Parameters

  • this: void

  • proportion: FixedX18

  Returns FixedX18

Static powerScaleToExpiry

• powerScaleToExpiry(this, lnValue, timeToExpiry_s): FixedX18

• Parameters

  • this: void

  • lnValue: FixedX18

  • timeToExpiry_s: bigint

  Returns FixedX18