Class YieldContractFactory

Hierarchy (view full)

PendleEntity
- YieldContractFactory

Index

Constructors

Properties

_contract address multicall? networkConnection

Accessors

contract entityConfig

Methods

addExtraParams getDefaultMetaMethodExtraParams

Constructors

constructor

new YieldContractFactory(address, config): YieldContractFactory
Parameters
- address: Address
- config: PendleEntityConfigOptionalAbi
Returns YieldContractFactory
Overrides PendleEntity.constructor
- Defined in src/entities/YieldContractFactory.ts:8

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

`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<PendleYieldContractFactory>
this._contract but with the casted type.

Returns WrappedContract<PendleYieldContractFactory>
Remarks
It is intended to be overridden in the subclasses.

See
PendleEntity#_contract
Overrides PendleEntity.contract
- Defined in src/entities/YieldContractFactory.ts:15

entityConfig

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

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

Methods

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 PendleEntity.addExtraParams
- Defined in src/entities/PendleEntity.ts:96

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

Generated using TypeDoc