Skip to content

Latest commit

 

History

History
82 lines (63 loc) · 3.25 KB

README.md

File metadata and controls

82 lines (63 loc) · 3.25 KB
Raw

How to Submit Token Information via GitHub

This guide outlines how to add your token information to the repository using the GitHub web interface. Follow these steps to ensure your submission is organized correctly and processed efficiently.

Step 1: Go to the main page of the GitHub repository.

Step 2: Navigate to the tokens /tokens/psp22/ directory within the repository. This directory is specifically for PSP22 tokens.

Step 3: Create a new directory for your token.

  • Click the Add file button and select Create new file.
  • In the path field ascan-tokenlists/tokens/psp22 /, type [contract-address]/ with the actual contract address of your token on Aleph Zero Mainnet network. This automatically creates a new directory for your token under the psp22 subdirectory.

Step 4: Add the info.json file content

With the directory path set, name the new file info.json.

Paste the JSON structure into the content area. Here is an example template you should follow:

{
  "name": "",
  "symbol": "",
  "type": "PSP22",
  "contractAddress": "",
  "decimals": 12,
  "description": "",
  "website": "",
  "sourceCode": "https://github.com/{Github_Username}/{Repository_Name}/path/to/contract",
  "links": [
    {
      "name": "X/Twitter",
      "url": ""
    },
    {
      "name": "Telegram",
      "url": ""
    },
    {
      "name": "Discord",
      "url": ""
    }
  ],
  "customTags": [
    "burnerWallet",
    "otherTag"
  ],
  "warnings": [],
  "owner": "",
  "minter": ""
}

After entering the content, use the Commit changes button to save the info.json file into your new directory. Name branch using contract address of your token and use Propose changes button. That will move you to screen for Pull Request creation.

Step 5: Add the logo.png File

  • After committing the info.json file, stay in the same directory.
  • Click the Add file button again and select Upload files.
  • Drag and drop your logo.png file into the space provided or use the file selector to navigate and select your file. Remember, the logo should be a 256x256 pixel PNG image.
  • Commit the file similarly by providing a commit message and selecting Commit changes.

Step 6: Add the metadata.json File

  • Following the addition of the logo.png, add a metadata.json file in the same directory.
  • Click the Add file button again and select Create new file.
  • Name the new file metadata.json and paste the appropriate JSON content that describes additional metadata about the token.
  • Commit the file as described above.

Step 7: Review and Submit

  • After adding the info.json, logo.png and metadata.json files, review the directory to ensure everything is in place.
  • If you are ready to submit to the repository maintainers for review, navigate to the Pull requests tab at the repository's top menu.
  • Select New pull request, set the base repository to the main branch, and compare your branch.
  • Fill in the title and description of your changes and click Create pull request.

Note

Ensure that the directory name matches the contract address of your token exactly to avoid confusion and ensure accuracy.

The repository maintainers will review your pull request and merge it if everything meets the submission criteria. They may also request changes if needed.