> For the complete documentation index, see [llms.txt](https://ref-finance.gitbook.io/ref-finance/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ref-finance.gitbook.io/ref-finance/smart-contracts/how_to_interact_with_ref-farming_contract.md). # 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 ```bash export FARMING=ref-farming.testnet export EX=ref-finance.testnet export TOKEN=token.ref-finance.testnet ``` ## views ### global info **contract metadata** ```bash % 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** ```bash 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** ```bash 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** ```bash 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** ```bash 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** ```bash 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** ```bash 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** ```bash 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** ```bash near view $FARMING get_unclaimed_reward "{\"account_id\": \"pika456.testnet\", \"farm_id\": \"$EX@30#0\"}" #return number string '2429999999999' ``` **list user seeds** ```bash 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 ```bash # 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 ```bash # 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 ```bash # 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. ```bash 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. ```bash # 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. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://ref-finance.gitbook.io/ref-finance/smart-contracts/how_to_interact_with_ref-farming_contract.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.