gakonst / solidity-book

The Senior Solidity Engineer's Book is a resource meant to transform you into a Senior Solidity Engineer.

The Senior Solidity Engineer's Book

Still in early development

Available live at: https://solidity-book.netlify.app/

The Senior Solidity Engineer's Book is a resource meant to transform you into a Senior Solidity Engineer.

To view the book locally: mdbook serve and navigate to http://localhost:3000

Requirements

This section is copied from the rust-lang book

Building the book requires mdBook, ideally the same version that rust-lang/rust uses in this file. To get it:

$ cargo install mdbook-mermaid
$ cargo install mdbook --vers [version-num]

Building

This section is copied from the rust-lang book

To build the book, type:

$ mdbook build

The output will be in the book subdirectory. To check it out, open it in your web browser.

Firefox:

$ firefox book/index.html                       # Linux
$ open -a "Firefox" book/index.html             # OS X
$ Start-Process "firefox.exe" .\book\index.html # Windows (PowerShell)
$ start firefox.exe .\book\index.html           # Windows (Cmd)

Chrome:

$ google-chrome book/index.html                 # Linux
$ open -a "Google Chrome" book/index.html       # OS X
$ Start-Process "chrome.exe" .\book\index.html  # Windows (PowerShell)
$ start chrome.exe .\book\index.html            # Windows (Cmd)

To run the tests:

$ mdbook test

Deploying to Netlify

npm i -g netlify
netlify deploy

solidity-book's Issues

Content Suggestions

Some ideas for content:-

Recreating some famous hacks/bugs to demonstrate exploitable code and what to avoid
Reliable sources of libraries and audited code OpenZeppelin etc.
Design patterns
Quirks and gotchas with Solidity compiler
Hardhat vs Truffle
IDE Plugins and custom deployment scripts
How EVM works
Layer 2 technologies
Best practices for storing on chain vs off chain data
Gas optimisation tips
MEV and flashbots
Useful code snippets
Oracles and Uni twap
Swaps and UniV2 vs V3 concentrated liquidity
Connecting lego bricks to build yield farming vaults
Creating custom and bootlegged interfaces
Unit testing
Fuzzing and linters
Community Hackathons, Meetups, EthGlobal etc.

If you want any help I wouldn't mind researching and writing a chapter.

addition info for ethereum basics

• https://takenobu-hs.github.io/downloads/ethereum_evm_illustrated.pdf
• https://ethdebug.github.io/solidity-data-representation/

t11s security checklist

https://github.com/Rari-Capital/solcurity
transmissions11/solcurity#1

Feel free to fork my educational articles

I wrote some articles a while back that might be super useful for this book. Feel free to use however you like.

Gas optimizations: https://betterprogramming.pub/how-to-write-smart-contracts-that-optimize-gas-spent-on-ethereum-30b5e9c5db85
Smart contract security: https://betterprogramming.pub/the-encyclopedia-of-smart-contract-attacks-vulnerabilities-dfc1129fdaac

Solidity Learning

EVM Articles

Here are some good EVM-related articles that we could provide a modernized summary of:

• https://programtheblockchain.com/posts/2018/03/09/understanding-ethereum-smart-contract-storage/
• https://blog.qtum.org/diving-into-the-ethereum-vm-6e8d5d2f3c30
• https://medium.com/@hayeah/diving-into-the-ethereum-vm-part-2-storage-layout-bc5349cb11b7
• https://medium.com/@hayeah/diving-into-the-ethereum-vm-the-hidden-costs-of-arrays-28e119f04a9b
• https://medium.com/@hayeah/how-to-decipher-a-smart-contract-method-call-8ee980311603

Content Suggestion List

Let's use this issue to track all useful content types, so we don't end up with very fragmented information:

How others have been teaching

• https://github.com/alcueca/solidity-mentorship/
• https://jamesbachini.com/blockchain-developer/

Solidity Best Practices

• https://github.com/Rari-Capital/solcurity / transmissions11/solcurity#1
• https://github.com/Rari-Capital/golf-course/tree/some-tips-to-start
• Gas optimizations: https://betterprogramming.pub/how-to-write-smart-contracts-that-optimize-gas-spent-on-ethereum-30b5e9c5db85
• Smart contract security: https://betterprogramming.pub/the-encyclopedia-of-smart-contract-attacks-vulnerabilities-dfc1129fdaac

EVM Internals

• https://programtheblockchain.com/posts/2018/03/09/understanding-ethereum-smart-contract-storage/
• https://blog.qtum.org/diving-into-the-ethereum-vm-6e8d5d2f3c30
• https://medium.com/@hayeah/diving-into-the-ethereum-vm-part-2-storage-layout-bc5349cb11b7
• https://medium.com/@hayeah/diving-into-the-ethereum-vm-the-hidden-costs-of-arrays-28e119f04a9b
• https://medium.com/@hayeah/how-to-decipher-a-smart-contract-method-call-8ee980311603

• https://takenobu-hs.github.io/downloads/ethereum_evm_illustrated.pdf
• https://ethdebug.github.io/solidity-data-representation/

Topic Ideas

• Recreating some famous hacks/bugs to demonstrate exploitable code and what to avoid
• Reliable sources of libraries and audited code OpenZeppelin etc.
• Design patterns
• Quirks and gotchas with Solidity compiler
• Hardhat vs Truffle
• IDE Plugins and custom deployment scripts
• How EVM works
• Layer 2 technologies
• Best practices for storing on chain vs off chain data
• Gas optimisation tips
• MEV and flashbots
• Useful code snippets
• Oracles and Uni twap
• Swaps and UniV2 vs V3 concentrated liquidity
• Connecting lego bricks to build yield farming vaults
• Creating custom and bootlegged interfaces
• Unit testing
• Fuzzing and linters
• Community Hackathons, Meetups, EthGlobal etc.

Recipe for validating off-chain data

Publish a recipe for validating off-chain data, both how to set it up in the smart contract and how to set it up on the back-end server with web3 or ethers. I've seen this used to good effect for saving gas or sending trusted data to a smart contract that would be difficult to do otherwise. I couldn't really find anything online detailing how to do this.

• For example, how to set up a website that can check a database for a whitelist, and provide a signed payload to use in a transaction (prevents having to store a whitelist on-chain and saves gas) (e.g. see presaleMint function in GrayBoys.sol contract here: https://etherscan.io/address/0x8d4100897447d173289560bc85c5c432be4f44e4#code)
  Something like this could be set up in ethers.js on the whitelisting server by doing:

const encodedAddress = ethers.utils.defaultAbiCoder.encode(["address"], [whitelistedAddress]);
const messageHash = ethers.utils.arrayify(ethers.utils.solidityKeccak256(['address'], [encodedAddress]));
const whitelistSignature = await owner.signMessage(messageHash);

• Another use case is to check some kind of data like how many tokens a user can mint (see claim function in OpenDao.sol contract: https://etherscan.io/address/0x3b484b82567a09e2588A13D54D032153f0c0aEe0#code claim)
• Is this approach used to set up multisig functionality?

t11s' optimizations

https://github.com/Rari-Capital/golf-course/tree/some-tips-to-start

Content suggestions.