Initial commit

initialize mainnet repo with data, gitignore and readme

added missed readme and gitignore

fixed incorrect tag of tokens

added legacy tag to all vaults

.gitignore

@@ -0,0 +1,8 @@
+**/.DS_Store
+.idea
+.vscode/
+*~
+*.txt
+.env
+.env.test
+bin/

README.md

@@ -0,0 +1,185 @@
+# **Symbiotic entities metadata repository**
+
+This repository is designed to manage metadata and related resources for decentralized entities, such as vaults, networks, operators, and tokens. 
+It provides a standardized structure for organizing and accessing information about these entities. 
+By contributing to this repository, you help create a reliable, decentralized knowledge base. After being merged, this 
+data will be used in [app.symbiotic.fi]() to provide users with accurate and up-to-date information about various entities in the DeFi ecosystem.
+
+---
+
+## **How to Add a New Entity to the Repository via Pull Requests**
+
+### **Repository Structure**
+
+The repository is organized as follows:
+
+```
+repository/
+├── vaults/
+│   ├── 0x<address>/
+│   │   ├── info.json
+│   │   └── logo.png (optional)
+├── networks/
+├── operators/
+├── tokens/
+```
+
+Each entity is identified by its Ethereum address (`0x...`), and its data is stored in a folder named after the address. Inside this folder, there must be a file `info.json` containing metadata, and optionally, an icon file `logo.png`.
+
+---
+
+### **Steps to Add a New Entity**
+
+1. **Determine the entity type**: Decide whether the entity belongs to `vaults`, `networks`, `operators`, or `tokens`.
+2. **Create a new folder**: 
+   - Navigate to the appropriate directory for the entity type.
+   - Create a folder named after the Ethereum address (e.g., `0x1234567890abcdef1234567890abcdef12345678`).
+3. **Add the `info.json` file**:
+   - Include metadata in the specified format (see below).
+4. **(Optional) Add an icon file**:
+   - If available, include a `logo.png` file with the entity’s logo.
+
+---
+
+### **File Format: `info.json`**
+
+The `info.json` file must follow this structure:
+
+#### **Required Fields**
+- `name` (string): The name of the entity.
+- `description` (string): A brief description of the entity.
+- `tags` (array of strings): Tags categorizing the entity.
+- `links` (array of objects): External links related to the entity.
+
+#### **Optional Fields (for tokens)**
+- `cmcId` (string): The CoinMarketCap ID for the token. Used to fetch price of the token in USD.
+- `permitName` (string): The `name` field for EIP-2612 support.
+- `permitVersion` (string): The `version` field for EIP-2612 support.
+
+#### **Supported `links` Types**
+Each link should include:
+- `type`: The type of the link. Supported values are:
+  - `website`: The official website of the entity.
+  - `explorer`: A blockchain explorer link for the entity's Ethereum address or contract.
+  - `docs`: Documentation related to the entity.
+  - `example`: Example use cases or tutorials.
+- `name`: A user-friendly name for the link.
+- `url`: The URL of the resource.
+
+#### **Examples**
+
+##### **Token Example**
+```json
+{
+  "name": "USDT",
+  "description": "USDT is a stablecoin pegged to the US Dollar, widely used for trading and liquidity in cryptocurrency markets.",
+  "tags": ["stablecoin", "usdt"],
+  "links": [
+    {
+      "type": "website",
+      "name": "Website",
+      "url": "https://tether.to/"
+    },
+    {
+      "type": "explorer",
+      "name": "Etherscan",
+      "url": "https://etherscan.io/token/0xdac17f958d2ee523a2206206994597c13d831ec7"
+    },
+    {
+      "type": "docs",
+      "name": "Tether Documentation",
+      "url": "https://docs.tether.to/"
+    },
+    {
+      "type": "example",
+      "name": "Integration Guide",
+      "url": "https://example.com/usdt-integration"
+    }
+  ],
+  "cmcId": "825",
+  "permitName": "USDT Permit Token",
+  "permitVersion": "1"
+}
+```
+
+##### **Vault Example**
+```json
+{
+  "name": "DeFi Vault",
+  "description": "A secure vault for decentralized finance.",
+  "tags": ["vault", "DeFi"],
+  "links": [
+    {
+      "type": "website",
+      "name": "Website",
+      "url": "https://example-vault.com/"
+    },
+    {
+      "type": "docs",
+      "name": "Vault Documentation",
+      "url": "https://example-vault.com/docs"
+    }
+  ]
+}
+```
+
+---
+
+### **Icon File: `logo.png` (Optional)**
+
+If you want to include an icon for the entity, follow these guidelines:
+- **File Name**: `logo.png`
+- **Dimensions**: 256x256 pixels
+- **Format**: PNG
+
+Place the `logo.png` file in the same folder as the `info.json` file.
+
+---
+
+### **Validation**
+
+Before submitting your PR, ensure the following:
+1. The Ethereum address is valid:
+   - It must start with `0x` and be exactly 42 characters long.
+2. The `info.json` file is valid:
+   - Use a JSON validator, such as [https://jsonlint.com/](https://jsonlint.com/).
+3. The `logo.png` file (if included) meets the size requirement of **256x256 pixels**.
+
+---
+
+### **Submitting the Pull Request**
+
+Once your files are added to the repository, create a Pull Request with the following details:
+1. **Entity Type**: Specify the type (vault, network, operator, token).
+2. **Ethereum Address**: Provide the address of the entity.
+3. **Description**: Summarize the entity’s purpose and data.
+
+#### **Example PR Description**
+```
+Added new token entity: 0x1234567890abcdef1234567890abcdef12345678
+
+- **Name**: USDT
+- **Description**: USDT is a stablecoin pegged to the US Dollar, widely used for trading and liquidity in cryptocurrency markets.
+- **Tags**: stablecoin, usdt
+- **Links**: 
+  - [Website](https://tether.to/)
+  - [Etherscan](https://etherscan.io/token/0xdac17f958d2ee523a2206206994597c13d831ec7)
+  - [Tether Documentation](https://docs.tether.to/)
+- **CMC ID**: 825
+- **Permit Name**: USDT Permit Token
+- **Permit Version**: 1
+- **Icon**: Included (256x256 px)
+```
+
+---
+
+### **Review and Approval**
+
+Your PR will be reviewed to ensure:
+- The `info.json` file has all required fields and valid data.
+- The `logo.png` file (if included) meets the requirements.
+- The metadata is accurate and well-structured.
+
+After approval, your changes will be merged into the repository. Thank you for your contribution! 🎉
+
+If you have any questions or issues, feel free to reach out to the symbiotic team.

tokens/0x0a6e7ba5042b38349e437ec6db6214aec7b35676/info.json

@@ -0,0 +1,26 @@
+{
+  "name": "SWELL",
+  "description": "SWELL is the native governance token of Swell DAO, a decentralized community responsible for the development, growth, and maintenance of the Swell protocol. The protocol serves as a leading platform for liquid staking and restaking, offering users a decentralized and secure way to participate in Ethereum staking while maintaining liquidity.",
+  "tags": [
+    "token",
+    "SWELL"
+  ],
+  "links": [
+    {
+      "type": "explorer",
+      "name": "Etherscan",
+      "url": "https://etherscan.io/address/0x0a6e7ba5042b38349e437ec6db6214aec7b35676"
+    },
+    {
+      "type": "website",
+      "name": "Website",
+      "url": "https://www.swellnetwork.io/"
+    },
+    {
+      "type": "docs",
+      "name": "Intro into Swell Governance",
+      "url": "https://docs.swellnetwork.io/swell-dao/overview"
+    }
+  ],
+  "cmcId": "24924"
+}

tokens/0x18084fba666a33d37592fa2633fd49a74dd93a88/info.json

@@ -0,0 +1,28 @@
+{
+  "name": "tBTC",
+  "description": "tBTC is Threshold’s decentralized bridge to bring BTC to the Ethereum network. tBTC allows you to unlock your Bitcoin’s value to borrow and lend, mint stablecoins, provide liquidity, and much more. Instead of centralized intermediaries, tBTC uses a randomly selected group of operators running nodes on the Threshold Network to secure deposited Bitcoin through threshold cryptography.",
+  "tags": [
+    "token",
+    "tBTC"
+  ],
+  "links": [
+    {
+      "type": "explorer",
+      "name": "Etherscan",
+      "url": "https://etherscan.io/address/0x18084fba666a33d37592fa2633fd49a74dd93a88"
+    },
+    {
+      "type": "website",
+      "name": "Website",
+      "url": "https://tbtc.network/"
+    },
+    {
+      "type": "docs",
+      "name": "https://github.com/keep-network/tbtc-v2/blob/main/docs/README.adoc",
+      "url": "tBTC detailed system architecture"
+    }
+  ],
+  "cmcId": "26133",
+  "permitName": "tBTC v2",
+  "permitVersion": "1"
+}

tokens/0x2260fac5e5542a773aa44fbcfedf7c193bc2c599/info.json

@@ -0,0 +1,21 @@
+{
+  "name": "WBTC",
+  "description": "WBTC brings greater liquidity to the Ethereum ecosystem including decentralized exchanges (DEXs) and financial applications. Today, the majority of trading volume takes place on centralized exchanges with Bitcoin. WBTC changes that, bringing Bitcoin’s liquidity to DEXs and making it possible to use Bitcoin for token trades.",
+  "tags": [
+    "token",
+    "WBTC"
+  ],
+  "links": [
+    {
+      "type": "explorer",
+      "name": "Etherscan",
+      "url": "https://etherscan.io/address/0x2260fac5e5542a773aa44fbcfedf7c193bc2c599"
+    },
+    {
+      "type": "website",
+      "name": "Website",
+      "url": "https://wbtc.network/"
+    }
+  ],
+  "cmcId": "3717"
+}

tokens/0x3432b6a60d23ca0dfca7761b7ab56459d9c964d0/info.json

@@ -0,0 +1,26 @@
+{
+  "name": "FXS",
+  "description": "Frax Share (FXS) as base layer governance token – Frax Share (FXS) is the governance token of the entire Frax ecosystem of smart contracts which accrues fees, revenue, and excess collateral value.",
+  "tags": [
+    "token",
+    "FXS"
+  ],
+  "links": [
+    {
+      "type": "explorer",
+      "name": "Etherscan",
+      "url": "https://etherscan.io/address/0x3432b6a60d23ca0dfca7761b7ab56459d9c964d0"
+    },
+    {
+      "type": "website",
+      "name": "Website",
+      "url": "https://frax.finance/"
+    },
+    {
+      "type": "docs",
+      "name": "Frax Shares (FXS) Documentation",
+      "url": "https://docs.frax.finance/fxs-and-vefxs/seigniorage"
+    }
+  ],
+  "cmcId": "6953"
+}

tokens/0x57e114b691db790c35207b2e685d4a43181e6061/info.json

@@ -0,0 +1,28 @@
+{
+  "name": "ENA",
+  "description": "The ENA token serves multiple key roles within the Ethena ecosystem, primarily focused on governance and utility. ENA token holders can participate in the decentralized governance of the Ethena protocol, influencing decisions about the platform''s development and future direction.",
+  "tags": [
+    "token",
+    "ENA"
+  ],
+  "links": [
+    {
+      "type": "explorer",
+      "name": "Etherscan",
+      "url": "https://etherscan.io/address/0x57e114b691db790c35207b2e685d4a43181e6061"
+    },
+    {
+      "type": "website",
+      "name": "Website",
+      "url": "https://ethena.fi/"
+    },
+    {
+      "type": "docs",
+      "name": "ENA Documentation",
+      "url": "https://docs.ethena.fi/ena"
+    }
+  ],
+  "cmcId": "30171",
+  "permitName": "ENA",
+  "permitVersion": "1"
+}

tokens/0x7f39c581f595b53c5cb19bd0b3f8da6c935e2ca0/info.json

@@ -0,0 +1,33 @@
+{
+  "name": "wstETH",
+  "description": "stETH is a transferable rebasing utility token representing a share of the total ETH staked through the protocol, which consists of user deposits and staking rewards. Because stETH rebases daily, it communicates the position of the share daily.",
+  "tags": [
+    "token",
+    "wstETH"
+  ],
+  "links": [
+    {
+      "type": "explorer",
+      "name": "Etherscan",
+      "url": "https://etherscan.io/address/0x7f39c581f595b53c5cb19bd0b3f8da6c935e2ca0"
+    },
+    {
+      "type": "website",
+      "name": "Website",
+      "url": "https://lido.fi/ethereum"
+    },
+    {
+      "type": "docs",
+      "name": "Lido Documentation",
+      "url": "https://docs.lido.fi/"
+    },
+    {
+      "type": "example",
+      "name": "wstETH rollup bridging guide",
+      "url": "https://docs.lido.fi/token-guides/wsteth-bridging-guide"
+    }
+  ],
+  "cmcId": "12409",
+  "permitName": "Wrapped liquid staked Ether 2.0",
+  "permitVersion": "1"
+}

tokens/0x8236a87084f8b84306f72007f36f2618a5634494/info.json

@@ -0,0 +1,26 @@
+{
+  "name": "LBTC",
+  "description": "Lombard unlocks Bitcoin’s potential as a dynamic financial tool by connecting it to DeFi. Its flagship product is LBTC, the Universal Liquid Bitcoin Standard. LBTC is yield-bearing, natively cross-chain, and backed 1:1 by BTC. With LBTC, BTC holders can earn a Babylon staking yield, points from multiple ecosystems and also participate in DeFi to trade, borrow/lend, yield farm, and more.",
+  "tags": [
+    "token",
+    "LBTC"
+  ],
+  "links": [
+    {
+      "type": "explorer",
+      "name": "Etherscan",
+      "url": "https://etherscan.io/address/0x8236a87084f8b84306f72007f36f2618a5634494"
+    },
+    {
+      "type": "website",
+      "name": "Website",
+      "url": "https://www.lombard.finance/"
+    },
+    {
+      "type": "docs",
+      "name": "Introduction to LBTC",
+      "url": "https://docs.lombard.finance/lbtc-liquid-bitcoin/introduction-to-lbtc"
+    }
+  ],
+  "cmcId": "33652"
+}