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
10 Oct 21, 2022
11 Aug 29, 2022
145 Dec 30, 2022
2 Nov 17, 2021
1 Feb 06, 2022
4.3k Jan 07, 2023
33 Apr 19, 2022
8 Sep 27, 2022
510 Dec 28, 2022
3 Feb 21, 2022
36 Dec 06, 2022
1 Dec 30, 2021
20 Sep 04, 2022
13 Oct 09, 2022
964 Jan 08, 2023
2 Aug 08, 2022
8 Sep 15, 2022
4 Apr 25, 2022
1 Jan 27, 2022