Class PendleLimitRouter

Hierarchy (view full)

PendleEntity
- PendleLimitRouter

Constructors

constructor

new PendleLimitRouter(address, config): PendleLimitRouter
Parameters
- address: Address
- config: PendleLimitRouterConfig
Returns PendleLimitRouter
Overrides PendleEntity.constructor
- Defined in src/entities/Router/limitOrder/PendleLimitRouter.ts:21

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.

`Readonly` version

version: string

Accessors

contract

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

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

See
PendleEntity#_contract
Overrides PendleEntity.contract
- Defined in src/entities/Router/limitOrder/PendleLimitRouter.ts:36

domain

get domain(): {
    chainId: ChainId;
    name: "Pendle Limit Order Protocol";
    verifyingContract: Address;
    version: string;
}
Returns {
    chainId: ChainId;
    name: "Pendle Limit Order Protocol";
    verifyingContract: Address;
    version: string;
}
- Readonly chainId: ChainId
- Readonly name: "Pendle Limit Order Protocol"
- Readonly verifyingContract: Address
- Readonly version: string
- Defined in src/entities/Router/limitOrder/PendleLimitRouter.ts:40

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

cancelBatch

cancelBatch<T>(orders, params?): Promise<MetaMethodReturnType<T, PendleLimitRouter, "cancelBatch", {}>>
Type Parameters
- T extends MetaMethodType
Parameters
- orders: Iterable<{
      YT: Address;
      expiry: BN;
      failSafeRate: FixedX18;
      lnImpliedRate: FixedX18;
      maker: Address;
      makingAmount: BN;
      nonce: BN;
      orderType: BN;
      permit: BytesLike;
      receiver: Address;
      salt: BN;
      token: Address;
  }>
- Optional params: MetaMethodExtraParams<T>
Returns Promise<MetaMethodReturnType<T, PendleLimitRouter, "cancelBatch", {}>>
- Defined in src/entities/Router/limitOrder/PendleLimitRouter.ts:93

cancelSingle

cancelSingle<T>(order, params?): Promise<MetaMethodReturnType<T, PendleLimitRouter, "cancelSingle", {}>>
Type Parameters
- T extends MetaMethodType
Parameters
- order: {
      YT: Address;
      expiry: BN;
      failSafeRate: FixedX18;
      lnImpliedRate: FixedX18;
      maker: Address;
      makingAmount: BN;
      nonce: BN;
      orderType: BN;
      permit: BytesLike;
      receiver: Address;
      salt: BN;
      token: Address;
  }
  - YT: Address
  - expiry: BN
  - failSafeRate: FixedX18
  - lnImpliedRate: FixedX18
  - maker: Address
  - makingAmount: BN
  - nonce: BN
  - orderType: BN
  - permit: BytesLike
  - receiver: Address
  - salt: BN
  - token: Address
- Optional params: MetaMethodExtraParams<T>
Returns Promise<MetaMethodReturnType<T, PendleLimitRouter, "cancelSingle", {}>>
- Defined in src/entities/Router/limitOrder/PendleLimitRouter.ts:84

fill

fill<T>(fillOrderParams, receiver, maxTaking, params?): MetaMethodReturnType<T, PendleLimitRouter, "fill", {}>
Type Parameters
- T extends MetaMethodType
Parameters
- fillOrderParams: Iterable<{
      makingAmount: BN;
      order: {
          YT: Address;
          expiry: BN;
          failSafeRate: FixedX18;
          lnImpliedRate: FixedX18;
          maker: Address;
          makingAmount: BN;
          nonce: BN;
          orderType: BN;
          permit: BytesLike;
          receiver: Address;
          salt: BN;
          token: Address;
      };
      signature: BytesLike;
  }>
- receiver: Address
- maxTaking: BN
- Optional params: MulticallStaticParams & {
      calcBufferedGas?: CalcBufferedGasFunction;
      method?: T;
  } & {
      callback?: BytesLike;
      optionalData?: BytesLike;
  }
Returns MetaMethodReturnType<T, PendleLimitRouter, "fill", {}>
- Defined in src/entities/Router/limitOrder/PendleLimitRouter.ts:106

generateTypedDataForSigning

generateTypedDataForSigning(order): [TypedDataDomain, Record<string, TypedDataField[]>, OrderStruct]
Sync function to generate sign data so that the user can pick it up and sign it elsewhere.
Parameters
- order: {
      YT: Address;
      expiry: BN;
      failSafeRate: FixedX18;
      lnImpliedRate: FixedX18;
      maker: Address;
      makingAmount: BN;
      nonce: BN;
      orderType: BN;
      permit: BytesLike;
      receiver: Address;
      salt: BN;
      token: Address;
  }
  - YT: Address
  - expiry: BN
  - failSafeRate: FixedX18
  - lnImpliedRate: FixedX18
  - maker: Address
  - makingAmount: BN
  - nonce: BN
  - orderType: BN
  - permit: BytesLike
  - receiver: Address
  - salt: BN
  - token: Address
Returns [TypedDataDomain, Record<string, TypedDataField[]>, OrderStruct]
Example
```
const data = PendleLimitRouter.generateTypedDataForSigning(order);
const signature = await signer._signTypedData(...data);
```
- Defined in src/entities/Router/limitOrder/PendleLimitRouter.ts:132

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

getOrderStatuses

getOrderStatuses(orders, params?): Promise<OrderStatus[]>
Parameters
- orders: {
      YT: Address;
      expiry: BN;
      failSafeRate: FixedX18;
      lnImpliedRate: FixedX18;
      maker: Address;
      makingAmount: BN;
      nonce: BN;
      orderType: BN;
      permit: BytesLike;
      receiver: Address;
      salt: BN;
      token: Address;
  }[]
- Optional params: MulticallStaticParams
Returns Promise<OrderStatus[]>
- Defined in src/entities/Router/limitOrder/PendleLimitRouter.ts:75

getOrderStatusesUnchecked

getOrderStatusesUnchecked(orders, params?): Promise<(undefined | OrderStatus)[]>
Parameters
- orders: {
      YT: Address;
      expiry: BN;
      failSafeRate: FixedX18;
      lnImpliedRate: FixedX18;
      maker: Address;
      makingAmount: BN;
      nonce: BN;
      orderType: BN;
      permit: BytesLike;
      receiver: Address;
      salt: BN;
      token: Address;
  }[]
- Optional params: MulticallStaticParams
Returns Promise<(undefined | OrderStatus)[]>
- Defined in src/entities/Router/limitOrder/PendleLimitRouter.ts:67

getOrderStatusesUncheckedWithHashes

getOrderStatusesUncheckedWithHashes(orders, hashes, params?): Promise<(undefined | OrderStatus)[]>
Parameters
- orders: {
      YT: Address;
      expiry: BN;
      failSafeRate: FixedX18;
      lnImpliedRate: FixedX18;
      maker: Address;
      makingAmount: BN;
      nonce: BN;
      orderType: BN;
      permit: BytesLike;
      receiver: Address;
      salt: BN;
      token: Address;
  }[]
- hashes: string[]
- Optional params: MulticallStaticParams
Returns Promise<(undefined | OrderStatus)[]>
- Defined in src/entities/Router/limitOrder/PendleLimitRouter.ts:49

hashOrder

hashOrder(order): string
Parameters
- order: {
      YT: Address;
      expiry: BN;
      failSafeRate: FixedX18;
      lnImpliedRate: FixedX18;
      maker: Address;
      makingAmount: BN;
      nonce: BN;
      orderType: BN;
      permit: BytesLike;
      receiver: Address;
      salt: BN;
      token: Address;
  }
  - YT: Address
  - expiry: BN
  - failSafeRate: FixedX18
  - lnImpliedRate: FixedX18
  - maker: Address
  - makingAmount: BN
  - nonce: BN
  - orderType: BN
  - permit: BytesLike
  - receiver: Address
  - salt: BN
  - token: Address
Returns string
- Defined in src/entities/Router/limitOrder/PendleLimitRouter.ts:138

nonce

nonce(userAddress, params?): Promise<BN>
Parameters
- userAddress: Address
- Optional params: MulticallStaticParams
Returns Promise<BN>
- Defined in src/entities/Router/limitOrder/PendleLimitRouter.ts:102

signOrder

signOrder(order): Promise<BytesLike>
Parameters
- order: {
      YT: Address;
      expiry: BN;
      failSafeRate: FixedX18;
      lnImpliedRate: FixedX18;
      maker: Address;
      makingAmount: BN;
      nonce: BN;
      orderType: BN;
      permit: BytesLike;
      receiver: Address;
      salt: BN;
      token: Address;
  }
  - YT: Address
  - expiry: BN
  - failSafeRate: FixedX18
  - lnImpliedRate: FixedX18
  - maker: Address
  - makingAmount: BN
  - nonce: BN
  - orderType: BN
  - permit: BytesLike
  - receiver: Address
  - salt: BN
  - token: Address
Returns Promise<BytesLike>
- Defined in src/entities/Router/limitOrder/PendleLimitRouter.ts:146

`Static` getPendleLimitRouter

getPendleLimitRouter(this, config): PendleLimitRouter
Parameters
- this: void
- config: PendleLimitRouterConfig
Returns PendleLimitRouter
- Defined in src/entities/Router/limitOrder/PendleLimitRouter.ts:27

Class PendleLimitRouter

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

address: Address

config: PendleLimitRouterConfig

Returns PendleLimitRouter

Properties

Protected Readonly _contract

Remarks

Readonly address

Readonly chainId

Optional Readonly multicall

Readonly networkConnection

Readonly version

Accessors

contract

Returns WrappedContract<PendleLimitRouter>

Remarks

See

domain

Returns { chainId: ChainId; name: "Pendle Limit Order Protocol"; verifyingContract: Address; version: string; }

Readonly chainId: ChainId

Readonly name: "Pendle Limit Order Protocol"

Readonly verifyingContract: Address

Readonly version: string

entityConfig

Returns PendleEntityConfigOptionalAbi

Remarks

Methods

addExtraParams

Type Parameters

T extends MetaMethodType

Parameters

params: MetaMethodExtraParams<T>

Returns MetaMethodExtraParams<T>

cancelBatch

Type Parameters

T extends MetaMethodType

Parameters

orders: Iterable<{ YT: Address; expiry: BN; failSafeRate: FixedX18; lnImpliedRate: FixedX18; maker: Address; makingAmount: BN; nonce: BN; orderType: BN; permit: BytesLike; receiver: Address; salt: BN; token: Address; }>

Optional params: MetaMethodExtraParams<T>

Returns Promise<MetaMethodReturnType<T, PendleLimitRouter, "cancelBatch", {}>>

cancelSingle

Type Parameters

T extends MetaMethodType

Parameters

order: { YT: Address; expiry: BN; failSafeRate: FixedX18; lnImpliedRate: FixedX18; maker: Address; makingAmount: BN; nonce: BN; orderType: BN; permit: BytesLike; receiver: Address; salt: BN; token: Address; }

YT: Address

expiry: BN

failSafeRate: FixedX18

lnImpliedRate: FixedX18

maker: Address

makingAmount: BN

nonce: BN

orderType: BN

permit: BytesLike

receiver: Address

salt: BN

token: Address

Optional params: MetaMethodExtraParams<T>

Returns Promise<MetaMethodReturnType<T, PendleLimitRouter, "cancelSingle", {}>>

fill

Type Parameters

T extends MetaMethodType

Parameters

fillOrderParams: Iterable<{ makingAmount: BN; order: { YT: Address; expiry: BN; failSafeRate: FixedX18; lnImpliedRate: FixedX18; maker: Address; makingAmount: BN; nonce: BN; orderType: BN; permit: BytesLike; receiver: Address; salt: BN; token: Address; }; signature: BytesLike; }>

receiver: Address

maxTaking: BN

Optional params: MulticallStaticParams & { calcBufferedGas?: CalcBufferedGasFunction; method?: T; } & { callback?: BytesLike; optionalData?: BytesLike; }

Returns MetaMethodReturnType<T, PendleLimitRouter, "fill", {}>

generateTypedDataForSigning

Parameters

order: { YT: Address; expiry: BN; failSafeRate: FixedX18; lnImpliedRate: FixedX18; maker: Address; makingAmount: BN; nonce: BN; orderType: BN; permit: BytesLike; receiver: Address; salt: BN; token: Address; }

`Protected` `Readonly` _contract

`Readonly` address

`Readonly` chainId

`Optional` `Readonly` multicall

`Readonly` networkConnection

`Readonly` version

Returns {
chainId: ChainId;
name: "Pendle Limit Order Protocol";
verifyingContract: Address;
version: string;
}

`Readonly` chainId: ChainId

`Readonly` name: "Pendle Limit Order Protocol"

`Readonly` verifyingContract: Address

`Readonly` version: string

orders: Iterable<{
YT: Address;
expiry: BN;
failSafeRate: FixedX18;
lnImpliedRate: FixedX18;
maker: Address;
makingAmount: BN;
nonce: BN;
orderType: BN;
permit: BytesLike;
receiver: Address;
salt: BN;
token: Address;
}>

`Optional` params: MetaMethodExtraParams<T>

order: {
YT: Address;
expiry: BN;
failSafeRate: FixedX18;
lnImpliedRate: FixedX18;
maker: Address;
makingAmount: BN;
nonce: BN;
orderType: BN;
permit: BytesLike;
receiver: Address;
salt: BN;
token: Address;
}

`Optional` params: MetaMethodExtraParams<T>

fillOrderParams: Iterable<{
makingAmount: BN;
order: {
YT: Address;
expiry: BN;
failSafeRate: FixedX18;
lnImpliedRate: FixedX18;
maker: Address;
makingAmount: BN;
nonce: BN;
orderType: BN;
permit: BytesLike;
receiver: Address;
salt: BN;
token: Address;
};
signature: BytesLike;
}>

`Optional` params: MulticallStaticParams & {
calcBufferedGas?: CalcBufferedGasFunction;
method?: T;
} & {
callback?: BytesLike;
optionalData?: BytesLike;
}

order: {
YT: Address;
expiry: BN;
failSafeRate: FixedX18;
lnImpliedRate: FixedX18;
maker: Address;
makingAmount: BN;
nonce: BN;
orderType: BN;
permit: BytesLike;
receiver: Address;
salt: BN;
token: Address;
}

orders: {
YT: Address;
expiry: BN;
failSafeRate: FixedX18;
lnImpliedRate: FixedX18;
maker: Address;
makingAmount: BN;
nonce: BN;
orderType: BN;
permit: BytesLike;
receiver: Address;
salt: BN;
token: Address;
}[]

`Optional` params: MulticallStaticParams

orders: {
YT: Address;
expiry: BN;
failSafeRate: FixedX18;
lnImpliedRate: FixedX18;
maker: Address;
makingAmount: BN;
nonce: BN;
orderType: BN;
permit: BytesLike;
receiver: Address;
salt: BN;
token: Address;
}[]

`Optional` params: MulticallStaticParams

orders: {
YT: Address;
expiry: BN;
failSafeRate: FixedX18;
lnImpliedRate: FixedX18;
maker: Address;
makingAmount: BN;
nonce: BN;
orderType: BN;
permit: BytesLike;
receiver: Address;
salt: BN;
token: Address;
}[]

`Optional` params: MulticallStaticParams

order: {
YT: Address;
expiry: BN;
failSafeRate: FixedX18;
lnImpliedRate: FixedX18;
maker: Address;
makingAmount: BN;
nonce: BN;
orderType: BN;
permit: BytesLike;
receiver: Address;
salt: BN;
token: Address;
}

`Optional` params: MulticallStaticParams

order: {
YT: Address;
expiry: BN;
failSafeRate: FixedX18;
lnImpliedRate: FixedX18;
maker: Address;
makingAmount: BN;
nonce: BN;
orderType: BN;
permit: BytesLike;
receiver: Address;
salt: BN;
token: Address;
}