openzeppelin / chai-bn Goto Github PK

https://github.com/ZeppelinSolutions/chai-bn/blob/1900f60a9d5fbba3d44c755e24b5efe2f81d3a1d/chai-bn.js#L1

We could add a default value of BN = require('bn.js'). What do you think? Coupled with #3 it works out nicely I think.

$ npm i --save-dev @types/chai-bn
npm ERR! code E404
npm ERR! 404 Not Found - GET https://registry.npmjs.org/@types%2fchai-bn - Not found

Are there any plans to add types?

Chai's members can be used to test that an array contains certain values, as determined by strict equality or optionally deep equality.

Neither of those is appropriate to test arrays of big numbers (although deep equality works, it isn't ideal). We could maybe make the bignumber property modify members to compare values using bignumber equality?

On the other hand, this same issue shows up with many other Chai assertions, like oneOf...

The isBN function is implemented with duck typing and it should only use the stricter instanceof.

https://github.com/ZeppelinSolutions/chai-bn/blob/4c036a28bd5b5b3e7273199b9520ce788ab1a51d/chai-bn.js#L15-L19

Both Chai and BN should be peerDependencies.

TS types were provided by #10

Hoping that someone can submit these to Definitely Types.

I am not sure as to the etiquette of doing this for a Repo to which I am not an approver. So posting here.

We should provide a way to test for almost-equality: this is very useful when dealing with time, where some sort of tolerance is required.

See chai.closeTo.

https://github.com/ZeppelinSolutions/chai-bn/blob/4c036a28bd5b5b3e7273199b9520ce788ab1a51d/chai-bn.js#L118

https://github.com/ZeppelinSolutions/chai-bn/blob/4c036a28bd5b5b3e7273199b9520ce788ab1a51d/chai-bn.js#L131

See overwriteProperty.