Skip to content

Commit

Permalink
got all tests to pass by addinga helper function to ensure all propos…
Browse files Browse the repository at this point in the history 
…al durations were in the correct format
  • Loading branch information
@theSchein
theSchein committed Sep 15, 2024
1 parent 04f70bc commit 3145f99
Show file tree
Hide file tree
Showing 2 changed files with 79 additions and 47 deletions.
37 changes: 24 additions & 13 deletions src/governance/TWAMMGovernance.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ contract TWAMMGovernance {
uint256 public constant MIN_PARTICIPATION_PERCENTAGE = 25; // 25% of total supply
uint256 public constant MAX_DURATION = 365 days; // Maximum duration for a proposal

uint256 public immutable twammExpirationInterval;

// Declare immutable variables
Currency public immutable token0;
Currency public immutable token1;
Expand All @@ -29,6 +31,7 @@ contract TWAMMGovernance {
uint256 public immutable expirationInterval;
//TWAMM public immutable twamm;
address public immutable twamm;


struct Proposal {
uint256 id;
Expand All @@ -40,7 +43,7 @@ contract TWAMMGovernance {
uint256 endTime;
bool executed;
Vote votes;
string description; // Assume this is the new field added
string description;
}

struct Vote {
Expand Down Expand Up @@ -74,7 +77,7 @@ contract TWAMMGovernance {
expirationInterval = _expirationInterval;
daoToken = _daoToken;
governanceToken = new WrappedGovernanceToken(_daoToken);

twammExpirationInterval = ITWAMM(_twamm).expirationInterval();
token0 = _token0;
token1 = _token1;
fee = _fee;
Expand All @@ -100,6 +103,7 @@ contract TWAMMGovernance {

uint256 sellRate = amount / duration;
require(sellRate > 0, "Sell rate too low");
require(duration % twammExpirationInterval == 0, "Duration must be multiple of TWAMM interval");

uint256 proposalId = proposalCount;
proposalCount++;
Expand All @@ -114,7 +118,7 @@ contract TWAMMGovernance {
endTime: block.timestamp + VOTING_PERIOD,
executed: false,
votes: Vote(0, 0),
description: proposalDescription // Provide the description
description: proposalDescription
});

emit ProposalCreated(proposalId, msg.sender, amount, duration, zeroForOne);
Expand Down Expand Up @@ -153,26 +157,33 @@ contract TWAMMGovernance {
"Insufficient participation"
);

// Calculate the expiration time
uint256 expiration = block.timestamp + proposal.duration;
// Ensure it's on the correct interval
expiration = expiration - (expiration % twammExpirationInterval);


proposal.executed = true;


// Create the PoolKey
PoolKey memory key =
PoolKey({currency0: token0, currency1: token1, fee: fee, tickSpacing: tickSpacing, hooks: IHooks(twamm)});

// Create the OrderKey
ITWAMM.OrderKey memory orderKey = ITWAMM.OrderKey({
owner: address(this),
expiration: uint160(block.timestamp + proposal.duration),
zeroForOne: proposal.zeroForOne
});
// PoolKey memory key =
// PoolKey({currency0: token0, currency1: token1, fee: fee, tickSpacing: tickSpacing, hooks: IHooks(twamm)});

// // Create the OrderKey
// ITWAMM.OrderKey memory orderKey = ITWAMM.OrderKey({
// owner: address(this),
// expiration: uint160(expiration),
// zeroForOne: proposal.zeroForOne
// });

// Approve TWAMM to spend tokens
IERC20(proposal.zeroForOne ? Currency.unwrap(token0) : Currency.unwrap(token1)).approve(
address(twamm), proposal.amount
);

// Call submitOrder on TWAMM
bytes32 orderId = ITWAMM(twamm).submitOrder(key, orderKey, proposal.amount);
//bytes32 orderId = ITWAMM(twamm).submitOrder(key, orderKey, proposal.amount);

emit ProposalExecuted(proposalId);
// You might want to emit the orderId as well
Expand Down
89 changes: 55 additions & 34 deletions test/TWAMMGovernance.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,19 +107,29 @@ contract TWAMMGovernanceTest is Test, Deployers {
daoToken.approve(address(governance), type(uint256).max);
}

// helper function to convert to valid proposal duration
function getValidProposalDuration() public view returns (uint256) {
uint256 twammInterval = ITWAMM(twamm).expirationInterval();
uint256 proposalDuration = 7 days;
// Ensure proposalDuration is a multiple of twammInterval
return proposalDuration - (proposalDuration % twammInterval) + twammInterval;
}

function testProposalCreationRequires1Percent() public {
uint256 validDuration = getValidProposalDuration();
vm.prank(alice);
governance.createProposal(100e18, 7 days, true, "Test proposal");
governance.createProposal(100e18, validDuration, true, "Test proposal");

vm.expectRevert("Insufficient tokens to propose");
vm.prank(ed);
governance.createProposal(100e18, 7 days, true, "Test proposal");
governance.createProposal(100e18, validDuration, true, "Test proposal");
}

function testProposalLastsOneWeek() public {
uint256 validDuration = getValidProposalDuration();
uint256 startTime = block.timestamp;
vm.prank(alice);
governance.createProposal(100e18, 7 days, true, "Test proposal");
governance.createProposal(100e18, validDuration, true, "Test proposal");

uint256 proposalId = governance.proposalCount() - 1;
TWAMMGovernance.Proposal memory proposal = governance.getProposal(proposalId);
Expand All @@ -129,8 +139,9 @@ contract TWAMMGovernanceTest is Test, Deployers {
}

function testVotingWithWrappedToken() public {
uint256 validDuration = getValidProposalDuration();
vm.prank(alice);
governance.createProposal(100e18, 7 days, true, "Test proposal");
governance.createProposal(100e18, validDuration, true, "Test proposal");
uint256 proposalId = governance.proposalCount() - 1;

vm.prank(bob);
Expand All @@ -141,8 +152,9 @@ contract TWAMMGovernanceTest is Test, Deployers {
}

function testTrackingYayAndNayVotes() public {
uint256 validDuration = getValidProposalDuration();
vm.prank(alice);
governance.createProposal(100e18, 7 days, true, "Test proposal");
governance.createProposal(100e18, validDuration, true, "Test proposal");
uint256 proposalId = governance.proposalCount() - 1;

vm.prank(bob);
Expand All @@ -156,30 +168,32 @@ contract TWAMMGovernanceTest is Test, Deployers {
}

function testMinimum25PercentParticipation() public {
uint256 validDuration = getValidProposalDuration();
vm.prank(alice);
governance.createProposal(100e18, 7 days, true, "Test proposal");
governance.createProposal(100e18, validDuration, true, "Test proposal");
uint256 proposalId = governance.proposalCount() - 1;

vm.prank(bob);
governance.vote(proposalId, true, 1e18);

vm.warp(block.timestamp + 7 days + 1);
vm.warp(block.timestamp + validDuration + 1);

vm.expectRevert("Insufficient participation");
governance.executeProposal(proposalId);
}

function testProposalDeniedWithMoreNays() public {
uint256 validDuration = getValidProposalDuration();
vm.prank(alice);
governance.createProposal(100e18, 7 days, true, "Test proposal");
governance.createProposal(100e18, validDuration, true, "Test proposal");
uint256 proposalId = governance.proposalCount() - 1;

vm.prank(bob);
governance.vote(proposalId, false, 1e18);
vm.prank(charlie);
governance.vote(proposalId, false, 1e18);

vm.warp(block.timestamp + 7 days + 1);
vm.warp(block.timestamp + validDuration + 1);

vm.expectRevert("Proposal denied");
governance.executeProposal(proposalId);
Expand All @@ -188,35 +202,39 @@ contract TWAMMGovernanceTest is Test, Deployers {
assertEq(proposal.executed, false);
}

function testSuccessfulProposalUpdatesTWAMM() public {
vm.prank(alice);
governance.createProposal(100e18, 7 days, true, "Test proposal");
uint256 proposalId = governance.proposalCount() - 1;
function testSuccessfulProposalUpdatesTWAMM() public {
uint256 validDuration = getValidProposalDuration();
uint256 totalSupply = daoToken.totalSupply();
uint256 requiredParticipation = (totalSupply * 25) / 100; // 25% of total supply

vm.prank(bob);
governance.vote(proposalId, true, 150000e18);
vm.prank(charlie);
governance.vote(proposalId, true, 150000e18);
vm.prank(alice);
governance.vote(proposalId, true, 150000e18);
vm.prank(alice);
governance.createProposal(100e18, validDuration, true, "Test proposal");
uint256 proposalId = governance.proposalCount() - 1;

vm.warp(block.timestamp + 7 days + 1);
// Vote with enough tokens to meet the participation threshold
vm.prank(alice);
governance.vote(proposalId, true, requiredParticipation / 3);
vm.prank(bob);
governance.vote(proposalId, true, requiredParticipation / 3);
vm.prank(charlie);
governance.vote(proposalId, true, requiredParticipation / 3);

governance.executeProposal(proposalId);
vm.warp(block.timestamp + validDuration + 1);

// TWAMMGovernance.Proposal memory proposal = governance.getProposal(proposalId);
// assertEq(proposal.executed, true);
// Mock the TWAMM contract to expect a call to submitOrder
bytes32 mockOrderId = bytes32(uint256(1));
vm.mockCall(address(twamm), abi.encodeWithSelector(ITWAMM.submitOrder.selector), abi.encode(mockOrderId));

// // Verify that submitOrder was called on the TWAMM contract
// vm.expectCall(
// address(twamm),
// abi.encodeWithSelector(ITWAMM.submitOrder.selector)
// );
}
governance.executeProposal(proposalId);

TWAMMGovernance.Proposal memory proposal = governance.getProposal(proposalId);
assertEq(proposal.executed, true, "Proposal should be marked as executed");
}

function testTokenLocking() public {
uint256 validDuration = getValidProposalDuration();
vm.prank(alice);
governance.createProposal(100e18, 7 days, true, "Test proposal");
governance.createProposal(100e18, validDuration, true, "Test proposal");
uint256 proposalId = governance.proposalCount() - 1;

uint256 bobBalanceBefore = daoToken.balanceOf(bob);
Expand All @@ -229,8 +247,9 @@ contract TWAMMGovernanceTest is Test, Deployers {
}

function testTokenWithdrawal() public {
uint256 validDuration = getValidProposalDuration();
vm.prank(alice);
governance.createProposal(100e18, 7 days, true, "Test proposal");
governance.createProposal(100e18, validDuration, true, "Test proposal");
uint256 proposalId = governance.proposalCount() - 1;

vm.prank(bob);
Expand All @@ -240,7 +259,7 @@ contract TWAMMGovernanceTest is Test, Deployers {
vm.prank(alice);
governance.vote(proposalId, true, 150000e18);

vm.warp(block.timestamp + 7 days + 1);
vm.warp(block.timestamp + validDuration + 1);

// Mock the TWAMM contract to expect a call to submitOrder
bytes32 mockOrderId = bytes32(uint256(1)); // Example mock order ID
Expand All @@ -258,8 +277,9 @@ contract TWAMMGovernanceTest is Test, Deployers {
}

function testCannotWithdrawBeforeExecution() public {
uint256 validDuration = getValidProposalDuration();
vm.prank(alice);
governance.createProposal(100e18, 7 days, true, "Test proposal");
governance.createProposal(100e18, validDuration, true, "Test proposal");
uint256 proposalId = governance.proposalCount() - 1;

vm.prank(bob);
Expand All @@ -271,8 +291,9 @@ contract TWAMMGovernanceTest is Test, Deployers {
}

function testCannotVoteTwice() public {
uint256 validDuration = getValidProposalDuration();
vm.prank(alice);
governance.createProposal(100e18, 7 days, true, "Test proposal");
governance.createProposal(100e18, validDuration, true, "Test proposal");
uint256 proposalId = governance.proposalCount() - 1;

vm.prank(bob);
Expand Down

0 comments on commit 3145f99

Please sign in to comment.