ethereum-waffle

Ethereum Waffle

Sweeter and simpler than truffle. Works with ethers-js. Taste best with chai and ES6.

Philosophy

• Simpler: Set of helpers rather than framework
• Sweeter: Easy to customize and extend

Features:

• Build, deploy link and test solidity based smart contracts
• No need to run mock rpc server
• Easily import contracts from other npms
• Coming soon: Parallel testing

Install:

To start using with npm, type:

npm i ethereum-waffle

or with Yarn:

yarn add ethereum-waffle

Step by step guide

Compiling contracts

To compile you contracts simply type:

npx waffle

Waffle expects your contracts are in contracts directory. The output will be saved in the build directory.

Adding a task

For convince, you can add a task to your package.json. In the sections scripts, add following line:

  "build": "waffle"        

Now you can build you contracts with:

yarn build

Example test

Waffle is test suite agnostic. Here is example test written using mocha:

import chai from 'chai';
import {createMockProvider, deployContract, getWallets} from 'ethereum-waffle';
import ethers from 'ethers';
import BasicToken from './contracts/BasicToken';

const {expect} = chai;

describe('Example', () => {
  let provider;
  let token;
  let wallet;

  beforeEach(async () => {
    provider = createMockProvider();
    [wallet] = await getWallets(provider);
    token = await deployContract(wallet, BasicToken);  
  });
  
  it('Should be able to test', async () => {
    const actualBalance = await token.balanceOf(wallet.address);
    expect(actualBalance.eq(0)).to.be.true;
  });  
});

To run test type in the console:

mocha