Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/blockchainlabsnz/awesome-solidity

A curated list of awesome Solidity resources
https://github.com/blockchainlabsnz/awesome-solidity

List: awesome-solidity

awesome-list best-practices dapp dapps-development ethereum smart-contracts solidity vulnerabilities

Last synced: 3 months ago
JSON representation

A curated list of awesome Solidity resources

Awesome Lists containing this project

README 

        
# Awesome Solidity



![Awesome](awesome_solidity_logo.jpg)



#### Contributing



[Contributors](https://github.com/BlockchainLabsNZ/awesome-solidity/graphs/contributors) are our favourite people, but we also love you readers too, thank you!



✨ **Index** ✨



* [Getting Started](#getting-started)

* [Vulnerabilities](#vulnerabilities)

* [Best practices](#best-practices)

* [Libraries](#libraries)

* [Code Examples](#code-and-patterns-examples)

* [Tools](#tools)

* [Dapps development](#dapps-development)







## Getting Started



* [The Hitchhiker's Guide to Smart Contracts](https://blog.zeppelin.solutions/the-hitchhikers-guide-to-smart-contracts-in-ethereum-848f08001f05)

* Solidity CRUD operations – [part1](https://medium.com/robhitchens/solidity-crud-part-1-824ffa69509a), [part2](https://medium.com/robhitchens/solidity-crud-part-2-ed8d8b4f74ec), [part3](https://medium.com/robhitchens/solidity-crud-epilogue-e563e794fde)

* [Airdrops](https://blog.ricmoo.com/merkle-air-drops-e6406945584d)

- [Note of setting up testing environment](https://github.com/BlockchainLabsNZ/awesome-solidity/blob/master/Note_of_setting_up_testing_environment.md) – A note of how to set up testing environment and avoid annoying errors (on Windows10). Including a few regular tools: testrpc, truffle, mocha.js,truffle flattener, gas-reporter, coveralls, sol-function-profiler, Parity

- [Testing tool errors](https://github.com/BlockchainLabsNZ/awesome-solidity/blob/master/Testing_errors.md) - A list of error messages when running testing tools, and the methods of how to deal with them. Update irregular. Contributions are welcome.



	### Concepts



	* [Blockchain Oracles, Explained](https://cointelegraph.com/explained/blockchain-oracles-explained)

	* [ABI](https://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI)

	* [Keccak256](https://www.slideshare.net/RajeevVerma14/keccakpptx)

	* [A Closer Look At Ethereum Signatures](https://hackernoon.com/a-closer-look-at-ethereum-signatures-5784c14abecc)

	* [Web 3.0 Explained](https://www.youtube.com/watch?v=aPVmd7SyKfQ)

	* [Random numbers](https://ethereum.stackexchange.com/questions/191/how-can-i-securely-generate-a-random-number-in-my-smart-contract)

	* [Velocity of Tokens](https://medium.com/newtown-partners/velocity-of-tokens-26b313303b77)

	* [HD Wallet explained](https://medium.com/bitcraft/hd-wallets-explained-from-high-level-to-nuts-and-bolts-9a41545f5b0)



	### Tutorials



	* [Kauri](https://beta.kauri.io/) – Super collection of up-to-date tutorials and tips on How to build on Ethereum

	* [CryptoZombies: Learn to Code Ethereum DApps By Building Your Own Game](https://cryptozombies.io)

	* [Ethernaut - Smart Contract Hacking Game](https://ethernaut.zeppelin.solutions/)

	* [Hack This Contract Game](http://hackthiscontract.io/)

	* [What's Solidity?](https://www.youtube.com/channel/UCaWes1eWQ9TbzA695gl_PtA/videos) – Youtube tutorials

	* [Building a fully decentralized User profile app on Ethereum and IPFS](https://medium.com/@sebinatx/building-a-fully-decentralized-user-profile-dapp-on-ethereum-and-ipfs-e55afac35718)

	* [Ethereum and Solidity: The Complete Developer's Guide](https://www.udemy.com/ethereum-and-solidity-the-complete-developers-guide/learn/v4/overview) – Udemy course

	* [Become a Blockchain Developer with Ethereum and Solidity](https://www.udemy.com/getting-started-with-ethereum-solidity-development/learn/v4/content) – Udemy course

	* [Creating your own DAO based on Aragon framework](https://medium.com/@joselfgaray/dao-workshop-testnet-b406380894a6)

	* [Test Driven Development for Solidity](https://michalzalecki.com/ethereum-test-driven-introduction-to-solidity/)



	### Short answers to some questions



	* ["Indexed" keyword / filtering logs](https://ethereum.stackexchange.com/questions/8658/what-does-the-indexed-keyword-do#8659)

	* [Execution of Fallback function with more 2300 gas](https://ethereum.stackexchange.com/questions/11237/execution-of-fallback-function-with-more-2300-gas)



	### Typical Business logic



	* [Tokens](logic/tokens.md)

	* Wallets

	* Crowd sale

	* Distribution/Exchange

	* Vesting/Locking



	### News



	* [ICO Alert](https://www.icoalert.com/) – upcoming ICOs

	* [Dappradar](https://dappradar.com) – list of new dapps



	### Blogs



	* [ConsenSys](https://medium.com/@ConsenSys)

	* [Sarah Baker Mills](https://medium.com/@starsoup7) – Design director @Consensys

	* [David Rugendyke](https://medium.com/@darcius) – Rocket Pool developer

	* [Alex Sherbuck](https://medium.com/@alexsherbuck) – market news and hacks observation

	* [Matthew Di Ferrante](https://medium.com/@matthewdif) – Founder @ ZK Labs

	* [Philippe Castonguay](https://medium.com/@PhABC)

	* [Elena Dimitrova](https://blog.colony.io/@elena_di) – Dev at colony.io

	* [Aragon techblog](https://blog.aragon.org/tag/development/)

	* [Eric Elliot's blog about blockchain](https://medium.com/the-challenge)







## Vulnerabilities



* Consensys: [known attacks](http://ethereum-contract-security-techniques-and-tips.readthedocs.io/en/latest/known_attacks/) (updates are irregular)

* Honey Pots: [1](https://medium.com/@gerhard.wagner/the-phenomena-of-smart-contract-honeypots-755c1f943f7b),

[2](https://medium.com/@alexsherbuck/dissecting-an-ethereum-honey-pot-7102d7def5e0), [3](https://medium.com/@jsanjuas/an-analysis-of-a-couple-ethereum-honeypot-contracts-5c07c95b0a8d)



	### Known hacks

	* [Integer Overflow (i.e., proxyOverflow Bug)](http://telegra.ph/Integer-Overflow-ie-proxyOverflow-Bug-Found-in-Multiple-ERC20-Smart-Contracts-04-25) – Found in Multiple ERC20 Smart Contracts

	* [The DAO Hack](http://hackingdistributed.com/2016/06/18/analysis-of-the-dao-exploit/)

	* [Parity Wallet Hack](https://medium.freecodecamp.org/a-hacker-stole-31m-of-ether-how-it-happened-and-what-it-means-for-ethereum-9e5dc29e33ce)

	* [Parity Wallet Hack II](https://hackernoon.com/parity-wallet-hack-2-electric-boogaloo-e493f2365303)

	* [How $800K Evaporated from PoWH Ponzi](https://blog.goodaudience.com/how-800k-evaporated-from-the-powh-coin-ponzi-scheme-overnight-1b025c33b530)







## Best practices



### Security



* [Ethereum Smart Contract Security Best Practices (Consensys) ](https://consensys.github.io/smart-contract-best-practices/)

* [Exceptions on overflow](https://github.com/ethereum/solidity/issues/796#issuecomment-253578925)



### Gas spending



* [How to write an optimized (gas-cost) smart contract?](https://ethereum.stackexchange.com/questions/28813/how-to-write-an-optimized-gas-cost-smart-contract/28818)

* [Gas Costs from Yellow paper](https://docs.google.com/spreadsheets/d/1n6mRqkBz3iWcOlRem_mO09GtSKEKrAsfO7Frgx18pNU/edit#gid=0)

* [Under-Optimized Smart Contracts Devour Your Money](https://arxiv.org/pdf/1703.03994.pdf) (.pdf)

* [public vs external](https://ethereum.stackexchange.com/questions/19380/external-vs-public-best-practices?answertab=active#tab-top) – latter is twice cheaper (496 vs 261)



### Common design principles



* [Off-Chain Whitelist with On-Chain Verification for Ethereum Smart Contracts](https://medium.com/@PhABC/off-chain-whitelist-with-on-chain-verification-for-ethereum-smart-contracts-1563ca4b8f11)

* [Library Driven Development in Solidity](https://blog.aragon.one/library-driven-development-in-solidity-2bebcaf88736), and [SOLDOC#Libraries](https://solidity.readthedocs.io/en/develop/contracts.html#libraries)

* [Reversing Ethereum Smart Contracts](https://arvanaghi.com/blog/reversing-ethereum-smart-contracts/) – smart contract reverse engineering

* [A Crash Course for Mechanism Design](https://medium.com/blockchannel/a-crash-course-in-mechanism-design-for-cryptoeconomic-applications-a9f06ab6a976)



### ERCs



- [ERC-20](https://eips.ethereum.org/EIPS/eip-20) - original token contract for fungible assets  [ [The Anatomy of ERC20](https://medium.com/blockchannel/the-anatomy-of-erc20-c9e5c5ff1d02) / [Example](https://theethereum.wiki/w/index.php/ERC20_Token_Standard) ]

- [ERC-165](https://eips.ethereum.org/EIPS/eip-165) - creates a standard method to publish and detect what interfaces a smart contract implements

- [ERC-173](https://eips.ethereum.org/EIPS/eip-173) - a standard interface for ownership of contracts

- [ERC-223](https://github.com/ethereum/EIPs/issues/223) – contracts with safety methods that allow return tokens sent accidentally to the contract address

- [ERC-721](https://github.com/ethereum/eips/issues/721) - token standard for non-fungible assets [ [Walking Through the ERC721 Full Implementation 

](https://medium.com/blockchannel/walking-through-the-erc721-full-implementation-72ad72735f3c) ]

- [ERC-725](https://eips.ethereum.org/EIPS/eip-725) - proxy contract for key management and execution, to establish a Blockchain identity

- [ERC-827](https://github.com/ethereum/EIPs/issues/827) – transfers/approvals with calls

- [ERC-875](https://github.com/ethereum/EIPs/issues/875) - for non fungible tokens and simple atomic swaps

- [ERC-918](https://eips.ethereum.org/EIPS/eip-918) - mineable Token Standard

- [ERC Token Standards for Dummies, Like Me](https://decentral.market/2018/03/04/erc-token-standards-for-dummies-like-me/) – ERC20, ERC223, ERC827, ERC721 short review with major points and concerns



### EIPs

* [Ethereum Natural Specification Format](https://github.com/ethereum/wiki/wiki/Ethereum-Natural-Specification-Format)

* [EIP821](https://github.com/ethereum/EIPs/issues/821) – EIP (not ERC) 821. Contracts for Non Fungible Tokens (NFTs)

* [A New Advanced Token Standard](https://github.com/ethereum/EIPs/issues/777) – Contract defines operators to send tokens on behalf of another address – contract or regular account



### Other



* [Style Guide](http://solidity.readthedocs.io/en/develop/style-guide.html#function-declaration) – Follow the style guide to make solidity codes layout look pretty

* [Upgradable contracts](upgradable-contracts.md)







## Libraries



### Standard contracts



- [OpenZeppelin Contracts](https://github.com/OpenZeppelin/zeppelin-solidity) – A framework to build secure smart contracts on Ethereum

- [OpenZeppelin Base Tokens](https://github.com/OpenZeppelin/zeppelin-solidity/tree/master/contracts/token) – Collection of basic token skeletons to extend

- [MiniMe Token](https://github.com/Giveth/minime) – The MiniMeToken contract is a standard ERC20 token with extra functionality

- [aragonOS](https://hack.aragon.org/docs/aragonos-intro.html) – A smart contract framework for building DAOs, Dapps and protocols

- [Gnosis MultiSig](https://github.com/gnosis/MultiSigWallet) – Popular multisig deployed by the likes of District0x, Golem, andon, Bancor, and more

- [Status.im Crowdsale](https://github.com/status-im/status-network-token/tree/master/contracts) – Crowdsale contracts from Status

- [cryptofin-solidity](https://github.com/cryptofinlabs/cryptofin-solidity) - A collection of Solidity libraries for building secure and gas-efficient smart contracts on Ethereum.

- [Modular Libraries](https://github.com/Modular-Network/ethereum-libraries) - A group of packages built for use on blockchains utilising the Ethereum Virtual Machine

- [DateTime Library](https://github.com/bokkypoobah/BokkyPooBahsDateTimeLibrary) - A gas-efficient Solidity date and time library

- [Aragon](https://github.com/aragon/aragon) - DAO protocol. Contains [aragonOS smart contract framework](https://github.com/aragon/aragonOS) with focus on upgradeability and governance

- [0x](https://github.com/0xProject) - DEX protocol

- [Token Libraries with Proofs](https://github.com/sec-bit/tokenlibs-with-proofs) - Contains correctness proofs of token contracts wrt. given specifications and high-level properties



### Utils



- [SafeMath](https://github.com/OpenZeppelin/zeppelin-solidity/blob/master/contracts/math/SafeMath.sol) – Safely perform mathematical operations

- [Solidity String Utils](https://github.com/Arachnid/solidity-stringutils) (use with care)

- [Easily Send Many Tokens to Many Addresses](https://github.com/poanetwork/multisender)

- [BytesHelper](https://github.com/izqui/keybase-ethereum-registry/blob/rocksolid/contracts/BytesHelper.sol) - library to deal with bytes32







## Code and patterns examples



- [Bitwise Operations and Bit Manipulation in Solidity, Ethereum](https://medium.com/@imolfar/bitwise-operations-and-bit-manipulation-in-solidity-ethereum-1751f3d2e216)

- [Upgradable contracts](examples/upgradable-contracts.md) – example

- [Solidity Security Exploits](https://github.com/tenthirtyone/weaponized_math): Re-Entrancy, Denial of Service - Gas, Denial of Service - Revert, Force Ether - selfdestruct, Storage Allocation Exploit, Underflow / Overflow, Re-Entrancy Honey Pot, Function Call Honey Pot[Explanations here](https://medium.com/@alexsherbuck/two-ways-to-force-ether-into-a-contract-1543c1311c56)

- [Not so smart contracts](https://github.com/trailofbits/not-so-smart-contracts) – Another examples of known vulnerabilities

- [Changing contract storage from inside of the Library](examples/libraries.md#changing-contract-storage-from-inside-of-the-library)

- [Emitting events from the Library](examples/libraries.md#emitting-events-from-the-library)

- Chai.js, [BDD approach in testing](http://www.chaijs.com/api/bdd/)

- [Memory vs Storage & How to initialize an array inside a struct](https://medium.com/loom-network/ethereum-solidity-memory-vs-storage-how-to-initialize-an-array-inside-a-struct-184baf6aa2eb)

- [Multisig contracts](https://medium.com/@ChrisLundkvist/exploring-simpler-ethereum-multisig-contracts-b71020c19037) – Simpler Ethereum Multisig Contracts

- [Self-balancing binary search trees](https://hackernoon.com/binary-search-trees-and-order-statistics-for-ethereum-db47e2dd2c36) - BST adapted for Solidity and EVM







## Tools



Check [ConsenSys' Tools List](https://github.com/ConsenSys/ethereum-developer-tools-list) - A great list of frameworks, patterns, and tools from ConsenSys



### Testing tools



- [Truffle](https://github.com/trufflesuite/truffle) – Truffle is a development environment, testing framework and asset pipeline for Ethereum, aiming to make life as an Ethereum developer easier.

- [TestRPC](https://github.com/ethereumjs/testrpc) – Fast Ethereum RPC client for testing and development.

- [Solhint](https://github.com/protofire/solhint) – Solidity linter that provides security, style guide and best practice rules for smart contract validation.

- [Solidity Function Profiler](https://github.com/EricR/sol-function-profiler) -  Analysis report of function signatures, visibility, return values, and modifiers.



### Development tools



- [pocketh](https://github.com/ajsantander/pocketh) – Toolset, provides a series of cli commands that allow you to quickly operate on a contract

- [solc-select](https://github.com/crytic/solc-select) – A script to switch between solidity versions, including solc 0.4.x for MacOS 

- [Web3.js](https://github.com/ethereum/web3.js/) – Ethereum JavaScript API

- [ethers.js](https://github.com/ethers-io/ethers.js/) –  Ethereum wallet implementation and utilities in JavaScript (and TypeScript)

- [Docker images](https://hub.docker.com/r/nzblabs/) / [Audit repo](https://github.com/BlockchainLabsNZ/audit-env) - Solidity testing environment from us (Blockchain Labs, NZ)

- [eth-cli](https://github.com/protofire/eth-cli) – A collection of CLI tools to help with ethereum learning and development

- [11 Best Ethereum Development Tools](https://hackernoon.com/11-best-ethereum-development-tools-to-grow-your-stack-e782fd7156ab)

- [Solidity Doc generator](https://github.com/matt-lough/solidity-docstring-generator) – from Matt Lough

- [Solidity syntax highlighting on Github](https://medium.com/@danielque/psa-how-to-fix-githubs-syntax-highlighting-for-solidity-4e9867c540b6) – howto



### Test Ether faucets



- [Rinkeby faucet](https://faucet.rinkeby.io/)

- [Kovan faucet](https://github.com/kovan-testnet/faucet)

- [Ropsten faucet](http://faucet.ropsten.be:3001/)



### Storage



- [IPFS](https://ipfs.io/) - Decentralised storage and file referencing

	- [IPFS-Store](https://github.com/ConsenSys/IPFS-Store) - IPFS Storage service with added search capability

	- [OrbitDB](https://github.com/orbitdb/orbit-db) - Decentralised database on top of IPFS

	- [JS IPFS API](https://github.com/ipfs/js-ipfs-api) - A client library for the IPFS HTTP API, implemented in JavaScript.

	- [TEMPORAL](https://github.com/RTradeLtd/Temporal) - Easy to use API into IPFS and other distributed/decentralised storage protocols

	- [Infura API](https://infura.io/docs/) - Another API to IPFS

- [Swarm](http://swarm-gateways.net/) - Distributed storage platform and content distribution service, a native base layer service of the Ethereum web3 stack

- [Filecoin](https://filecoin.io) – "DECENTRALIZED MARKET FOR STORAGE". Blockchain on top of IPFS



### Online services



- [Ethereum gas station](https://www.ethgasstation.info)

- [Ethereum unit converter](https://etherconverter.online)







## Dapps development



Helpful information about Dapps.



* [Web3 Design principles](https://medium.com/@lyricalpolymath/web3-design-principles-f21db2f240c1) – Dapps development

* [Blockchain Design Principles](https://medium.com/design-ibm/blockchain-design-principles-599c5c067b6e)

* [How to create a DApp using Truffle, Oraclize, ethereum-bridge and Webpack](https://medium.com/coinmonks/how-to-create-a-dapp-using-truffle-oraclize-ethereum-bridge-and-webpack-9cb84b8f6bcb)

* [Create Blockchain Dapp with Ethereum and VueJS](https://www.danielefavi.com/create-your-blockchain-dapp-with-ethereum-and-vuejs-part-1/)



### Design



* [Designing for the blockchain](https://hackernoon.com/designing-for-the-blockchain-launching-an-ethereum-smart-contract-app-3a972615731c)

* [How to make a user-friendly Ethereum dApp

](https://blog.hellobloom.io/how-to-make-a-user-friendly-ethereum-dapp-5a7e5ea6df22)



### Private networks



- [Local Raiden](https://github.com/ConsenSys/Local-Raiden) - Run a local Raiden network in docker containers for demo and testing purposes

- [Private networks deployment scripts](https://github.com/ConsenSys/private-networks-deployment-scripts) - Out-of-the-box deployment scripts for private PoA networks

- [Parity Demo-PoA Tutorial](https://wiki.parity.io/Demo-PoA-tutorial.html) - Step-by-Step tutorial for building a PoA test chain with 2 nodes with Parity authority round consensus

- [Local Ethereum Network](https://github.com/ConsenSys/local_ethereum_network) - Out-of-the-box deployment scripts for private PoW networks

- [Kaleido](https://kaleido.io/) - Use Kaleido for spinning up a consortium blockchain network. Great for PoCs and testing



### React / Redux



- [React boilerplate](https://github.com/silentcicero/react-dapp-boilerplate)

- [React Truffle Box](https://github.com/truffle-box/react-box)

- [Drizzle](https://github.com/truffle-box/drizzle-box)  - Redux library to connect a frontend to a blockchain

- [Vortex](https://github.com/Horyus/vortex)  - A Dapp-ready Redux Store. Smart and Dynamic background data refresh thanks to WebSockets. Works with Truffle and Embark.



### APIs / subproviders



#### Javascript



- [Web3.js](https://github.com/ethereum/web3.js/)  - Javascript Web3

- [Eth.js](https://github.com/ethjs)  - Javascript Web3 alternative

- [Ethers.js](https://github.com/ethers-io/ethers.js/) - Javascript Web3 alternative, useful utilities and wallet features

- [Web3Wrapper](https://github.com/0xProject/0x-monorepo/tree/v2-prototype/packages/web3-wrapper) - Typescript Web3 alternative

- [Ethereumjs](https://github.com/ethereumjs/)  - A collection of utility functions for Ethereum like ethereumjs-util and ethereumjs-tx

- [Subproviders](https://github.com/0xProject/0x-monorepo/tree/v2-prototype/packages/subproviders)  - Several useful subproviders to use in conjunction with Web3-provider-engine (including a LedgerSubprovider for adding Ledger hardware wallet support to your dApp)

- [web3-webpacked](https://github.com/NoahHydro/web3-webpacked)  - JS framework to manage web3 injection



#### Other languages



- [elm-ethereum](https://github.com/cmditch/elm-ethereum) 

- [purescript-web3](https://github.com/f-o-a-m/purescript-web3) 

- [Web3.py](https://github.com/ethereum/web3.py) - Python Web3

- [Web3.php](https://github.com/sc0Vu/web3.php)  - PHP Web3

- [Ethereum-php](https://github.com/digitaldonkey/ethereum-php)  - PHP Web3

- [Web3j](https://github.com/web3j/web3j)  - Java Web3

- [web3swift](https://github.com/matter-labs/web3swift) - Swift Web3

- [Nethereum](https://nethereum.com/)  - .Net Web3

- [Ethereum.rb](https://github.com/EthWorks/ethereum.rb)  - Ruby Web3

- [Web3.hs](http://hackage.haskell.org/package/web3)  - Haskell Web3

- [KEthereum](https://github.com/walleth/kethereum)  - Kotlin Web3

- [Pyethereum](https://github.com/ethereum/pyethereum)  - The Python core library of the Ethereum project

- [Eventeum](https://github.com/ConsenSys/eventeum)  - A bridge between Ethereum smart contract events and backend microservices, written in Java by Kauri

- [Ethereumex](https://github.com/exthereum/ethereumex)  - Elixir JSON-RPC client for the Ethereum blockchain

- [EthContract](https://github.com/AgileAlpha/eth_contract)  - A set of helper methods to help query ETH smart contracts in Elixir