Class HoneyReserve

Hierarchy

HoneyReserve

Index

Constructors

Properties

conn data? reserve

Methods

fetchReserveValue gatherReserveState getReserveConfig getReserveState getUtilizationAndInterestRate makeRefreshIx refresh refreshOldReserves sendRefreshTx updateReserveConfig decodeReserve deriveAccounts load

Constructors

constructor

new HoneyReserve(client: HoneyClient, market: HoneyMarket, reserve: PublicKey, data?: helpers.TReserve): HoneyReserve
Parameters
- client: HoneyClient
- market: HoneyMarket
- reserve: PublicKey
- Optional data: helpers.TReserve
Returns HoneyReserve
- Defined in src/wrappers/reserve.ts:106

Properties

`Private` conn

conn: Connection

`Optional` data

data?: helpers.TReserve

reserve

reserve: PublicKey

Methods

fetchReserveValue

fetchReserveValue(cluster?: "mainnet-beta" | "devnet"): Promise<number>
Parameters
- cluster: "mainnet-beta" | "devnet" = 'mainnet-beta'
Returns Promise<number>
- Defined in src/wrappers/reserve.ts:203

gatherReserveState

gatherReserveState(): helpers.TotalReserveState
Returns
gathers all of the state information for the reserve from the chain and converts it into human readable format useable by the front end.

Returns helpers.TotalReserveState
- Defined in src/wrappers/reserve.ts:134

getReserveConfig

getReserveConfig(): ReserveConfig
Get specific information about the configuration of the reserve. Example include fees charges, expected collateralization ratios and interest rate.

Returns
The reserve config

Returns ReserveConfig
- Defined in src/wrappers/reserve.ts:149

getReserveState

getReserveState(): helpers.ReserveState
Get the top level information needed for each reserve. outstandingDebt, uncollectedFees and protocolUncollectedFees are stored as a special Number type on the backend and therefore need to be converted by dividing by 10^15.

Returns
The latest state of the total reserve in string format

Returns helpers.ReserveState
- Defined in src/wrappers/reserve.ts:159

getUtilizationAndInterestRate

getUtilizationAndInterestRate(): { interestRate: number; utilization: number }
Takes the reserve level state and calculates the current utilization and interest rate based on the utilization.

Returns { interestRate: number; utilization: number }
- interestRate: number
- utilization: number
- Defined in src/wrappers/reserve.ts:182

makeRefreshIx

makeRefreshIx(): Promise<TransactionInstruction>
Returns Promise<TransactionInstruction>
- Defined in src/wrappers/reserve.ts:221

refresh

refresh(): Promise<void>
Returns Promise<void>
- Defined in src/wrappers/reserve.ts:115

refreshOldReserves

refreshOldReserves(): Promise<void>
Returns Promise<void>
- Defined in src/wrappers/reserve.ts:209

sendRefreshTx

sendRefreshTx(): Promise<string>
Returns Promise<string>
- Defined in src/wrappers/reserve.ts:198

updateReserveConfig

updateReserveConfig(params: UpdateReserveConfigParams): Promise<void>
Parameters
- params: UpdateReserveConfigParams
Returns Promise<void>
- Defined in src/wrappers/reserve.ts:250

`Static` decodeReserve

decodeReserve(client: HoneyClient, address: PublicKey): Promise<helpers.TReserve>
Parameters
- client: HoneyClient
- address: PublicKey
Returns Promise<helpers.TReserve>
- Defined in src/wrappers/reserve.ts:121

`Static` deriveAccounts

deriveAccounts(client: HoneyClient, address: PublicKey, tokenMint: PublicKey): Promise<ReserveAccounts>
Derive all the associated accounts for a reserve.
Parameters
- client: HoneyClient
- address: PublicKey
  
  The reserve address to derive the accounts for.
- tokenMint: PublicKey
  
  The address of the mint for the token stored in the reserve.
Returns Promise<ReserveAccounts>
- Defined in src/wrappers/reserve.ts:273

`Static` load

load(client: HoneyClient, address: PublicKey, maybeMarket?: HoneyMarket): Promise<HoneyReserve>
Parameters
- client: HoneyClient
- address: PublicKey
- Optional maybeMarket: HoneyMarket
Returns Promise<HoneyReserve>
- Defined in src/wrappers/reserve.ts:261

Generated using TypeDoc