1 of 5

Farm guide

This section contains SDK reference for Farm contracts

The remaining sections of the documentation will demonstrate specific examples of the Farm usage:

stake in farm
claim farm rewards
unstake from farm
destroy farm NFT

stake in farm

This section contains SDK example for staking tokens in Farm

Staking of the LP tokens in Farm

import { TonClient, toNano } from "@ton/ton";
import { FARM } from "@ston-fi/sdk";

const client = new TonClient({
  endpoint: "https://toncenter.com/api/v2/jsonRPC",
});

const farm = client.open(FARM.v3.NftMinter.create(
  "EQATBSfNArrEFmchmy1XabKmxMNp9KezscqjPzfmstCU7VXO", // STON/TON Farm v3
));

// Stake 1 STON/TON LP token in v3 farm
const txParams = await farm.getStakeTxParams({
  userWalletAddress: "", // ! replace with your address
  jettonAddress: "EQDtZHOtVWaf9UIU6rmjLPNLTGxNLNogvK5xUZlMRgZwQ4Gt", // STON/TON pool LP token address
  jettonAmount: toNano("1"),
  queryId: 12345,
});

To execute the transaction, you need to send a transaction with these parameters to the blockchain. This code will be different based on the wallet you are using to send the tx from, so please check our doc section about transaction sending guide with examples for different libraries.

claim farm rewards

This section contains SDK example for claiming rewards in Farm

Claim rewards from Farm NFT

import { TonClient } from "@ton/ton";
import { FARM } from "@ston-fi/sdk";

const client = new TonClient({
  endpoint: "https://toncenter.com/api/v2/jsonRPC",
});

const farmNft = client.open(FARM.v3.NftItem.create(
  "EQA18JnBVNZZ8Wz-Kn6Mc5cy9pv798Pn8tfScjKw9NLPK3U2", // Farm v3 nft address
));

// Unstake all staked funds from Farm NFT back to the owner's wallet
const txParams = await farmNft.getClaimRewardsTxParams({
  queryId: 12345,
});

unstake from farm

This section contains SDK example for unstaking tokens in Farm

Unstake funds from Farm NFT

import { TonClient } from "@ton/ton";
import { FARM } from "@ston-fi/sdk";

const client = new TonClient({
  endpoint: "https://toncenter.com/api/v2/jsonRPC",
});

const farmNft = client.open(FARM.v3.NftItem.create(
  "EQA18JnBVNZZ8Wz-Kn6Mc5cy9pv798Pn8tfScjKw9NLPK3U2", // Farm v3 nft address
));

// Unstake all staked funds from Farm NFT back to the owner's wallet
const txParams = await farmNft.getUnstakeTxParams({
  queryId: 12345,
});

destroy farm NFT

This section contains SDK example for destroying unstaked farm NFT

Destroy of the Farm NFT is a transfer of the Farm NFT from the user wallet to the zero address.

import { TonClient } from "@ton/ton";
import { FARM } from "@ston-fi/sdk";

const client = new TonClient({
  endpoint: "https://toncenter.com/api/v2/jsonRPC",
});

const farmNft = client.open(FARM.v3.NftItem.create(
  "EQA18JnBVNZZ8Wz-Kn6Mc5cy9pv798Pn8tfScjKw9NLPK3U2", // Farm v3 nft address
));

// Destroy farm NFT from the owner's wallet
const txParams = await farmNft.getDestroyTxParams({
  queryId: 12345,
});