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
3 Sep 30, 2021
24 Jan 01, 2023
1 Jun 08, 2022
123 Jan 01, 2023
40 Nov 29, 2021
7 Jan 03, 2023
2 Nov 16, 2021
2 Apr 19, 2022
4 Oct 20, 2021
216 Jan 03, 2023
1 Feb 03, 2022
572 Jan 09, 2023
3.9k Jan 01, 2023
73 Nov 03, 2022
2.7k Jan 07, 2023
7 Mar 07, 2022
40 Dec 31, 2022
10 Dec 01, 2022
3 Aug 29, 2022
71 Dec 17, 2022