Add and Edit Pool Metadata

In Defactor, pool metadata is stored in a database rather than on-chain. As a result, when new Defactor instances are deployed (or if the database is cleared for any reason), the metadata must be manually saved back to the database. The easiest way to do this is by webapp's admin section or alternatively by calling the API endpoint /v2/pools/update-metadata.

For more information, please see the API documentation.

Note: Pools without metadata are display with the same generic name and logo in the UI.

---

Metadata Structure

The metadata is stored as a independent row in the pool_metadata table in the database. This is a normalized structure, with the name, logo, description and link to the terms of conditions.

The following JSON example shows the structure and attributes required by the frontend:

{
  "pool": {
    "id": "1",
    "name": "FACTR Pool 1",
    "description": "FACTR is a tool that facilitates the connection between the traditional world of assets and the decentralized ecosystem of cryptocurrencies. Explore more about Defactor and its potential in the financial world!",
    "logo": "https://assets.coingecko.com/coins/images/19201/standard/jFLSu4U9_400x400.png?1696518648",
  }
}

Metadata Attributes

Here's a description of each attribute in the metadata used by the UI:

• id: The internal pool metadata ID in the database.
• name: The name of the pool.
• description: A brief description of the pool.
• logo: The logo URL representing the pool.
• visibility: Determinate how the pool is displayed.
• terms:
  • url: The URL with the terms and conditions
  • label: The label shown in the link

Best Practices

Important: Make sure to update the pool metadata promptly after spinning up a new Defactor instance or if the database is cleared. Proper metadata ensures pools are accurately represented and shown in the UI as needed.