Roadmap for future Waffle releases

Note that even though these are features for Waffle 3 we will be rolling them out as part of Waffle 2, issuing deprecation messages when necessary.

Milestone 1

• Add dynamic Smart Contracts mocking (Add dynamic Smart Contracts mocking #109)
• Use truffle-flattener from CLI for convince (Add a flattener for contracts #156)
• Configuration improvements (see below)
• Add support for ENS (Add support for ENS #197)
• Mock matchers expect(...).to.be.called (expect(...).to.be.called #229)

Milestone 2

• Documentation: Examples on recurring patterns and solutions (optional)
• New matchers (New matcher: expect to change balance #9) (optional)
• Enable minimal output (abi and bytecode only)
• Waffle 2 to Waffle 3 migration guide
• Upgrade to Ethers.js 5.x

No milestone

• provider.getWallets() or getWallets() without provider
• replace createMockProvider with new MockProvider(options)
• Support for Vyper
• Show file and line of revert (Display revert location #225 )

Configuration improvements:

• Migrate to a monorepo structure (Waffle monorepo #167)
• Update waffle.json config file schema (Config file improvements #166)
• Simplify specifying solc version in configuration

Planned breaking Changes in Waffle 3.0

• Remove deprecated APIs (Remove deprecated APIs #256 )
• Swap arguments in loadFixture and make provider optional (Issue Swap arguments for fixture #116, PR Swap arguments for fixture #215)
• Automatically recognise .waffle.json config without cli argument
• Introduce MockProviderOptions (instead of Ganache options) in MockProvider constructor
• drop support for contract.interface

Package improvements

• Migrate to CircleCi
• Correctly configure build output (Cleanup published package #164)
• Do not include unnecessary files in the resulting npm package (Cleanup published package #164)

Optional

• Add a custom provider based on ethereumjs-vm
• Explore having built in utility contracts (optional)

Promotion:

• Blog posts on Waffle update (when new features released)
• Blog post series on advanced testing techniuqes
  • Fixture
  • Dynamic mocking
  • ENS mocking
  • Waffle configuration tutorial
• Presentations
  • Apply for Devcon
  • Apply for EthBerlin/Dappcon