mirror of
https://github.com/luxfi/onchain-id.git
synced 2026-10-30 15:23:49 +00:00
0407b3bfa4
## [2.0.0] Version 2.0.0 Audited by Hacken, more details [here](https://tokeny.com/wp-content/uploads/2023/04/Tokeny_ONCHAINID_SC-Audit_Report.pdf) ### Breaking changes ## Deprecation Notice - ClaimIssuer `revokeClaim` is now deprecated, usage of `revokeClaimBySignature(bytes signature)` is preferred. ### Added - Add typechain-types (targeting ethers v5). - Add tests cases for `execute` and `approve` methods. - Add method `revokeClaimBySignature(bytes signature)` in ClaimIssuer, prefer using this method instead of the now deprecated `revokeClaim` method. - Add checks on ClaimIssuer to prevent revoking an already revoked claim. - Added Factory for ONCHAINIDs ### Updated - Switch development tooling to hardhat. - Implemented tests for hardhat (using fixture for faster testing time). - Prevent calling `approve` method with a non-request execute nonce (added a require on `executionNone`). - Update NatSpec of `execute` and `approve` methods. --------- Co-authored-by: Joachim <[email protected]>
259 lines
11 KiB
TypeScript
259 lines
11 KiB
TypeScript
import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
|
|
import { expect } from "chai";
|
|
import {ethers} from "hardhat";
|
|
|
|
import { deployIdentityFixture } from '../fixtures';
|
|
|
|
describe('Identity', () => {
|
|
describe('Execute', () => {
|
|
describe('when calling execute as a MANAGEMENT key', () => {
|
|
describe('when execution is possible (transferring value with enough funds on the identity)', () => {
|
|
it('should execute immediately the action', async () => {
|
|
const { aliceIdentity, aliceWallet, carolWallet } = await loadFixture(deployIdentityFixture);
|
|
|
|
const previousBalance = await ethers.provider.getBalance(carolWallet.address);
|
|
const action = {
|
|
to: carolWallet.address,
|
|
value: 10,
|
|
data: '0x',
|
|
};
|
|
|
|
const tx = await aliceIdentity.connect(aliceWallet).execute(action.to, action.value, action.data, { value: action.value });
|
|
await expect(tx).to.emit(aliceIdentity, 'Approved');
|
|
await expect(tx).to.emit(aliceIdentity, 'Executed');
|
|
const newBalance = await ethers.provider.getBalance(carolWallet.address);
|
|
|
|
expect(newBalance).to.equal(previousBalance.add(action.value));
|
|
});
|
|
});
|
|
|
|
describe('when execution is possible (successfull call)', () => {
|
|
it('should emit Executed', async () => {
|
|
const { aliceIdentity, aliceWallet } = await loadFixture(deployIdentityFixture);
|
|
|
|
const aliceKeyHash = ethers.utils.keccak256(
|
|
ethers.utils.defaultAbiCoder.encode(['address'], [aliceWallet.address])
|
|
);
|
|
|
|
const action = {
|
|
to: aliceIdentity.address,
|
|
value: 0,
|
|
data: new ethers.utils.Interface(['function addKey(bytes32 key, uint256 purpose, uint256 keyType) returns (bool success)']).encodeFunctionData('addKey', [
|
|
aliceKeyHash,
|
|
3,
|
|
1,
|
|
]),
|
|
};
|
|
|
|
const tx = await aliceIdentity.connect(aliceWallet).execute(action.to, action.value, action.data);
|
|
await expect(tx).to.emit(aliceIdentity, 'Approved');
|
|
await expect(tx).to.emit(aliceIdentity, 'Executed');
|
|
|
|
const purposes = await aliceIdentity.getKeyPurposes(aliceKeyHash);
|
|
expect(purposes).to.deep.equal([1, 3]);
|
|
});
|
|
});
|
|
|
|
describe('when execution is not possible (failing call)', () => {
|
|
it('should emit an ExecutionFailed event', async () => {
|
|
const { aliceIdentity, aliceWallet, carolWallet } = await loadFixture(deployIdentityFixture);
|
|
|
|
const previousBalance = await ethers.provider.getBalance(carolWallet.address);
|
|
const action = {
|
|
to: aliceIdentity.address,
|
|
value: 0,
|
|
data: new ethers.utils.Interface(['function addKey(bytes32 key, uint256 purpose, uint256 keyType) returns (bool success)']).encodeFunctionData('addKey', [
|
|
ethers.utils.keccak256(
|
|
ethers.utils.defaultAbiCoder.encode(['address'], [aliceWallet.address])
|
|
),
|
|
1,
|
|
1,
|
|
]),
|
|
};
|
|
|
|
const tx = await aliceIdentity.connect(aliceWallet).execute(action.to, action.value, action.data);
|
|
await expect(tx).to.emit(aliceIdentity, 'Approved');
|
|
await expect(tx).to.emit(aliceIdentity, 'ExecutionFailed');
|
|
const newBalance = await ethers.provider.getBalance(carolWallet.address);
|
|
|
|
expect(newBalance).to.equal(previousBalance.add(action.value));
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('when calling execute as an ACTION key', () => {
|
|
describe('when target is the identity contract', () => {
|
|
it('should create an execution request', async () => {
|
|
const { aliceIdentity, aliceWallet, bobWallet, carolWallet } = await loadFixture(deployIdentityFixture);
|
|
|
|
const aliceKeyHash = ethers.utils.keccak256(
|
|
ethers.utils.defaultAbiCoder.encode(['address'], [aliceWallet.address])
|
|
);
|
|
const carolKeyHash = ethers.utils.keccak256(
|
|
ethers.utils.defaultAbiCoder.encode(['address'], [carolWallet.address])
|
|
);
|
|
await aliceIdentity.connect(aliceWallet).addKey(carolKeyHash, 2, 1);
|
|
|
|
const action = {
|
|
to: aliceIdentity.address,
|
|
value: 0,
|
|
data: new ethers.utils.Interface(['function addKey(bytes32 key, uint256 purpose, uint256 keyType) returns (bool success)']).encodeFunctionData('addKey', [
|
|
aliceKeyHash,
|
|
2,
|
|
1,
|
|
]),
|
|
};
|
|
|
|
const tx = await aliceIdentity.connect(carolWallet).execute(action.to, action.value, action.data, { value: action.value });
|
|
await expect(tx).to.emit(aliceIdentity, 'ExecutionRequested');
|
|
});
|
|
});
|
|
|
|
describe('when target is another address', () => {
|
|
it('should emit ExecutionFailed for a failed execution', async () => {
|
|
const { aliceIdentity, aliceWallet, carolWallet, davidWallet, bobIdentity } = await loadFixture(deployIdentityFixture);
|
|
|
|
const carolKeyHash = ethers.utils.keccak256(
|
|
ethers.utils.defaultAbiCoder.encode(['address'], [carolWallet.address])
|
|
);
|
|
await aliceIdentity.connect(aliceWallet).addKey(carolKeyHash, 2, 1);
|
|
|
|
const aliceKeyHash = ethers.utils.keccak256(
|
|
ethers.utils.defaultAbiCoder.encode(['address'], [aliceWallet.address])
|
|
);
|
|
|
|
const action = {
|
|
to: bobIdentity.address,
|
|
value: 10,
|
|
data: new ethers.utils.Interface(['function addKey(bytes32 key, uint256 purpose, uint256 keyType) returns (bool success)']).encodeFunctionData('addKey', [
|
|
aliceKeyHash,
|
|
3,
|
|
1,
|
|
]),
|
|
};
|
|
|
|
const previousBalance = await ethers.provider.getBalance(bobIdentity.address);
|
|
|
|
const tx = await aliceIdentity.connect(carolWallet).execute(action.to, action.value, action.data, { value: action.value });
|
|
await expect(tx).to.emit(aliceIdentity, 'Approved');
|
|
await expect(tx).to.emit(aliceIdentity, 'ExecutionFailed');
|
|
const newBalance = await ethers.provider.getBalance(bobIdentity.address);
|
|
|
|
expect(newBalance).to.equal(previousBalance);
|
|
});
|
|
|
|
it('should execute immediately the action', async () => {
|
|
const { aliceIdentity, aliceWallet, carolWallet, davidWallet } = await loadFixture(deployIdentityFixture);
|
|
|
|
const carolKeyHash = ethers.utils.keccak256(
|
|
ethers.utils.defaultAbiCoder.encode(['address'], [carolWallet.address])
|
|
);
|
|
await aliceIdentity.connect(aliceWallet).addKey(carolKeyHash, 2, 1);
|
|
|
|
const previousBalance = await ethers.provider.getBalance(davidWallet.address);
|
|
const action = {
|
|
to: davidWallet.address,
|
|
value: 10,
|
|
data: '0x',
|
|
};
|
|
|
|
const tx = await aliceIdentity.connect(carolWallet).execute(action.to, action.value, action.data, { value: action.value });
|
|
await expect(tx).to.emit(aliceIdentity, 'Approved');
|
|
await expect(tx).to.emit(aliceIdentity, 'Executed');
|
|
const newBalance = await ethers.provider.getBalance(davidWallet.address);
|
|
|
|
expect(newBalance).to.equal(previousBalance.add(action.value));
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('when calling execute as a non-action key', () => {
|
|
it('should create a pending execution request', async () => {
|
|
const { aliceIdentity, bobWallet, carolWallet } = await loadFixture(deployIdentityFixture);
|
|
|
|
const previousBalance = await ethers.provider.getBalance(carolWallet.address);
|
|
const action = {
|
|
to: carolWallet.address,
|
|
value: 10,
|
|
data: '0x',
|
|
};
|
|
|
|
const tx = await aliceIdentity.connect(bobWallet).execute(action.to, action.value, action.data, { value: action.value });
|
|
await expect(tx).to.emit(aliceIdentity, 'ExecutionRequested');
|
|
const newBalance = await ethers.provider.getBalance(carolWallet.address);
|
|
|
|
expect(newBalance).to.equal(previousBalance);
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('Approve', () => {
|
|
describe('when calling a non-existing execution request', () => {
|
|
it('should revert for execution request not found', async () => {
|
|
const { aliceIdentity, aliceWallet } = await loadFixture(deployIdentityFixture);
|
|
|
|
await expect(aliceIdentity.connect(aliceWallet).approve(2, true)).to.be.revertedWith('Cannot approve a non-existing execution');
|
|
});
|
|
});
|
|
|
|
describe('when calling an already executed request', () => {
|
|
it('should revert for execution request already executed', async () => {
|
|
const { aliceIdentity, aliceWallet, bobWallet } = await loadFixture(deployIdentityFixture);
|
|
|
|
await aliceIdentity.connect(aliceWallet).execute(bobWallet.address, 10, '0x', { value: 10 });
|
|
|
|
await expect(aliceIdentity.connect(aliceWallet).approve(0, true)).to.be.revertedWith('Request already executed');
|
|
});
|
|
});
|
|
|
|
describe('when calling approve for an execution targeting another address as a non-action key', () => {
|
|
it('should revert for not authorized', async () => {
|
|
const { aliceIdentity, bobWallet, carolWallet } = await loadFixture(deployIdentityFixture);
|
|
|
|
await aliceIdentity.connect(bobWallet).execute(carolWallet.address, 10, '0x', { value: 10 });
|
|
|
|
await expect(aliceIdentity.connect(bobWallet).approve(0, true)).to.be.revertedWith('Sender does not have action key');
|
|
});
|
|
});
|
|
|
|
describe('when calling approve for an execution targeting another address as a non-management key', () => {
|
|
it('should revert for not authorized', async () => {
|
|
const { aliceIdentity, davidWallet, bobWallet } = await loadFixture(deployIdentityFixture);
|
|
|
|
await aliceIdentity.connect(bobWallet).execute(aliceIdentity.address, 10, '0x', { value: 10 });
|
|
|
|
await expect(aliceIdentity.connect(davidWallet).approve(0, true)).to.be.revertedWith('Sender does not have management key');
|
|
});
|
|
});
|
|
|
|
describe('when calling approve as a MANAGEMENT key', () => {
|
|
it('should approve the execution request', async () => {
|
|
const { aliceIdentity, aliceWallet, bobWallet, carolWallet } = await loadFixture(deployIdentityFixture);
|
|
|
|
const previousBalance = await ethers.provider.getBalance(carolWallet.address);
|
|
await aliceIdentity.connect(bobWallet).execute(carolWallet.address, 10, '0x', { value: 10 });
|
|
|
|
const tx = await aliceIdentity.connect(aliceWallet).approve(0, true);
|
|
await expect(tx).to.emit(aliceIdentity, 'Approved');
|
|
await expect(tx).to.emit(aliceIdentity, 'Executed');
|
|
const newBalance = await ethers.provider.getBalance(carolWallet.address);
|
|
|
|
expect(newBalance).to.equal(previousBalance.add(10));
|
|
});
|
|
|
|
it('should leave approve to false', async () => {
|
|
const { aliceIdentity, aliceWallet, bobWallet, carolWallet } = await loadFixture(deployIdentityFixture);
|
|
|
|
const previousBalance = await ethers.provider.getBalance(carolWallet.address);
|
|
await aliceIdentity.connect(bobWallet).execute(carolWallet.address, 10, '0x', { value: 10 });
|
|
|
|
const tx = await aliceIdentity.connect(aliceWallet).approve(0, false);
|
|
await expect(tx).to.emit(aliceIdentity, 'Approved');
|
|
const newBalance = await ethers.provider.getBalance(carolWallet.address);
|
|
|
|
expect(newBalance).to.equal(previousBalance);
|
|
});
|
|
});
|
|
});
|
|
});
|