Update docs

2023-09-19 19:19:10 +00:00
commit dbe796d542
624 changed files with 107720 additions and 0 deletions
--- a/test/utils/structs/BitMap.test.js
+++ b/test/utils/structs/BitMap.test.js
@ -0,0 +1,145 @@
+const { BN } = require('@openzeppelin/test-helpers');
+const { expect } = require('chai');
+
+const BitMap = artifacts.require('$BitMaps');
+
+contract('BitMap', function () {
+  const keyA = new BN('7891');
+  const keyB = new BN('451');
+  const keyC = new BN('9592328');
+
+  beforeEach(async function () {
+    this.bitmap = await BitMap.new();
+  });
+
+  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);
+  });
+
+  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);
+    });
+
+    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);
+    });
+
+    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);
+    });
+  });
+
+  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);
+    });
+
+    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);
+    });
+
+    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);
+    });
+  });
+
+  describe('unset', function () {
+    it('removes added keys', async 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);
+    });
+
+    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);
+    });
+
+    it('adds and removes multiple keys', async function () {
+      // []
+
+      await this.bitmap.$set(0, keyA);
+      await this.bitmap.$set(0, keyC);
+
+      // [A, C]
+
+      await this.bitmap.$unset(0, keyA);
+      await this.bitmap.$unset(0, keyB);
+
+      // [C]
+
+      await this.bitmap.$set(0, keyB);
+
+      // [C, B]
+
+      await this.bitmap.$set(0, keyA);
+      await this.bitmap.$unset(0, keyC);
+
+      // [A, B]
+
+      await this.bitmap.$set(0, keyA);
+      await this.bitmap.$set(0, keyB);
+
+      // [A, B]
+
+      await this.bitmap.$set(0, keyC);
+      await this.bitmap.$unset(0, keyA);
+
+      // [B, C]
+
+      await this.bitmap.$set(0, keyA);
+      await this.bitmap.$unset(0, keyB);
+
+      // [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);
+    });
+  });
+});