Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename README.md to BLu2000 #330

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions BLu2000
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Adding new token
The JSON schema for the tokens includes: address, name, decimals, symbol, logoURI, official homepage, MarketCap link, existing Markets.

Follow the steps below to add a new token:
1) Fork this repo.
2) change the JSON file `tokenlist.json`, adding such as: (PLEASE DO NOT REMOVE EXISITING TOKENS)
```
{
"address": "TLa2f6VPqDgRE67v1736s7bJ8Ray5wYjU7",
"symbol": "WIN",
"name": "WINkLink",
"decimals": 6,
"logoURI": "https://coin.top/profile_images/JKtJTydD_400x400.jpg",
"homepage": "https://winklink.org/",
"MarketCapLink": "https://coinmarketcap.com/currencies/wink/",
"existingMarkets": [
{
"source": "Binance",
"pairs": [
"WIN/USDT",
"WIN/BUSD",
"WIN/BNB",
"WIN/USDC"
]
},
{
"source": "Poloniex",
"pairs": [
"WIN/USDT"
]
},
{
"source": "KuCoin",
"pairs": [
"WIN/USDT"
]
}
]
}
```
* `address`[Required]: your token address.
* `symbol`[Required]: your token symbol.
* `name`[Required]: your token name.
* `logoURI`[Required]: the logo URI of your token.
* `homepage`[Required]: the home page of your token.
* `MarketCapLink`[Optional]: the coinmarketcap or coingecko link for your token.
* `existingMarkets`[Required]: where to trade with your token.
3) Submit PR with the changed JSON file.


54 changes: 54 additions & 0 deletions DRAWING
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# OpenSea Drop - Instructions for Media and Metadata files



## Media file instructions

Supported files include JPG, PNG, SVG, and GIF. The per file size limit is 50000000000 MB.

All files should have the same extension (e.g. all of them should be .png).



### When there is no metadata file

Media file naming can be anything you want. The tokenID will be set based on order of submission.



### When there is a metadata file

The name of the media file should be matched in the column 'file_name' in the metadata file.





## Metadata file instructions



On the metadata file, make sure that the tokenIDs are consecutive numbers. So if you have 1000 items, you must have tokenIDs consecutive from 1 to 1000 without missing any numbers.



Mandatory columns are:

- 'tokenID' -- identification of the item, which is a number between 1 and the number of files you have, consecutively

- 'name' -- name of your item (max 200 characters)

- 'file_name' -- name of your media file, including the extension



Optional columns are:

- 'description' -- description of your item

- 'external_url' -- URL shown on your item (can be an external URL to provide more information about your item)

You can add trait columns, which must follow the convention 'attributes[name_of_trait]'. For example, if you wanted eye color to be a trait, you can have a column named 'attributes[eye color]'.



100 changes: 52 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,54 @@
# Adding new token
The JSON schema for the tokens includes: address, name, decimals, symbol, logoURI, official homepage, MarketCap link, existing Markets.

Follow the steps below to add a new token:
1) Fork this repo.
2) change the JSON file `tokenlist.json`, adding such as: (PLEASE DO NOT REMOVE EXISITING TOKENS)
```
{
"address": "TLa2f6VPqDgRE67v1736s7bJ8Ray5wYjU7",
"symbol": "WIN",
"name": "WINkLink",
"decimals": 6,
"logoURI": "https://coin.top/profile_images/JKtJTydD_400x400.jpg",
"homepage": "https://winklink.org/",
"MarketCapLink": "https://coinmarketcap.com/currencies/wink/",
"existingMarkets": [
{
"source": "Binance",
"pairs": [
"WIN/USDT",
"WIN/BUSD",
"WIN/BNB",
"WIN/USDC"
]
},
{
"source": "Poloniex",
"pairs": [
"WIN/USDT"
]
},
{
"source": "KuCoin",
"pairs": [
"WIN/USDT"
]
}
]
}
```
* `address`[Required]: your token address.
* `symbol`[Required]: your token symbol.
* `name`[Required]: your token name.
* `logoURI`[Required]: the logo URI of your token.
* `homepage`[Required]: the home page of your token.
* `MarketCapLink`[Optional]: the coinmarketcap or coingecko link for your token.
* `existingMarkets`[Required]: where to trade with your token.
3) Submit PR with the changed JSON file.
# OpenSea Drop - Instructions for Media and Metadata files



## Media file instructions

Supported files include JPG, PNG, SVG, and GIF. The per file size limit is 50 MB.

All files should have the same extension (e.g. all of them should be .png).



### When there is no metadata file

Media file naming can be anything you want. The tokenID will be set based on order of submission.



### When there is a metadata file

The name of the media file should be matched in the column 'file_name' in the metadata file.





## Metadata file instructions



On the metadata file, make sure that the tokenIDs are consecutive numbers. So if you have 1000 items, you must have tokenIDs consecutive from 1 to 1000 without missing any numbers.



Mandatory columns are:

- 'tokenID' -- identification of the item, which is a number between 1 and the number of files you have, consecutively

- 'name' -- name of your item (max 200 characters)

- 'file_name' -- name of your media file, including the extension



Optional columns are:

- 'description' -- description of your item

- 'external_url' -- URL shown on your item (can be an external URL to provide more information about your item)

You can add trait columns, which must follow the convention 'attributes[name_of_trait]'. For example, if you wanted eye color to be a trait, you can have a column named 'attributes[eye color]'.