Contract Serializer
Microservice to extract structured information on EVM smart contract.
Why?
Modern NFT contracts may have different names for getPrice, mint and totalSupply methods (or even be a property instead). So it is hard to extract the information and call methods - they just have different names!
The purpose of this tool is to extract NFT contract information in structured way with common names for same properties.
How does it work?
It basically utilises Etherscan API and parse Etherscan 'Read Contract' page using BS4.
Example
Check deployed demo: https://contractserializer.herokuapp.com/. Open link to read the swagger docs.
Get contract's static variables
GET https://cs.webill.io/137/0xbc1fe0f3b02ce5ff516f14ac7b79dd6397a54b9c/readcontract Params: chain_id, contract_address
Example response
{
"data": {
"raw_data": {
"DEVELOPER": "https://buildship.dev",
"DEVELOPER_ADDRESS": "0x704c043ceb93bd6cbe570c6a2708c3e1c0310587",
"MAX_SUPPLY": "10000",
"MAX_TOKENS_PER_MINT": "20",
"PROVENANCE_HASH": " ",
"REFERRAL_PERCENT": "3000",
"baseURI": "https://metadata.buildship.dev/api/token/moon/",
"contractURI": "https://metadata.buildship.dev/api/token/moon/",
"getPrice": "200000000000000000000",
"getReservedLeft": "0",
"name": "NFT Moon Metaverse",
"owner": "0x197727ad2ec7326952843fbd83a0d57b907afbdf",
"saleStarted": "True",
"startingIndex": "0",
"symbol": "MOON",
"totalSupply": "178"
},
"serialized": {
"nft_contract": {
"price": 200000000000000000000,
"total_supply": 178,
"max_supply": 10000,
"paused": false,
"max_tokens_per_mint": 20,
"base_uri": "https://metadata.buildship.dev/api/token/moon/"
}
}
},
"contract_address": "0xbc1fe0f3b02ce5ff516f14ac7b79dd6397a54b9c",
"chain_id": 137
}
Get ABI of a contract in network
GET https://cs.webill.io/137/0xbc1fe0f3b02ce5ff516f14ac7b79dd6397a54b9c/abi Params: chain_id, contract_address Example response:
Local development
-
Copy .env_template file to .env and fill it with your Etherscan creadentials.
-
Run fastapi server:
uvicorn main:app --reload
Made by webill.io team
2 Jan 01, 2022
16 Dec 19, 2022
1 Feb 16, 2022
1 Feb 09, 2022
12 Feb 19, 2022
206 Jan 03, 2023
3 Nov 17, 2021
4 Feb 19, 2022
8 May 08, 2022
2 Jun 28, 2022
1 Oct 10, 2021
10 Aug 09, 2022
74 Dec 24, 2022
5 Apr 29, 2022
24 Sep 29, 2022
1 Nov 21, 2021
7 Jul 31, 2021
2 Feb 16, 2022
36 Dec 30, 2022
1 Jan 05, 2022