Class YtEntity

This class represents a Pendle Yield token (YT token).

Hierarchy (view full)

PyEntity
- YtEntity

Constructors

constructor

new YtEntity(address, config): YtEntity
Parameters
- address: Address
- config: PyEntityConfig
Returns YtEntity
Overrides PyEntity.constructor
- Defined in src/entities/YtEntity.ts:25

Properties

`Protected` `Readonly` _contract

_contract: WrappedContract

The wrapped contract that the entity is holding.

Remarks

This should not be used directly. Instead, the getter contract should be used to have the correct type of the wrapped contract.

`Readonly` address

address: Address

the inner contract address

`Readonly` chainId

chainId: ChainId

`Optional` `Readonly` multicall

multicall?: Multicall

The Multicall instance used by this entity.

`Readonly` networkConnection

networkConnection: NetworkConnection

The networkConnection of this entity.

Accessors

contract

get contract(): WrappedContract<PendleYieldTokenV2>
this._contract but with the casted type.

Returns WrappedContract<PendleYieldTokenV2>
See
PendleEntity#_contract
Overrides PyEntity.contract
- Defined in src/entities/YtEntity.ts:37

entityConfig

get entityConfig(): PyEntityConfig
The config of this entity.

Returns PyEntityConfig
Remarks
It can be used to pass as configuration for a new entity. It should be overridden in the subclass.
Inherited from PyEntity.entityConfig
- Defined in src/entities/PyEntity.ts:86

Methods

PT

PT(params?): Promise<Address>
Get the address of the PT token, correspond to this YT token.
Parameters
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<Address>
Remarks
The naming is in uppercase to reflect the same function of the contract.
Overrides PyEntity.PT
- Defined in src/entities/YtEntity.ts:59

SY

SY(params?): Promise<Address>
Get the address of the SY token, correspond to this YT token.
Parameters
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<Address>
Remarks
The naming is in uppercase to reflect the same function of the contract.
Overrides PyEntity.SY
- Defined in src/entities/YtEntity.ts:48

YT

YT(_params?): Promise<Address>
Return this address.
Parameters
- Optional _params: MulticallStaticParams
Returns Promise<Address>
Remarks
The naming is in uppercase to reflect the same function of the contract.
Overrides PyEntity.YT
- Defined in src/entities/YtEntity.ts:70

addExtraParams

addExtraParams<T>(params): MetaMethodExtraParams<T>
Merge user-defined parameters with the default parameters (from getDefaultMetaMethodExtraParam()) and return the result to use use in a write method.
Type Parameters
- T extends MetaMethodType
  the type of the meta method, used to determine the correct return type of the write functions.
Parameters
- params: MetaMethodExtraParams<T>
  the user defined parameters
Returns MetaMethodExtraParams<T>
the merged parameters
Inherited from PyEntity.addExtraParams
- Defined in src/entities/PendleEntity.ts:96

allowance

allowance(owner, spender, params?): Promise<BN>
Get the allowance
Parameters
- owner: Address
  the owner's address
- spender: Address
  the spender's address
- Optional params: MulticallStaticParams
Returns Promise<BN>
the balance of the user
Inherited from PyEntity.allowance
- Defined in src/entities/erc20/ERC20Entity.ts:63

approve

approve<T>(spender, amount, params?): ERC20EntityMetaMethodReturnType<T, "approve", object>
Perform ERC20's approve method.
Type Parameters
- T extends MetaMethodType
  the type of the meta method. This should be infer by tsc to determine the correct return type. See ERC20 contract interaction tutorial with Pendle SDK to see the example usage with explanation.
Parameters
- spender: Address
  the spender's Address
- amount: BigNumberish
  the amount to approve
- params: MetaMethodExtraParams<T> = {}
  the additional parameters for write method.
Returns ERC20EntityMetaMethodReturnType<T, "approve", object>
When params is not defined, or when params.method is not defined, this method will perform the transaction, and return Promise<ethers.ContractTransaction>.

Otherwise, params.method's value is used to determine the return type. See MetaMethodReturnType for the detailed explanation of the return type.
Inherited from PyEntity.approve
- Defined in src/entities/erc20/ERC20Entity.ts:131

balanceOf

balanceOf(account, params?): Promise<BN>
Get the balance of an user, given the account
Parameters
- account: Address
  the account address of the user
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<BN>
the balance of the user
Inherited from PyEntity.balanceOf
- Defined in src/entities/erc20/ERC20Entity.ts:73

decimals

decimals(params?): Promise<number>
Get the decimals of the token
Parameters
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<number>
the decimals of the token.
Inherited from PyEntity.decimals
- Defined in src/entities/erc20/ERC20Entity.ts:82

getDefaultMetaMethodExtraParams

getDefaultMetaMethodExtraParams<T>(): MetaMethodExtraParams<T>
Type Parameters
- T extends MetaMethodType
Returns MetaMethodExtraParams<T>
the set of parameters for an entity's write-method (that will do a metaCall). It should be overridden in the subclass.
Inherited from PyEntity.getDefaultMetaMethodExtraParams
- Defined in src/entities/PendleEntity.ts:82

getExpiry

getExpiry(params?): Promise<Date>
Parameters
- Optional params: MulticallStaticParams
Returns Promise<Date>
- Defined in src/entities/YtEntity.ts:161

getRewardTokens

getRewardTokens(params?): Promise<Address[]>
Get the list addresses of the reward tokens, corresponding to this YT token.
Parameters
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<Address[]>
- Defined in src/entities/YtEntity.ts:121

isExpired

isExpired(params?): Promise<boolean>
Parameters
- Optional params: MulticallStaticParams
Returns Promise<boolean>
- Defined in src/entities/YtEntity.ts:166

name

name(params?): Promise<string>
Get the name of the token
Parameters
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<string>
the name of the token.
Inherited from PyEntity.name
- Defined in src/entities/erc20/ERC20Entity.ts:91

previewMintPyFromSy

previewMintPyFromSy(netSyIn, params?): Promise<BN>
Parameters
- netSyIn: BigNumberish
- Optional params: MulticallStaticParams
Returns Promise<BN>
- Defined in src/entities/YtEntity.ts:126

previewRedeemPyToSy

previewRedeemPyToSy(netPYIn, params?): Promise<BN>
Parameters
- netPYIn: BigNumberish
- Optional params: MulticallStaticParams
Returns Promise<BN>
- Defined in src/entities/YtEntity.ts:136

pt

pt(params?): Promise<Address>
Alias for PyEntity#PT
Parameters
- Optional params: MulticallStaticParams
Returns Promise<Address>
Inherited from PyEntity.pt
- Defined in src/entities/PyEntity.ts:75

ptEntity

ptEntity(params?): Promise<PtEntity>
Get the entity of the PT token, correspond to this YT token.
Parameters
- Optional params: MulticallStaticParams & {
  entityConfig?: PyEntityConfig;
  }
  the additional parameters for read method.
Returns Promise<PtEntity>
Overrides PyEntity.ptEntity
- Defined in src/entities/YtEntity.ts:93

pyIndexCurrent

pyIndexCurrent(params?): Promise<PyIndex>
Get the py index, which
Parameters
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<PyIndex>
- Defined in src/entities/YtEntity.ts:111

redeemDueInterestAndRewards

redeemDueInterestAndRewards<T>(userAddress, params?): MetaMethodReturnType<T, PendleYieldTokenV2, "redeemDueInterestAndRewards", object>
Type Parameters
- T extends MetaMethodType
Parameters
- userAddress: Address
- Optional params: MulticallStaticParams & {
      calcBufferedGas?: CalcBufferedGasFunction;
      method?: T;
  } & {
      redeemInterest?: boolean;
      redeemRewards?: boolean;
  }
Returns MetaMethodReturnType<T, PendleYieldTokenV2, "redeemDueInterestAndRewards", object>
- Defined in src/entities/YtEntity.ts:146

sy

sy(params?): Promise<Address>
Alias for PtEntity#SY
Parameters
- Optional params: MulticallStaticParams
Returns Promise<Address>
Inherited from PyEntity.sy
- Defined in src/entities/PyEntity.ts:82

syEntity

syEntity(params?): Promise<SyEntity>
Get the entity of the SY token, correspond to this YT token.
Parameters
- Optional params: MulticallStaticParams & {
  entityConfig?: SyEntityConfig;
  }
  the additional parameters for read method.
Returns Promise<SyEntity>
Overrides PyEntity.syEntity
- Defined in src/entities/YtEntity.ts:81

symbol

symbol(params?): Promise<string>
Get the symbol of the token
Parameters
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<string>
the symbol of the token.
Inherited from PyEntity.symbol
- Defined in src/entities/erc20/ERC20Entity.ts:100

totalSupply

totalSupply(params?): Promise<BN>
Get the total supply of the token
Parameters
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<BN>
the total supply of the token.
Inherited from PyEntity.totalSupply
- Defined in src/entities/erc20/ERC20Entity.ts:109

transfer

transfer<T>(to, amount, params?): ERC20EntityMetaMethodReturnType<T, "transfer", object>
Perform ERC20's transfer method.
Type Parameters
- T extends MetaMethodType
  the type of the meta method. This should be infer by tsc to determine the correct return type. See ERC20 contract interaction tutorial with Pendle SDK to see the example usage with explanation.
Parameters
- to: Address
  the receiver's Address
- amount: BigNumberish
  the amount to transfer
- params: MetaMethodExtraParams<T> = {}
  the additional parameters for write method.
Returns ERC20EntityMetaMethodReturnType<T, "transfer", object>
When params is not defined, or when params.method is not defined, this method will perform the transaction, and return Promise<ethers.ContractTransaction>.

Otherwise, params.method's value is used to determine the return type. See MetaMethodReturnType for the detailed explanation of the return type.
Inherited from PyEntity.transfer
- Defined in src/entities/erc20/ERC20Entity.ts:157

userInfo

userInfo(user, params?): Promise<UserPyInfo>
Get user information of the current PY token.
Parameters
- user: Address
- Optional params: MulticallStaticParams & {
  multicallForSimulateRedeemDueInterestAndRewards?: Multicall;
  }
  the additional parameters for read method.
Returns Promise<UserPyInfo>
Inherited from PyEntity.userInfo
- Defined in src/entities/PyEntity.ts:96

yt

yt(params?): Promise<Address>
Alias for PyEntity#YT
Parameters
- Optional params: MulticallStaticParams
Returns Promise<Address>
Inherited from PyEntity.yt
- Defined in src/entities/PyEntity.ts:68

ytEntity

ytEntity(params?): Promise<YtEntity>
Parameters
- Optional params: MulticallStaticParams & {
  entityConfig?: PyEntityConfig;
  }
Returns Promise<YtEntity>
Overrides PyEntity.ytEntity
- Defined in src/entities/YtEntity.ts:98

`Static` previewMintSyFromSyWithPyIndex

previewMintSyFromSyWithPyIndex(this, pyIndex, netSyIn): BN
Parameters
- this: void
- pyIndex: PyIndex
- netSyIn: BigNumberish
Returns BN
- Defined in src/entities/YtEntity.ts:131

`Static` previewRedeemPyToSyWithPyIndex

previewRedeemPyToSyWithPyIndex(this, pyIndex, netPYIn): BN
Parameters
- this: void
- pyIndex: PyIndex
- netPYIn: BigNumberish
Returns BN
- Defined in src/entities/YtEntity.ts:141

`Static` toUserPyInfo

toUserPyInfo(userPyInfoStructOutput): UserPyInfo
Convert IPRouterStatic.UserPYInfoStructOutput to UserPyInfo.
Parameters
- userPyInfoStructOutput: UserPYInfoStructOutput
Returns UserPyInfo
Remarks
Both structures have the same shape, but the return type has a stricter type.
Inherited from PyEntity.toUserPyInfo
- Defined in src/entities/PyEntity.ts:133

Class YtEntity

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

address: Address

config: PyEntityConfig

Returns YtEntity

Properties

Protected Readonly _contract

Remarks

Readonly address

Readonly chainId

Optional Readonly multicall

Readonly networkConnection

Accessors

contract

Returns WrappedContract<PendleYieldTokenV2>

See

entityConfig

Returns PyEntityConfig

Remarks

Methods

PT

Parameters

Optional params: MulticallStaticParams

Returns Promise<Address>

Remarks

SY

Parameters

Optional params: MulticallStaticParams

Returns Promise<Address>

Remarks

YT

Parameters

Optional _params: MulticallStaticParams

Returns Promise<Address>

Remarks

addExtraParams

Type Parameters

T extends MetaMethodType

Parameters

params: MetaMethodExtraParams<T>

Returns MetaMethodExtraParams<T>

allowance

Parameters

owner: Address

spender: Address

Optional params: MulticallStaticParams

Returns Promise<BN>

approve

Type Parameters

T extends MetaMethodType

Parameters

spender: Address

amount: BigNumberish

params: MetaMethodExtraParams<T> = {}

Returns ERC20EntityMetaMethodReturnType<T, "approve", object>

balanceOf

Parameters

account: Address

Optional params: MulticallStaticParams

Returns Promise<BN>

decimals

Parameters

Optional params: MulticallStaticParams

Returns Promise<number>

getDefaultMetaMethodExtraParams

Type Parameters

T extends MetaMethodType

Returns MetaMethodExtraParams<T>

getExpiry

Parameters

Optional params: MulticallStaticParams

Returns Promise<Date>

`Protected` `Readonly` _contract

`Readonly` address

`Readonly` chainId

`Optional` `Readonly` multicall

`Readonly` networkConnection

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` _params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams & {
entityConfig?: PyEntityConfig;
}

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams & {
calcBufferedGas?: CalcBufferedGasFunction;
method?: T;
} & {
redeemInterest?: boolean;
redeemRewards?: boolean;
}

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams & {
entityConfig?: SyEntityConfig;
}

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams & {
multicallForSimulateRedeemDueInterestAndRewards?: Multicall;
}