Class: ReadWriteLsEth

Hierarchy

• ReadLsEthMixin & ReadWriteErc20<this>

  ↳ ReadWriteLsEth

Constructors

constructor

• new ReadWriteLsEth(options): ReadWriteLsEth

Parameters

Name	Type
options	ReadWriteErc20Options

Returns

ReadWriteLsEth

Inherited from

readLsEthMixin(ReadWriteErc20).constructor

Defined in

packages/hyperdrive-js-core/src/token/erc20/ReadWriteErc20.ts:18

Properties

contract

• contract: CachedReadWriteContract<readonly [{ inputs: readonly [{ internalType: "address" ; name: "owner" ; type: "address" }, { internalType: "address" ; name: "spender" ; type: "address" }] ; name: "allowance" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [{ internalType: "address" ; name: "spender" ; type: "address" }, { internalType: "uint256" ; name: "amount" ; type: "uint256" }] ; name: "approve" ; outputs: readonly [{ internalType: "bool" ; name: "" ; type: "bool" }] ; stateMutability: "nonpayable" ; type: "function" }, { inputs: readonly [{ internalType: "address" ; name: "account" ; type: "address" }] ; name: "balanceOf" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [] ; name: "decimals" ; outputs: readonly [{ internalType: "uint8" ; name: "" ; type: "uint8" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [] ; name: "name" ; outputs: readonly [{ internalType: "string" ; name: "" ; type: "string" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [] ; name: "symbol" ; outputs: readonly [{ internalType: "string" ; name: "" ; type: "string" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [] ; name: "totalSupply" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [{ internalType: "address" ; name: "to" ; type: "address" }, { internalType: "uint256" ; name: "amount" ; type: "uint256" }] ; name: "transfer" ; outputs: readonly [{ internalType: "bool" ; name: "" ; type: "bool" }] ; stateMutability: "nonpayable" ; type: "function" }, { inputs: readonly [{ internalType: "address" ; name: "from" ; type: "address" }, { internalType: "address" ; name: "to" ; type: "address" }, { internalType: "uint256" ; name: "amount" ; type: "uint256" }] ; name: "transferFrom" ; outputs: readonly [{ internalType: "bool" ; name: "" ; type: "bool" }] ; stateMutability: "nonpayable" ; type: "function" }, { anonymous: false ; inputs: readonly [{ indexed: true ; internalType: "address" ; name: "owner" ; type: "address" }, { indexed: true ; internalType: "address" ; name: "spender" ; type: "address" }, { indexed: false ; internalType: "uint256" ; name: "value" ; type: "uint256" }] ; name: "Approval" ; type: "event" }, { anonymous: false ; inputs: readonly [{ indexed: true ; internalType: "address" ; name: "from" ; type: "address" }, { indexed: true ; internalType: "address" ; name: "to" ; type: "address" }, { indexed: false ; internalType: "uint256" ; name: "value" ; type: "uint256" }] ; name: "Transfer" ; type: "event" }]>

Inherited from

readLsEthMixin(ReadWriteErc20).contract

Defined in

packages/hyperdrive-js-core/src/token/erc20/ReadWriteErc20.ts:15

---

contractFactory

• contractFactory: ReadWriteContractFactory

Inherited from

readLsEthMixin(ReadWriteErc20).contractFactory

Defined in

packages/hyperdrive-js-core/src/token/erc20/ReadWriteErc20.ts:16

---

lsEthContract

• lsEthContract: CachedReadWriteContract<readonly [{ inputs: readonly [{ internalType: "address" ; name: "owner" ; type: "address" }, { internalType: "address" ; name: "spender" ; type: "address" }] ; name: "allowance" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [{ internalType: "address" ; name: "_spender" ; type: "address" }, { internalType: "uint256" ; name: "_value" ; type: "uint256" }] ; name: "approve" ; outputs: readonly [{ internalType: "bool" ; name: "" ; type: "bool" }] ; stateMutability: "nonpayable" ; type: "function" }, { inputs: readonly [{ internalType: "address" ; name: "_owner" ; type: "address" }] ; name: "balanceOf" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [{ internalType: "address" ; name: "_owner" ; type: "address" }] ; name: "balanceOfUnderlying" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [] ; name: "decimals" ; outputs: readonly [{ internalType: "uint8" ; name: "" ; type: "uint8" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [] ; name: "name" ; outputs: readonly [{ internalType: "string" ; name: "" ; type: "string" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [{ internalType: "uint256" ; name: "_underlyingAssetAmount" ; type: "uint256" }] ; name: "sharesFromUnderlyingBalance" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [] ; name: "symbol" ; outputs: readonly [{ internalType: "string" ; name: "" ; type: "string" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [] ; name: "totalSupply" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [] ; name: "totalUnderlyingSupply" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [{ internalType: "address" ; name: "_to" ; type: "address" }, { internalType: "uint256" ; name: "_value" ; type: "uint256" }] ; name: "transfer" ; outputs: readonly [{ internalType: "bool" ; name: "" ; type: "bool" }] ; stateMutability: "nonpayable" ; type: "function" }, { inputs: readonly [{ internalType: "address" ; name: "_from" ; type: "address" }, { internalType: "address" ; name: "_to" ; type: "address" }, { internalType: "uint256" ; name: "_value" ; type: "uint256" }] ; name: "transferFrom" ; outputs: readonly [{ internalType: "bool" ; name: "" ; type: "bool" }] ; stateMutability: "nonpayable" ; type: "function" }, { inputs: readonly [{ internalType: "uint256" ; name: "_shares" ; type: "uint256" }] ; name: "underlyingBalanceFromShares" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { anonymous: false ; inputs: readonly [{ indexed: true ; internalType: "address" ; name: "owner" ; type: "address" }, { indexed: true ; internalType: "address" ; name: "spender" ; type: "address" }, { indexed: false ; internalType: "uint256" ; name: "value" ; type: "uint256" }] ; name: "Approval" ; type: "event" }, { anonymous: false ; inputs: readonly [{ indexed: true ; internalType: "address" ; name: "from" ; type: "address" }, { indexed: true ; internalType: "address" ; name: "to" ; type: "address" }, { indexed: false ; internalType: "uint256" ; name: "value" ; type: "uint256" }] ; name: "Transfer" ; type: "event" }]>

Overrides

readLsEthMixin(ReadWriteErc20).lsEthContract

Defined in

packages/hyperdrive-js-core/src/token/lseth/ReadWriteLsEth.ts:7

---

name

• name: string

Inherited from

readLsEthMixin(ReadWriteErc20).name

Defined in

packages/hyperdrive-js-core/src/model/ReadModel.ts:27

---

network

• network: Network

Inherited from

readLsEthMixin(ReadWriteErc20).network

Defined in

packages/hyperdrive-js-core/src/model/ReadModel.ts:28

Accessors

address

• get address(): `0x${string}`

Returns

`0x${string}`

Inherited from

readLsEthMixin(ReadWriteErc20).address

Defined in

packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:28

---

namespace

• get namespace(): undefined | string

Returns

undefined | string

Inherited from

readLsEthMixin(ReadWriteErc20).namespace

Defined in

packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:31

Methods

approve

▸ approve(«destructured»): Promise<`0x${string}`>

Parameters

Name	Type
«destructured»	Object
› amount	bigint
› options?	ContractWriteOptions
› owner?	`0x${string}`
› spender	`0x${string}`

Returns

Promise<`0x${string}`>

Inherited from

readLsEthMixin(ReadWriteErc20).approve

Defined in

packages/hyperdrive-js-core/src/token/erc20/ReadWriteErc20.ts:25

---

getAllowance

▸ getAllowance(«destructured»): Promise<bigint>

Parameters

Name	Type
«destructured»	Object
› options?	ContractReadOptions
› owner	`0x${string}`
› spender	`0x${string}`

Returns

Promise<bigint>

Inherited from

readLsEthMixin(ReadWriteErc20).getAllowance

Defined in

packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:47

---

getBalanceOf

▸ getBalanceOf(«destructured»): Promise<bigint>

Parameters

Name	Type
«destructured»	Object
› account	`0x${string}`
› options?	ContractReadOptions

Returns

Promise<bigint>

Inherited from

readLsEthMixin(ReadWriteErc20).getBalanceOf

Defined in

packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:59

---

getDecimals

▸ getDecimals(): Promise<number>

Returns

Promise<number>

Inherited from

readLsEthMixin(ReadWriteErc20).getDecimals

Defined in

packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:43

---

getEthBalanceFromShares

▸ getEthBalanceFromShares(«destructured»): Promise<bigint>

Get the amount of ETH that would be received for a given number of shares.

Parameters

Name	Type
«destructured»	Object
› options?	ContractReadOptions
› sharesAmount	bigint

Returns

Promise<bigint>

Inherited from

readLsEthMixin(ReadWriteErc20).getEthBalanceFromShares

Defined in

packages/hyperdrive-js-core/src/token/lseth/ReadLsEth.ts:33

---

getEthBalanceOf

▸ getEthBalanceOf(«destructured»): Promise<bigint>

Get the underlying eth balance of an account.

Parameters

Name	Type
«destructured»	Object
› account	`0x${string}`
› options?	ContractReadOptions

Returns

Promise<bigint>

Inherited from

readLsEthMixin(ReadWriteErc20).getEthBalanceOf

Defined in

packages/hyperdrive-js-core/src/token/lseth/ReadLsEth.ts:22

---

getName

▸ getName(): Promise<string>

Returns

Promise<string>

Inherited from

readLsEthMixin(ReadWriteErc20).getName

Defined in

packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:35

---

getSharesFromEthBalance

▸ getSharesFromEthBalance(«destructured»): Promise<bigint>

Get the number of shares that would be received for a given amount of ETH.

Parameters

Name	Type
«destructured»	Object
› ethBalance	bigint
› options?	ContractReadOptions

Returns

Promise<bigint>

Inherited from

readLsEthMixin(ReadWriteErc20).getSharesFromEthBalance

Defined in

packages/hyperdrive-js-core/src/token/lseth/ReadLsEth.ts:44

---

getSymbol

▸ getSymbol(): Promise<string>

Returns

Promise<string>

Inherited from

readLsEthMixin(ReadWriteErc20).getSymbol

Defined in

packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:39

---

getTotalEthSupply

▸ getTotalEthSupply(options?): Promise<bigint>

Get the total supply of underlying eth in the lsEth contract.

Parameters

Name	Type
options?	ContractReadOptions

Returns

Promise<bigint>

Inherited from

readLsEthMixin(ReadWriteErc20).getTotalEthSupply

Defined in

packages/hyperdrive-js-core/src/token/lseth/ReadLsEth.ts:17

---

getTotalSupply

▸ getTotalSupply(options?): Promise<bigint>

Get the total supply of the token.

Parameters

Name	Type
options?	ContractReadOptions

Returns

Promise<bigint>

Inherited from

readLsEthMixin(ReadWriteErc20).getTotalSupply

Defined in

packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:72