Class HoneyUser

Hierarchy

HoneyUser

Implements

User

Constructors

`Private` constructor

new HoneyUser(client: HoneyClient, market: HoneyMarket, address: PublicKey, obligation: wrappers.DerivedAccount, reserves: HoneyReserve[]): HoneyUser
Parameters
- client: HoneyClient
- market: HoneyMarket
- address: PublicKey
- obligation: wrappers.DerivedAccount
- reserves: HoneyReserve[]
Returns HoneyUser
- Defined in src/wrappers/user.ts:60

Properties

`Private` _deposits

_deposits: TokenAmount[] = []

`Private` _loans

_loans: TokenAmount[] = []

address

address: PublicKey

client

client: HoneyClient

`Private` conn

conn: Connection

market

market: HoneyMarket

reserves

reserves: HoneyReserve[]

Methods

borrow

borrow(reserve: HoneyReserve, receiver: PublicKey, amount: wrappers.Amount): Promise<actions.TxResponse>
Parameters
- reserve: HoneyReserve
- receiver: PublicKey
- amount: wrappers.Amount
Returns Promise<actions.TxResponse>
- Defined in src/wrappers/user.ts:691

borrowAndRefresh

borrowAndRefresh(reserve: HoneyReserve, receiver: PublicKey, amount: wrappers.Amount): Promise<actions.TxResponse>
Parameters
- reserve: HoneyReserve
- receiver: PublicKey
- amount: wrappers.Amount
Returns Promise<actions.TxResponse>
- Defined in src/wrappers/user.ts:696

deposit

deposit(reserve: HoneyReserve, tokenAccount: PublicKey, amount: wrappers.Amount): Promise<actions.TxResponse>
Parameters
- reserve: HoneyReserve
- tokenAccount: PublicKey
- amount: wrappers.Amount
Returns Promise<actions.TxResponse>
- Defined in src/wrappers/user.ts:594

depositNFT

depositNFT(tokenAccount: PublicKey, tokenMint: PublicKey, updateAuthority: PublicKey): Promise<actions.TxResponse>
Parameters
- tokenAccount: PublicKey
- tokenMint: PublicKey
- updateAuthority: PublicKey
Returns Promise<actions.TxResponse>
- Defined in src/wrappers/user.ts:420

deposits

deposits(): TokenAmount[]
Get all the deposits held by the user, excluding those amounts being used as collateral for a loan.

Returns TokenAmount[]
Implementation of User.deposits
- Defined in src/wrappers/user.ts:992

fetchAllowanceAndDebt

fetchAllowanceAndDebt(index: number, cluster?: "mainnet-beta" | "devnet" | "localnet" | "testnet"): Promise<{ allowance: number; debt: number; exponent: number; liquidationThreshold: number; ltv: number; ratio: BN }>
fetch the user specfic allowance and debt

Returns
Parameters
- index: number
  
  index of the reserve to use for the calculation
- cluster: "mainnet-beta" | "devnet" | "localnet" | "testnet" = 'mainnet-beta'
  
  which cluster to connect to
Returns Promise<{ allowance: number; debt: number; exponent: number; liquidationThreshold: number; ltv: number; ratio: BN }>
- Defined in src/wrappers/user.ts:106

fetchUserDeposits

fetchUserDeposits(index: number): Promise<number>
Returns
totalDeposits / decimals
Parameters
- index: number
Returns Promise<number>
- Defined in src/wrappers/user.ts:88

`Private` findCollateralAddress

findCollateralAddress(program: Program<Idl>, reserve: PublicKey, obligation: PublicKey, wallet: PublicKey): Promise<[collateralPubkey: PublicKey, collateralBump: number]>
Find collateral account for the reserve, obligation and wallet.
Parameters
- program: Program<Idl>
- reserve: PublicKey
- obligation: PublicKey
- wallet: PublicKey
Returns Promise<[collateralPubkey: PublicKey, collateralBump: number]>
- Defined in src/wrappers/user.ts:954

`Private` findDepositNoteAddress

findDepositNoteAddress(program: Program<Idl>, reserve: PublicKey, wallet: PublicKey): Promise<[depositNotePubkey: PublicKey, depositAccountBump: number]>
Find reserve deposit note account for wallet
Parameters
- program: Program<Idl>
- reserve: PublicKey
- wallet: PublicKey
Returns Promise<[depositNotePubkey: PublicKey, depositAccountBump: number]>
- Defined in src/wrappers/user.ts:935

`Private` findLoanNoteAddress

findLoanNoteAddress(program: Program<Idl>, reserve: PublicKey, obligation: PublicKey, wallet: PublicKey): Promise<[loanNotePubkey: PublicKey, loanNoteBump: number]>
Find loan note token account for the reserve, obligation and wallet.
Parameters
- program: Program<Idl>
- reserve: PublicKey
- obligation: PublicKey
- wallet: PublicKey
Returns Promise<[loanNotePubkey: PublicKey, loanNoteBump: number]>
- Defined in src/wrappers/user.ts:944

`Private` findNftMetadata

findNftMetadata(tokenMint: PublicKey): Promise<wrappers.DerivedAccount>
Parameters
- tokenMint: PublicKey
Returns Promise<wrappers.DerivedAccount>
- Defined in src/wrappers/user.ts:900

`Private` findProgramAddress

findProgramAddress(programId: PublicKey, seeds: (string | Uint8Array | HasPublicKey | ToBytes)[]): Promise<[PublicKey, number]>
Find a program derived address

Returns
The address found and the bump seed required
Parameters
- programId: PublicKey
  
  The program the address is being derived for
- seeds: (string | Uint8Array | HasPublicKey | ToBytes)[]
  
  The seeds to find the address
Returns Promise<[PublicKey, number]>
- Defined in src/wrappers/user.ts:915

`Private` findReserveAccounts

findReserveAccounts(reserve: HoneyReserve | helpers.CachedReserveInfo): Promise<UserReserveAccounts>
Parameters
- reserve: HoneyReserve | helpers.CachedReserveInfo
Returns Promise<UserReserveAccounts>
- Defined in src/wrappers/user.ts:963

getObligationData

getObligationData(): Promise<Error | helpers.ObligationAccount>
Returns Promise<Error | helpers.ObligationAccount>
- Defined in src/wrappers/user.ts:161

loans

loans(): TokenAmount[]
Get the loans held by the user

Returns TokenAmount[]
Implementation of User.loans
- Defined in src/wrappers/user.ts:999

makeBorrowTx

makeBorrowTx(reserve: HoneyReserve, receiver: PublicKey, amount: wrappers.Amount): Promise<helpers.InstructionAndSigner[]>
Parameters
- reserve: HoneyReserve
- receiver: PublicKey
- amount: wrappers.Amount
Returns Promise<helpers.InstructionAndSigner[]>
- Defined in src/wrappers/user.ts:705

makeDepositTx

makeDepositTx(reserve: HoneyReserve, tokenAccount: PublicKey, amount: wrappers.Amount): Promise<[Transaction, Keypair[]]>
Parameters
- reserve: HoneyReserve
- tokenAccount: PublicKey
- amount: wrappers.Amount
Returns Promise<[Transaction, Keypair[]]>
- Defined in src/wrappers/user.ts:605

`Private` makeInitDepositAccountIx

makeInitDepositAccountIx(reserve: HoneyReserve, account: wrappers.DerivedAccount): Promise<TransactionInstruction>
Parameters
- reserve: HoneyReserve
- account: wrappers.DerivedAccount
Returns Promise<TransactionInstruction>
- Defined in src/wrappers/user.ts:818

`Private` makeInitLoanAccountIx

makeInitLoanAccountIx(reserve: HoneyReserve, account: wrappers.DerivedAccount): Promise<TransactionInstruction>
Parameters
- reserve: HoneyReserve
- account: wrappers.DerivedAccount
Returns Promise<TransactionInstruction>
- Defined in src/wrappers/user.ts:841

makeNFTDepositTx

makeNFTDepositTx(tokenAccount: PublicKey, tokenMint: PublicKey, updateAuthority: PublicKey): Promise<Transaction>
Parameters
- tokenAccount: PublicKey
- tokenMint: PublicKey
- updateAuthority: PublicKey
Returns Promise<Transaction>
- Defined in src/wrappers/user.ts:431

makeNFTWithdrawSolventTx

makeNFTWithdrawSolventTx(tokenAccount: PublicKey, tokenMint: PublicKey, depositor: PublicKey, nftCollectionCreator: PublicKey): Promise<Transaction>
Parameters
- tokenAccount: PublicKey
- tokenMint: PublicKey
- depositor: PublicKey
- nftCollectionCreator: PublicKey
Returns Promise<Transaction>
- Defined in src/wrappers/user.ts:301

makeNFTWithdrawTx

makeNFTWithdrawTx(tokenAccount: PublicKey, tokenMint: PublicKey, nftCollectionCreator: PublicKey): Promise<Transaction>
Parameters
- tokenAccount: PublicKey
- tokenMint: PublicKey
- nftCollectionCreator: PublicKey
Returns Promise<Transaction>
- Defined in src/wrappers/user.ts:353

makeRepayTx

makeRepayTx(reserve: HoneyReserve, tokenAccount: PublicKey, amount: wrappers.Amount): Promise<{ ix: TransactionInstruction[]; signers: Signer[] }[]>
Parameters
- reserve: HoneyReserve
- tokenAccount: PublicKey
- amount: wrappers.Amount
Returns Promise<{ ix: TransactionInstruction[]; signers: Signer[] }[]>
- Defined in src/wrappers/user.ts:191

makeWithdrawTx

makeWithdrawTx(reserve: HoneyReserve, tokenAccount: PublicKey, amount: wrappers.Amount): Promise<actions.TxResponse>
Parameters
- reserve: HoneyReserve
- tokenAccount: PublicKey
- amount: wrappers.Amount
Returns Promise<actions.TxResponse>
- Defined in src/wrappers/user.ts:499

refresh

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

`Private` refreshAccount

refreshAccount(appendTo: TokenAmount[], account: wrappers.DerivedAccount): Promise<void>
Parameters
- appendTo: TokenAmount[]
- account: wrappers.DerivedAccount
Returns Promise<void>
- Defined in src/wrappers/user.ts:880

`Private` refreshReserve

refreshReserve(reserve: helpers.CachedReserveInfo): Promise<void>
Parameters
- reserve: helpers.CachedReserveInfo
Returns Promise<void>
- Defined in src/wrappers/user.ts:873

repay

repay(reserve: HoneyReserve, tokenAccount: PublicKey, amount: wrappers.Amount): Promise<actions.TxResponse>
Parameters
- reserve: HoneyReserve
- tokenAccount: PublicKey
- amount: wrappers.Amount
Returns Promise<actions.TxResponse>
- Defined in src/wrappers/user.ts:168

repayAndRefresh

repayAndRefresh(reserve: HoneyReserve, tokenAccount: PublicKey, amount: wrappers.Amount): Promise<actions.TxResponse>
Parameters
- reserve: HoneyReserve
- tokenAccount: PublicKey
- amount: wrappers.Amount
Returns Promise<actions.TxResponse>
- Defined in src/wrappers/user.ts:178

withdraw

withdraw(reserve: HoneyReserve, tokenAccount: PublicKey, amount: wrappers.Amount): Promise<actions.TxResponse>
Parameters
- reserve: HoneyReserve
- tokenAccount: PublicKey
- amount: wrappers.Amount
Returns Promise<actions.TxResponse>
- Defined in src/wrappers/user.ts:493

withdrawNFT

withdrawNFT(tokenAccount: PublicKey, tokenMint: PublicKey, updateAuthority: PublicKey): Promise<actions.TxResponse>
Parameters
- tokenAccount: PublicKey
- tokenMint: PublicKey
- updateAuthority: PublicKey
Returns Promise<actions.TxResponse>
- Defined in src/wrappers/user.ts:273

withdrawNFTSolvent

withdrawNFTSolvent(tokenAccount: PublicKey, tokenMint: PublicKey, depositor: PublicKey, updateAuthority: PublicKey): Promise<actions.TxResponse>
Parameters
- tokenAccount: PublicKey
- tokenMint: PublicKey
- depositor: PublicKey
- updateAuthority: PublicKey
Returns Promise<actions.TxResponse>
- Defined in src/wrappers/user.ts:284

`Static` load

load(client: HoneyClient, market: HoneyMarket, address: PublicKey, reserves: HoneyReserve[]): Promise<HoneyUser>
Parameters
- client: HoneyClient
- market: HoneyMarket
- address: PublicKey
- reserves: HoneyReserve[]
Returns Promise<HoneyUser>
- Defined in src/wrappers/user.ts:70

Class HoneyUser

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

client: HoneyClient

market: HoneyMarket

address: PublicKey

obligation: wrappers.DerivedAccount

reserves: HoneyReserve[]

Returns HoneyUser

Properties

Private _deposits

Private _loans

address

client

Private conn

market

reserves

Methods

borrow

Parameters

reserve: HoneyReserve

receiver: PublicKey

amount: wrappers.Amount

Returns Promise<actions.TxResponse>

borrowAndRefresh

Parameters

reserve: HoneyReserve

receiver: PublicKey

amount: wrappers.Amount

Returns Promise<actions.TxResponse>

deposit

Parameters

reserve: HoneyReserve

tokenAccount: PublicKey

amount: wrappers.Amount

Returns Promise<actions.TxResponse>

depositNFT

Parameters

tokenAccount: PublicKey

tokenMint: PublicKey

updateAuthority: PublicKey

Returns Promise<actions.TxResponse>

deposits

Returns TokenAmount[]

fetchAllowanceAndDebt

Returns

Parameters

index: number

cluster: "mainnet-beta" | "devnet" | "localnet" | "testnet" = 'mainnet-beta'

Returns Promise<{ allowance: number; debt: number; exponent: number; liquidationThreshold: number; ltv: number; ratio: BN }>

fetchUserDeposits

Returns

Parameters

index: number

Returns Promise<number>

Private findCollateralAddress

Parameters

program: Program<Idl>

reserve: PublicKey

obligation: PublicKey

wallet: PublicKey

Returns Promise<[collateralPubkey: PublicKey, collateralBump: number]>

Private findDepositNoteAddress

Parameters

program: Program<Idl>

reserve: PublicKey

wallet: PublicKey

Returns Promise<[depositNotePubkey: PublicKey, depositAccountBump: number]>

Private findLoanNoteAddress

Parameters

program: Program<Idl>

reserve: PublicKey

obligation: PublicKey

`Private` constructor

`Private` _deposits

`Private` _loans

`Private` conn

`Private` findCollateralAddress

`Private` findDepositNoteAddress

`Private` findLoanNoteAddress

`Private` findNftMetadata

`Private` findProgramAddress

`Private` findReserveAccounts

`Private` makeInitDepositAccountIx

`Private` makeInitLoanAccountIx