List Your Token In BeeDex

Hurry Up to list your token in BeeDex

Here’s the formatted content tailored for listing tokens in BeeDex, based on the repository structure you provided:

---

BeeDex Token List Repository

Welcome to the BeeDex Token List Repository! This repository maintains a curated list of tokens that are compatible with BeeDex on the Loop Network. Below, you will find details on the token format, guidelines for submitting your token, and how to utilize the token list in your applications.

---

Token List Format

Every token entry in the repository follows the JSON format below. Ensure that your entry strictly adheres to this schema to avoid validation failures.

{
  "symbol": "TOKEN",
  "name": "Token Name",
  "address": "0x1234567890abcdef1234567890abcdef12345678",
  "decimals": 18,
  "chainId": 1,
  "sellFeeBps": 0,
  "buyFeeBps": 0,
  "isNative": true,
  "isToken": false,
  "logoURI": "https://path-to-your-logo/logo.png",
  "socials": {
    "twitter": "https://twitter.com/yourtoken",
    "telegram": "https://t.me/yourtoken"
  },
  "coingeckoId": "your-token-id"
}

Field Descriptions

Field	Type	Description	Required
symbol	String	The token's ticker symbol (e.g., ETH, BEE).	Yes
name	String	The full name of the token.	Yes
address	String	The token's contract address in 0x... format.	Yes
decimals	Number	The number of decimals the token supports (e.g., 18 for most ERC-20 tokens).	Yes
chainId	Number	The chain ID where the token resides (e.g., 1 for Ethereum, 56 for BNB Chain).	Yes
sellFeeBps	Number	The sell fee in basis points (bps).	No
buyFeeBps	Number	The buy fee in basis points (bps).	No
isNative	Boolean	Indicates if the token is a native token on the blockchain.	No
isToken	Boolean	Indicates if the entry is a token (set to true for tokens).	No
logoURI	String	A public URL to the token's logo image (must be PNG or SVG).	Yes
socials	Object	Links to the token’s social profiles (Twitter, Telegram, etc.).	No
coingeckoId	String	The token's ID on CoinGecko for price tracking.	No

---

How to Add Your Token

Follow these steps to list your token on BeeDex:

1. Fork the Repository:

   • Click the "Fork" button in the top-right corner of the repository page.

2. Clone Your Forked Repository:

   git clone https://github.com/0x3f-lancers/loop-token-list.git
   cd loop-token-list/src
3. Add Your Token:

   • Edit the main-tokens.json file.

   • Add your token details using the JSON format described above.

4. Commit Your Changes:

   git add main-tokens.json
   git commit -m "Add TOKEN_NAME to the token list"
5. Push Your Changes:

   git push origin main
6. Submit a Pull Request (PR):

   • Open your forked repository on GitHub.

   • Click "Compare & Pull Request" to submit your changes for review.

---

Submitting a Pull Request (PR)

When submitting a PR, please follow these guidelines:

1. Adhere to the Token Format:

   • Ensure all fields are accurate and properly formatted.

   • Use a valid contract address in 0x... format.

2. Include Your Token Logo:

   • The logo must be hosted on a public URL.

   • Recommended sizes: 24x24 pixels or 32x32 pixels.

3. Provide Accurate Information:

   • Social media links, decimals, and contract addresses should be correct.

4. Review Your Submission:

   • Include a clear description of your token in the PR summary.

---

Alternative Submission Methods

If you are unable to create a pull request, you can use one of the following methods:

1. Create an Issue

• Open an issue in this repository and include all token details.

• The maintainers will assist you in adding the token.

2. Contact the Maintainers

• Reach out to the maintainers directly via Telegram and provide your token details.

• The maintainers will handle the submission for you.

---

Usage Guidelines

Developers can use the token list in their frontend applications. Here's how to fetch the list:

Fetch Token List via API

curl -X GET https://raw.githubusercontent.com/0x3f-lancers/loop-token-list/main/src/main-tokens.json

Integrate Token List in Your Application

async function fetchTokenList() {
  const response = await fetch(
    "https://raw.githubusercontent.com/0x3f-lancers/loop-token-list/main/src/main-tokens.json"
  );
  const tokens = await response.json();
  console.log(tokens);
}

fetchTokenList();

---

Token Validation

All token submissions undergo manual and automated validation checks. Common reasons for rejection include:

• Invalid contract address format.

• Incorrect or missing decimals.

• Non-working social media URLs.

• Using non-public URLs for token logos.

---

Maintainers

For assistance, please contact:

• 0xlancersT
• BusyBee

---

License

This repository is licensed under the MIT License.

---

By following these steps, you’ll ensure your token is listed smoothly on BeeDex. Happy Trading!