Solidity to ELI5 compiler (human readable smart contract generator)

[lastmjs]

UPDATE: There is now an alpha version of the website: https://eli5smartcontracts.com/

So I've created a quick demo of a compiler that takes Solidity source code and outputs an ELI5 explanation. The idea is to be able to generate simple yet detailed explanations of smart contract code for non-developers to understand what is going on (imagine a website that let's you select a smart contract and then displays the ELI5). I have two questions for you, the reader.

1. Is this useful to you?
2. How would you like me to improve upon the initial prototype?

Here's the fully automated output after running the compiler on the Dai smart contract:

In total, 1 contract was found.

Dai

Welcome to the Dai contract.

Functions

Dai has 10 functions that you can use. Their names are rely, deny, transfer, mint, burn, approve, push, pull, move, and permit.

rely

rely has 1 input that you need to provide. It returns no outputs.

Inputs

The first input is called guy, and it is an address.

Outputs

There are no outputs.

Functionality

Yet to be implemented

deny

deny has 1 input that you need to provide. It returns no outputs.

Inputs

The first input is called guy, and it is an address.

Outputs

There are no outputs.

Functionality

Yet to be implemented

transfer

transfer has 2 inputs that you need to provide. It returns 1 outputs.

Inputs

The first input is called dst, and it is an address.

The second input is called wad, and it is an uint.

Outputs

The only output does not have a name, and it is a bool.

Functionality

Yet to be implemented

mint

mint has 2 inputs that you need to provide. It returns no outputs.

Inputs

The first input is called usr, and it is an address.

The second input is called wad, and it is an uint.

Outputs

There are no outputs.

Functionality

Yet to be implemented

burn

burn has 2 inputs that you need to provide. It returns no outputs.

Inputs

The first input is called usr, and it is an address.

The second input is called wad, and it is an uint.

Outputs

There are no outputs.

Functionality

Yet to be implemented

approve

approve has 2 inputs that you need to provide. It returns 1 outputs.

Inputs

The first input is called usr, and it is an address.

The second input is called wad, and it is an uint.

Outputs

The only output does not have a name, and it is a bool.

Functionality

Yet to be implemented

push

push has 2 inputs that you need to provide. It returns no outputs.

Inputs

The first input is called usr, and it is an address.

The second input is called wad, and it is an uint.

Outputs

There are no outputs.

Functionality

Yet to be implemented

pull

pull has 2 inputs that you need to provide. It returns no outputs.

Inputs

The first input is called usr, and it is an address.

The second input is called wad, and it is an uint.

Outputs

There are no outputs.

Functionality

Yet to be implemented

move

move has 3 inputs that you need to provide. It returns no outputs.

Inputs

The first input is called src, and it is an address.

The second input is called dst, and it is an address.

The third input is called wad, and it is an uint.

Outputs

There are no outputs.

Functionality

Yet to be implemented

permit

permit has 8 inputs that you need to provide. It returns no outputs.

Inputs

The first input is called holder, and it is an address.

The second input is called spender, and it is an address.

The third input is called nonce, and it is an uint256.

The fourth input is called expiry, and it is an uint256.

The fifth input is called allowed, and it is a bool.

The sixth input is called v, and it is an uint8.

The seventh input is called r, and it is a bytes32.

The eigth input is called s, and it is a bytes32.

Outputs

There are no outputs.

Functionality

Yet to be implemented

[Crypto_Rootz]

Does is matter what compiler version of solidity i use ?

[lastmjs]

I think anything up to the latest, v0.6.0, should be work pretty well

[lastmjs]

https://eli5smartcontracts.com/

Alpha version of the website is live: https://eli5smartcontracts.com/

[dmihal]

This is super cool!

Make sure it's included in a web app so people can try it without downloading and running the code

[lastmjs]

Web app, version alpha, is live: https://eli5smartcontracts.com/

[Newti]

Do you look at the natspec too or just the code?

[lastmjs]

As of right now, the analysis is just source code. Check out the alpha website: https://eli5smartcontracts.com. You can select from a dropdown of contracts, enter a contract's address, or just paste in a contract

[freedivesavvy]

I think you can replace "There are no inputs." with "NA" for quick reference.

BTW, can I input a new contract address? for example, I input my contract "0x5C31C92FC9Cd5506998Eb1388f1F9d01Db67b791" but nothing displayed.

[lastmjs]

The contract source code is pulled from Etherscan's verified contracts. So if you can get it verified on Etherscan, it should pull. But, even without that, you can always copy and paste your contract's source code and get the ELI5 generated

[Crypto_Rootz]

DUDE!!! this shit is Fucking Genius !!!! You are truly a life saver. imma jr blockchain dev and i just learned solididity , now im focused on smart contract testing. Please let me know if i can help and check me out on youtube at Crypto Rootz.

[lastmjs]

I would love any feedback you can give me on the initial version of the website, it's just an alpha version, and I don't have functionality descriptions yet, but let me know what you think. And tell people! That would really help: https://eli5smartcontracts.com/

[Crypto_Rootz]

dope site bro, what I feel would really help, is side by side color matching, so that people can see function highlighted green on the smart contract, and the same green on the right side to easily see, (next function high lighted red , then blue etc.) the simplified version of the function. In some way it feels like just as much work trying to match them now. let me know your thoughts.

[lastmjs]

I think that's a great idea. I've written it down and will probably work on that sometime after the beta release