Skip to content

Commit

Permalink
Add tests for getPastTotalSupply
Browse files Browse the repository at this point in the history
  • Loading branch information
@cygnusv
cygnusv committed Oct 6, 2021
1 parent c44ff0b commit 23664a2
Showing 1 changed file with 123 additions and 9 deletions.
132 changes: 123 additions & 9 deletions test/token/T.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ const {
to1e18,
lastBlockNumber,
lastBlockTime,
mineBlock,
ZERO_ADDRESS,
MAX_UINT96,
} = require("../helpers/contract-test-helpers")
Expand Down Expand Up @@ -51,7 +52,7 @@ describe("T token", () => {
it("should revert", async () => {
await expect(
t.getPriorVotes(tokenHolder.address, await lastBlockNumber())
).to.be.revertedWith("Checkpoints: block not yet mined")
).to.be.revertedWith("Block not yet determined")
})
})
})
Expand Down Expand Up @@ -679,6 +680,13 @@ describe("T token", () => {
})

describe("mint", () => {
context("when minting", () => {
it("historic supply should be tracked", async () => {
const block = await mineBlock()
expect(await t.getPastTotalSupply(block - 1)).to.equal(initialBalance)
})
})

context("when trying to mint more than the checkpoint can store", () => {
context("in one step", () => {
it("should revert", async () => {
Expand Down Expand Up @@ -708,6 +716,24 @@ describe("T token", () => {
await t.connect(deployer).mint(thirdParty.address, initialBalance)
expect(await t.getCurrentVotes(thirdParty.address)).to.equal(0)
})

it("but historical supply should be tracked", async () => {
const block1 = await mineBlock()
expect(await t.getPastTotalSupply(block1 - 1)).to.equal(initialBalance)

await t.connect(deployer).mint(thirdParty.address, initialBalance)
const block2 = await mineBlock()
expect(await t.getPastTotalSupply(block2 - 1)).to.equal(
initialBalance.mul(2)
)

// one more time, when not starting from zero balance
await t.connect(deployer).mint(thirdParty.address, initialBalance)
const block3 = await mineBlock()
expect(await t.getPastTotalSupply(block3 - 1)).to.equal(
initialBalance.mul(3)
)
})
})

context("when delegated to someone else", () => {
Expand All @@ -725,6 +751,26 @@ describe("T token", () => {
)
})

it("historical supply should be tracked", async () => {
const block1 = await mineBlock()
expect(await t.getPastTotalSupply(block1 - 1)).to.equal(
initialBalance.mul(2)
)

await t.connect(deployer).mint(thirdParty.address, initialBalance)
const block2 = await mineBlock()
expect(await t.getPastTotalSupply(block2 - 1)).to.equal(
initialBalance.mul(3)
)

// one more time, when not starting from zero balance
await t.connect(deployer).mint(thirdParty.address, initialBalance)
const block3 = await mineBlock()
expect(await t.getPastTotalSupply(block3 - 1)).to.equal(
initialBalance.mul(4)
)
})

it("should emit DelegateVotesChanged", async () => {
await expect(tx)
.to.emit(t, "DelegateVotesChanged")
Expand All @@ -746,6 +792,26 @@ describe("T token", () => {
)
})

it("historical supply should be tracked", async () => {
const block1 = await mineBlock()
expect(await t.getPastTotalSupply(block1 - 1)).to.equal(
initialBalance.mul(2)
)

await t.connect(deployer).mint(thirdParty.address, initialBalance)
const block2 = await mineBlock()
expect(await t.getPastTotalSupply(block2 - 1)).to.equal(
initialBalance.mul(3)
)

// one more time, when not starting from zero balance
await t.connect(deployer).mint(thirdParty.address, initialBalance)
const block3 = await mineBlock()
expect(await t.getPastTotalSupply(block3 - 1)).to.equal(
initialBalance.mul(4)
)
})

it("should emit DelegateVotesChanged", async () => {
await expect(tx)
.to.emit(t, "DelegateVotesChanged")
Expand Down Expand Up @@ -790,10 +856,22 @@ describe("T token", () => {

const describeBurn = (doBurn) => {
context("when no delegation was done", () => {
const amount = to1e18(10)

beforeEach(async () => {
await doBurn(amount)
})

it("should keep current votes at zero", async () => {
t.connect(tokenHolder).burn(to1e18(10))
expect(await t.getCurrentVotes(tokenHolder.address)).to.equal(0)
})

it("historical supply should be reduced", async () => {
const block1 = await mineBlock()
expect(await t.getPastTotalSupply(block1 - 1)).to.equal(
initialBalance.sub(amount)
)
})
})

context("when delegated to someone else", () => {
Expand Down Expand Up @@ -821,6 +899,13 @@ describe("T token", () => {
initialBalance.sub(amount)
)
})

it("historical supply should be reduced", async () => {
const block1 = await mineBlock()
expect(await t.getPastTotalSupply(block1 - 1)).to.equal(
initialBalance.sub(amount)
)
})
})

context("when self-delegated", () => {
Expand All @@ -847,22 +932,34 @@ describe("T token", () => {
initialBalance.sub(amount)
)
})

it("historical supply should be reduced", async () => {
const block1 = await mineBlock()
expect(await t.getPastTotalSupply(block1 - 1)).to.equal(
initialBalance.sub(amount)
)
})
})

context("when burned several times", () => {
let block1
let block2
let block3

const amount1 = to1e18(3)
const amount2 = to1e18(1)
const amount3 = to1e18(5)
const amount4 = to1e18(2)

beforeEach(async () => {
await t.connect(tokenHolder).delegate(delegatee.address)
await doBurn(to1e18(3))
await doBurn(amount1)
block1 = await lastBlockNumber()
await doBurn(to1e18(1))
await doBurn(amount2)
block2 = await lastBlockNumber()
await doBurn(to1e18(5))
await doBurn(amount3)
block3 = await lastBlockNumber()
await doBurn(to1e18(2))
await doBurn(amount4)
})

it("should update current votes", async () => {
Expand All @@ -874,13 +971,30 @@ describe("T token", () => {

it("should keep track of prior votes", async () => {
expect(await t.getPriorVotes(delegatee.address, block1)).to.equal(
initialBalance.sub(to1e18(3))
initialBalance.sub(amount1)
)
expect(await t.getPriorVotes(delegatee.address, block2)).to.equal(
initialBalance.sub(to1e18(4))
initialBalance.sub(amount1).sub(amount2)
)
expect(await t.getPriorVotes(delegatee.address, block3)).to.equal(
initialBalance.sub(to1e18(9))
initialBalance.sub(amount1).sub(amount2).sub(amount3)
)
})

it("historical supply should decrease every time", async () => {
expect(await t.getPastTotalSupply(block1)).to.equal(
initialBalance.sub(amount1)
)
expect(await t.getPastTotalSupply(block2)).to.equal(
initialBalance.sub(amount1).sub(amount2)
)
expect(await t.getPastTotalSupply(block3)).to.equal(
initialBalance.sub(amount1).sub(amount2).sub(amount3)
)
await mineBlock()
const block4 = (await lastBlockNumber()) - 1
expect(await t.getPastTotalSupply(block4)).to.equal(
initialBalance.sub(amount1).sub(amount2).sub(amount3).sub(amount4)
)
})
})
Expand Down

0 comments on commit 23664a2

Please sign in to comment.