Stake

Hierarchy

Tx
- Stake

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Stake(stakeProgramAddress?: string, spltProgramAddress?: string, splataProgramAddress?: string, nodeUrl: string): Stake

Overrides Tx.constructor
- Defined in stake/index.ts:38
Parameters
- stakeProgramAddress: string = ...
- spltProgramAddress: string = ...
- splataProgramAddress: string = ...
- nodeUrl: string
Returns Stake

Properties

connection

connection: Connection

nodeUrl

nodeUrl: string

splataProgramId

splataProgramId: PublicKey

spltProgramId

spltProgramId: PublicKey

stakeProgramId

stakeProgramId: PublicKey

Methods

deriveDebtAddress

deriveDebtAddress(index: number, ownerAddress: string, farmAddress: string): Promise<string>

- Defined in stake/index.ts:175
Derive debt address

Parameters
- index: number
  
  Account index (MAX: 4294967296)
- ownerAddress: string
  
  Owner address of the debt account
- farmAddress: string
  
  Corresponding farm address to the debt account
Returns Promise<string>

Debt account address

freeze

freeze(farmAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in stake/index.ts:706
Freeze the farm Prevent all functions such as stake, unstake, and harvest

remarks

Farm owner only

Parameters
- farmAddress: string
  
  Farm address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ txId: string }>

Transaction hash txId

getDebtData

getDebtData(debtAddress: string): Promise<StakeDebtData>

- Defined in stake/index.ts:160
Get debt data

Parameters
- debtAddress: string
  
  Debt account address
Returns Promise<StakeDebtData>

Readable json data respect to STAKE_DEBT_SCHEMA

getFarmData

getFarmData(farmAddress: string): Promise<StakeFarmData>

- Defined in stake/index.ts:135
Get farm data

Parameters
- farmAddress: string
  
  Farm account address
Returns Promise<StakeFarmData>

Readable json data respect to STAKE_FARM_SCHEMA

harvest

harvest(index: number, farmAddress: string, rewardedAddress: string, wallet: WalletInterface): Promise<{ debtAddress: string; txId: string }>

- Defined in stake/index.ts:417
Havest You havest rewards and send tokens to the rewarded address

Parameters
- index: number
  
  The account's index
- farmAddress: string
  
  Farm address
- rewardedAddress: string
  
  Rewarded address that receive havested tokens
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ debtAddress: string; txId: string }>

Transaction hash txId, and debt account address debtAddress

initializeFarm

initializeFarm(reward: bigint, period: bigint, scope: bigint, ownerAddress: string, mintStakeAddress: string, mintRewardAddress: string, wallet: WalletInterface): Promise<{ farmAddress: string; txId: string }>

- Defined in stake/index.ts:233
Initialize a farm

Parameters
- reward: bigint
  
  The number of tokens per period
- period: bigint
  
  The number of seconds for a reward period
- scope: bigint
  
  The maximum number of periods
- ownerAddress: string
  
  Farm owner address
- mintStakeAddress: string
  
  Mint address for staking
- mintRewardAddress: string
  
  Mint address for rewarding
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ farmAddress: string; txId: string }>

Transaction hash txId and the farm address farmAddress

parseDebtData

parseDebtData(data: Buffer): StakeDebtData

- Defined in stake/index.ts:148
Parse debt buffer data

Parameters
- data: Buffer
  
  Buffer data (raw data) that you get by connection.getAccountInfo
Returns StakeDebtData

Readable json data respect to STAKE_DEBT_SCHEMA

parseFarmData

parseFarmData(data: Buffer): StakeFarmData

- Defined in stake/index.ts:123
Parse farm buffer data

Parameters
- data: Buffer
  
  Buffer data (raw data) that you get by connection.getAccountInfo
Returns StakeFarmData

Readable json data respect to STAKE_FARM_SCHEMA

seed

seed(amount: bigint, farmAddress: string, srcAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in stake/index.ts:577
Seed more reward to the farm treasury

remarks

Owner only

Parameters
- amount: bigint
  
  The number of rewarded tokens that will be seeded
- farmAddress: string
  
  Farm address
- srcAddress: string
  
  Source address that sends the rewarded tokens to the farm treasury
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ txId: string }>

Transaction hash txId

stake(index: number, amount: bigint, srcAddress: string, farmAddress: string, wallet: WalletInterface): Promise<{ debtAddress: string; txId: string }>

- Defined in stake/index.ts:334
Stake Create accounts and stake tokens from the source address

Parameters
- index: number
  
  The account's index
- amount: bigint
  
  The number of staked amount
- srcAddress: string
  
  Source address that stakes tokens
- farmAddress: string
  
  Farm address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ debtAddress: string; txId: string }>

Transaction hash txId, and debt account address debtAddress

thaw

thaw(farmAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in stake/index.ts:745
Thaw the farm

remarks

Farm owner only

Parameters
- farmAddress: string
  
  Farm address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ txId: string }>

Transaction hash txId

transferFarmOwnership

transferFarmOwnership(farmAddress: string, newOwnerAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in stake/index.ts:785
Transfer farm's ownership

remarks

Farm owner only

Parameters
- farmAddress: string
  
  Farm address
- newOwnerAddress: string
  
  New owner address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ txId: string }>

Transaction hash txId

unseed

unseed(amount: bigint, farmAddress: string, dstAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in stake/index.ts:637
Unseed less reward

remarks

Farm owner only

Parameters
- amount: bigint
  
  The number of rewarded tokens that will be unseeded
- farmAddress: string
  
  Farm address
- dstAddress: string
  
  Destination address that receives the rewarded tokens from the farm treasury
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ txId: string }>

Transaction hash txId

unstake

unstake(index: number, dstAddress: string, farmAddress: string, wallet: WalletInterface): Promise<{ debtAddress: string; txId: string }>

- Defined in stake/index.ts:498
Unstake You unstake all tokens and send them to the destination address

Parameters
- index: number
  
  The account's index
- dstAddress: string
  
  Destination address that receives unstaked tokens
- farmAddress: string
  
  Farm address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ debtAddress: string; txId: string }>

Transaction hash txId, and debt account address debtAddress

unwatch

unwatch(watchId: number): Promise<void>

- Defined in stake/index.ts:113
Unwatch a watcher by watch id

Parameters
- watchId: number
  
  The watchId was returned by watch function.
Returns Promise<void>

watch

watch(callback: (error: null | string, data: null | (Omit<StakeAccountChangeInfo, "data"> & { data: StakeFarmData | StakeDebtData })) => void, filters?: GetProgramAccountsFilter[]): number

- Defined in stake/index.ts:65
Watch account changes

Parameters
- callback: (error: null | string, data: null | (Omit<StakeAccountChangeInfo, "data"> & { data: StakeFarmData | StakeDebtData })) => void
  
  The callback will be called when there is any change
  - - (error: null | string, data: null | (Omit<StakeAccountChangeInfo, "data"> & { data: StakeFarmData | StakeDebtData })): void
    - Parameters
      - error: null | string
      - data: null | (Omit<StakeAccountChangeInfo, "data"> & { data: StakeFarmData | StakeDebtData })
      Returns void
- Optional filters: GetProgramAccountsFilter[]
  
  GetProgramAccountsFilter - Ref: https://solana-labs.github.io/solana-web3.js/modules.html#GetProgramAccountsFilter
Returns number

Watch id

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

stakeProgramAddress: string = ...

spltProgramAddress: string = ...

splataProgramAddress: string = ...

nodeUrl: string

Returns Stake

Properties

connection

nodeUrl

splataProgramId

spltProgramId

stakeProgramId

Methods

deriveDebtAddress

Parameters

index: number

ownerAddress: string

farmAddress: string

Returns Promise<string>

freeze

Parameters

farmAddress: string

wallet: WalletInterface

Returns Promise<{ txId: string }>

getDebtData

Parameters

debtAddress: string

Returns Promise<StakeDebtData>

getFarmData

Parameters

farmAddress: string

Returns Promise<StakeFarmData>

harvest

Parameters

index: number

farmAddress: string

rewardedAddress: string

wallet: WalletInterface

Returns Promise<{ debtAddress: string; txId: string }>

initializeFarm

Parameters

reward: bigint

period: bigint

scope: bigint

ownerAddress: string

mintStakeAddress: string

mintRewardAddress: string

wallet: WalletInterface

Returns Promise<{ farmAddress: string; txId: string }>

parseDebtData

Parameters

data: Buffer

Returns StakeDebtData

parseFarmData

Parameters

data: Buffer

Returns StakeFarmData

seed

Parameters

amount: bigint

farmAddress: string

srcAddress: string

wallet: WalletInterface

Returns Promise<{ txId: string }>

stake

Parameters

index: number

amount: bigint

srcAddress: string

farmAddress: string

wallet: WalletInterface

Returns Promise<{ debtAddress: string; txId: string }>

thaw