Comment on page
🏭
Incentive Factory
Migaloo's incentive factory contract is used to create incentive flows associated with LP tokens. Incentive contracts allow permissioned users to create an incentive contract associated with an LP token. Once an incentive contract is created for an LP token, it is stored in state, allowing the incentive factory to act as an incentive registry, which can be queried for reference. Note that the incentive factory is permissioned, meaning the messages can only be executed by the owner of the contract.
Instantiates an instance of the incentive factory contract
{
"fee_collector_addr": "migaloo1...",
"fee_distributor_addr": "migaloo1...",
"create_flow_fee": {
"info": {
"native_token": {
"denom": "uwhale"
}
},
"amount": "1000000000"
},
"max_concurrent_flows": 5,
"incentive_code_id": 123,
"max_flow_epoch_buffer": 14,
"min_unbonding_duration": 86400,
"max_unbonding_duration": 31536000
}
Key | Type | Description |
|---|---|---|
fee_collector_addr | String | The address of the fee collector to send flow creation fees to |
fee_distributor_addr | String | Fee distributor contract address |
create_flow_fee | Asset | The fee that must be paid to create a flow |
max_concurrent_flows | u64 | The maximum amount of flows that can exist for a single LP token at a single time |
incentive_code_id | u64 | The code ID of the incentive contract |
max_flow_epoch_buffer | u64 | New flows are allowed to start up to current_epoch + start_epoch_buffer into the future |
min_unbonding_duration | u64 | The minimum amount of seconds that a user must bond their tokens for |
max_unbonding_duration | u64 | The maximum amount of seconds that a user must bond their tokens for |
Creates a new incentive contract tied to the
lp_asset specified.{
"create_incentive": {
"lp_asset": {
"native_token": {
"denom": "factory/migaloo1.../uLP"
}
}
}
}
Key | Type | Description |
|---|---|---|
lp_asset | AssetInfo | Information about the LP asset |
Updates the configuration of the contract.
{
"update_config": {
"owner": "migaloo1...",
"fee_collector_addr": "migaloo1...",
"fee_distributor_addr": "migaloo1...",
"create_flow_fee": {
"native_token": {
"denom": "uwhale"
}
},
"max_concurrent_flows": 10,
"incentive_code_id": 123,
"max_flow_epoch_buffer": 10,
"min_unbonding_duration": 10,
"max_unbonding_duration": 10
}
}
Key | Type | Description |
|---|---|---|
owner | Option<String> | The owner of the contract. If unspecified, the owner address will not change. |
fee_collector_addr | Option<String> | The new fee collector address to send flow creation fees to. If unspecified, the fee collector address will not change. |
fee_distributor_addr | Option<String> | The new fee distributor address to get epochs from. If unspecified, the fee distributor address will not change. |
create_flow_fee | Option<Asset> | The new fee that must be paid to create a flow. If unspecified, the flow fee will not change. |
max_concurrent_flows | Option<u64> | The maximum amount of concurrent flows that can exist for a single LP token at a single time. If unspecified, the max concurrent flows will not change. |
incentive_code_id | Option<u64> | The new code ID of the incentive contract. If unspecified, the incentive contract id will not change. |
max_flow_epoch_buffer | Option<u64> | The new maximum start time buffer for a new flow (in seconds). If unspecified, the flow start buffer will not change. |
min_unbonding_duration | Option<u64> | The minimum amount of seconds that a user must bond their tokens for. If unspecified, the min_unbonding_duration will not change. |
max_unbonding_duration | Option<u64> | The maximum amount of seconds that a user must bond their tokens for. If unspecified, the max_unbonding_duration will not change. |
Migrates an incentive contract to a new code ID. If
incentive_address is not provided, migrates all incentive contracts registered in the factory.{
"migrate_incentive": {
"incentive_address": "migaloo1...",
"code_id": 123
}
}
Key | Type | Description |
|---|---|---|
incentive_address | Option<String> | The address of the incentive contract |
code_id | u64 | The new code ID to migrate the incentive contract to. If unspecified, will default to the incentive factory's configured incentive code ID. |
Retrieves the config of the incentive factory.
Query
Response (ConfigResponse)
{
"config": {}
}
{
"owner": "migaloo1...",
"fee_collector_addr": "migaloo1...",
"fee_distributor_addr": "migaloo1...",
"create_flow_fee": {
"info": {
"native_token": {
"denom": "uwhale"
}
},
"amount": "1000000000"
},
"max_concurrent_flows": 100,
"incentive_code_id": 1,
"max_flow_epoch_buffer": 10,
"min_unbonding_duration": 3600,
"max_unbonding_duration": 86400
}
Key | Type | Description |
|---|---|---|
owner | Addr | The contract's owner |
fee_collector_addr | Addr | The fee collector contract address |
fee_distributor_addr | Addr | The fee distributor contract address |
create_flow_fee | Asset | The fee that must be paid each time a user wants to create a flow |
max_concurrent_flows | u64 | The maximum amount of flows that can exist at any one time |
incentive_code_id | u64 | The code ID of the incentive contract |
max_flow_epoch_buffer | u64 | The maximum amount of epochs in the future a new flow is allowed to start in |
min_unbonding_duration | u64 | The minimum amount of seconds that a user must bond their tokens for |
max_unbonding_duration | u64 | The maximum amount of seconds that a user must bond their tokens for |
Retrieves a specific incentive address for the given lp_asset.
Query
Response (IncentiveResponse)
{
"incentive": {
"lp_asset": {
"native_token": {
"denom": "uwhale"
}
}
}
}
Key | Type | Description |
|---|---|---|
lp_asset | AssetInfo | Information about the LP asset |
{
"data": "migaloo1..."
}
Retrieves a list of incentive contracts. Allows pagination.
Query
Response (IncentivesResponse)
{
"incentives": {
"start_after": {
"native_token": {
"denom": "uwhale"
}
},
"limit": 10
}
}
Key | Type | Description |
|---|---|---|
start_after | Option<AssetInfo> | An optional parameter specifying what incentive contract to start searching after. |
limit | Option<u32> | The amount of incentive contracts to return. If unspecified, will default to a value specified by the contract. |
{
"data": [
{
"incentive_address": "migaloo1...",
"lp_reference": [9 18 52 54]
}
]
}
pub type IncentivesResponse = Vec;
Key | Type | Description |
|---|---|---|
start_after | Option<AssetInfo> | An optional parameter specifying what incentive contract to start searching after. |
limit | Option<u32> | The amount of incentive contracts to return. If unspecified, will default to a value specified by the contract. |
Last modified 2mo ago