Update docs

This commit is contained in:
github-actions
2023-05-09 19:56:30 +00:00
parent 47e38c7bda
commit 6ae39c4dc1
579 changed files with 30453 additions and 21485 deletions

View File

@ -3,19 +3,19 @@ const { MAX_INT256, MIN_INT256 } = constants;
const { expect } = require('chai');
const SignedSafeMathMock = artifacts.require('SignedSafeMathMock');
const SignedSafeMath = artifacts.require('$SignedSafeMath');
contract('SignedSafeMath', function (accounts) {
contract('SignedSafeMath', function () {
beforeEach(async function () {
this.safeMath = await SignedSafeMathMock.new();
this.safeMath = await SignedSafeMath.new();
});
async function testCommutative (fn, lhs, rhs, expected) {
async function testCommutative(fn, lhs, rhs, expected) {
expect(await fn(lhs, rhs)).to.be.bignumber.equal(expected);
expect(await fn(rhs, lhs)).to.be.bignumber.equal(expected);
}
async function testFailsCommutative (fn, lhs, rhs) {
async function testFailsCommutative(fn, lhs, rhs) {
await expectRevert.unspecified(fn(lhs, rhs));
await expectRevert.unspecified(fn(rhs, lhs));
}
@ -25,28 +25,28 @@ contract('SignedSafeMath', function (accounts) {
const a = new BN('1234');
const b = new BN('5678');
await testCommutative(this.safeMath.add, a, b, a.add(b));
await testCommutative(this.safeMath.$add, a, b, a.add(b));
});
it('adds correctly if it does not overflow and the result is negative', async function () {
const a = MAX_INT256;
const b = MIN_INT256;
await testCommutative(this.safeMath.add, a, b, a.add(b));
await testCommutative(this.safeMath.$add, a, b, a.add(b));
});
it('reverts on positive addition overflow', async function () {
const a = MAX_INT256;
const b = new BN('1');
await testFailsCommutative(this.safeMath.add, a, b);
await testFailsCommutative(this.safeMath.$add, a, b);
});
it('reverts on negative addition overflow', async function () {
const a = MIN_INT256;
const b = new BN('-1');
await testFailsCommutative(this.safeMath.add, a, b);
await testFailsCommutative(this.safeMath.$add, a, b);
});
});
@ -55,7 +55,7 @@ contract('SignedSafeMath', function (accounts) {
const a = new BN('5678');
const b = new BN('1234');
const result = await this.safeMath.sub(a, b);
const result = await this.safeMath.$sub(a, b);
expect(result).to.be.bignumber.equal(a.sub(b));
});
@ -63,7 +63,7 @@ contract('SignedSafeMath', function (accounts) {
const a = new BN('1234');
const b = new BN('5678');
const result = await this.safeMath.sub(a, b);
const result = await this.safeMath.$sub(a, b);
expect(result).to.be.bignumber.equal(a.sub(b));
});
@ -71,14 +71,14 @@ contract('SignedSafeMath', function (accounts) {
const a = MAX_INT256;
const b = new BN('-1');
await expectRevert.unspecified(this.safeMath.sub(a, b));
await expectRevert.unspecified(this.safeMath.$sub(a, b));
});
it('reverts on negative subtraction overflow', async function () {
const a = MIN_INT256;
const b = new BN('1');
await expectRevert.unspecified(this.safeMath.sub(a, b));
await expectRevert.unspecified(this.safeMath.$sub(a, b));
});
});
@ -87,28 +87,28 @@ contract('SignedSafeMath', function (accounts) {
const a = new BN('5678');
const b = new BN('-1234');
await testCommutative(this.safeMath.mul, a, b, a.mul(b));
await testCommutative(this.safeMath.$mul, a, b, a.mul(b));
});
it('multiplies by zero correctly', async function () {
const a = new BN('0');
const b = new BN('5678');
await testCommutative(this.safeMath.mul, a, b, '0');
await testCommutative(this.safeMath.$mul, a, b, '0');
});
it('reverts on multiplication overflow, positive operands', async function () {
const a = MAX_INT256;
const b = new BN('2');
await testFailsCommutative(this.safeMath.mul, a, b);
await testFailsCommutative(this.safeMath.$mul, a, b);
});
it('reverts when minimum integer is multiplied by -1', async function () {
const a = MIN_INT256;
const b = new BN('-1');
await testFailsCommutative(this.safeMath.mul, a, b);
await testFailsCommutative(this.safeMath.$mul, a, b);
});
});
@ -117,7 +117,7 @@ contract('SignedSafeMath', function (accounts) {
const a = new BN('-5678');
const b = new BN('5678');
const result = await this.safeMath.div(a, b);
const result = await this.safeMath.$div(a, b);
expect(result).to.be.bignumber.equal(a.div(b));
});
@ -125,28 +125,28 @@ contract('SignedSafeMath', function (accounts) {
const a = new BN('0');
const b = new BN('5678');
expect(await this.safeMath.div(a, b)).to.be.bignumber.equal('0');
expect(await this.safeMath.$div(a, b)).to.be.bignumber.equal('0');
});
it('returns complete number result on non-even division', async function () {
const a = new BN('7000');
const b = new BN('5678');
expect(await this.safeMath.div(a, b)).to.be.bignumber.equal('1');
expect(await this.safeMath.$div(a, b)).to.be.bignumber.equal('1');
});
it('reverts on division by zero', async function () {
const a = new BN('-5678');
const b = new BN('0');
await expectRevert.unspecified(this.safeMath.div(a, b));
await expectRevert.unspecified(this.safeMath.$div(a, b));
});
it('reverts on overflow, negative second', async function () {
const a = new BN(MIN_INT256);
const b = new BN('-1');
await expectRevert.unspecified(this.safeMath.div(a, b));
await expectRevert.unspecified(this.safeMath.$div(a, b));
});
});
});