The ChildChainGaugeInjectorV2 was built to encapsulate over a year of learnings that came from operating Injector V1 in the wild. The primary goal of this contract is to provide a more flexible and robust system for scheduling a steady stream of single token rewards to ChildChainGauges.
The contract is designed to be a distributor for the ChildChainGauge, and has functionality to return distributorship to the owner. The owner is also able to sweep all funds.
In such, this contract is not at all intended to be an onchain promise, but more of a way to automate the distribution of rewards to the ChildChainGauge. The contract is designed to be operated by a Chainlink Keeper, and the owner is able to add new schedules without implicating the already running schedules for a gauge. It can easily be used with other keepers that adapt to the chainlink interface.
The primary changes in this contract from V1 are:
Go to the factory contract on the chain you need on etherscan, and call createInjector with the following parameters:
| Parameter | Description |
|---|---|
| keeperAddress[] | A list of addresses that can trigger a due injection. To start perhaps add your EOA, can include zero address in list to allow anyone to upkeep. |
| minWaitPeriodSeconds | A gauge should only be ready every 7 days. This is a safeguard against something that should never happen, by default set to 6 days or 518400 |
| injectTokenAddress | An Injector runs on a single token. Specify which one here. For multiple tokens use multiple injectors |
| maxInjectionAmount | The maximum amount of tokens that can be injected in a single transaction. Set it to something sane for your token/budget or 0 for no limit. This is to prevent catostrophic scehduling mistakes |
| owner | The owner of the injector. This address can add and remove schedules, and sweep tokens. Can be changed, if you're not sure set to your EOA. |
All the settings above can be changed above by clearly marked setter functions in the contract.
In addition, there are setters for the following global settings, which default to 0 (which means no limit). Note that the limits below, which apply when setting schedules only will not be respected if a limit lowered, but the schedules already in place violates it:
| Parameter | Description |
|---|---|
| MaxGlobalAmountPerPeriod | A new program will not allowed to be added, if it would increase the total amount spent of all active programs in the a single period. |
| MaxTotalDue | A new program will not allowed to be added, if it would increase the total amount spent of all active programs in all periods. |
The injector is intended to be used on Balancer gauges that already have a reward token configured with the injector set as distributor. The Balancer Maxis can help you configure this.
The injector supports adding/overwriting one or more programs to the schedule at a time using add recipients:
| Parameter | Description |
|---|---|
| recipients | A list of gauges that should be added or overwritten each with these settings. Note that if a gauge already has a program in scheduled in this injector, it will be overwritten. The new program will run for the total number of rounds specified in maxPeriods below. |
| amountPerPeriod | The amount of tokens that should be injected to the gauge each period. Note that if the injector already has a schedule from one of the listed gauges, it will be overwritten. |
| maxPeriods | The number of periods that the program should run. |
| doNotStartBeforeTimestamp | The earliest time that the program should start. The injector will only fire when it is able to, and there is no currently streaming rewards of that token on the gauge |
removeRecipients can be called with a list of recipients to remove their schedules from the injector and abort any furture scheduled payments.
There are good comments, and most of the other functions are pretty self explanitory.