Skip to content

Management of rental payments and tenancy deposits using Smart Contracts and Ethereum: a tutorial and Proof of Concept.

License

Notifications You must be signed in to change notification settings

Web3-Architects/open-rental

Repository files navigation

Solidity Tutorial (w/ ERC20 & AAVE)

👉👉 LINK TO THE FULL TUTORIAL 👈👈

This is a tutorial for beginners which can be done ideally after completing CryptoZombies!

This repository was created from this Solidity template which contains the following tools:

  • Hardhat: compile and run the smart contracts on a local development network
  • TypeChain: generate TypeScript types for smart contracts
  • Ethers: renowned Ethereum library and wallet implementation
  • Waffle: tooling for writing comprehensive smart contract tests
  • Solhint: linter
  • Solcover code coverage
  • Prettier Plugin Solidity: code formatter

Usage

Pre Requisites

Before running any command, make sure to install dependencies:

$ yarn install

Compile

Compile the smart contracts with Hardhat:

$ yarn compile

TypeChain

Compile the smart contracts and generate TypeChain artifacts:

$ yarn typechain

Lint Solidity

Lint the Solidity code:

$ yarn lint:sol

Lint TypeScript

Lint the TypeScript code:

$ yarn lint:ts

Test

Run the Mocha tests:

$ yarn test

Coverage

Generate the code coverage report:

$ yarn coverage

Clean

Delete the smart contract artifacts, the coverage reports and the Hardhat cache:

$ yarn clean

About

Management of rental payments and tenancy deposits using Smart Contracts and Ethereum: a tutorial and Proof of Concept.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published