https://github.com/fukuball/rarity-analyser
Cool Rarity is an open source package for easy rarity score calculation with ERC721 NFT metadata collection. It was born in punkscape 01 rarity analyser hackathon.
https://github.com/fukuball/rarity-analyser
erc721 nft rarity
Last synced: 3 months ago
JSON representation
Cool Rarity is an open source package for easy rarity score calculation with ERC721 NFT metadata collection. It was born in punkscape 01 rarity analyser hackathon.
- Host: GitHub
- URL: https://github.com/fukuball/rarity-analyser
- Owner: fukuball
- Created: 2021-09-11T13:24:19.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-12T12:02:51.000Z (over 3 years ago)
- Last Synced: 2025-02-27T05:55:55.627Z (4 months ago)
- Topics: erc721, nft, rarity
- Language: JavaScript
- Homepage: https://onedaypunk-rarity-tool.herokuapp.com/
- Size: 14.5 MB
- Stars: 85
- Watchers: 1
- Forks: 72
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cool Rarity
Cool Rarity is an open source package for easy rarity score calculation.
Cool Rarity was born in a [Hackathon](https://github.com/punkscape/01-rarity-analyser-hackathon) hosted by [PunkScape](https://punkscape.xyz/), made with love by [Fukuball](https://twitter.com/fukuball). It is easy to configure for developers and easy to use for users, any ERC721 NFT collection with [OpenSea metadata stardard](https://docs.opensea.io/docs/metadata-standards) can use Cool Rarity as the rarity score calculation tool. If you have the collection metadata in hand, you can depoly Cool Rarity as your collection rarity tool in minues!
Here's the demo:
- One Day Punk rarity website: [https://onedaypunk.coolrarity.com/](https://onedaypunk.coolrarity.com/)
- BAYC rarity website: [https://bayc.coolrarity.com/](https://bayc.coolrarity.com/)
- Anti CryptoPunks rarity website: [https://rarity.anticryptopunks.com/](https://rarity.anticryptopunks.com/)
## Prerequisites
Cool Rarity was built using Node.js, so you have to install:
- Node.js (v14.x)
- NPM
I personally use Yarn and NVM, so you can consider install them too:
- Yarn
- NVM
## Run Cool Rarity locally
### Step 1: Clone from GitHub
```
$ git clone https://github.com/fukuball/rarity-analyser.git
```
### Step 2: Configure collection data
You should have the collection metadata on hand, or you can use the default [collection.json](https://github.com/fukuball/rarity-analyser/blob/main/config/collection.json) provided by Cool Rarity, be sure your collection metadata is formated like the default collection.json.
Put your collection metadata json file (all token metadata in one json file!) in `config` folder, the same location as the default collection.json, then open the `config.js` in the folder, modify it for your collection.
Here's the content of `config.js`:
```
{
app_name: 'Cool Rarity',
app_description: 'A cool rarity tool.',
collection_file_name: 'collection.json',
collection_contract_address: '0x5537d90a4a2dc9d9b37bab49b490cf67d4c54e91',
collection_name: '10k One Day Punks',
collection_description: '10k "One Day I\'ll Be A Punk"-punks – a homage to the one and only CryptoPunks. Holding a OneDayPunk will give you early access to PunkScapes and reserve a profile on the PunkScape website.',
sqlite_file_name: 'database.sqlite',
ga: 'G-BW69Z04YTP',
main_og_image: 'https://onedaypunk-rarity-tool.herokuapp.com/images/og.png'
}
```
- `app_name`: You can name your rarity app here.
- `collection_file_name`: Your NFT collection metadata file name, the metadata file you put in `config` folder.
- `collection_contract_address`: Your NFT collection smart contract address, will use to show the "View on OpenSea" link.
- `collection_name`: Your NFT collection name.
- `sqlite_file_name`: SQLite database file name, no need to change.
- `ga`: If you want to use Google Analytic, then change to your code.
- `main_og_image`: You can set default open graph image here.
### Step 3: Install package
```
$ yarn install
```
When package installed, postinstall script will be tiggered, and the `./cmd/rarity_analyze.js` will run for the first install. This will take some time for the rarity score calculation. (generally in minues)
### Final Step: Run
```
$ DEBUG=rarity-analyser:* yarn start-dev
```
Then open: http://localhost:3000/ on your web browser. Yes! Now you see the rarity website of your NFT collection!
### Extra
You can generate `collection-rarities.json` file by using this command:
```
yarn rarity-output-json
```
The `collection-rarities.json` file will store in `config` folder.
## Deploy to Heroku
### Step 1: Prerequisites
- Register Heroku account
- Install [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli)
### Step 2: Login and Create App
In your Cool Rarity folder:
```
$ heroku login
```
```
$ heroku create your_app_name
```
### Final Step: Deploy
```
$ git push heroku main
```
If you have any update want to deploy to Heroku, just use this final step to deploy to Heroku.
### Use One Click Heroku Deploy
Here you can deploy this rarity tool to Heroku in one click, just be sure you have the Heroku account.
## Tasks
### Hackathon Tasks
- [X] The app lets the deployer configure a collection json file like this one: [collection.json](https://github.com/fukuball/rarity-analyser/blob/main/config/collection.json)
- [X] Take all metadata items and analyse their `attributes`.
- [X] Derive a rarity score for each attribute of each NFT item. Example: Property "Type", Attribute "Ape"; 24 of 10000 have this attribute/property combination; `rarity_score = 1/(24/10000) = 416.67`
- [X] Derive a rarity score for each NFT in the collection. The rarity score for each NFT is the **sum of all attributes**.
- [X] Account for missing `trait_type`s of an NFT.
- [X] Account for the `trait_count` of an NFT.
- [X] Calculate the Rarity Score for each token (SUM of all rare trait attributes / missing traits / trait counts).
- [X] Compute and store a `collection-rarities.json` file which can be exported for use elsewhere for the given collection.
### Additional Tasks
- [X] Search by ID and sort by rarity or ID.
- [X] Put OpenSea link and offlicial site link.
- [X] Endpoint of JSON rarity data for every punk.
- [X] Test with other ERC721 collection metadata.
- [X] Matrix page.
- [X] Similarity analysis, create one page to show top 12 similar for every punk.
## Other Rarity Tools
### Our Friends (One Day Punk) - Also making cool tools!
- [NotChris & RickLove](https://github.com/cryptoDevAmigos/rarity-analyzer)
- [Nishu](https://github.com/nishantrpai/rarity-score)
- [OxNight](https://github.com/middlerange/rarity-analyzer)
- [Mikk-o](https://github.com/mikko-o/rarity-analyser)
### Other
- https://rarity.tools/
- https://gaswars.io/collections/0x51ae5e2533854495f6c587865af64119db8f59b4/5217
- https://rarity.guide/
- https://intermezzo.tools/
## Support
Thanks to [PunkScape](https://punkscape.xyz) Community for this initiative.