Protocol Files

Continuing with the Liquity example...

Protocol files each export a Protocol object (line 55) which contains these properties:

  • Each distinct section of token allocation, function | function[], required:

    These sections can take on whatever keys are required. These keys will be used to label the chart on our UI, so please make them readable and nice to look at. The value for each chart section key will usually either be a manual....() or manual....()[] (more info on the next page). For example, the Liquity adapter has:

    • Stability Pool rewards

    • Uniswap LPs

    • Endowment

    • Team and advisors

    • Service providers

    • Investors.

  • notes, string[], optional:

    Anything you think DefiLlama users should know about the emissions data. Maybe you made an assumption somewhere, or have excluded certain allocations because they were impossible to quantify.

  • token, string, required:

    The token address, preferably on the chain it was first deployed.

  • sources, string[], required:

    Links to wherever you got the data. Official protocol docs are preferred, but discord servers etc can also be used if needed.

  • ProtocolIds, string[], required:

    Please leave this as an empty array ([]) and the DefiLlama team will complete this for you.

Last updated