Skip to content

Commit

Permalink
added instructions for listing a token to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gtaschuk committed Mar 15, 2022
1 parent 0e6652a commit 3d8564d
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,24 @@
# Balancer Asset Repository

## How to add a token to Balancer

To add a token, the bytecode must be verified. For example [https://etherscan.io/verifyContract](Verify Contract on Etherscan)
Furthermore, it must not be a rebasing token, as these are incompatible with the balancer v2 vault

The tokens should be added to the appropriate list(s) below and then pull requested so they can be subject to community review. In most cases, for a token to be on the balancer ui, it should be added to `/lists/listed.json` and `/lists/ui-not-eligible.json`.

If a custom token icon is to be used, a png named `<token address>.png` should be added to the `/assets/` folder, and the token address should be added to `/assets/index.json`

If the token is incompatible with balancer - such as a rebasing token - please add it to `/lists/untrusted.json`

## Lists

* `eligible.json`: assets eligible for BAL mining as per weekly proposals
Lists of tokens are found in the `/lists` directory

* `listed.json`: assets listed on balancer.exchange
* `ui-not-eligible.json`: assets vetted by community members
* `untrusted.json`: assets that are incompatible with Balancer
* `eligible.json`: assets eligible for BAL mining as per weekly proposals

## Generated

Expand Down

0 comments on commit 3d8564d

Please sign in to comment.