https://github.com/balancer/metadata
Public metadata for the Balancer protocol.
https://github.com/balancer/metadata
Last synced: about 1 year ago
JSON representation
Public metadata for the Balancer protocol.
- Host: GitHub
- URL: https://github.com/balancer/metadata
- Owner: balancer
- Created: 2023-10-20T13:01:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-04T16:16:05.000Z (over 1 year ago)
- Last Synced: 2025-03-04T17:26:23.130Z (over 1 year ago)
- Homepage:
- Size: 464 KB
- Stars: 2
- Watchers: 3
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Balancer Metadata
Public metadata for the Balancer protocol.
## Tags
Tags are used to tag sets of pools in the [Balancer API](https://github.com/balancer/backend) and [frontend](https://github.com/balancer/frontend-monorepo).
### Adding new tags
To add a new tag, update the [tag json](https://github.com/balancer/metadata/blob/main/pools/tag/index.json) with an object using the following schema:
```ts
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"`.
## Pools
### Adding pool metadata
To add new pool metadata, update the [pools
json](https://github.com/balancer/metadata/blob/main/pools/index.json) with a
object using the following schema:
```ts
type PoolMeta = {
name?: string
description?: string
iconUrl?: string
}