Convert Figma logo to code with AI

bkrem logoawesome-solidity

⟠ A curated list of awesome Solidity resources, libraries, tools and more

6,844
961
6,844
17
View on GitHub

Top Related Projects

OpenZeppelin's avatar

openzeppelin-contracts

25,709

OpenZeppelin Contracts is a library for secure smart contract development.

ethereum's avatar

solidity

24,310

Solidity, the Smart Contract Programming Language

crytic's avatar

awesome-ethereum-security

1,384

A curated list of awesome Ethereum security references

smartcontractkit's avatar

chainlink

7,385

node of the decentralized oracle network, bridging on and off-chain computation

trufflesuite's avatar

truffle

13,998

:warning: The Truffle Suite is being sunset. For information on ongoing support, migration options and FAQs, visit the Consensys blog. Thank you for all the support over the years.

Quick Overview

The bkrem/awesome-solidity repository is a curated list of awesome Solidity resources, tools, and libraries. It aims to provide a comprehensive collection of materials for developers working with the Solidity programming language, which is used for writing smart contracts on the Ethereum blockchain.

Pros

  • Comprehensive Collection: The repository covers a wide range of Solidity-related resources, including tutorials, libraries, tools, and best practices.
  • Regularly Updated: The project is actively maintained, with new resources being added and existing ones being updated regularly.
  • Community-Driven: The repository is a collaborative effort, with contributions from the Solidity community, ensuring a diverse and up-to-date collection of resources.
  • Organized Structure: The resources are categorized and organized in a clear and intuitive manner, making it easy for developers to find the information they need.

Cons

  • Potential Duplication: As a community-driven project, there may be some overlap or duplication of resources, which could make it slightly more challenging to navigate.
  • Varying Quality: The quality of the resources listed may vary, as they are contributed by different sources, and there is no strict quality control process.
  • Limited Depth: While the repository provides a broad overview of Solidity resources, it may not offer in-depth coverage or detailed explanations for some topics.
  • Dependency on External Sources: The usefulness of the repository is largely dependent on the continued availability and maintenance of the external resources it links to.

Code Examples

This repository is a curated list of resources and does not contain any code examples itself. However, the resources listed within the repository may provide various Solidity code examples for different use cases and functionalities.

Getting Started

As this is a curated list of resources and not a code library, there are no specific getting started instructions. However, users can follow these general steps to get started with the bkrem/awesome-solidity repository:

  1. Visit the bkrem/awesome-solidity repository on GitHub.
  2. Browse the table of contents to find the categories and resources that are most relevant to your needs.
  3. Click on the links to the external resources to explore tutorials, libraries, tools, and other materials related to Solidity development.
  4. Refer to the individual resource pages for any specific installation, setup, or usage instructions.
  5. Contribute to the repository by submitting new resources or updating existing ones through pull requests, if desired.

Competitor Comparisons

OpenZeppelin logo

openzeppelin-contracts

25,709

OpenZeppelin Contracts is a library for secure smart contract development.

Pros of openzeppelin-contracts

  • Provides a comprehensive library of secure, tested, and community-audited smart contracts
  • Regularly updated and maintained by a dedicated team of developers
  • Offers standardized implementations of common contract patterns and ERC standards

Cons of openzeppelin-contracts

  • Focuses solely on contract implementations, lacking broader resources and tools
  • May require more in-depth knowledge to utilize effectively compared to a curated list

Code Comparison

openzeppelin-contracts:

contract ERC20 is Context, IERC20, IERC20Metadata {
    mapping(address => uint256) private _balances;
    mapping(address => mapping(address => uint256)) private _allowances;
    uint256 private _totalSupply;
    string private _name;
    string private _symbol;
    // ... (additional implementation)
}

awesome-solidity:

## Libraries
- [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts) - A library for secure smart contract development.
- [solmate](https://github.com/Rari-Capital/solmate) - Modern, opinionated and gas optimized building blocks for smart contract development.

Summary

openzeppelin-contracts provides a robust library of smart contract implementations, while awesome-solidity offers a curated list of Solidity resources. The former is more focused on practical code, while the latter serves as a comprehensive guide to the Solidity ecosystem. Developers may find both repositories valuable for different aspects of their Solidity development journey.

ethereum logo

solidity

24,310

Solidity, the Smart Contract Programming Language

Pros of Solidity

  • Official Ethereum repository for the Solidity language
  • Contains the actual Solidity compiler implementation
  • Provides comprehensive documentation and language specifications

Cons of Solidity

  • Focused solely on the Solidity language, not a curated list of resources
  • May be overwhelming for beginners looking for learning materials
  • Less community-driven content compared to Awesome Solidity

Code Comparison

Solidity (main repository):

pragma solidity ^0.8.0;

contract SimpleStorage {
    uint256 private storedData;

    function set(uint256 x) public {
        storedData = x;
    }
}

Awesome Solidity (example from a linked resource):

pragma solidity ^0.8.0;

contract Counter {
    uint public count;

    function increment() public {
        count += 1;
    }
}

Summary

Solidity is the official repository for the Solidity programming language, containing the compiler implementation and detailed specifications. It's ideal for developers working directly with the language or contributing to its development.

Awesome Solidity, on the other hand, is a curated list of Solidity resources, tutorials, and tools. It's more suitable for developers looking to learn Solidity or find helpful resources for their projects.

While Solidity provides the core language implementation, Awesome Solidity offers a community-driven collection of learning materials and tools to support Solidity development.

crytic logo

awesome-ethereum-security

1,384

A curated list of awesome Ethereum security references

Pros of awesome-ethereum-security

  • More focused on security aspects of Ethereum and smart contract development
  • Includes tools, guidelines, and resources specifically for auditing and vulnerability detection
  • Regularly updated with the latest security practices and tools

Cons of awesome-ethereum-security

  • Narrower scope, primarily covering security-related topics
  • May be less accessible for beginners due to its specialized focus
  • Fewer general-purpose Solidity development resources

Code comparison

awesome-solidity example:

pragma solidity ^0.8.0;

contract SimpleStorage {
    uint256 private storedData;

    function set(uint256 x) public {
        storedData = x;
    }
}

awesome-ethereum-security example (security pattern):

pragma solidity ^0.8.0;

contract SecureStorage {
    uint256 private storedData;
    address private owner;

    constructor() {
        owner = msg.sender;
    }

    function set(uint256 x) public {
        require(msg.sender == owner, "Only owner can set data");
        storedData = x;
    }
}

Summary

awesome-solidity provides a broader range of resources for Solidity development, including tutorials, libraries, and tools. It's more suitable for developers looking for general Solidity knowledge and resources.

awesome-ethereum-security focuses specifically on security aspects of Ethereum and smart contract development. It's ideal for developers and auditors looking to enhance their understanding of blockchain security practices and tools.

smartcontractkit logo

chainlink

7,385

node of the decentralized oracle network, bridging on and off-chain computation

Pros of Chainlink

  • Comprehensive blockchain oracle solution with production-ready code
  • Active development and maintenance by a dedicated team
  • Extensive documentation and integration guides for developers

Cons of Chainlink

  • Focused specifically on oracle functionality, not a general Solidity resource
  • Steeper learning curve for beginners compared to a curated list
  • Requires more setup and infrastructure to use effectively

Code Comparison

Chainlink (smart contract integration):

import "@chainlink/contracts/src/v0.8/ChainlinkClient.sol";

contract MyContract is ChainlinkClient {
    using Chainlink for Chainlink.Request;
    // ... (contract implementation)
}

Awesome Solidity (example from a linked resource):

pragma solidity ^0.8.0;

contract SimpleStorage {
    uint256 private storedData;
    
    function set(uint256 x) public {
        storedData = x;
    }
}

Summary

Chainlink is a robust oracle solution for blockchain developers, offering production-ready code and extensive documentation. However, it has a narrower focus compared to Awesome Solidity, which serves as a curated list of Solidity resources. Chainlink is more suitable for developers working on projects requiring external data integration, while Awesome Solidity provides a broader overview of Solidity development resources and tools.

trufflesuite logo

truffle

13,998

:warning: The Truffle Suite is being sunset. For information on ongoing support, migration options and FAQs, visit the Consensys blog. Thank you for all the support over the years.

Pros of Truffle

  • Comprehensive development environment with built-in testing framework and asset pipeline
  • Active community and regular updates
  • Integrated with popular tools like Ganache for local blockchain development

Cons of Truffle

  • Steeper learning curve for beginners compared to a curated list
  • More opinionated and less flexible than a collection of resources
  • Requires installation and setup, unlike a simple list of links

Code Comparison

Truffle configuration example:

module.exports = {
  networks: {
    development: {
      host: "127.0.0.1",
      port: 8545,
      network_id: "*"
    }
  }
};

Awesome Solidity doesn't contain code, but rather links to resources. For example:

## Tutorials
- [CryptoZombies](https://cryptozombies.io/) - Interactive code school that teaches Solidity through building your own crypto-collectibles game.

Summary

Truffle is a full-featured development environment for Ethereum, offering a complete suite of tools for smart contract development, testing, and deployment. It provides a more structured approach to Solidity development but requires more setup and has a steeper learning curve.

Awesome Solidity, on the other hand, is a curated list of resources for Solidity development. It offers a wide range of links to tutorials, tools, and libraries, making it easier for developers to find relevant information quickly. However, it doesn't provide a unified development environment like Truffle does.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

Awesome Solidity

awesome list badge build status badge GitHub contributors pull requests welcome badge support via gitcoin badge

A curated list of awesome Solidity resources, libraries, tools and more.

Please check the contribution guidelines for information on formatting and writing pull requests.

Contents

Resources

Official

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.
  • CryptoZombies - Interactive code school that teaches you to write smart contracts through building your own crypto-collectibles game.
  • cryptodevhub.io - Community-driven effort to unite like-minded people interested in Blockchain- and Crypto Technologies.
  • Discover Ethereum & Solidity (ludu.co) - Complete course that takes you through the process of creating a decentralized Twitter clone using best practices.
  • ExtropyIO/defi-bot - Tutorial for building DeFi arbitrage bots.
  • karmacoma-eth/sending-ether-cheat-sheet - Tips and best practices for sending Ether.
  • LearnXInY - Learn Solidity in 15 mins (for experienced devs).
  • manojpramesh/solidity-cheatsheet - Cheat sheet and best practices.
  • Questbook - Questbook is building a University DAO where learning is always free. Starting with crypto-dev courses by leading devs.
  • Solidity and Vyper cheat sheet - Review syntax of both languages side-by-side.
  • topmonks/solidity_quick_ref - Syntax overview.
  • 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.
  • useweb3.xyz/tutorials - A curated list of free, community tutorials that are based around specific projects, tasks or challenges.
  • WTF Solidity - An open-source and community reviewed tutorial in Chinese and English, covering intro, advanced, and application topics.
  • WTF Ethers - An open-source and community reviewed Ethers.js tutorial in Chinese covering intro and advanced topics [Chinese Language - 中文版].

Articles

Security

Audits

Examples

Educational
Deployed on Ethereum Mainnet

Templates

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/damn-vulnerable-defi - A set of challenges to hack implementations of DeFi in Ethereum.
  • 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'.

Jobs

Libraries

Tools

General

  • Anish-Agnihotri/MultiFaucet - MultiFaucet drips ETH, tokens, and NFTs across many testnet networks, at once.
  • create-truffle-dapp - CLI to create and deploy Truffle projects with no configuration.
  • dapp-scratch - CLI for generating javascript modules from Contracts for Decentralized Apps.
  • dethcrypto/ethereum-code-viewer - View the source of deployed Ethereum contracts in VSCode.
  • dapphub/dapptools - Command-line-friendly tools for blockchain development.
  • eagr/sol-repl - Lightweight, feature-rich REPL for instant feedback.
  • eth-brownie/brownie - Python-based development and testing framework for smart contracts targeting the Ethereum Virtual Machine.
  • EthFiddle - Find, share and embed contracts.
  • EthereumStudio - Standalone desktop IDE.
  • foundry-rs/foundry - Blazing fast, portable and modular toolkit for Ethereum application development written in Rust.
  • 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.
  • naddison36/sol2uml - Unified Modeling Language (UML) class diagram generator for smart contracts.
  • OpenZeppelin - Framework to build secure smart contracts.
  • raineorshine/solidity-repl - REPL CLI.
  • Remix - Online realtime compiler and runtime.
  • SIF - Code generation from the AST, analyse and instrument source code.
  • Smart Contract Sanctuary - A home for ethereum smart contracts, all verified smart contracts from Etherscan.
  • Sourcify - Decentralized and open-sourced smart contract verification service.
  • solgraph - Visualize control flows for smart contract security analysis.
  • sol-merger - Merges all imports into single file for contracts.
  • solidity-docgen - Documentation generator for Solidity projects.
  • Tenderly - Easily monitor your smart contracts with error tracking, alerting, performance metrics, and detailed contract analytics.
  • Truffle - Development environment, testing framework and asset pipeline for Ethereum.
  • 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

Audit

  • a16z/metamorphic-contract-detector - Check whether a given contract exhibits red flags that could indicate the potential for metamorphism instead of immutability.
  • Echidna - Define properties for your smart contract then use fuzzing to catch security bugs.
  • 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.
  • eth-sri/securify2 - Tool for analyzing smart contracts for vulnerabilities and insecure coding.
  • 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.
  • Moesif - Service that provides Ethereum smart contract analytics and anomaly detection for DApps and DAPIs.
  • 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

OCaml

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

Editor Plugins

Eclipse

Emacs

IntelliJ

Sublime

Vim

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.
  • Ethereum Security Bundle - A meta-extension bundling marketplace plugins for secure Ethereum smart contract development.
  • sol-profiler-vscode - Visual Code Extension to generate & store smart contract methods profile.
  • vscode-solidity - Visual Studio Code language support extension.
  • 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.

License

CC0

To the extent possible under law, Ben Kremer has waived all copyright and related or neighboring rights to this work.