GITBOOK-98: No subject

Author: waynebruce0x

.gitbook/assets/patagonia Aug '22.png

@@ -22,6 +22,10 @@
   * [Examples](list-your-project/other-dashboards/examples/README.md)
     * [Fees adapter](list-your-project/other-dashboards/examples/fees-adapter.md)
     * [Dex adapter](list-your-project/other-dashboards/examples/dex-adapter.md)
+* [Emissions dashboard](list-your-project/emissions-dashboard/README.md)
+  * [Protocol Files](list-your-project/emissions-dashboard/protocol-files.md)
+  * [Emission Sections](list-your-project/emissions-dashboard/emission-sections.md)
+  * [Testing](list-your-project/emissions-dashboard/testing.md)
 
 ## Chainlist
 

SUMMARY.md

@@ -0,0 +1,33 @@
+---
+description: How to add your favourite projects token emission schedules to DefiLlama
+---
+
+# Emissions dashboard
+
+## **Example**
+
+Throughout the pages in this guide we will refer to the [Liquity emissions adapter](https://github.com/DefiLlama/emissions-adapters/blob/master/protocols/liquity.ts).
+
+## **Format**
+
+Once a day we run all of the protocol files in the emissions adapters repo (listed in `protocols/index.ts` ). Protocol files give us a schedule and metadata for a specified token.
+
+When adding a new emissions schedule to DefiLlama, it's vital to test your code before you submit it. If your code doesn't produce an expected result it won't be accepted, so please read the [Testing section](testing.md).
+
+
+
+## How To Contribute Your Code
+
+Just like for TVL adapters, if you'd like to add an emissions schedule to DefiLlama:
+
+1. Fork the [emissions-adapters repo](https://github.com/DefiLlama/emissions-adapters) (button towards the top right of the repo page).
+2. Add a new [protocol file ](protocol-files.md)to protocols/ .
+3. Make a Pull Request with the changes on your fork, to the main DefiLlama emissions-adapters repo, with a brief explanation of what you changed.
+4. Wait for someone to either comment on or merge your Pull Request. There is no need to ask for someone to check your PR as there a monitored regularly.
+5. Once your PR has been merged, **please give 24 hours** for the team to load your listing onto the UI.
+
+![prayge](https://cdn.discordapp.com/emojis/1011049613186318376.webp?size=48\&quality=lossless)
+
+2
+
+1.

list-your-project/emissions-dashboard/README.md

@@ -0,0 +1,49 @@
+---
+description: Continuing with the Liquity example...
+---
+
+# Emission Sections
+
+## Manual Entry Functions
+
+90% of the time you'll only need the `manual...` functions (imported on line 1). There are 3 of them:
+
+*   manualStep(
+
+    start: unixTimestamp <- time of the first vest
+
+    stepDuration: unixTimestamp <- time period between vests
+
+    number: number <- number of discreet unlocks in the vesting schedule
+
+    amount: number <- number of coins emitted **in each** discreet unlock
+
+    )
+*   manualCliff(
+
+    start: unixTimestamp <- timestamp of the cliff&#x20;
+
+    amount: number <- number of coins emitted in the cliff
+
+    )
+*   manualLinear(
+
+    start: unixTimestamp <- start of the linear vesting period
+
+    end: unixTimestamp <- end of the linear vesting period
+
+    amount: number <- number of coins emitted over the period
+
+    )
+
+## More Complex Emission Shapes
+
+Sometimes you might need to make more advanced shapes, for example, if the rate of emissions decrease over time. In this example, We created a rewards() function which makes a complex shape out of smaller linear sections (line 9, used on line 33).&#x20;
+
+{% hint style="info" %}
+Emissions sections should return real quantities of tokens. Not percentages, and accounting for any token decimals.
+{% endhint %}
+
+## On Chain Data
+
+Some protocol files use on-chain data (Aave, Tornado etc). Where possible we like to use on chain data. The time sensitive nature of emissions schedules can make on-chain data more difficult to research and write. If you think using on-chain data is a better option for you, contact us through Discord and we can help out.

list-your-project/emissions-dashboard/emission-sections.md

@@ -0,0 +1,30 @@
+---
+description: Continuing with the Liquity example...
+---
+
+# Protocol Files
+
+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](emission-sections.md)). 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.

list-your-project/emissions-dashboard/protocol-files.md

@@ -0,0 +1,13 @@
+---
+description: The most important part
+---
+
+# Testing
+
+Once you're ready to debug your protocol file, add it to `protocols/index.ts`  (preferably in alphabetical order). Run `ts-node utils/test.ts [name of your protocol]` and it should save a `result.png` where you can see the result of your protocol file. Check that the values make sense and it looks like what you expected. 
+
+Thanks for reading this guide. If you have any further questions, don't hesitate to reach out on our Discord. We are all very responsive and happy to help. 
+
+We always appreciate feedback on our developer experience. If anything seems unintuitive or complicated, let us know and we'll do our best to improve our processes. 
+
+<figure><img src="../../.gitbook/assets/patagonia Aug &#x27;22.png" alt=""><figcaption><p>Bentura and Shaman, Patagonia, August 2021</p></figcaption></figure>