# Farm
Farm module allows you to easily create farm activities on irishub.
# Available Commands
Name | Description |
---|---|
create | Create a new farm pool |
adjust | Adjust farm pool parameters |
destroy | Destroy the farm pool and get back the invested bonus |
stake | Deposit liquidity token |
harvest | Get back the bonus for participating in the farm pool |
farmer | Query farmer information |
pool | Query the current status of a farm pool |
pools | Query farm pool information by page |
params | Query the management parameters of the farm module |
# iris tx farm create
Create a new farm pool and pay the handling fee and bonus.
iris tx farm create <Farm Pool Name> [flags]
Flags:
Name, shorthand | Required | Default | Description |
---|---|---|---|
--lp-token-denom | true | The liquidity token accepted by farm pool | |
--reward-per-block | true | The reward per block,ex: 1iris,1atom | |
--total-reward | true | The Total reward for the farm pool | |
--description | false | "" | The simple description of a farm pool |
--start-height | true | The start height the farm pool | |
--editable | false | false | Is it possible to adjust the parameters of the farm pool |
# iris tx farm adjust
Adjust the parameters of the pool before the farm pool ends, such as reward-per-block
, total-reward
.
iris tx farm adjust <Farm Pool Name> [flags]
Flags:
Name, shorthand | Required | Default | Description |
---|---|---|---|
--additional-reward | And --reward-per-block must choose one | "" | Bonuses added to the farm pool |
--reward-per-block | And --additional-reward must choose one | "" | The reward per block,ex: 1iris,1atom |
# iris tx farm destroy
Destroy the farm pool and get back the invested bonus.The rewards earned by the user farm ends at this moment, requiring the user to manually retrieve the income and the liquidity of the deposit.
iris tx farm destroy <Farm Pool Name> [flags]
# iris tx farm stake
The farmer participates in farm activities by staking the liquidity tokens specified by the pool. The rewards obtained by participating in the activities are related to the number of staking tokens and farm pool parameters.
iris tx farm stake <Farm Pool Name> <lp token> [flags]
# iris tx farm harvest
The farmer withdraws his rewards back.
iris tx farm harvest <Farm Pool Name>
# iris query farm farmer
Query farmer's information, including unclaimed rewards, mortgage liquidity, etc.
iris query farm farmer <Farmer Address> --pool-name <Farm Pool Name>
Flags:
Name, shorthand | Required | Default | Description |
---|---|---|---|
--pool-name | false | "" | the farm pool name |
# iris query farm pool
Query related information of a farm pool by name
iris query farm pool <Farm Pool Name>
# iris query farm pools
Paging query farm pool
iris query farm pools
# iris query farm params
Paging query farm pool
iris query farm params