Waffle Documentation

Waffle is a library for writing and testing smart contracts.

Sweeter, simpler and faster than Truffle.

Works with ethers-js.

Philosophy:

• Simpler: Minimalistic, few dependencies.

• Sweeter: Nice syntax, easy to extend.

• Faster: Focus on the speed of tests execution.

Features:

• Sweet set of chai matchers,

• Easy contract importing from npm modules,

• Fast compilation with native and dockerized solc,

• Typescript compatible,

• Fixtures that help write fast and maintainable test suites,

• Well documented.

Versions and ethers compatibility

• Use version 0.2.3 with ethers 3 and solidity 4,

• Use version 1.2.0 with ethers 4 and solidity 4,

• Use version 2.*.* with ethers 4, solidity 4, 5 and ability to use native or dockerized solc.

Contents:

• Getting Started
  • Installation
  • Writing a contract
  • Compiling the contract
  • Flattener
  • Writing tests
  • Running tests
• Compilation
  • Using third party libraries
  • Reducing compile times
  • Using native solc
  • Using dockerized solc
  • Experimental Using dockerized vyper
• Basic testing
  • Creating a provider
  • Getting wallets
  • Setup ENS
  • Deploying contracts
  • Linking
• Chai matchers
  • Bignumbers
  • Emitting events
  • Called on contract
  • Called on contract with arguments
  • Revert
  • Revert with message
  • Change balance
  • Change balance (multiple accounts)
  • Proper address
  • Proper private key
  • Proper hex
• Fixtures
• Configuration
  • Configuration file
  • Other configuration file formats
  • Setting Solidity compiler version
  • Usage with Truffle
  • Custom compiler options
  • KLAB compatibility
  • Monorepo
  • Usage with Lernajs
• Mock contract
  • Usage
  • Example
• ENS
  • Creating a ENS
  • Creating top level domain
  • Creating sub domain
  • Setting address