Skip to content

balancer/metadata

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Balancer Metadata

Public metadata for the Balancer protocol.

Tags

Tags are used to tag sets of pools in the Balancer API and frontend.

Adding new tags

To add a new tag, update the tag json with an object using the following schema:

type Tag = {
    id: string; // If it's a points tag, prepend id with `points_`, see existing tags for examples.
    name: string;
    description: string;
    value?: string; // Arbitrary value that may be used by the frontend to provide more context, e.g. points multiples for points tags.
    url?: string; // A link you want to associate with the tag.
    icon?: string; // Icon to be used in frontend to represent the tag. Should be a relative path, see existing tags for examples.
    pools: string[]; // A list of pool IDs that should receive the tag.
};

Adding a tag icon

To add an icon to be used for a tag, add a new file to the /icons directory with the ID of the tag as its name, e.g. my_tag_id.svg. Then add the icon property to the category object in index.json.

Creating a points tag

Tags are generic pool <> metadata associations that are ingested by the API. We use these tags for specific use cases like 3rd party point programs. To add a new point program tag there are a couple of things to pay attention to.

  1. The id should include points, preferably as a prepend, e.g. id: "points_protocol_name".
  2. If the points program has a multiple, you can use the value attribute to specify that multiple. If the multiple is 5x then value: "5".

About

Public metadata for the Balancer protocol.

Resources

Stars

Watchers

Forks