Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(purity): remove submitDirectly #20

Merged
merged 2 commits into from
Jan 19, 2024
Merged

fix(purity): remove submitDirectly #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7ce5ec
fix: remove submitDirectly
Sabnock01 Dec 19, 2023
3f78bd6
Merge branch 'main' of github.com:waterfall-mkt/curta-golf into sabno…
Sabnock01 Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion script/metadata/PrintKingArt.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,19 @@ import { BaseTest } from "test/utils/BaseTest.sol";
/// tokens, as outputted by {KingArt}.
/// @dev Must be compiled with `--via-ir` to avoid stack too deep errors.
contract PrintKingArtScript is BaseTest, Script {
// -------------------------------------------------------------------------
// Constants
// -------------------------------------------------------------------------

/// @notice The address of the recipient of the solution.
address constant RECIPIENT = 0xA85572Cd96f1643458f17340b6f0D6549Af482F5;

function setUp() public override {
super.setUp();

// Submit a solution to course #1 as `fiveoutofnine.eth`.
curtaGolf.submitDirectly(1, EFFICIENT_SOLUTION, 0xA85572Cd96f1643458f17340b6f0D6549Af482F5);
curtaGolf.commit(keccak256(abi.encode(RECIPIENT, EFFICIENT_SOLUTION, 0)));
curtaGolf.submit(1, EFFICIENT_SOLUTION, RECIPIENT, 0);
}
// -------------------------------------------------------------------------
// `run`
Expand Down
3 changes: 2 additions & 1 deletion script/metadata/PrintParArt.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ contract PrintParArtScript is BaseTest, Script {
super.setUp();

// Submit a solution to course #1 as `RECIPIENT`.
curtaGolf.submitDirectly(1, EFFICIENT_SOLUTION, RECIPIENT);
curtaGolf.commit(keccak256(abi.encode(RECIPIENT, EFFICIENT_SOLUTION, 0)));
curtaGolf.submit(1, EFFICIENT_SOLUTION, RECIPIENT, 0);
}
// -------------------------------------------------------------------------
// `run`
Expand Down
8 changes: 0 additions & 8 deletions src/CurtaGolf.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,14 +114,6 @@ contract CurtaGolf is ICurtaGolf, KingERC721, Owned {
return _submit(_courseId, _solution, _recipient);
}

/// @inheritdoc ICurtaGolf
function submitDirectly(uint32 _courseId, bytes memory _solution, address _recipient)
external
returns (uint32)
{
return _submit(_courseId, _solution, _recipient);
}

// -------------------------------------------------------------------------
// `owner`-only functions
// -------------------------------------------------------------------------
Expand Down
11 changes: 0 additions & 11 deletions src/interfaces/ICurtaGolf.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,15 +193,4 @@ interface ICurtaGolf {
function submit(uint32 _courseId, bytes memory _solution, address _recipient, uint256 _salt)
external
returns (uint32);

/// @notice Submits a solution to a course directly, skipping the 2-step
/// commit-reveal process. Only call this function if front-running is not
/// a concern (e.g. the solution is not to become the leading solution).
/// @param _courseId The ID of the course.
/// @param _solution The bytecode of the solution.
/// @param _recipient The address of the recipient.
/// @return The gas used by the solution.
function submitDirectly(uint32 _courseId, bytes memory _solution, address _recipient)
external
returns (uint32);
}
134 changes: 4 additions & 130 deletions test/CurtaGolf.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,135 +284,6 @@ contract CurtaGolfTest is BaseTest {
}
}

// -------------------------------------------------------------------------
// `submitDirectly`
// -------------------------------------------------------------------------

/// @notice Test the emitted events and storage updates upon submitting
/// solutions in the following order:
/// 1. `solver1` submits an inefficient solution but becomes the king.
/// 2. `solver2` submits an efficient solution and becomes the new king.
/// 3. `solver3` submits an inefficient solution and doesn't become the
/// new king.
/// All solvers get `par` NFTs minted to them, but only `solver1` and
/// `solver3` hold ownership of a King NFT.
function test_submitDirectly() public {
// Check that there is no King for course 1.
{
(, uint32 gasUsed, uint32 solutionCount, uint32 kingCount) = curtaGolf.getCourse(1);
assertEq(gasUsed, 0);
assertEq(solutionCount, 0);
assertEq(kingCount, 0);
vm.expectRevert("NOT_MINTED");
curtaGolf.ownerOf(1);
}
// Check that all solvers have 0 King NFTs.
{
assertEq(curtaGolf.balanceOf(solver1), 0);
assertEq(curtaGolf.balanceOf(solver2), 0);
assertEq(curtaGolf.balanceOf(solver3), 0);
}
// Check that all solvers have 0 Par NFTs.
{
assertEq(par.balanceOf(solver1), 0);
assertEq(par.balanceOf(solver2), 0);
assertEq(par.balanceOf(solver3), 0);
}

// Submit the inefficient solution as `solver1`.
vm.prank(solver1);
vm.expectEmit(true, true, true, true);
emit Transfer(address(0), solver1, 1);
vm.expectEmit(true, true, false, false);
emit UpdateKing(1, solver1, 0);
vm.expectEmit(true, true, true, true);
emit Transfer(address(0), solver1, (1 << 160) | uint256(uint160(solver1)));
vm.expectEmit(true, true, false, false);
emit SubmitSolution(1, solver1, address(0), 0);
curtaGolf.submitDirectly(1, INEFFICIENT_SOLUTION, solver1);

// Check that there is 1 King and 1 solution for course 1.
{
(,, uint32 solutionCount, uint32 kingCount) = curtaGolf.getCourse(1);
assertEq(solutionCount, 1);
assertEq(kingCount, 1);
assertEq(curtaGolf.ownerOf(1), solver1);
}
// Check that `solver1` has 1 King NFT, and the others have 0.
{
assertEq(curtaGolf.balanceOf(solver1), 1);
assertEq(curtaGolf.balanceOf(solver2), 0);
assertEq(curtaGolf.balanceOf(solver3), 0);
}
// Check that `solver1` has 1 Par NFT, and the others have 0.
{
assertEq(par.balanceOf(solver1), 1);
assertEq(par.balanceOf(solver2), 0);
assertEq(par.balanceOf(solver3), 0);
}

// Submit the efficient solution as `solver2`.
vm.prank(solver2);
vm.expectEmit(true, true, true, true);
emit Transfer(solver1, solver2, 1);
vm.expectEmit(true, true, false, false);
emit UpdateKing(1, solver2, 0);
vm.expectEmit(true, true, true, true);
emit Transfer(address(0), solver2, (1 << 160) | uint256(uint160(solver2)));
vm.expectEmit(true, true, false, false);
emit SubmitSolution(1, solver2, address(0), 0);
curtaGolf.submitDirectly(1, EFFICIENT_SOLUTION, solver2);

// Check that there is 2 Kings and 2 solutions for course 1.
{
(,, uint32 solutionCount, uint32 kingCount) = curtaGolf.getCourse(1);
assertEq(solutionCount, 2);
assertEq(kingCount, 2);
assertEq(curtaGolf.ownerOf(1), solver2);
}
// Check that `solver2` has 1 King NFT, and the others have 0.
{
assertEq(curtaGolf.balanceOf(solver1), 0);
assertEq(curtaGolf.balanceOf(solver2), 1);
assertEq(curtaGolf.balanceOf(solver3), 0);
}
// Check that `solver1` and `solver2` have 1 Par NFT each, and `solver3`
// has 0.
{
assertEq(par.balanceOf(solver1), 1);
assertEq(par.balanceOf(solver2), 1);
assertEq(par.balanceOf(solver3), 0);
}

// Submit the efficient solution as `solver3`.
vm.prank(solver3);
vm.expectEmit(true, true, true, true);
emit Transfer(address(0), solver3, (1 << 160) | uint256(uint160(solver3)));
vm.expectEmit(true, true, false, false);
emit SubmitSolution(1, solver3, address(0), 0);
curtaGolf.submitDirectly(1, INEFFICIENT_SOLUTION, solver3);

// Check that there is 2 Kings and 3 solutions for course 1.
{
(,, uint32 solutionCount, uint32 kingCount) = curtaGolf.getCourse(1);
assertEq(solutionCount, 3);
assertEq(kingCount, 2);
assertEq(curtaGolf.ownerOf(1), solver2);
}
// Check that `solver2` has 1 King NFT, and the others have 0.
{
assertEq(curtaGolf.balanceOf(solver1), 0);
assertEq(curtaGolf.balanceOf(solver2), 1);
assertEq(curtaGolf.balanceOf(solver3), 0);
}
// Check each solver has 1 Par NFT each.
{
assertEq(par.balanceOf(solver1), 1);
assertEq(par.balanceOf(solver2), 1);
assertEq(par.balanceOf(solver3), 1);
}
}

// -------------------------------------------------------------------------
// `addCourse`
// -------------------------------------------------------------------------
Expand Down Expand Up @@ -547,7 +418,10 @@ contract CurtaGolfTest is BaseTest {

/// @notice Test that calling `tokenURI` on a minted token succeeds.
function test_tokenURI_MintedToken_Succeeds() public {
curtaGolf.submitDirectly(1, EFFICIENT_SOLUTION, solver1);
curtaGolf.commit(keccak256(abi.encode(solver1, EFFICIENT_SOLUTION, 0)));
vm.warp(MIN_COMMIT_AGE + 1);
vm.prank(solver1);
curtaGolf.submit(1, EFFICIENT_SOLUTION, solver1, 0);
curtaGolf.tokenURI(1);
}
}