Interact With Ref Farming

Here we using near-cli as tools to demonstrate how to interact with ref-farming contract.

It's important for front-end developers to understand the interface logic from FE perspective.

assumption

export FARMING=ref-farming.testnet
export EX=ref-finance.testnet
export TOKEN=token.ref-finance.testnet

views

global info

contract metadata

% near view $FARMING get_metadata
# return statics
{
  version: '1.0.0',
  owner_id: 'ref_finance_owner.testnet',
  farmer_count: '4',
  farm_count: '7',
  seed_count: '6',
  reward_count: '1'
}

all farms with pagination

near view $FARMING list_farms '{"from_index": 0, "limit": 100}'
# return list
[
  {
    farm_id: 'ref-finance.testnet@20#0',
    farm_kind: 'SIMPLE_FARM',
    farm_status: 'Ended',
    seed_id: 'ref-finance.testnet@20',
    reward_token: 'rft.tokenfactory.testnet',
    start_at: 1629771373,
    reward_per_session: '10000000000',
    session_interval: 3600,
    total_reward: '6000000000000',
    cur_round: '600',
    last_round: '600',
    claimed_reward: '4490147960435',
    unclaimed_reward: '1509852039565',
    beneficiary_reward: '0'
  },
  ...
]

Note:

• outdated_farms are excluded;

• There are three farm_status in contract, they are Created, Running, Ended;

• start_at is timestamp in seconds;

• session_interval is timestamp in seconds;

all seeds with pagination

near view $FARMING list_seeds_info '{"from_index": 0, "limit": 100}'
# return dict
{
  'ref-finance.testnet@9': {
    seed_id: 'ref-finance.testnet@9',
    seed_type: 'MFT',
    farms: [
      'ref-finance.testnet@9#2',
      'ref-finance.testnet@9#0',
      'ref-finance.testnet@9#1'
    ],
    next_index: 3,
    amount: '0',
    min_deposit: '1000000000000000000'
  },
  ...
}

all rewards with pagination

near view $FARMING list_rewards_info '{"from_index": 0, "limit": 100}'
# return dict
{
  'rft.tokenfactory.testnet': '42012000000000',
  'token.ref-finance.testnet': '12000000000000000000000',
  'wrap.testnet': '200000000000000000000000000'
}

per seed info

get single seed info

near view $FARMING get_seed_info "{\"seed_id\": \"$EX@9\"}"
# return dict
{
  seed_id: 'ref-finance.testnet@9',
  seed_type: 'MFT',
  farms: [
    'ref-finance.testnet@9#2',
    'ref-finance.testnet@9#0',
    'ref-finance.testnet@9#1'
  ],
  next_index: 3,
  amount: '0',
  min_deposit: '1000000000000000000'
}

farms in a seed

near view $FARMING list_farms_by_seed "{\"seed_id\": \"$EX@9\"}"
# return list
[
  {
    farm_id: 'ref-finance.testnet@9#2',
    farm_kind: 'SIMPLE_FARM',
    farm_status: 'Running',
    seed_id: 'ref-finance.testnet@9',
    reward_token: 'wrap.testnet',
    start_at: 1629771373,
    reward_per_session: '1000000000000000000000000',
    session_interval: 3600,
    total_reward: '100000000000000000000000000',
    cur_round: '38',
    last_round: '0',
    claimed_reward: '0',
    unclaimed_reward: '38000000000000000000000000',
    beneficiary_reward: '0'
  },
  ...
]

per farm info

single farm info

near view $FARMING get_farm "{\"farm_id\": \"$EX@11#0\"}"
# return dict
{
  farm_id: 'ref-finance.testnet@11#0',
  farm_kind: 'SIMPLE_FARM',
  farm_status: 'Running',
  seed_id: 'ref-finance.testnet@11',
  reward_token: 'token.ref-finance.testnet',
  start_at: '55735800',
  reward_per_session: '10000000000000000000',
  session_interval: '3600',
  total_reward: '2400000000000000000000',
  cur_round: '38',
  last_round: '0',
  claimed_reward: '0',
  unclaimed_reward: '380000000000000000000',
  beneficiary_reward: '0'
}

per user

list rewards

near view $FARMING list_rewards '{"account_id": "pika456.testnet"}'
#return dict
{ 'rft.tokenfactory.testnet': '281999999999' }

near view $FARMING get_reward "{\"account_id\": \"pika456.testnet\", \"token_id\": \"$TOKEN\"}"
#return number string
'281999999999'

get unclaimed

near view $FARMING get_unclaimed_reward "{\"account_id\": \"pika456.testnet\", \"farm_id\": \"$EX@30#0\"}"
#return number string
'2429999999999'

list user seeds

near view $FARMING list_user_seeds '{"account_id": "pika456.testnet"}'
#return dict
{
  'ref-finance.testnet@31': '1000000000000000000000000',
  'ref-finance.testnet@30': '1100000000000000000000000'
}

stake/unstake seeds

# if needed, register user to the farming
near call $FARMING storage_deposit '{"account_id": "u1.testnet", "registration_only": true}' --account_id=u1.testnet --amount=1

# if needed, register farming contract to seed token
near call $EX mft_register "{\"token_id\":\"31\", \"account_id\": \"$FARMING\"}" --account_id=u1.testnet --amount=0.01

# staking
near call $EX mft_transfer_call "{\"receiver_id\": \"$FARMING\", \"token_id\":\"31\", \"amount\": \"1000000000000000000000000\", \"msg\": \"\"}" --account_id=u1.testnet --amount=0.000000000000000000000001

# unstaking
near call $FARMING withdraw_seed "{\"seed_id\": \"$EX@31\", \"amount\": \"1000000000000000000000000\"}" --account_id=u1.testnet --amount=0.000000000000000000000001

claim reward

# you can claim reward per farm
near call $FARMING claim_reward_by_farm "{\"farm_id\": \"$EX@0#1\"}" --account_id=u1.testnet --amount=0.000000000000000000000001
# or you can claim reward per seed (kind of batch claim)
near call $FARMING claim_reward_by_seed "{\"seed_id\": \"$EX@0\"}" --account_id=u1.testnet --amount=0.000000000000000000000001

withdraw reward token

# amount set to 0 means withdraw all balance
near call $FARMING withdraw_reward "{\"token_id\": \"$TOKEN\", \"amount\": \"0\"}" --account_id=u1.testnet --amount=0.000000000000000000000001

create farm

To create a farm, you need prepare farming terms.

near call $FARMING create_simple_farm "{\"terms\": {\"seed_id\": \"$EX@31\", \"reward_token\": \"$TOKEN\", \"start_at\": 0, \"reward_per_session\": \"10000000000000000000\", \"session_interval\": 3600}}\" --account_id=pika456.testnet --amount 0.01
# this will return a farm id like ref-finance.testnet@31#0

At this point, this is a farm with no reward deposited, farm status is Created.

To activate a farm, deposit some reward token into the farm with ft_transfer_call.

# if needed, register farming contract to reward token
near call $TOKEN storage_deposit "{\"account_id\": \"$FARMING\"}" --account_id=pika456.testnet --amount 0.00125
# deposit reward token into the farm
near call $TOKEN ft_transfer_call "{\"receiver_id\": \"$FARMING\", \"amount\": \"2400000000000000000000\", \"msg\": \"$EX@31#0\"}" --account_id=$REF_OWNER --amount=0.000000000000000000000001 --gas=100000000000000

Note: Only owner of this contract can create farms.