Class Farm

Hierarchy

Farm

Constructors

constructor

new Farm(algod: default, appId: number, rawState: any, internalState: FarmInternalState, state: FarmState): Farm

- Defined in src/farming/farm.ts:70
Parameters
- algod: default
- appId: number
- rawState: any
- internalState: FarmInternalState
- state: FarmState
Returns Farm

Properties

Private _suggestedParams

_suggestedParams: null | SuggestedParams = null

algod

algod: default

appAddress

appAddress: string

appId

appId: number

internalState

internalState: FarmInternalState

rawState

rawState: any

state

state: FarmState

Accessors

stakedAsset

get stakedAsset(): Asset

- Defined in src/farming/farm.ts:109
Returns Asset

suggestedParams

get suggestedParams(): SuggestedParams

- Defined in src/farming/farm.ts:84
Returns SuggestedParams

Methods

adminBuildAddRewardAssetTx

adminBuildAddRewardAssetTx(asset: Asset): Transaction

- Defined in src/farming/farm.ts:452
Parameters
- asset: Asset
Returns Transaction

adminBuildDepositRewardsTxs

adminBuildDepositRewardsTxs(rewards: FarmingRewards, duration: number): Transaction[]

- Defined in src/farming/farm.ts:462
Parameters
- rewards: FarmingRewards
- duration: number
Returns Transaction[]

buildClaimRewardsTx

buildClaimRewardsTx(escrow: Escrow, assets?: Asset[]): Transaction

- Defined in src/farming/farm.ts:416
Parameters
- escrow: Escrow
- Optional assets: Asset[]
Returns Transaction

buildUpdateGlobalStateTx

buildUpdateGlobalStateTx(sender: string): Transaction

- Defined in src/farming/farm.ts:443
Parameters
- sender: string
Returns Transaction

buildUpdateIncreaseOpcodeQuotaTx

buildUpdateIncreaseOpcodeQuotaTx(sender: string): null | Transaction

- Defined in src/farming/farm.ts:361
Parameters
- sender: string
Returns null | Transaction

buildUpdateTx

buildUpdateTx(escrow: Escrow): Transaction

- Defined in src/farming/farm.ts:397
Parameters
- escrow: Escrow
Returns Transaction

buildUpdateWithOpcodeIncreaseTxs

buildUpdateWithOpcodeIncreaseTxs(escrow: Escrow): Transaction[]

- Defined in src/farming/farm.ts:383
Parameters
- escrow: Escrow
Returns Transaction[]

calculatePastAccruedRewards

calculatePastAccruedRewards(stakedAmount: number, userRpt: FarmingRewards): Record<number, number>

- Defined in src/farming/farm.ts:330
Parameters
- stakedAmount: number
- userRpt: FarmingRewards
Returns Record<number, number>

estimateAccruedRewards

estimateAccruedRewards(atTime: Date, userState: FarmUserState): FarmingRewards

- Defined in src/farming/farm.ts:202
Parameters
- atTime: Date
- userState: FarmUserState
Returns FarmingRewards

fetchAllAssets

fetchAllAssets(): Promise<void>

- Defined in src/farming/farm.ts:97
Returns Promise<void>

fetchEscrowByAddress

fetchEscrowByAddress(address: string): Promise<null | Escrow>

- Defined in src/farming/farm.ts:144
Parameters
- address: string
Returns Promise<null | Escrow>

fetchEscrowById

fetchEscrowById(appId: number): Promise<Escrow>

- Defined in src/farming/farm.ts:140
Parameters
- appId: number
Returns Promise<Escrow>

fetchEscrowFromAccountInfo

fetchEscrowFromAccountInfo(accountInfo: any): Promise<null | Escrow>

- Defined in src/farming/farm.ts:152
Parameters
- accountInfo: any
Returns Promise<null | Escrow>

fetchUserState

fetchUserState(address: string): Promise<null | FarmUserState>

- Defined in src/farming/farm.ts:167
Parameters
- address: string
Returns Promise<null | FarmUserState>

getUserStateFromAccountInfo

getUserStateFromAccountInfo(accountInfo: any): null | FarmUserState

- Defined in src/farming/farm.ts:172
Parameters
- accountInfo: any
Returns null | FarmUserState

haveRewards

haveRewards(dt?: Date): boolean

- Defined in src/farming/farm.ts:113
Parameters
- Optional dt: Date
Returns boolean

prepareDeployEscrowTxs

prepareDeployEscrowTxs(sender: string): Promise<Transaction[]>

- Defined in src/farming/farm.ts:352
Parameters
- sender: string
Returns Promise<Transaction[]>

refreshSuggestedParams

refreshSuggestedParams(): Promise<void>

- Defined in src/farming/farm.ts:93
Returns Promise<void>

setSuggestedParams

setSuggestedParams(suggestedParams: SuggestedParams): void

- Defined in src/farming/farm.ts:80
Parameters
- suggestedParams: SuggestedParams
Returns void

simulateAccruedRewards

simulateAccruedRewards(atTime: Date, stakedAmount: number, totalStaked: number, options?: { extrapolateFutureRewards?: boolean }): FarmingRewards

- Defined in src/farming/farm.ts:231
Parameters
- atTime: Date
- stakedAmount: number
- totalStaked: number
- options: { extrapolateFutureRewards?: boolean } = {}
  - Optional extrapolateFutureRewards?: boolean
Returns FarmingRewards

Private simulateCycleRewards

simulateCycleRewards(stakeRatio: number, rewards: FarmingRewards, stakeDuration: number, cycleDuration: number): FarmingRewards

- Defined in src/farming/farm.ts:308
Parameters
- stakeRatio: number
- rewards: FarmingRewards
- stakeDuration: number
- cycleDuration: number
Returns FarmingRewards

simulateNewStaker

simulateNewStaker(atTime: Date, stakedAmount: number): FarmingRewards

- Defined in src/farming/farm.ts:222
Parameters
- atTime: Date
- stakedAmount: number
Returns FarmingRewards

sumRewards

sumRewards(rewardsA: FarmingRewards, rewardsB: FarmingRewards): FarmingRewards

- Defined in src/farming/farm.ts:342
Parameters
- rewardsA: FarmingRewards
- rewardsB: FarmingRewards
Returns FarmingRewards

updateState

updateState(): Promise<void>

- Defined in src/farming/farm.ts:160
Returns Promise<void>

Generated using TypeDoc