Class AlgofiUser

Hierarchy

AlgofiUser

Index

Constructors

Properties

address algod algofiClient balances governance indexer lending minBalance staking transactions

Methods

getTransactionHistory isOptedInToAsset loadState

Constructors

constructor

new AlgofiUser(algofiClient: AlgofiClient, address: string): AlgofiUser
Constructor for the algofi client class.
Parameters
- algofiClient: AlgofiClient
  
  algofi client
- address: string
  
  address for user
Returns AlgofiUser
- Defined in algofiUser.ts:60

Properties

address

address: string

algod

algod: Algodv2

algofiClient

algofiClient: AlgofiClient

balances

balances: {
[key: number]: number;
} = {}

Type declaration

[key: number]: number

governance

governance: default

indexer

indexer: Indexer

lending

lending: default

minBalance

minBalance: number

staking

staking: default

transactions

transactions: default[]

Methods

getTransactionHistory

getTransactionHistory(mode: TxnLoadMode): Promise<void>
Parameters
- mode: TxnLoadMode
Returns Promise<void>
- Defined in algofiUser.ts:117

isOptedInToAsset

isOptedInToAsset(assetId: number): boolean
Function to determine whether someone is opted into an asset or not.

Returns
whether or not the user is opted into the asset id.
Parameters
- assetId: number
  
  asset id
Returns boolean
- Defined in algofiUser.ts:109

loadState

loadState(): Promise<void>
Function to load the states of all of the sub users on the algofi user class.

Returns Promise<void>
- Defined in algofiUser.ts:80

Generated using TypeDoc