Protected
Readonly
_contractThis 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
Optional
Readonly
multicallThe Multicall
instance used by this entity.
Readonly
networkThe networkConnection
of this entity.
this._contract
but with the casted type.
It is intended to be overridden in the subclasses.
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.
Merge 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
Claim rewards for a specific user in given markets
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.
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.
If params.filterEmptyRewardPools equals true, then only the pools with non-zero rewards will be claimed.
Note that the param.filterEmptyRewardPools does not filter out the result for meta-method,
that is, the result data.poolRewards
will still contain the pools with zero rewards.
Return all the pools that are eligible for claiming rewards
Optional
params: MulticallStaticParamsthe additional parameters for read method.
the set of parameters for an entity's write-method (that will do
a metaCall
). It should be overridden in the subclass.
Return the address of the reward token
Optional
params: MulticallStaticParamsthe additional parameters for read method.
Static
getCreate a FeeDistributor object for a given config.
The address of FeeDistributor is obtained from the config
.
Generated using TypeDoc
The wrapped contract that the entity is holding.