Class: ReadWriteStEth
Hierarchy
-
ReadStEthMixin&ReadWriteErc20<this>↳
ReadWriteStEth
Constructors
constructor
• new ReadWriteStEth(options): ReadWriteStEth
Parameters
| Name | Type |
|---|---|
options | ReadWriteErc20Options |
Returns
Inherited from
readStEthMixin(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
readStEthMixin(ReadWriteErc20).contract
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadWriteErc20.ts:15
contractFactory
• contractFactory: ReadWriteContractFactory
Inherited from
readStEthMixin(ReadWriteErc20).contractFactory
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadWriteErc20.ts:16
name
• name: string
Inherited from
readStEthMixin(ReadWriteErc20).name
Defined in
packages/hyperdrive-js-core/src/model/ReadModel.ts:27
network
• network: Network
Inherited from
readStEthMixin(ReadWriteErc20).network
Defined in
packages/hyperdrive-js-core/src/model/ReadModel.ts:28
stEthContract
• stEthContract: 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: "getBufferedEther" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [{ internalType: "uint256" ; name: "_sharesAmount" ; type: "uint256" }] ; name: "getPooledEthByShares" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [{ internalType: "uint256" ; name: "_ethAmount" ; type: "uint256" }] ; name: "getSharesByPooledEth" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [] ; name: "getTotalPooledEther" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [] ; name: "getTotalShares" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [] ; name: "name" ; outputs: readonly [{ internalType: "string" ; name: "" ; type: "string" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [{ internalType: "address" ; name: "_account" ; type: "address" }] ; name: "sharesOf" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "view" ; type: "function" }, { inputs: readonly [{ internalType: "address" ; name: "_referral" ; type: "address" }] ; name: "submit" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "payable" ; 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" }, { inputs: readonly [{ internalType: "address" ; name: "_recipient" ; type: "address" }, { internalType: "uint256" ; name: "_sharesAmount" ; type: "uint256" }] ; name: "transferShares" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; stateMutability: "nonpayable" ; type: "function" }, { inputs: readonly [{ internalType: "address" ; name: "_sender" ; type: "address" }, { internalType: "address" ; name: "_recipient" ; type: "address" }, { internalType: "uint256" ; name: "_sharesAmount" ; type: "uint256" }] ; name: "transferSharesFrom" ; outputs: readonly [{ internalType: "uint256" ; name: "" ; type: "uint256" }] ; 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" }]>
Overrides
readStEthMixin(ReadWriteErc20).stEthContract
Defined in
packages/hyperdrive-js-core/src/token/steth/ReadWriteStEth.ts:7
Accessors
address
• get address(): `0x${string}`
Returns
`0x${string}`
Inherited from
readStEthMixin(ReadWriteErc20).address
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:28
namespace
• get namespace(): undefined | string
Returns
undefined | string
Inherited from
readStEthMixin(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
readStEthMixin(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
readStEthMixin(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
readStEthMixin(ReadWriteErc20).getBalanceOf
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:59
getDecimals
▸ getDecimals(): Promise<number>
Returns
Promise<number>
Inherited from
readStEthMixin(ReadWriteErc20).getDecimals
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:43
getName
▸ getName(): Promise<string>
Returns
Promise<string>
Inherited from
readStEthMixin(ReadWriteErc20).getName
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:35
getPooledEthByShares
▸ getPooledEthByShares(«destructured»): Promise<bigint>
Get the amount of pooled ETH (stETH) that would be received for a given number of shares.
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› options? | ContractReadOptions |
› sharesAmount | bigint |
Returns
Promise<bigint>
Inherited from
readStEthMixin(ReadWriteErc20).getPooledEthByShares
Defined in
packages/hyperdrive-js-core/src/token/steth/ReadStEth.ts:29
getSharesByPooledEth
▸ getSharesByPooledEth(«destructured»): Promise<bigint>
Get the number of shares that would be received for a given amount of pooled ETH (stETH).
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› ethAmount | bigint |
› options? | ContractReadOptions |
Returns
Promise<bigint>
Inherited from
readStEthMixin(ReadWriteErc20).getSharesByPooledEth
Defined in
packages/hyperdrive-js-core/src/token/steth/ReadStEth.ts:41
getSharesOf
▸ getSharesOf(«destructured»): Promise<bigint>
Get the number of stETH shares held by an account.
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› account | `0x${string}` |
› options? | ContractReadOptions |
Returns
Promise<bigint>
Inherited from
readStEthMixin(ReadWriteErc20).getSharesOf
Defined in
packages/hyperdrive-js-core/src/token/steth/ReadStEth.ts:17
getSymbol
▸ getSymbol(): Promise<string>
Returns
Promise<string>
Inherited from
readStEthMixin(ReadWriteErc20).getSymbol
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:39
getTotalSupply
▸ getTotalSupply(options?): Promise<bigint>
Get the total supply of the token.
Parameters
| Name | Type |
|---|---|
options? | ContractReadOptions |
Returns
Promise<bigint>
Inherited from
readStEthMixin(ReadWriteErc20).getTotalSupply
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:72