Solidity Doc Pages

A list of solidity resources

Resources

Official

• Docs - Official documentation.
• Cheatsheet - Cheatsheet from the official docs.
• Ethereum Stackexchange - Ethereum's Stackexchange board.
• ethereum/solc-bin - Current and historical builds of the compiler.
• ethereum/solidity-examples - Loose collection of example code.
• ethereum/solidity - Source code.
• Ethereum Wiki - The Ethereum Wiki.
• Gitter - Gitter channel.

Tutorials

• androlo/solidity-workshop - Comprehensive series of tutorials covering contract-oriented programming and advanced language concepts.
• buildspace.so - Hands-on Web3 course especially for beginners. It is completely free and you get an NFT on completion.
• Cadena - Tutorials for building smart contracts, dapps, on multiple chains and earn a Cadena NFT Certificate.
• cryptodevhub.io - Community-driven effort to unite like-minded people interested in Blockchain- and Crypto Technologies.
• CryptoZombies - Interactive code school that teaches you to write smart contracts through building your own crypto-collectibles game.
• karmacoma-eth/sending-ether-cheat-sheet - Tips and best practices for sending Ether.
• ExtropyIO/defi-bot - Tutorial for building DeFi arbitrage bots.
• manojpramesh/solidity-cheatsheet - Cheat sheet and best practices.
• nishuzumi/Web3-Enterprise-level-engineering - Web3 Enterprise Engineering Writing Specification Tutorial [Chinese Language - 中文版].
• willitscale/learning-solidity - Complete guide on getting started, creating your own crypto, ICOs and deployment.
• LearnXInY - Learn Solidity in 15 mins (for experienced devs).
• Solidity and Vyper cheat sheet - Review syntax of both languages side-by-side.
• topmonks/solidity_quick_ref - Syntax overview.
• Discover Ethereum & Solidity (ludu.co) - Complete course that takes you through the process of creating a decentralized Twitter clone using best practices.
• Questbook - Questbook is building a University DAO where learning is always free. Starting with crypto-dev courses by leading devs.
• Teach Yourself Web3 - Join a community of Web3 engineers & educators that can help you supercharge your way into Web3 development.
• useweb3.xyz/tutorials - A curated list of free, community tutorials that are based around specific projects, tasks or challenges.

Articles

• Best Practices for Smart Contract Development (yos.io, Yos Riady, 2019) - Developer handbook for smart contract developers.
• Solidity gas optimizations
• Clean Contracts (wslyvh.com, Wesley van Heije, 2020) - Developer guide to writing clean smart contract code.
• The Complete Guide to Full Stack Ethereum Development (dev.to, Nader Dabit, 2021) - Building Full Stack dApps with React, Ethers.js, Solidity, and Hardhat.
• How to create an ERC20 Token and a Solidity Vendor Contract (medium.com, Emanuele Ricci, 2021) - Create your own ERC20 Token and a Token Vendor Contract that will handle the sell/buy process.
• soliditydeveloper.com/blog - Concepts, guides, design patterns and more.

Security

• Capture the Ether - Game in which you hack Ethereum smart contracts to learn about security.
• crytic/awesome-ethereum-security - Curated list of awesome Ethereum security references, guidance, tools, and more.
• crytic/building-secure-contracts - Guidelines and training material to write secure smart contracts.
• crytic/not-so-smart-contracts - Examples of common vulnerabilities, including code from real smart contracts.
• Crypto-Virus/cream-finance-exploit-example - Example implementation of the Cream Finance flashloan exploit.
• d-xo/weird-erc20 - Minimal example implementations of ERC20 tokens with surprising/unexpected behaviour.
• Ethereum Smart Contract Security Best Practices (Consensys) - General security philosophy, known attacks, and sample code.
• Rari-Capital/security-checklist - Opinionated security and code quality checklist for smart contracts.
• SecDim - Online edutainment platform with content on smart contract security using real world examples, as well as online appsec games.
• securing/SCSVS - Smart Contract Security Verification Standard.
• sigp/solidity-security-blog - Comprehensive list of known attack vectors and common anti-patterns.

Audits

• Trail of Bits - Public security audits by the Trail of Bits Team.
• Consensys Diligence - Public security audits by the Consensys Diligence Team.
• MixBytes - Public security audits by the MixBytes Team.

Examples

Educational

• alephao/solidity-benchmarks - Benchmarks of popular implementations of ERC standards.
• cyrusadkisson/solidity-baby-steps - Comprehensive collection of contract examples.
• flashbots/simple-arbitrage - Example arbitrage bot using Flashbots.
• fravoll/solidity-patterns - A collection of patterns and best practices for smart contract development.
• m1guelpf/lil-web3 - Simple, intentionally-limited versions of web3 protocols & apps.
• miguelmota/solidity-idiosyncrasies - Common gotchas, pitfalls, limitations, and idiosyncrasies.
• pedrobergamini/flashloaner-contract - Smart contracts that operate arbitrages between Sushiswap and Uniswap.
• raineorshine/solidity-by-example - A collection of short yet fully-functional contracts that demonstrate language features.
• kauri.io - Archive of kauri community's content created with the goal to foster the spread of Ethereum development knowledge far and wide.
• Solidity By Example - An introduction to the language with simple examples.
• useWeb3 - Learn web3 development - A curated overview of the best and latest resources on Ethereum, Solidity and Web3 development.

Deployed on Ethereum Mainnet

• Abracadabra-money/magic-internet-money - Magic Internet Money (MIM) contracts.
• Synthetixio/synthetix - Synthetix smart contracts.
• Uniswap/uniswap-v3-core - Core smart contracts of Uniswap v3.
• bancorprotocol/contract-solidity - Bancor Protocol contracts.
• compound-finance/compound-protocol - Compound Protocol contracts.
• dharma-eng/dharma-smart-wallet - Smart wallet for earning interest on stablecoins while retaining custody of funds, with an added security backstop provided by Dharma Labs.
• ensdomains/ens-contracts - Ethereum Name Service (ENS) contracts.
• graphprotocol/contracts - Graph Protocol Contracts.
• smartcontractkit/LinkToken - LINK token contracts for the Chainlink Network.
• trusttoken/smart-contracts - TrustToken smart contracts.
• wyvernprotocol/wyvern-v3 - Core smart contracts for Wyvern v3, a decentralized digital asset exchange protocol.

Templates

• ZumZoom/solidity-template - Hardhat template with preconfigured Github Actions and Coveralls support.
• austintgriffith/scaffold-eth - Github template providing an Ethereum dev stack focused on fast product iterations.
• 0xClandestine/solplot A Foundry plugin that enables you to plot charts within solidity.
• ethereum-boilerplate/ethereum-boilerplate - React components and hooks to build dApps fast without running your own backend.
• gakonst/dapptools-template - Forkable template to get you started with Dapp Tools.
• paulrberg/solidity-template - Github template for writing contracts (uses: Hardhat, TypeChain, Ethers, Waffle, Solhint, Solcover, Prettier Plugin Solidity).
• transmissions11/foundry-template - Streamlined template for getting started with Foundry and Solmate.
• kjr217/foundry-python-template - template for getting started with Foundry and Python.
• wighawag/template-ethereum-contracts - Template to develop smart contracts.

Books

• Blockchain in Action - Book that teaches the essential principles of blockchain and how to create your own decentralized apps.
• Mastering Ethereum - Mastering Ethereum is a book for developers, offering a guide to the operation and use of the Ethereum, Ethereum Classic, RootStock (RSK) and other compatible EVM-based open blockchains.

Practice

• ChainShot - Hands-on learning with challenging coding tutorials.
• OpenZeppelin/ethernaut - Ethernaut is a Web3/Solidity based wargame to be played in the Ethereum Virtual Machine. Each level is a smart contract that needs to be 'hacked'.

Libraries

• 0age/AttributeRegistry ERC-1616 Attribute Registry Standard - interface, tests and implementation.
• 0age/Spawner - Spawn EIP 1167 minimal proxies with an included initialization step during contract creation.
• EthWorks/Waffle - Library for writing and testing smart contracts.
• ItsNickBarry/hardhat-abi-exporter - Export contract ABIs on compilation via Hardhat.
• Keydonix/uniswap-oracle - General purpose price feed oracle built on Uniswap v2 that uses merkle proofs under the hood.
• NTA-Capital/SolMATe - Libraries for floating-point matrix manipulation, linear algebra operations, and vector math.
• OpenZeppelin/openzeppelin-contracts - A library for secure smart contract development.
• OpenZeppelin/openzeppelin-contracts-upgradeable - Upgradeable variant of OpenZeppelin Contracts, meant for use in upgradeable contracts.
• Smart Contracts Skeleton - Preconfigured skeleton repository for building or starting with development of Smart contracts.
• Uniswap/merkle-distributor - Smart contract that distributes a balance of tokens according to a merkle root.
• Uniswap/uniswap-v3-periphery - Peripheral smart contracts for interacting with Uniswap V3.
• alexvansande/ENSTools - A set of contracts to extend ENS functionality to other smart contracts.
• Solidity Standard Library - Standard library (Array, random, math, string).
• dapphub/dappsys - Contract system framework for flexible multi-contract dapps.
• Unicode Ethereum Project - Libraries and contracts for Unicode data, algorithms, and utilities.
• dapp-bin - Ethereum repo providing implementations for many common data structures and utilities in Solidity, Serpent and LLL.
• hifi-finance/prb-math - Smart contract library for advanced fixed-point math.
• makerdao/multicall - Aggregate multiple constant function call results into one.
• maple-labs/erc-20 - Maple implementation of the ERC-20 standard.
• mattdf/RingCrypto - Ring signature related implementations for Ethereum.
• Modular Libraries - Deployed utility libraries to use in your smart contracts.
• optionality/clone-factory - Simple clone contract factory. Install a master copy of a contract, then easily (cheaply) create clones with separate state.
• pcaversaccio/xdeployer - Hardhat plugin to deploy your smart contracts across multiple EVM chains with the same deterministic address.
• truffle-assertions - Adds additional assertions and utilities used in testing smart contracts with truffle.
• rugpullindex/indexed-sparse-merkle-tree - Dapptools-ready and gas-optimized implementation of a sparse merkle tree.
• solana-labs/solana-solidity.js - Compile, deploy, and use contracts on Solana.
• solidstate-network/solidstate-solidity - Upgradeable-first smart contract development library.
• studydefi/money-legos - NPM package that provides you with the mainnet addresses, ABIs, and Solidity interfaces for popular DeFi protocols.
• ThirdWeb/Contracts - Pre-built contracts for Token, NFT, Governance and Marketplace from ThirdWeb.
• transmissions11/solmate - Modern, opinionated and gas optimized building blocks for smart contract development.
• wbobeirne/eth-balance-checker - Smart contract and library pair that allows you to check for multiple ERC20 and Ether balances across multiple addresses in a single RPC call.

Tools

General

• Anish-Agnihotri/MultiFaucet - MultiFaucet drips ETH, tokens, and NFTs across many testnet networks, at once.
• EthFiddle - Find, share and embed contracts.
• create-truffle-dapp - CLI to create and deploy Truffle projects with no configuration.
• dapphub/dapptools - Command-line-friendly tools for blockchain development.
• dethcrypto/ethereum-code-viewer - View the source of deployed Ethereum contracts in VSCode.
• eth-brownie/brownie - Python-based development and testing framework for smart contracts targeting the Ethereum Virtual Machine.
• gakonst/foundry - Blazing fast, portable and modular toolkit for Ethereum application development written in Rust.
• dapp-scratch - CLI for generating javascript modules from Contracts for Decentralized Apps.
• instant-dapp-ide - Complete Dapp and Solidity development environment as a docker image you can run from command line.
• Hardhat - Development environment to compile, deploy, test, and debug your Ethereum software.
• Laika - Make requests to smart contracts without the hassle of writing a single line of code.
• EthereumStudio - Standalone desktop IDE.
• solidity-docgen - Documentation generator for Solidity projects.
• solgraph - Visualize control flows for smart contract security analysis.
• raineorshine/solidity-repl - REPL CLI.
• OpenZeppelin - Framework to build secure smart contracts.
• Tenderly - Easily monitor your smart contracts with error tracking, alerting, performance metrics, and detailed contract analytics.
• tintinweb/solidity-shell - An interactive Solidity shell with lightweight session recording.
• weiroll/weiroll - A simple and efficient operation-chaining/scripting language for the EVM.

Utility

• Aniket-Engg/sol-profiler - CLI tool to list & store solidity smart contract methods attributes.
• DiverseSolutions/Diverse-Eth-Calculator - Website with Ethereum unit conversion & utility components.
• ItsNickBarry/hardhat-contract-sizer - Output contract sizes with Hardhat.
• cleanunicorn/abi2signature - Use the ABI of a smart contract to find out the function signatures.
• duaraghav8/Ethlint - Linter to identify and fix style & security issues in smart contracts.
• prettier-solidity/prettier-plugin-solidity - Prettier plugin for automatically formatting your code.
• protofire/solhint - Solidity linter that provides security, style guide and best practice rules for smart contract validation.
• sambacha/prettier-config-solidity - Prettier config optimized to reduce AST churn & conform to the Solidity spec.
• sc-forks/solidity-coverage - Code coverage tool.
• Tenderly/tenderly-cli - Speed up your development with error stack traces.
• tintinweb/solgrep - A scriptable semantic grep utility for Solidity.

Audit

• a16z/metamorphic-contract-detector - Check whether a given contract exhibits red flags that could indicate the potential for metamorphism instead of immutability.
• Manticore - Detects many common bug types, and can prove correctness properties with symbolic execution.
• Mythril - Security analysis tool for smart contracts.
• ethereum/sourcify - Re-compiler that can be used to verify that bytecode corresponds to certain source code.
• Slither - Static analyzer with support for many common bug types, including visualization tools for security-relevant information.
• MythX - Detection for security vulnerabilities in Ethereum smart contracts throughout the development life cycle

DevOps

• Embark - Framework that allows you to easily develop and deploy DApps.
• solidity-sizer - GitHub Action that adds a comment to the PR indicating the size of contracts, including size differences.

Languages

JavaScript

• deno-web3/solc - Solidity bindings for Deno.
• solc-js - JavaScript bindings for the Solidity compiler.
• solidity-parser - Solidity parser built in JavaScript.
• sulk - Configurable contract compilation.

TypeScript

• Soltsice - Generates strongly-typed TypeScript classes for contracts from Truffle artifacts with a single command.
• TypeChain - TypeScript bindings for Ethereum smart contracts.

Rust

• hyperledger-labs/solang - A Solidity-to-WASM-and-BPF compiler written in Rust.
• rust-ethereum/ethabi -Encode and decode smart contract invocations.

OCaml

• ocaml-solidity - OCaml library providing a parser, a typechecker and miscellaneous utilities for manipulating contracts.

Editor Plugins

Eclipse

• uml2solidity - Model smart contracts with UML.

Emacs

• emacs-solidity - Solidity mode for Emacs.
• company-solidity - Autocomplete with company-mode.

IntelliJ

• intellij-solidity - Solidity plugin for IntelliJ.

Sublime

• SublimeEthereum - Solidity syntax for SublimeText.

Vim

• solidity.vim - Vim compiler plugin.
• vim-solidity - Vim syntax file.

Visual Studio Code

👉 For a comprehensive list, see results for "Solidity" on Visual Studio Marketplace.

• ConsenSys/vscode-solidity-auditor - Language support and visual security auditor for Visual Studio Code.
• sol-profiler-vscode - Visual Code Extension to generate & store smart contract methods profile.
• vscode-solidity - Visual Studio Code language support extension.
• Ethereum Security Bundle - A meta-extension bundling marketplace plugins for secure Ethereum smart contract development.
• Solidity Visual Developer - Visual Security audit, Security centric syntax and semantic highlighting, detailed class outline, UML diagram generator, and many more features.
• Solidity Contract Flattener - Flatten Solidity Contracts using truffle-flattener
• Solidity + Hardhat - Adds general support for Solidity contracts development with features user expect to find in an IDE (code formatting, linting, prettifier, snippets, go to references, and so on). Go to choice for those relying on VSCode and Hardhat in their projects.
• Truffle for VS Code - Truffle for VS Code simplifies how you create, build, debug and deploy smart contracts on Ethereum and all EVM-compatible blockchains and layer 2 scaling solutions.
• More blockchain resources