Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 1.82 KB

listing-your-project.md

File metadata and controls

31 lines (23 loc) · 1.82 KB

Listing your project

Same as TVL adapters, the majority of adapters for the dashboards under this section are contributed and maintained by their respective communities, with all changes being coordinated through the DefiLlama/dimension-adapters github repo.

Here you will find information about how you can list your DeFi project to one of the following dashboards:

  • Dexs dashboard. Tracks volume from different dexs (only spot/swaps).
  • Aggregators dashboard. Tracks volume from different aggregators.
  • Fees dashboard. Tracks fees and revenue from different protocols.
  • Incentives dashboard. Tracks daily incentives distributed from different protocols.
  • Derivatives dashboard. Tracks volume from different protocols.
  • Options dashboard. Tracks notional and premium volume from different options dexs.

The simple instructions to add your project are:

  1. Fork the dimension-adapters repository.
  2. Add a new folder with the slug of the project under the respective adapters folder.
  3. Add your adapter to an index.ts file and export it. It should look like this: ./[dashboard]/[slug]/index.ts. You will find more information in the next sections.
  4. Test that the adapter works correctly by running yarn test [dashboard] [protocolSlug]. You will find more information in the next sections.
  5. Submit a PR! A llama will take a look at it and merge it. Once merged, it can take up to 24h to be available in the dashboard.

{% hint style="info" %} Seeing issues getting logs or with calls at historical blocks?
You can replace the RPC being used by creating a .env file and filling it with rows like this:
ETHEREUM_RPC="https://..."

BSC_RPC="https://..."

POLYGON_RPC="https://..."
... {% endhint %}