Interface: ReadStEthHyperdriveOptions
The options required to create a read model that represents a specific contract.
Hierarchy
-
↳
ReadStEthHyperdriveOptions
Properties
address
• address: `0x${string}`
Inherited from
Defined in
packages/hyperdrive-js-core/src/evm-client/contractFactory.ts:10
cache
• Optional cache: SimpleCache<any, SimpleCacheKey>
Inherited from
Defined in
packages/hyperdrive-js-core/src/evm-client/contractFactory.ts:11
contractFactory
• contractFactory: ReadContractFactory
Inherited from
ReadHyperdriveOptions.contractFactory
Defined in
packages/hyperdrive-js-core/src/model/ReadModel.ts:12
name
• Optional name: string
An arbitrary name for the instance. This is for convenience only (e.g., for use as a display name or in logging) and has no affect on the model's behavior.
Inherited from
Defined in
packages/hyperdrive-js-core/src/model/ReadModel.ts:20
namespace
• Optional namespace: string
Inherited from
ReadHyperdriveOptions.namespace
Defined in
packages/hyperdrive-js-core/src/evm-client/contractFactory.ts:12
network
• network: Network
Inherited from
Defined in
packages/hyperdrive-js-core/src/model/ReadModel.ts:13
useSharesAccounting
• Optional useSharesAccounting: boolean
The StETHHyperdrive contract stores and operates on Lido balances in
shares. However, since users are most familiar with stETH public balances,
this model will accept and return balances in stETH by default and convert
them to shares when interacting with the contract to ease UI integration.
To use shares instead of stETH, set this to true.
Default
false
See
https://docs.lido.fi/guides/lido-tokens-integration-guide#bookkeeping-shares
Defined in
packages/hyperdrive-js-core/src/hyperdrive/steth/ReadStEthHyperdrive.ts:24