Is there ERC20 token test library?

Question

I have a custom ERC20 token project and I would like to cover the token behaviour with tests. As the ERC20 interface is standardized I wonder whether there are some libraries to test ERC20 functionality or to help me with it?

I use truffle in my project so I prefer tests specifically for this framework but it is not required.

Answer 1

I haven't found out nothing similar to what I was looking for. Hence I have came up with the custom package:

https://github.com/CryptoverseRocks/token-test-suite

With this package all the tests are already written. Just configure and run the test suite contained!

Answer 2

Take a look at the heavily audited ERC20 token contracts found on github.com/ConsenSys/Tokens and github.com/OpenZeppelin/zeppelin-solidity. You'll find extensive tests using truffle.

Answer 3

If you have existing tests and you don't want to figure out how to integrate @mancze's solution, read on.

The key is to use truffle's builtin ERC20 contract using artifacts.require("ERC20");

const { constants } = require('@openzeppelin/test-helpers')
const ERC20 = artifacts.require("ERC20");

then your test will look like

contract('Your_Contract', (accounts) => {
  beforeEach(async () => {
    `let erc20Instance = await ERC20.new();`
  })

  it('ERC20 should work', async () => {
      await expectRevert(
          erc20Instance.transfer(constants.ZERO_ADDRESS, 42, { from: accounts[1] }),
          'ERC20: transfer to the zero address'
      )
  })
})

This was tested with versions:

1. "@openzeppelin/test-helpers": "^0.5.5",
2. "truffle": "^5.1.24"

so YMMV!