Class VePendleMainchain

Hierarchy (view full)

VePendle
- VePendleMainchain

Constructors

constructor

new VePendleMainchain(address, config): VePendleMainchain
Parameters
- address: Address
- config: VePendleMainchainConfig
Returns VePendleMainchain
Overrides VePendle.constructor
- Defined in src/entities/VePendle.ts:101

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.

`Static` BROADCAST_FEE_BUFFER

BROADCAST_FEE_BUFFER: number = 0.02

`Static` `Readonly` MAX_LOCK_TIME_s

MAX_LOCK_TIME_s: number = ...

`Static` `Readonly` MIN_LOCK_TIME_s

MIN_LOCK_TIME_s: number = VePendle.ONE_WEEK_s

`Static` `Readonly` ONE_DAY_s

ONE_DAY_s: number = ...

`Static` `Readonly` ONE_WEEK_s

ONE_WEEK_s: number = ...

Accessors

contract

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

Returns WrappedContract<VotingEscrowPendleMainchain>
See
PendleEntity#_contract
Overrides VePendle.contract
- Defined in src/entities/VePendle.ts:118

entityConfig

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

Returns VePendleMainchainConfig
Remarks
It can be used to pass as configuration for a new entity. It should be overridden in the subclass.
Overrides VePendle.entityConfig
- Defined in src/entities/VePendle.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 VePendle.addExtraParams
- Defined in src/entities/PendleEntity.ts:96

balanceOf

balanceOf(userAddress, params?): Promise<BN>
Get the balance of an user, given the account
Parameters
- userAddress: 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 VePendle.balanceOf
- Defined in src/entities/VePendle.ts:55

broadcastTotalSupply

broadcastTotalSupply<T>(chainIds, params): VePendleMainchainMetaMethodReturnType<T, "broadcastTotalSupply", object>
Type Parameters
- T extends MetaMethodType
Parameters
- chainIds: ChainId[]
- params: MetaMethodExtraParams<T>
Returns VePendleMainchainMetaMethodReturnType<T, "broadcastTotalSupply", object>
- Defined in src/entities/VePendle.ts:271

broadcastUserPosition

broadcastUserPosition<T>(chainIds, params?): VePendleMainchainMetaMethodReturnType<T, "broadcastUserPosition", object>
Type Parameters
- T extends MetaMethodType
Parameters
- chainIds: ChainId[]
- params: MulticallStaticParams & {
      calcBufferedGas?: CalcBufferedGasFunction;
      method?: T;
  } & {
      userAddress?: Address;
  } = {}
Returns VePendleMainchainMetaMethodReturnType<T, "broadcastUserPosition", object>
- Defined in src/entities/VePendle.ts:251

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

increaseLockPosition

increaseLockPosition<T>(additionalRawAmountToLock, newExpiry_s, params?): VePendleMainchainMetaMethodReturnType<T, "increaseLockPosition", object>
Increase Lock position.
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
- additionalRawAmountToLock: BigNumberish
- newExpiry_s: BigNumberish
- Optional params: MulticallStaticParams & {
      calcBufferedGas?: CalcBufferedGasFunction;
      method?: T;
  } & {
      broadcastChainIds?: [];
  }
  the additional parameters for write method.
Returns VePendleMainchainMetaMethodReturnType<T, "increaseLockPosition", 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.

Remarks
The sender will be the one who has his lock position increased.

If params.broadcastChainIds are specified and non-empty, the contract function increaseLockPositionAndBroadcast is called, otherwise increaseLockPosition is called instead. Note that this also affects the return type of the function, but the difference is minimal.
- Defined in src/entities/VePendle.ts:177
increaseLockPosition<T>(additionalRawAmountToLock, newExpiry_s, params): VePendleMainchainMetaMethodReturnType<T, "increaseLockPositionAndBroadcast", object>
Increase Lock position.
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
- additionalRawAmountToLock: BigNumberish
- newExpiry_s: BigNumberish
- params: MulticallStaticParams & {
      calcBufferedGas?: CalcBufferedGasFunction;
      method?: T;
  } & {
      broadcastChainIds: ChainId[];
  }
  the additional parameters for write method.
Returns VePendleMainchainMetaMethodReturnType<T, "increaseLockPositionAndBroadcast", 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.

Remarks
The sender will be the one who has his lock position increased.

If params.broadcastChainIds are specified and non-empty, the contract function increaseLockPositionAndBroadcast is called, otherwise increaseLockPosition is called instead. Note that this also affects the return type of the function, but the difference is minimal.
- Defined in src/entities/VePendle.ts:185

positionData

positionData(userAddress, params?): Promise<[BN, BN] & {
amount: BN;
expiry: BN;
}>
Get the user lock position.
Parameters
- userAddress: Address
  the address of the user.
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<[BN, BN] & {
amount: BN;
expiry: BN;
}>
Inherited from VePendle.positionData
- Defined in src/entities/VePendle.ts:65

simulateIncreaseLockPosition

simulateIncreaseLockPosition(userAddress, additionalRawAmountToLock, newExpiry_s, params?): Promise<BN>
Simulate increase lock position
Parameters
- userAddress: Address
- additionalRawAmountToLock: BigNumberish
- newExpiry_s: BigNumberish
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<BN>
- Defined in src/entities/VePendle.ts:143

totalSupplyCurrent

totalSupplyCurrent(params?): Promise<BN>
Get the current total supply of this VePendle token
Parameters
- Optional params: MulticallStaticParams
  the additional parameters for read method.
Returns Promise<BN>
Inherited from VePendle.totalSupplyCurrent
- Defined in src/entities/VePendle.ts:75

withdraw

withdraw<T>(params?): VePendleMainchainMetaMethodReturnType<T, "withdraw", object>
Withdraw an expired lock position, get back all locked PENDLE
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
- params: MetaMethodExtraParams<T> = {}
  the additional parameters for write method.
Returns VePendleMainchainMetaMethodReturnType<T, "withdraw", 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.

Remarks
The user that receives the locked PENDLED is the sender.
- Defined in src/entities/VePendle.ts:299

`Static` createObject

createObject(chainId, networkConnection): VePendleMainchain
Create a VePendleMainchain object for a given the chainId.
Parameters
- chainId: MainchainId
- networkConnection: NetworkConnection
Returns VePendleMainchain
- Defined in src/entities/VePendle.ts:128

`Static` isValidWTime

isValidWTime(timestamp_s): boolean
Parameters
- timestamp_s: BigNumberish
Returns boolean
Inherited from VePendle.isValidWTime
- Defined in src/entities/VePendle.ts:79

Class VePendleMainchain

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

address: Address

config: VePendleMainchainConfig

Returns VePendleMainchain

Properties

Protected Readonly _contract

Remarks

Readonly address

Readonly chainId

Optional Readonly multicall

Readonly networkConnection

Static BROADCAST_FEE_BUFFER

Static Readonly MAX_LOCK_TIME_s

Static Readonly MIN_LOCK_TIME_s

Static Readonly ONE_DAY_s

Static Readonly ONE_WEEK_s

Accessors

contract

Returns WrappedContract<VotingEscrowPendleMainchain>

See

entityConfig

Returns VePendleMainchainConfig

Remarks

Methods

addExtraParams

Type Parameters

T extends MetaMethodType

Parameters

params: MetaMethodExtraParams<T>

Returns MetaMethodExtraParams<T>

balanceOf

Parameters

userAddress: Address

Optional params: MulticallStaticParams

Returns Promise<BN>

broadcastTotalSupply

Type Parameters

T extends MetaMethodType

Parameters

chainIds: ChainId[]

params: MetaMethodExtraParams<T>

Returns VePendleMainchainMetaMethodReturnType<T, "broadcastTotalSupply", object>

broadcastUserPosition

Type Parameters

T extends MetaMethodType

Parameters

chainIds: ChainId[]

params: MulticallStaticParams & { calcBufferedGas?: CalcBufferedGasFunction; method?: T; } & { userAddress?: Address; } = {}

Returns VePendleMainchainMetaMethodReturnType<T, "broadcastUserPosition", object>

getDefaultMetaMethodExtraParams

Type Parameters

T extends MetaMethodType

Returns MetaMethodExtraParams<T>

increaseLockPosition

Type Parameters

T extends MetaMethodType

Parameters

additionalRawAmountToLock: BigNumberish

newExpiry_s: BigNumberish

Optional params: MulticallStaticParams & { calcBufferedGas?: CalcBufferedGasFunction; method?: T; } & { broadcastChainIds?: []; }

Returns VePendleMainchainMetaMethodReturnType<T, "increaseLockPosition", object>

Remarks

Type Parameters

T extends MetaMethodType

Parameters

additionalRawAmountToLock: BigNumberish

newExpiry_s: BigNumberish

params: MulticallStaticParams & { calcBufferedGas?: CalcBufferedGasFunction; method?: T; } & { broadcastChainIds: ChainId[]; }

Returns VePendleMainchainMetaMethodReturnType<T, "increaseLockPositionAndBroadcast", object>

Remarks

positionData

`Protected` `Readonly` _contract

`Readonly` address

`Readonly` chainId

`Optional` `Readonly` multicall

`Readonly` networkConnection

`Static` BROADCAST_FEE_BUFFER

`Static` `Readonly` MAX_LOCK_TIME_s

`Static` `Readonly` MIN_LOCK_TIME_s

`Static` `Readonly` ONE_DAY_s

`Static` `Readonly` ONE_WEEK_s

`Optional` params: MulticallStaticParams

params: MulticallStaticParams & {
calcBufferedGas?: CalcBufferedGasFunction;
method?: T;
} & {
userAddress?: Address;
} = {}

`Optional` params: MulticallStaticParams & {
calcBufferedGas?: CalcBufferedGasFunction;
method?: T;
} & {
broadcastChainIds?: [];
}

params: MulticallStaticParams & {
calcBufferedGas?: CalcBufferedGasFunction;
method?: T;
} & {
broadcastChainIds: ChainId[];
}

`Optional` params: MulticallStaticParams

Returns Promise<[BN, BN] & {
amount: BN;
expiry: BN;
}>

`Optional` params: MulticallStaticParams

`Optional` params: MulticallStaticParams

`Static` createObject

`Static` isValidWTime