-
Fork this repository
- Click the "Fork" button in the top-right corner of this repository to create your own copy.
-
Clone the forked repository
- Clone the forked repository to your local machine:
git clone https://github.com/YOUR_USERNAME/Fibrous-tokens.git cd Fibrous-tokens
- Clone the forked repository to your local machine:
-
Add a new token JSON file
-
Navigate to the appropriate folder (
scroll/tokens
orstarknet/tokens
) based on the network your token is deployed on. -
Create a new
.json
file in the respective folder named after the token's contract address. For example, if your token's contract address is0x1234...abcd
, the filename should be0x1234...abcd.json
. -
The file should follow this format:
{ "address": "0x1234567890abcdef1234567890abcdef12345678", "name": "NAME", "symbol": "SYMBOL" }
-
-
Add your token image
-
Save your token's image as a
.png
file and ensure it's named after the token's contract address. -
The image must be uploaded to the corresponding folder:
- For tokens on Scroll, save the image to
images/scroll/
. - For tokens on Starknet, save the image to
images/starknet/
.
- For tokens on Scroll, save the image to
-
Example file path for a Scroll token:
images/scroll/0x1234567890abcdef1234567890abcdef12345678.png
Image Requirements:
- Format: PNG
- Size: 256x256 pixels
-
-
Commit and push your changes
- Once you have added the JSON file and the image, commit and push your changes:
git add . git commit -m "Add token 0x1234567890abcdef1234567890abcdef12345678" git push origin main
- Once you have added the JSON file and the image, commit and push your changes:
-
Create a Pull Request
- Go to your forked repository on GitHub and click on "New Pull Request."
- Ensure that you are comparing your forked repository's branch with the main branch of the
Fibrous-tokens
repository. - Submit the pull request for review.
-
Wait for Review
- Once you've submitted the pull request, the team will review your submission. If everything looks good, your token will be approved and merged into the repository.
If your token's contract address is 0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7
, your files should look like this:
-
JSON file:
starknet/tokens/0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7.json
{ "address": "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7", "name" : "Ether", "symbol": "ETH" }
-
Image file:
images/starknet/0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7.png