Class PyIndex

Based on the following two contracts

Index

Constructors

Properties

Methods

assetToSy assetToSyUnsigned assetToSyUp assetToSyUpUnsigned syToAsset syToAssetUnsigned syToAssetUp syToAssetUpUnsigned

Constructors

constructor

new PyIndex(index): PyIndex
Parameters
- index: BigNumberish
  the pyIndex. Normally it is the result of YtEntity#pyIndexCurrent()
Returns PyIndex
- Defined in src/common/math.ts:80

Properties

`Readonly` index

index: BN

Methods

assetToSy

assetToSy(assetAmount): BN
Parameters
- assetAmount: BigNumberish
Returns BN
- Defined in src/common/math.ts:123

assetToSyUnsigned

assetToSyUnsigned(assetAmount): BN
Parameters
- assetAmount: BigNumberish
Returns BN
Remarks
Precondition: syAmount >= 0 If not sure, use PyIndex#assetToSy
- Defined in src/common/math.ts:119

assetToSyUp

assetToSyUp(assetAmount): BN
Parameters
- assetAmount: BigNumberish
Returns BN
- Defined in src/common/math.ts:138

assetToSyUpUnsigned

assetToSyUpUnsigned(assetAmount): BN
Parameters
- assetAmount: BigNumberish
Returns BN
Remarks
Precondition: syAmount >= 0 If not sure, use PyIndex#assetToSyUp
- Defined in src/common/math.ts:134

syToAsset

syToAsset(syAmount): BN
Parameters
- syAmount: BigNumberish
Returns BN
- Defined in src/common/math.ts:93

syToAssetUnsigned

syToAssetUnsigned(syAmount): BN
Parameters
- syAmount: BigNumberish
Returns BN
Remarks
Precondition: syAmount >= 0 If not sure, use PyIndex#syToAsset
- Defined in src/common/math.ts:89

syToAssetUp

syToAssetUp(syAmount): BN
Parameters
- syAmount: BigNumberish
Returns BN
- Defined in src/common/math.ts:108

syToAssetUpUnsigned

syToAssetUpUnsigned(syAmount): BN
Parameters
- syAmount: BigNumberish
Returns BN
Remarks
Precondition: syAmount >= 0 If not sure, use PyIndex#syToAssetUp
- Defined in src/common/math.ts:104

Generated using TypeDoc