mirror of
https://github.com/luxfi/erc-3643.git
synced 2026-10-30 16:58:28 +00:00
5c6a3df5bd
# Version 4.0.1 All tests were rewritten using hardhat instead of truffle for optimisation and improvements (tests now properly check revert messages and emitted events). # Update in contract source: - Compliance module view methods no longer require the modifier `onlyComplianceBound`. - Update to version `4.0.1` - `coverage` folder and `coverage.json` are now ignored. - Update module exports. - Action on push (link & tests) now runs coverage and uploads coverage results to action artifacts. - Action on pre-release and release now runs coverage and uploads coverage results to release artifacts. - Update the license note date to 2023 (previously 2022) - Remove migrations contract # Update documentation - README updated - CONTRIBUTING documentation added - WhitePaper pdf added - remove outdated documentation on transfers --------- Co-authored-by: Joachim <[email protected]>
292 lines
11 KiB
TypeScript
292 lines
11 KiB
TypeScript
import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
|
|
import { expect } from 'chai';
|
|
import { ethers } from 'hardhat';
|
|
import { deployFullSuiteFixture, deploySuiteWithModularCompliancesFixture } from '../fixtures/deploy-full-suite.fixture';
|
|
|
|
describe('Token - Information', () => {
|
|
describe('.setName()', () => {
|
|
describe('when the caller is not the owner', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { anotherWallet },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.connect(anotherWallet).setName('My Token')).to.be.revertedWith('Ownable: caller is not the owner');
|
|
});
|
|
});
|
|
|
|
describe('when the caller is the owner', () => {
|
|
describe('when the name is empty', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.setName('')).to.be.revertedWith('invalid argument - empty string');
|
|
});
|
|
});
|
|
|
|
it('should set the name', async () => {
|
|
const {
|
|
suite: { token },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
const tx = await token.setName('Updated Test Token');
|
|
await expect(tx)
|
|
.to.emit(token, 'UpdatedTokenInformation')
|
|
.withArgs('Updated Test Token', await token.symbol(), await token.decimals(), await token.version(), await token.onchainID());
|
|
expect(await token.name()).to.equal('Updated Test Token');
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('.setSymbol()', () => {
|
|
describe('when the caller is not the owner', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { anotherWallet },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.connect(anotherWallet).setSymbol('UpdtTK')).to.be.revertedWith('Ownable: caller is not the owner');
|
|
});
|
|
});
|
|
|
|
describe('when the caller is the owner', () => {
|
|
describe('when the symbol is empty', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.setSymbol('')).to.be.revertedWith('invalid argument - empty string');
|
|
});
|
|
});
|
|
|
|
it('should set the symbol', async () => {
|
|
const {
|
|
suite: { token },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
const tx = await token.setSymbol('UpdtTK');
|
|
await expect(tx)
|
|
.to.emit(token, 'UpdatedTokenInformation')
|
|
.withArgs(await token.name(), 'UpdtTK', await token.decimals(), await token.version(), await token.onchainID());
|
|
expect(await token.symbol()).to.equal('UpdtTK');
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('.setOnchainID()', () => {
|
|
describe('when the caller is not the owner', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { anotherWallet },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.connect(anotherWallet).setOnchainID(ethers.constants.AddressZero)).to.be.revertedWith('Ownable: caller is not the owner');
|
|
});
|
|
});
|
|
|
|
describe('when the caller is the owner', () => {
|
|
it('should set the onchainID', async () => {
|
|
const {
|
|
suite: { token },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
const tx = await token.setOnchainID(ethers.constants.AddressZero);
|
|
await expect(tx)
|
|
.to.emit(token, 'UpdatedTokenInformation')
|
|
.withArgs(await token.name(), await token.symbol(), await token.decimals(), await token.version(), ethers.constants.AddressZero);
|
|
expect(await token.onchainID()).to.equal(ethers.constants.AddressZero);
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('.setIdentityRegistry()', () => {
|
|
describe('when the caller is not the owner', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { anotherWallet },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.connect(anotherWallet).setIdentityRegistry(ethers.constants.AddressZero)).to.be.revertedWith(
|
|
'Ownable: caller is not the owner',
|
|
);
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('.totalSupply()', () => {
|
|
it('should return the total supply', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { aliceWallet, bobWallet },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
|
|
const balance = await token.balanceOf(aliceWallet.address).then(async (b) => b.add(await token.balanceOf(bobWallet.address)));
|
|
expect(await token.totalSupply()).to.equal(balance);
|
|
});
|
|
});
|
|
|
|
describe('.setCompliance', () => {
|
|
describe('when the caller is not the owner', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { anotherWallet },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.connect(anotherWallet).setCompliance(ethers.constants.AddressZero)).to.be.revertedWith('Ownable: caller is not the owner');
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('.compliance()', () => {
|
|
it('should return the compliance address', async () => {
|
|
const {
|
|
suite: { token, compliance },
|
|
} = await loadFixture(deploySuiteWithModularCompliancesFixture);
|
|
await token.setCompliance(compliance.address);
|
|
expect(await token.compliance()).to.equal(compliance.address);
|
|
});
|
|
});
|
|
|
|
describe('.pause()', () => {
|
|
describe('when the caller is not an agent', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { anotherWallet },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.connect(anotherWallet).pause()).to.be.revertedWith('AgentRole: caller does not have the Agent role');
|
|
});
|
|
});
|
|
|
|
describe('when the caller is an agent', () => {
|
|
describe('when the token is not paused', () => {
|
|
it('should pause the token', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { tokenAgent },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
const tx = await token.connect(tokenAgent).pause();
|
|
await expect(tx).to.emit(token, 'Paused').withArgs(tokenAgent.address);
|
|
expect(await token.paused()).to.be.true;
|
|
});
|
|
});
|
|
|
|
describe('when the token is paused', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { tokenAgent },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await token.connect(tokenAgent).pause();
|
|
await expect(token.connect(tokenAgent).pause()).to.be.revertedWith('Pausable: paused');
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('.unpause()', () => {
|
|
describe('when the caller is not an agent', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { anotherWallet },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.connect(anotherWallet).unpause()).to.be.revertedWith('AgentRole: caller does not have the Agent role');
|
|
});
|
|
});
|
|
|
|
describe('when the caller is an agent', () => {
|
|
describe('when the token is paused', () => {
|
|
it('should unpause the token', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { tokenAgent },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await token.connect(tokenAgent).pause();
|
|
const tx = await token.connect(tokenAgent).unpause();
|
|
await expect(tx).to.emit(token, 'Unpaused').withArgs(tokenAgent.address);
|
|
expect(await token.paused()).to.be.false;
|
|
});
|
|
});
|
|
|
|
describe('when the token is not paused', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { tokenAgent },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.connect(tokenAgent).unpause()).to.be.revertedWith('Pausable: not paused');
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('.setAddressFrozen', () => {
|
|
describe('when sender is not an agent', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { anotherWallet },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.connect(anotherWallet).setAddressFrozen(anotherWallet.address, true)).to.be.revertedWith(
|
|
'AgentRole: caller does not have the Agent role',
|
|
);
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('.freezePartialTokens', () => {
|
|
describe('when sender is not an agent', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { anotherWallet },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.connect(anotherWallet).freezePartialTokens(anotherWallet.address, 1)).to.be.revertedWith(
|
|
'AgentRole: caller does not have the Agent role',
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('when sender is an agent', () => {
|
|
describe('when amounts exceed current balance', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { tokenAgent, anotherWallet },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.connect(tokenAgent).freezePartialTokens(anotherWallet.address, 1)).to.be.revertedWith(
|
|
'Amount exceeds available balance',
|
|
);
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('.unfreezePartialTokens', () => {
|
|
describe('when sender is not an agent', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { anotherWallet },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.connect(anotherWallet).unfreezePartialTokens(anotherWallet.address, 1)).to.be.revertedWith(
|
|
'AgentRole: caller does not have the Agent role',
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('when sender is an agent', () => {
|
|
describe('when amounts exceed current frozen balance', () => {
|
|
it('should revert', async () => {
|
|
const {
|
|
suite: { token },
|
|
accounts: { tokenAgent, anotherWallet },
|
|
} = await loadFixture(deployFullSuiteFixture);
|
|
await expect(token.connect(tokenAgent).unfreezePartialTokens(anotherWallet.address, 1)).to.be.revertedWith(
|
|
'Amount should be less than or equal to frozen tokens',
|
|
);
|
|
});
|
|
});
|
|
});
|
|
});
|
|
});
|