Class MarketEntity

This class represents an ERC20 token

Hierarchy (view full)

ERC20Entity
- MarketEntity

Constructors

constructor

new MarketEntity(address, config): MarketEntity
Parameters
- address: Address
- config: MarketEntityConfig
Returns MarketEntity
Overrides ERC20Entity.constructor
- Defined in src/entities/MarketEntity.ts:78

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.

`Private` readTokensCacheResult

readTokensCacheResult: undefined | Promise<{
    ptAddress: Address;
    syAddress: Address;
    ytAddress: Address;
}> = undefined

Accessors

contract

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

Returns WrappedContract<PendleMarket>
See
PendleEntity#_contract
Overrides ERC20Entity.contract
- Defined in src/entities/MarketEntity.ts:91

entityConfig

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

Returns MarketEntityConfig
Remarks
It can be used to pass as configuration for a new entity. It should be overridden in the subclass.
Overrides ERC20Entity.entityConfig
- Defined in src/entities/MarketEntity.ts:253

Methods

PT

PT(params?): Promise<Address>
Get the address of the PT token, correspond to this market.
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.
- Defined in src/entities/MarketEntity.ts:231

SY

SY(params?): Promise<Address>
Get the address of the SY token, correspond to this market.
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.
- Defined in src/entities/MarketEntity.ts:213

YT

YT(params?): Promise<Address>
Parameters
- Optional params: MulticallStaticParams
Returns Promise<Address>
- Defined in src/entities/MarketEntity.ts:242

activeBalance

activeBalance(userAddress, params?): Promise<BN>
Get the active balance of a give user.
Parameters
- userAddress: Address
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<BN>
- Defined in src/entities/MarketEntity.ts:370

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 ERC20Entity.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 ERC20Entity.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 ERC20Entity.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 ERC20Entity.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 ERC20Entity.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 ERC20Entity.getDefaultMetaMethodExtraParams
- Defined in src/entities/PendleEntity.ts:82

getMarketInfo

getMarketInfo(params?): Promise<MarketInfo>
Get the info of the market.
Parameters
- Optional params: MulticallStaticParams & {
  blockTimestamp?: number;
  pyIndex?: PyIndex;
  }
  the additional parameters for read method.
Returns Promise<MarketInfo>
- Defined in src/entities/MarketEntity.ts:121

getRewardTokens

getRewardTokens(params?): Promise<Address[]>
Get the reward tokens of a market.
Parameters
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<Address[]>
List of addresses of the reward tokens.
- Defined in src/entities/MarketEntity.ts:301

getUserMarketInfo

getUserMarketInfo(userAddress, params?): Promise<UserMarketInfo>
Get the market info of an user.
Parameters
- userAddress: Address
- Optional params: MulticallStaticParams & {
  multicallForSimulateRedeemRewards?: Multicall;
  }
  the additional parameters for read method.
Returns Promise<UserMarketInfo>
Deprecated
use the individual functions that returns the corresponding fields instead.
- Defined in src/entities/MarketEntity.ts:161

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 ERC20Entity.name
- Defined in src/entities/erc20/ERC20Entity.ts:91

pt

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

ptEntity

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

readState

readState(params?): Promise<MarketState>
Get the market state of a given router.
Parameters
- Optional params: MulticallStaticParams & {
  routerAddress?: Address;
  }
  the additional parameters for read method.
Returns Promise<MarketState>
The market state base on the router address.
- Defined in src/entities/MarketEntity.ts:380

readTokens

readTokens(params?): Promise<{
    ptAddress: Address;
    syAddress: Address;
    ytAddress: Address;
}>
Parameters
- Optional params: MulticallStaticParams
Returns Promise<{
    ptAddress: Address;
    syAddress: Address;
    ytAddress: Address;
}>
- Defined in src/entities/MarketEntity.ts:102

redeemRewards

redeemRewards<T>(userAddress, params?): MarketEntityMetaMethodReturnType<T, "redeemRewards", object>
Perform the redeem reward action.
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
- userAddress: Address
  the receiver address.
- params: MetaMethodExtraParams<T> = {}
  the additional parameters for write method.
Returns MarketEntityMetaMethodReturnType<T, "redeemRewards", 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.
- Defined in src/entities/MarketEntity.ts:323

simulateRedeemRewards

simulateRedeemRewards(userAddress): Promise<BN[]>
Simulate the redeem rewards actions, and return only the amounts for each reward tokens.
Parameters
- userAddress: Address
  the receiver address.
Returns Promise<BN[]>
Remarks
This function cannot be called with multicall because it is not a views function. Calling with multicall will mutate the contract's state.
- Defined in src/entities/MarketEntity.ts:339

simulateRedeemRewardsWithTokens

simulateRedeemRewardsWithTokens(userAddress, params?): Promise<RawTokenAmount[]>
Simulate the redeem rewards actions, and return only the list of pair of token address with the corresponding amount.
Parameters
- userAddress: Address
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<RawTokenAmount[]>
- Defined in src/entities/MarketEntity.ts:350

sy

sy(params?): Promise<Address>
Alias for MarketEntity#SY
Parameters
- Optional params: MulticallStaticParams
Returns Promise<Address>
- Defined in src/entities/MarketEntity.ts:220

syEntity

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

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 ERC20Entity.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 ERC20Entity.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 ERC20Entity.transfer
- Defined in src/entities/erc20/ERC20Entity.ts:157

yt

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

ytEntity

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

`Static` createMarketStateFromContractResult

createMarketStateFromContractResult(rawState): MarketState
Parameters
- rawState: MarketStateStructOutput
Returns MarketState
- Defined in src/entities/MarketEntity.ts:386

`Static` toUserMarketInfo

toUserMarketInfo(this, __namedParameters): UserMarketInfo
Convert IPRouterStatic.UserMarketInfoStructOutput to UserMarketInfo.
Parameters
- this: void
- __namedParameters: UserMarketInfoStructOutput
Returns UserMarketInfo
Remarks
Both structures have the same shape, but the return type has a stricter type.
- Defined in src/entities/MarketEntity.ts:194

Class MarketEntity

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

address: Address

config: MarketEntityConfig

Returns MarketEntity

Properties

Protected Readonly _contract

Remarks

Readonly address

Readonly chainId

Optional Readonly multicall

Readonly networkConnection

Private readTokensCacheResult

Accessors

contract

Returns WrappedContract<PendleMarket>

See

entityConfig

Returns MarketEntityConfig

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>

activeBalance

Parameters

userAddress: Address

Optional params: MulticallStaticParams

Returns Promise<BN>

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

`Protected` `Readonly` _contract

`Readonly` address

`Readonly` chainId

`Optional` `Readonly` multicall

`Readonly` networkConnection

`Private` readTokensCacheResult

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams & {
blockTimestamp?: number;
pyIndex?: PyIndex;
}

`Optional` params: MulticallStaticParams

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

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

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

`Optional` params: MulticallStaticParams & {
routerAddress?: Address;
}

`Optional` params: MulticallStaticParams

Returns Promise<{
ptAddress: Address;
syAddress: Address;
ytAddress: Address;
}>

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

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

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams