Farming | @senswap/sen-js

Hierarchy

Tx
- Farming

Index

Constructors

constructor

Properties

Constructors

constructor

new Farming(farmingProgramAddress?: string, spltProgramAddress?: string, splataProgramAddress?: string, nodeUrl: string): Farming

Overrides Tx.constructor
- Defined in farming.ts:51
Parameters
- farmingProgramAddress: string = ...
- spltProgramAddress: string = ...
- splataProgramAddress: string = ...
- nodeUrl: string
Returns Farming

Properties

connection

connection: Connection

farmingProgramId

farmingProgramId: PublicKey

nodeUrl

nodeUrl: string

splataProgramId

splataProgramId: PublicKey

spltProgramId

spltProgramId: PublicKey

Methods

closeDebt

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

- Defined in farming.ts:886
Close a debt account

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

Transaction hash txId

closeFarm

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

- Defined in farming.ts:932
Close a farm Only possible when all tokens has been unstaked

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

Transaction hash txId

deriveDebtAddress

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

- Defined in farming.ts:137
Derive debt address

Parameters
- 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 farming.ts:764
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<DebtData>

- Defined in farming.ts:200
Get debt data

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

Readable json data respect to DEBT_SCHEMA

getFarmData

getFarmData(farmAddress: string): Promise<FarmData>

- Defined in farming.ts:175
Get farm data

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

Readable json data respect to FARM_SCHEMA

harvest

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

- Defined in farming.ts:564
Havest You havest rewards and send tokens to the rewarded address

Parameters
- 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

initializeAccounts

initializeAccounts(farmAddress: string, ownerAddress: string, wallet: WalletInterface): Promise<{ debtAddress: string; rewardedAddress: string; txId: string }>

- Defined in farming.ts:312
Initialize accounts including rewarded and debt

Parameters
- farmAddress: string
  
  Farm account address
- ownerAddress: string
  
  Onwer address for the accounts (your wallet address usually)
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ debtAddress: string; rewardedAddress: string; txId: string }>

Transaction hash txId, associated account address to wallet for rewarding rewardedAddress, and debt account address debtAddress

initializeFarm

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

- Defined in farming.ts:218
Initialize a farm

Parameters
- reward: bigint
  
  The number of tokens per period
- period: bigint
  
  The number of seconds for a reward period
- 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 Farm address farmAddress

parseDebtData

parseDebtData(data: Buffer): DebtData

- Defined in farming.ts:188
Parse debt buffer data

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

Readable json data respect to DEBT_SCHEMA

parseFarmData

parseFarmData(data: Buffer): FarmData

- Defined in farming.ts:163
Parse farm buffer data

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

Readable json data respect to FARM_SCHEMA

rid

rid(dstAddress: string, rewardedAddress: string, farmAddress: string, wallet: WalletInterface): Promise<{ debtAddress: string; txId: string }>

- Defined in farming.ts:997
Rid Give up on reward, get rid of the farm

Parameters
- dstAddress: string
  
  Destination address that receives unstaked tokens
- rewardedAddress: string
  
  Rewarded address that receive havested tokens (for strict procedure)
- farmAddress: string
  
  Farm address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ debtAddress: string; txId: string }>

Transaction hash txId, and debt account address debtAddress

seed

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

- Defined in farming.ts:638
Seed more reward tot 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

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

- Defined in farming.ts:384
Stake You stake tokens from the source address, and havest tokens to rewarded address

Parameters
- amount: bigint
  
  The number of staked amount
- srcAddress: string
  
  Source address that stakes tokens
- rewardedAddress: string
  
  Rewarded address that receive havested 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 farming.ts:803
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 farming.ts:843
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 farming.ts:698
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(amount: bigint, dstAddress: string, rewardedAddress: string, farmAddress: string, wallet: WalletInterface): Promise<{ debtAddress: string; txId: string }>

- Defined in farming.ts:475
Unstake You unstake tokens and send them to the destination address, and havest tokens to rewarded address

Parameters
- amount: bigint
  
  The number of unstaked amount
- dstAddress: string
  
  Destination address that receives unstaked tokens
- rewardedAddress: string
  
  Rewarded address that receive havested 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 farming.ts:126
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<FarmingAccountChangeInfo, "data"> & { data: FarmData | DebtData })) => void, filters?: GetProgramAccountsFilter[]): number

- Defined in farming.ts:78
Watch account changes

Parameters
- callback: (error: null | string, data: null | (Omit<FarmingAccountChangeInfo, "data"> & { data: FarmData | DebtData })) => void
  
  The callback will be called when there is any change
  - - (error: null | string, data: null | (Omit<FarmingAccountChangeInfo, "data"> & { data: FarmData | DebtData })): void
    - Parameters
      - error: null | string
      - data: null | (Omit<FarmingAccountChangeInfo, "data"> & { data: FarmData | DebtData })
      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

farmingProgramAddress: string = ...

spltProgramAddress: string = ...

splataProgramAddress: string = ...

nodeUrl: string

Returns Farming

Properties

connection

farmingProgramId

nodeUrl

splataProgramId

spltProgramId

Methods

closeDebt

Parameters

farmAddress: string

wallet: WalletInterface

Returns Promise<{ txId: string }>

closeFarm

Parameters

farmAddress: string

wallet: WalletInterface

Returns Promise<{ txId: string }>

deriveDebtAddress

Parameters

ownerAddress: string

farmAddress: string

Returns Promise<string>

freeze

Parameters

farmAddress: string

wallet: WalletInterface

Returns Promise<{ txId: string }>

getDebtData

Parameters

debtAddress: string

Returns Promise<DebtData>

getFarmData

Parameters

farmAddress: string

Returns Promise<FarmData>

harvest

Parameters

farmAddress: string

rewardedAddress: string

wallet: WalletInterface

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

initializeAccounts

Parameters

farmAddress: string

ownerAddress: string

wallet: WalletInterface

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

initializeFarm

Parameters

reward: bigint

period: bigint

ownerAddress: string

mintStakeAddress: string

mintRewardAddress: string

wallet: WalletInterface

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

parseDebtData

Parameters

data: Buffer

Returns DebtData

parseFarmData

Parameters

data: Buffer

Returns FarmData

rid

Parameters

dstAddress: string