Update docs
This commit is contained in:
@ -1,80 +1,84 @@
|
||||
const { BN } = require('@openzeppelin/test-helpers');
|
||||
const { ethers } = require('hardhat');
|
||||
const { expect } = require('chai');
|
||||
const { loadFixture } = require('@nomicfoundation/hardhat-network-helpers');
|
||||
|
||||
const BitMap = artifacts.require('$BitMaps');
|
||||
async function fixture() {
|
||||
const bitmap = await ethers.deployContract('$BitMaps');
|
||||
return { bitmap };
|
||||
}
|
||||
|
||||
contract('BitMap', function () {
|
||||
const keyA = new BN('7891');
|
||||
const keyB = new BN('451');
|
||||
const keyC = new BN('9592328');
|
||||
describe('BitMap', function () {
|
||||
const keyA = 7891n;
|
||||
const keyB = 451n;
|
||||
const keyC = 9592328n;
|
||||
|
||||
beforeEach(async function () {
|
||||
this.bitmap = await BitMap.new();
|
||||
Object.assign(this, await loadFixture(fixture));
|
||||
});
|
||||
|
||||
it('starts empty', async function () {
|
||||
expect(await this.bitmap.$get(0, keyA)).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyB)).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyC)).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyA)).to.be.false;
|
||||
expect(await this.bitmap.$get(0, keyB)).to.be.false;
|
||||
expect(await this.bitmap.$get(0, keyC)).to.be.false;
|
||||
});
|
||||
|
||||
describe('setTo', function () {
|
||||
it('set a key to true', async function () {
|
||||
await this.bitmap.$setTo(0, keyA, true);
|
||||
expect(await this.bitmap.$get(0, keyA)).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyB)).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyC)).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyA)).to.be.true;
|
||||
expect(await this.bitmap.$get(0, keyB)).to.be.false;
|
||||
expect(await this.bitmap.$get(0, keyC)).to.be.false;
|
||||
});
|
||||
|
||||
it('set a key to false', async function () {
|
||||
await this.bitmap.$setTo(0, keyA, true);
|
||||
await this.bitmap.$setTo(0, keyA, false);
|
||||
expect(await this.bitmap.$get(0, keyA)).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyB)).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyC)).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyA)).to.be.false;
|
||||
expect(await this.bitmap.$get(0, keyB)).to.be.false;
|
||||
expect(await this.bitmap.$get(0, keyC)).to.be.false;
|
||||
});
|
||||
|
||||
it('set several consecutive keys', async function () {
|
||||
await this.bitmap.$setTo(0, keyA.addn(0), true);
|
||||
await this.bitmap.$setTo(0, keyA.addn(1), true);
|
||||
await this.bitmap.$setTo(0, keyA.addn(2), true);
|
||||
await this.bitmap.$setTo(0, keyA.addn(3), true);
|
||||
await this.bitmap.$setTo(0, keyA.addn(4), true);
|
||||
await this.bitmap.$setTo(0, keyA.addn(2), false);
|
||||
await this.bitmap.$setTo(0, keyA.addn(4), false);
|
||||
expect(await this.bitmap.$get(0, keyA.addn(0))).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyA.addn(1))).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyA.addn(2))).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyA.addn(3))).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyA.addn(4))).to.equal(false);
|
||||
await this.bitmap.$setTo(0, keyA + 0n, true);
|
||||
await this.bitmap.$setTo(0, keyA + 1n, true);
|
||||
await this.bitmap.$setTo(0, keyA + 2n, true);
|
||||
await this.bitmap.$setTo(0, keyA + 3n, true);
|
||||
await this.bitmap.$setTo(0, keyA + 4n, true);
|
||||
await this.bitmap.$setTo(0, keyA + 2n, false);
|
||||
await this.bitmap.$setTo(0, keyA + 4n, false);
|
||||
expect(await this.bitmap.$get(0, keyA + 0n)).to.be.true;
|
||||
expect(await this.bitmap.$get(0, keyA + 1n)).to.be.true;
|
||||
expect(await this.bitmap.$get(0, keyA + 2n)).to.be.false;
|
||||
expect(await this.bitmap.$get(0, keyA + 3n)).to.be.true;
|
||||
expect(await this.bitmap.$get(0, keyA + 4n)).to.be.false;
|
||||
});
|
||||
});
|
||||
|
||||
describe('set', function () {
|
||||
it('adds a key', async function () {
|
||||
await this.bitmap.$set(0, keyA);
|
||||
expect(await this.bitmap.$get(0, keyA)).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyB)).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyC)).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyA)).to.be.true;
|
||||
expect(await this.bitmap.$get(0, keyB)).to.be.false;
|
||||
expect(await this.bitmap.$get(0, keyC)).to.be.false;
|
||||
});
|
||||
|
||||
it('adds several keys', async function () {
|
||||
await this.bitmap.$set(0, keyA);
|
||||
await this.bitmap.$set(0, keyB);
|
||||
expect(await this.bitmap.$get(0, keyA)).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyB)).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyC)).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyA)).to.be.true;
|
||||
expect(await this.bitmap.$get(0, keyB)).to.be.true;
|
||||
expect(await this.bitmap.$get(0, keyC)).to.be.false;
|
||||
});
|
||||
|
||||
it('adds several consecutive keys', async function () {
|
||||
await this.bitmap.$set(0, keyA.addn(0));
|
||||
await this.bitmap.$set(0, keyA.addn(1));
|
||||
await this.bitmap.$set(0, keyA.addn(3));
|
||||
expect(await this.bitmap.$get(0, keyA.addn(0))).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyA.addn(1))).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyA.addn(2))).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyA.addn(3))).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyA.addn(4))).to.equal(false);
|
||||
await this.bitmap.$set(0, keyA + 0n);
|
||||
await this.bitmap.$set(0, keyA + 1n);
|
||||
await this.bitmap.$set(0, keyA + 3n);
|
||||
expect(await this.bitmap.$get(0, keyA + 0n)).to.be.true;
|
||||
expect(await this.bitmap.$get(0, keyA + 1n)).to.be.true;
|
||||
expect(await this.bitmap.$get(0, keyA + 2n)).to.be.false;
|
||||
expect(await this.bitmap.$get(0, keyA + 3n)).to.be.true;
|
||||
expect(await this.bitmap.$get(0, keyA + 4n)).to.be.false;
|
||||
});
|
||||
});
|
||||
|
||||
@ -83,21 +87,21 @@ contract('BitMap', function () {
|
||||
await this.bitmap.$set(0, keyA);
|
||||
await this.bitmap.$set(0, keyB);
|
||||
await this.bitmap.$unset(0, keyA);
|
||||
expect(await this.bitmap.$get(0, keyA)).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyB)).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyC)).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyA)).to.be.false;
|
||||
expect(await this.bitmap.$get(0, keyB)).to.be.true;
|
||||
expect(await this.bitmap.$get(0, keyC)).to.be.false;
|
||||
});
|
||||
|
||||
it('removes consecutive added keys', async function () {
|
||||
await this.bitmap.$set(0, keyA.addn(0));
|
||||
await this.bitmap.$set(0, keyA.addn(1));
|
||||
await this.bitmap.$set(0, keyA.addn(3));
|
||||
await this.bitmap.$unset(0, keyA.addn(1));
|
||||
expect(await this.bitmap.$get(0, keyA.addn(0))).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyA.addn(1))).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyA.addn(2))).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyA.addn(3))).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyA.addn(4))).to.equal(false);
|
||||
await this.bitmap.$set(0, keyA + 0n);
|
||||
await this.bitmap.$set(0, keyA + 1n);
|
||||
await this.bitmap.$set(0, keyA + 3n);
|
||||
await this.bitmap.$unset(0, keyA + 1n);
|
||||
expect(await this.bitmap.$get(0, keyA + 0n)).to.be.true;
|
||||
expect(await this.bitmap.$get(0, keyA + 1n)).to.be.false;
|
||||
expect(await this.bitmap.$get(0, keyA + 2n)).to.be.false;
|
||||
expect(await this.bitmap.$get(0, keyA + 3n)).to.be.true;
|
||||
expect(await this.bitmap.$get(0, keyA + 4n)).to.be.false;
|
||||
});
|
||||
|
||||
it('adds and removes multiple keys', async function () {
|
||||
@ -137,9 +141,9 @@ contract('BitMap', function () {
|
||||
|
||||
// [A, C]
|
||||
|
||||
expect(await this.bitmap.$get(0, keyA)).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyB)).to.equal(false);
|
||||
expect(await this.bitmap.$get(0, keyC)).to.equal(true);
|
||||
expect(await this.bitmap.$get(0, keyA)).to.be.true;
|
||||
expect(await this.bitmap.$get(0, keyB)).to.be.false;
|
||||
expect(await this.bitmap.$get(0, keyC)).to.be.true;
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user