Abstract Protected Readonly _contractThe wrapped contract that the entity is holding.
This should not be used directly. Instead, the getter contract should
be used to have the correct type of the wrapped contract.
Readonly addressthe inner contract address
Readonly chainOptional Readonly multicallThe Multicall instance used by this entity.
Readonly networkThe networkConnection of this entity.
this._contract but with the casted type.
PendleEntity#_contract
The config of this entity.
It can be used to pass as configuration for a new entity. It should be overridden in the subclass.
Abstract PTOptional params: MulticallStaticParamsAbstract SYOptional params: MulticallStaticParamsAbstract YTOptional params: MulticallStaticParamsMerge user-defined parameters with the default parameters (from
getDefaultMetaMethodExtraParam()) and return the result to use use in a
write method.
the type of the meta method, used to determine the correct return type of the write functions.
the user defined parameters
the merged parameters
Get the allowance
the owner's address
the spender's address
Optional params: MulticallStaticParamsthe balance of the user
Perform ERC20's approve method.
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.
the spender's Address
the amount to approve
the additional parameters for write method.
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.
Get the balance of an user, given the account
the account address of the user
Optional params: MulticallStaticParamsthe additional parameters for read method.
the balance of the user
Get the decimals of the token
Optional params: MulticallStaticParamsthe additional parameters for read method.
the decimals of the token.
the set of parameters for an entity's write-method (that will do
a metaCall). It should be overridden in the subclass.
Get the name of the token
Optional params: MulticallStaticParamsthe additional parameters for read method.
the name of the token.
Alias for PyEntity#PT
Optional params: MulticallStaticParamsAbstract ptOptional params: MulticallStaticParams & { Alias for PtEntity#SY
Optional params: MulticallStaticParamsAbstract syOptional params: MulticallStaticParams & { Get the symbol of the token
Optional params: MulticallStaticParamsthe additional parameters for read method.
the symbol of the token.
Get the total supply of the token
Optional params: MulticallStaticParamsthe additional parameters for read method.
the total supply of the token.
Perform ERC20's transfer method.
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.
the receiver's Address
the amount to transfer
the additional parameters for write method.
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.
Get user information of the current PY token.
Optional params: MulticallStaticParams & { the additional parameters for read method.
Alias for PyEntity#YT
Optional params: MulticallStaticParamsAbstract ytOptional params: MulticallStaticParams & { Static toConvert IPRouterStatic.UserPYInfoStructOutput to UserPyInfo.
Both structures have the same shape, but the return type has a stricter type.
Generated using TypeDoc
A super class for PT token and YT token.
Remarks
As PT and YT come in pair, they share some functionalities. Those shared functionalities are included in this class.
There is no
contractgetter for this class, as there is no base ABI for both PT and YT. This should be done in the subclasses.