Protocol Integration

This repository contains metadata for any external protocols that is integrating or working with Pendle, including addresses and relevant integration URLs for various markets.

Metadata Structure

The YAML file includes details for multiple objects (PT, YT, LP), each corresponding to different parts of the protocol with specific chain IDs, addresses, integration URLs, and descriptions. If your protocol's integration is not Market Specific (for example an exchange or insurance), ignore the metadata field.

Fields

Protocols fields

• name: The name of the protocol.
• icon: The protocol’s logo (circular logo in PNG). The string on this field should be the same as the name of the logo file uploaded. Size limit for logo is 20KB.
• category: The protocol's category. It must belong to one of the following categories: Money Market, Yield Strategy, Liquid Locker, CEX / Web3 Wallet, Insurance or Others.
• url: The protocol's home page. Clicking on protocol card on pencosystem landing page will redirect user to this url.
• description: The protocol's description. It will be displayed on Pendle landing page.
• metadata (optional): This section contains detailed information about the protocol's integration assets.
• dataUrl (optional): URL endpoint for dynamic asset metadata. Enables real-time updates and additional fields (liquidity, borrowApy, supplyApy, totalSupply, supplyCap, maxLtv, curatorAddress) not available in static config. See "Dynamic Data Integration" section below.

Asset fields

• chainId: chainId of the integrated assets
• address: Address of the integrated assets (PT token address for PT integrations, LP token address for LP integration, etc)
• subtitle: short additional info to distinguish multiple flavours of the same market supported by the same protocol, like 2 different looping strategy for the same PT (max 20 characters)
• integrationUrl: Link to the page that integrated the asset
• description: Description of the asset (max 120 characters).

Example

name: Protocol Name 2
icon: logo.png
category: 'Yield Strategy'
url: https://www.pendle.magpiexyz.io
dataUrl: https://api.yourprotocol.com/pendle/assets
metadata:
  pt:
    - chainId: 1
      address: '0x332a8ee60edff0a11cf3994b1b846bbc27d3dcd6'
      subtitle: USDC
      integrationUrl: https://www.pendle.magpiexyz.io/stake
      description: hello it's pt
    - chainId: 1
      address: '0x332a8ee60edff0a11cf3994b1b846bbc27d3dcd6'
      subtitle: DAI
      integrationUrl: https://www.pendle.magpiexyz.io/stake
      description: hello it's pt
  yt:
    - chainId: 1
      address: '0x1cae47aa3e10a77c55ee32f8623d6b5acc947344'
      integrationUrl: https://www.pendle.magpiexyz.io/stake
      description: hello it's yt
  lp:
    - chainId: 1
      address: '0xcae62858db831272a03768f5844cbe1b40bb381f'
      integrationUrl: https://www.pendle.magpiexyz.io/stake
      description: hello it's lp

Dynamic Data Integration

When dataUrl is provided, Pendle's backend fetches data directly from your endpoint instead of using static metadata. The metadata arrays can be empty as they will be ignored.

API Response Schema

Your endpoint must return JSON with this structure:

{
  "assets": [
    {
      "chainId": 1,
      "address": "0x332a8ee60edff0a11cf3994b1b846bbc27d3dcd6",
      "data": [
        {
          "integrationUrl": "https://www.pendle.magpiexyz.io/stake",
          "description": "hello it's pt",
          "subtitle": "USDC",
          "curatorAddress": "0x1234567890abcdef1234567890abcdef12345678",
          "liquidity": 5000000,
          "borrowApy": 0.045,
          "supplyApy": 0.032,
          "totalSupply": 10000000,
          "supplyCap": 50000000,
          "maxLtv": 0.85
        }
      ]
    }
  ]
}

Response Fields

• assets: List of Pendle assets (PT, YT, or LP tokens) with integrations.

Asset Entry (assets[])

• chainId: Chain ID of the integrated asset (e.g., 1 for Ethereum, 42161 for Arbitrum).
• address: Address of the integrated asset (PT, YT, or LP token).
• data: Array of market integrations for this asset.

Market Data (assets[].data[])

• integrationUrl: Link to the page that integrated the asset.
• description: Description of the integration (max 120 characters).
• subtitle (optional): Short additional info (max 20 characters).
• curatorAddress (optional): Curator or vault manager address.
• liquidity (optional): Available liquidity in USD.
• borrowApy (optional): Borrow APY as decimal (e.g., 0.05 for 5%).
• supplyApy (optional): Supply APY as decimal (e.g., 0.03 for 3%).
• totalSupply (optional): Total supplied amount in USD.
• supplyCap (optional): Maximum supply cap in USD.
• maxLtv (optional): Maximum loan-to-value ratio as decimal (e.g., 0.85 for 85%).

Fallback Behavior

If your endpoint is unreachable, returns invalid data, or times out, Pendle falls back to the static metadata field in your config. This ensures your protocol remains visible even during API outages.

How to Contribute

To add a new protocol or update existing data:

1. Fork this repository.
2. Add or update the YAML file with the new protocol information in the specified format.
3. Add a logo.png file to your protocol folder if there isn't any yet
4. Submit a pull request for review.

Please ensure that:

• All fields are correctly filled.
• The integration URL is valid and points to the appropriate page.
• The protocol folder name must be kebab-case.
• Do not change the global config.json file. This file will be automatically generated.