/asa-list

Tinyman - Algorand Standard Assets List

Primary LanguageJavaScript

asa-list

Tinyman - ASA List

We are collecting all the icons of projects built on Algorand in one place where everyone can easily access. In this public repository you can check and add the icons of Algorand Standard Assets. Also you can use dynamic link to use these icons on your projects. This repository is being developed with the contributions of ASA makers.

We have also integrated the ASA List to Pera Verification System so that missing icons can be retrieved from there. Thanks to the integration, ASA holders no longer need to apply to the Pera Verification System and ASA List separately to display their token’s icons on the platforms that are using the ASA List. Here is the workflow:

Tinyman team continues to maintain the ASA List repo but we will update it less frequently after this integration. Therefore, we highly recommend that all ASA creators apply for the Pera Verification System so that their icons can be listed quickly.

Please follow the requirements listed below for uploading an icon for your ASA. If you have any problems, you can join Tinyman Discord and ask your questions about the project in #asa-list channel.

Adding your icon

  • First of all, the asset icons should be properly updated for the repository. The following rules must be followed for icons.
    • The icon must have both SVG and PNG versions.
    • Icon sizes should be square, 256x256px for both SVG and PNG versions. Landscape, portrait icons will not be accepted. (Icons sent other than 256x256px will not be accepted.)
    • Note that these icons will mostly be used in rounded areas. Elements located at the corners of the container may not be visible in some applications.
    • SVG and PNG files should be consistent. All the elements (colors, size, elements’ position, text elements etc.) should look the same in both versions. (Grayscale image-traced SVG files will not be accepted.)
    • The SVG version must be compatible with web-rendering. These icons will mostly be used in Algorand applications. For example, if the SVG file does not appear in GitHub preview, it means it is not compatible.
    • The SVG version should mostly not contain images. Your icon should have a vector version. (Again, not grayscale image-traced...)
    • It would be better if your icons have a background. Icons consisting of pure-black or pure-white elements can cause problems in light mode and dark mode applications.
  • Icon file names should be icon.png and icon.svg.
    • File names are case-sensitive. Icon.png or ICON.png will not be accepted.
  • Icon files should be located inside of a folder in the repository under assets/ directory. This folder's name should be unit_name-asset_id, e.g. "USDC-31566704" without adding any space.
    • Unit names are case sensitive. Make sure you are typing the exact unit name, paying attention to case sensitivity.
  • If you think you paid attention to all these in your commit, create a pull request. Pull requests should be into review branch. When your PR is accepted, it will be merged with the main branch along with the other icons. Empty PRs and icons sent by adding comments will not be accepted.

If you think you have met all the criteria and your PR has not been accepted, you can join the Tinyman Discord and ask your questions in #asa-list channel.

 

Verifying your pull request

To add or update any icon in asa-list, you should prove your ownership of the ASA. PRs without this verification process will not be merged. Please do the following steps:

  1. Create the pull request
  2. Make a transaction from the ASA’s creator wallet. The transaction should be a 0 ALGO transfer to itself, including the pull request’s link in its text section.
  3. Comment with the transaction ID under the pull request.

 

Using in your project

You can use all ASA icons here in your projects dynamically. Each time the main branch is updated, the icons will be moved to the server. The following URLs can be used to access a project's icon.

  • https://asa-list.tinyman.org/assets/ asset_id /icon.png
  • https://asa-list.tinyman.org/assets/ asset_id /icon.svg

For example, we want to access the icon of USDc. USDc's asset ID is 31566704. It can be accessed via this URL.

https://asa-list.tinyman.org/assets/31566704/icon.png

The main branch is generating a JSON file every time it's updated. This file is a complete list of available icons with their information of asset_id, asset_name, unit_name, decimals, URL, total_amount, PNG and SVG URLs. You can access this file via the URL at the below.

  • https://asa-list.tinyman.org/assets.json