Shibarium Token Bridge

The “shibaone/shibarium-images” repository on GitHub serves as a central resource for images and details of tokens on the Ethereum, Sepolia, Shibarium, and Puppynet networks. This repository plays a vital role in supporting the Shibarium ecosystem by providing a structured and easily accessible collection of token assets.

What does this repository contain?

This repository contains images and associated data for tokens across the mentioned networks. The repository has a specific folder structure:

assets/images/: Contains token images, organized by network.

• Each network (ethereum, sepolia, shibarium, puppynet) has its own subfolder.
• Token images are named using the token’s address in lowercase, followed by “.png” (e.g., 0x1234567890abcdef.png).

assets/data/: Contains token details in JSON format, also organized by network.

• Each network (ethereum, sepolia, shibarium, puppynet) has its own subfolder.
• JSON files are named using the token’s address in lowercase, followed by “.json” (e.g., 0x1234567890abcdef.json).

Adding a new token to the repository

The repository encourages community contributions. Here’s how to add a new token:

• Determine the Token Network: Decide whether the token belongs to the Ethereum, Sepolia, Shibarium, or Puppynet network.
• Add Token Image and JSON File:

Token Image: Place the token image inside the appropriate images/{network}/ folder. The image file must use the token’s address in lower case followed by “.png” as its name, and should not exceed 200 KB.

Token Details: Add the token details in a JSON file inside the corresponding data/{network}/ folder. The JSON file must be named using the token’s address in lower case followed by “.json”.

The JSON file should include the following information:

parentName: Name of the parent token (e.g., BONE SHIBASWAP).

parentSymbol: Symbol of the parent token (e.g., BONE).

parentContract: Address of the parent token contract.

childName: Name of the child token (e.g., Bone Token).

childSymbol: Symbol of the child token (e.g., BONE).

childContract: Address of the child token contract.

bridgeType: Type of bridge (e.g., plasma, pos).

tokenWebsite: Token Website.

projectDescription: Brief description of the token project.

• Create a Pull Request (PR): Once the image and JSON file are added, create a pull request (PR) to the main branch with the changes.
• PR Review and Approval: Wait for the PR to be reviewed and approved by the maintainers.

Accessing Token Images and Data

Once a pull request is merged, token images and data can be accessed via specific URLs. The format is as follows:

• Image URL: https://cdn.shib.io/tokens/images/${chain}/${contractAddress.toLowerCase()}.png
• Data URL: https://cdn.shib.io/tokens/data/${chain}/${contractAddress.toLowerCase()}.json

${chain}: This should be replaced with the network name (ethereum, sepolia, shibarium, or puppynet).

${contractAddress}: This should be replaced with the token’s contract address in lowercase. For example, the URL for the BONE token on the Ethereum network with the contract address 0x9813037ee2218799597d83d4a5b6f3b6778218d9 would be: https://cdn.shib.io/tokens/images/ethereum/0x9813037ee2218799597d83d4a5b6f3b6778218d9.png and https://cdn.shib.io/tokens/data/ethereum/0x9813037ee2218799597d83d4a5b6f3b6778218d9.json

Contribution Guidelines

The repository has strict contribution guidelines to maintain consistency:

• Folder names must be the network name (ethereum, sepolia, shibarium, puppynet).
• Image file names must be the token address in lower case followed by “.png”.
• Image size must not exceed 200 KB.
• JSON file structures must be accurate.
• Contract addresses must be in lowercase and correct.

By adhering to these guidelines, community contributions will be reviewed and integrated more quickly.

Conclusion

The shibaone/shibarium-images repository is a valuable resource for the Shibarium ecosystem, enabling easy access to token images and details. With clear guidelines for contribution, it encourages community participation, ensuring its ongoing growth and accuracy.