Skip to content

Latest commit

 

History

History
89 lines (68 loc) · 3.18 KB

README.md

File metadata and controls

89 lines (68 loc) · 3.18 KB
Raw

Vechain NFT registry

The NFT registry is a repository of known NFT contracts with meta information that may not available on the chain.
Adding Tokens or suggesting changes can be done thru Pull Requests.
The original list was created from Milos at vnft-tools.com. The repository is structural based on the official token registry

Requirements

  1. Make sure the contract address is correct (main/test)
  2. Token image (optional)
  3. Folder name must be the same as the contract address
  4. Clear and simple description
  5. Comply with directory & contents rules

Getting Ready for Submission

Fork Token-registry

Forking a repository allows you to create your token details and send a pull request for the maintainers to review and merge into NFT registry.

Generate Token Information

  1. Create a directory in main /test/both and named the directory with Contract address.

Contract address start with 0x + 40 characters and must be lower case, E.g., 0xb81e9c5f9644dec9e5e3cac86b4461a222072302.

├── main 
│   └── 0xb81e9c5f9644dec9e5e3cac86b4461a222072302 //Contract address
│       ├── info.json
│       ├── token.webp
│       └── extra.json
│       └── marketplace.json

  1. Import your token image into the directory and named it token.(Image must be webp format, transparent background and 256 x 256 pixel size)

  2. Generate a info.json file includes token details.

{
    "name": "Vechain Node Token",
    "creator": "Vechain",
    "description": "X-Node"
}
  1. Generate an extra.json file includes following details.
{
  "website": "https://www.example.com/", 
  "links": {
      "discord": "https://discord.com/example",
      "twitter": "https://twitter.com/example",
      "telegram": "https://t.me/example",
      "facebook": "https://www.facebook.com",
      "medium": "https://medium.com/@example",
      "github": "https://github.com/example",
      "slack": "https://example.slack.com/"
  },
  "whitePaper": "https://www.example.com/whitepaper/"
}
  1. Generate a marketplace.json file includes following details.
[
  {
    "name": "VeChainStats",
    "link": "https://manager.vechainstats.com/vnt-marketplace",
    "tokenLink": "https://vechainstats.com/nft/vechain-nodes/{{tokenId}}"
  }
]

Only Discord / Twitter / Telegram / Facebook / Medium / Github / Slack are supported

Making a Pull Request / Submit Your token

After Create a pull request, your pull request will be reviewed by maintainers. Once the review is completed, your token will be merged into the base branch.

Get Approved token list

  1. Get token information
  2. Get token icon
    • https://vechain.github.io/nft-registry/{item.icon}