Skip to content

Hooks v extension benchmark #85

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

Merged
jakeloo merged 9 commits into from
Apr 22, 2024
Merged

Hooks v extension benchmark #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
412bf48
Update important interfaces naming away from Hooks to Extension + Cal…
nkrishang Apr 18, 2024
a0a7525
rename fn -> function
nkrishang Apr 19, 2024
2d7a134
cleanup redundancy in names
nkrishang Apr 19, 2024
b89b6ad
WIP no bitmasks
nkrishang Apr 19, 2024
03e4b70
update interfaces: replace bitmask with bytes4[]
nkrishang Apr 19, 2024
43b3ac1
abstract CoreContract inherits ICoreContract
nkrishang Apr 19, 2024
12a7876
ERC20CoreContract inherits ERC20Core
nkrishang Apr 19, 2024
8ab548a
Benchmark for ERC20CoreContract
nkrishang Apr 20, 2024
caef765
Resolve MockExtension
nkrishang Apr 22, 2024
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
246 changes: 246 additions & 0 deletions core/test/benchmark/ER20CoreContractBenchmark.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,246 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.0;

import {Test} from "forge-std/Test.sol";

import {EIP1967Proxy} from "test/utils/EIP1967Proxy.sol";

import {IExtensionContract} from "src/interface/IExtensionContract.sol";
import {CoreContract, ICoreContract} from "src/core/CoreContract.sol";

import {
MockExtensionERC20,
MockExtensionWithOneCallbackERC20,
MockExtensionWithFourCallbacksERC20
} from "test/mocks/MockExtension.sol";

import {ERC20CoreContract} from "src/core/token/ERC20CoreContract.sol";

contract ERC20CoreContractBenchmarkTest is Test {
/*//////////////////////////////////////////////////////////////
SETUP
//////////////////////////////////////////////////////////////*/

// Participants
address public platformAdmin = address(0x123);
address public platformUser = address(0x456);
address public claimer = 0xDDdDddDdDdddDDddDDddDDDDdDdDDdDDdDDDDDDd;

// Target test contracts
ERC20CoreContract public erc20;
address public hookProxyAddress;

function setUp() public {
// Setup: minting on ERC-20 contract.

// Platform contracts: gas incurred by platform.
vm.startPrank(platformAdmin);

hookProxyAddress = address(
new EIP1967Proxy(
address(new MockExtensionERC20()),
abi.encodeWithSelector(
MockExtensionERC20.initialize.selector,
platformAdmin // upgradeAdmin
)
)
);

vm.stopPrank();

// Developer contract: gas incurred by developer.
vm.startPrank(platformUser);

address[] memory extensionsToInstall = new address[](0);

erc20 = new ERC20CoreContract(
"Token",
"TKN",
"ipfs://QmPVMvePSWfYXTa8haCbFavYx4GM4kBPzvdgBw7PTGUByp/0",
platformUser, // core contract owner,
extensionsToInstall,
address(0),
bytes("")
);

vm.stopPrank();

vm.label(address(erc20), "ERC20CoreContract");
vm.label(hookProxyAddress, "MockExtensionERC20");
vm.label(platformAdmin, "Admin");
vm.label(platformUser, "Developer");
vm.label(claimer, "Claimer");
}

/*//////////////////////////////////////////////////////////////
DEPLOY END-USER CONTRACT
//////////////////////////////////////////////////////////////*/

function test_deployEndUserContract() public {
// Deploy a minimal proxy to the ERC20CoreContract implementation contract.

vm.pauseGasMetering();

address[] memory extensionsToInstall = new address[](1);
extensionsToInstall[0] = hookProxyAddress;

vm.resumeGasMetering();

ERC20CoreContract core = new ERC20CoreContract(
"Token",
"TKN",
"ipfs://QmPVMvePSWfYXTa8haCbFavYx4GM4kBPzvdgBw7PTGUByp/0",
platformUser, // core contract owner,
extensionsToInstall,
address(0),
bytes("")
);
}

/*//////////////////////////////////////////////////////////////
MINT 1 TOKEN AND 10 TOKENS
//////////////////////////////////////////////////////////////*/

function test_mintOneToken() public {
vm.pauseGasMetering();

vm.prank(platformUser);
erc20.installExtension(hookProxyAddress, 0, "");

// Check pre-mint state
address claimerAddress = claimer;
uint256 quantity = 1 ether;
ERC20CoreContract core = erc20;

vm.prank(claimer);

vm.resumeGasMetering();

// Claim token
core.mint(claimerAddress, quantity, "");
}

function test_mintTenTokens() public {
vm.pauseGasMetering();

vm.prank(platformUser);
erc20.installExtension(hookProxyAddress, 0, "");

// Check pre-mint state
address claimerAddress = claimer;
uint256 quantity = 10 ether;
ERC20CoreContract core = erc20;

vm.prank(claimer);

vm.resumeGasMetering();

// Claim token
core.mint(claimerAddress, quantity, "");
}

/*//////////////////////////////////////////////////////////////
TRANSFER 1 TOKEN
//////////////////////////////////////////////////////////////*/

function test_transferOneToken() public {
vm.pauseGasMetering();

vm.prank(platformUser);
erc20.installExtension(hookProxyAddress, 0, "");

// Check pre-mint state
address claimerAddress = claimer;
uint256 quantity = 10 ether;
ERC20CoreContract core = erc20;
core.mint(claimerAddress, quantity, "");

address to = address(0x121212);
vm.prank(claimer);

vm.resumeGasMetering();

// Transfer token
core.transfer(to, 1);
}

/*//////////////////////////////////////////////////////////////
PERFORM A BEACON UPGRADE
//////////////////////////////////////////////////////////////*/

function test_beaconUpgrade() public {
vm.pauseGasMetering();

address newImpl = address(new MockExtensionERC20());
address proxyAdmin = platformAdmin;
MockExtensionERC20 proxy = MockExtensionERC20(payable(hookProxyAddress));

vm.prank(proxyAdmin);

vm.resumeGasMetering();

// Perform upgrade
proxy.upgradeToAndCall(address(newImpl), bytes(""));
}

/*//////////////////////////////////////////////////////////////
ADD NEW FUNCTIONALITY AND UPDATE FUNCTIONALITY
//////////////////////////////////////////////////////////////*/

function test_installOneHook() public {
vm.pauseGasMetering();

address mockHook = address(new MockExtensionWithOneCallbackERC20());
ERC20CoreContract hookConsumer = erc20;

vm.prank(platformUser);

vm.resumeGasMetering();

hookConsumer.installExtension(mockHook, 0, "");
}

function test_installFourHooks() public {
vm.pauseGasMetering();

address mockHook = address(new MockExtensionWithFourCallbacksERC20());
ERC20CoreContract hookConsumer = erc20;

vm.prank(platformUser);

vm.resumeGasMetering();

hookConsumer.installExtension(mockHook, 0, "");
}

function test_uninstallOneHook() public {
vm.pauseGasMetering();

ERC20CoreContract hookConsumer = erc20;

vm.prank(platformUser);
hookConsumer.installExtension(hookProxyAddress, 0, "");

vm.prank(platformUser);

vm.resumeGasMetering();

hookConsumer.uninstallExtension(hookProxyAddress, 0, "");
}

function test_uninstallFourHooks() public {
vm.pauseGasMetering();

address mockHook = address(new MockExtensionWithFourCallbacksERC20());
ERC20CoreContract hookConsumer = erc20;

vm.prank(platformUser);
hookConsumer.installExtension(mockHook, 0, "");

vm.prank(platformUser);

vm.resumeGasMetering();

hookConsumer.uninstallExtension(mockHook, 0, "");
}
}
27 changes: 13 additions & 14 deletions core/test/benchmark/ERC20CoreBenchmark.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,6 @@ contract ERC20CoreBenchmarkTest is Test, HookFlagsDirectory {
hooksToInstallOnInit
);

// Developer installs `MockHookERC20` hook
erc20.installHook(IHookInstaller.InstallHookParams(hookProxyAddress, 0, bytes("")));

vm.stopPrank();

vm.label(address(erc20), "ERC20Core");
Expand Down Expand Up @@ -103,6 +100,9 @@ contract ERC20CoreBenchmarkTest is Test, HookFlagsDirectory {
function test_mintOneToken() public {
vm.pauseGasMetering();

vm.prank(platformUser);
erc20.installHook(IHookInstaller.InstallHookParams(hookProxyAddress, 0, bytes("")));

// Check pre-mint state
address claimerAddress = claimer;
uint256 quantity = 1 ether;
Expand All @@ -119,6 +119,9 @@ contract ERC20CoreBenchmarkTest is Test, HookFlagsDirectory {
function test_mintTenTokens() public {
vm.pauseGasMetering();

vm.prank(platformUser);
erc20.installHook(IHookInstaller.InstallHookParams(hookProxyAddress, 0, bytes("")));

// Check pre-mint state
address claimerAddress = claimer;
uint256 quantity = 10 ether;
Expand All @@ -139,6 +142,9 @@ contract ERC20CoreBenchmarkTest is Test, HookFlagsDirectory {
function test_transferOneToken() public {
vm.pauseGasMetering();

vm.prank(platformUser);
erc20.installHook(IHookInstaller.InstallHookParams(hookProxyAddress, 0, bytes("")));

// Check pre-mint state
address claimerAddress = claimer;
uint256 quantity = 10 ether;
Expand Down Expand Up @@ -183,9 +189,6 @@ contract ERC20CoreBenchmarkTest is Test, HookFlagsDirectory {
IHook mockHook = IHook(address(new MockOneHookImplERC20()));
ERC20Core hookConsumer = erc20;

vm.prank(platformUser);
hookConsumer.uninstallHook(hookProxyAddress);

vm.prank(platformUser);

vm.resumeGasMetering();
Expand All @@ -199,9 +202,6 @@ contract ERC20CoreBenchmarkTest is Test, HookFlagsDirectory {
IHook mockHook = IHook(address(new MockFourHookImplERC20()));
ERC20Core hookConsumer = erc20;

vm.prank(platformUser);
hookConsumer.uninstallHook(hookProxyAddress);

vm.prank(platformUser);

vm.resumeGasMetering();
Expand All @@ -212,14 +212,16 @@ contract ERC20CoreBenchmarkTest is Test, HookFlagsDirectory {
function test_uninstallOneHook() public {
vm.pauseGasMetering();

IHook mockHook = IHook(address(new MockOneHookImplERC20()));
ERC20Core hookConsumer = erc20;

vm.prank(platformUser);
erc20.installHook(IHookInstaller.InstallHookParams(hookProxyAddress, 0, bytes("")));

vm.prank(platformUser);

vm.resumeGasMetering();

hookConsumer.uninstallHook(address(mockHook));
hookConsumer.uninstallHook(hookProxyAddress);
}

function test_uninstallFourHooks() public {
Expand All @@ -228,9 +230,6 @@ contract ERC20CoreBenchmarkTest is Test, HookFlagsDirectory {
IHook mockHook = IHook(address(new MockFourHookImplERC20()));
ERC20Core hookConsumer = erc20;

vm.prank(platformUser);
hookConsumer.uninstallHook(hookProxyAddress);

vm.prank(platformUser);
hookConsumer.installHook(IHookInstaller.InstallHookParams(address(mockHook), 0, ""));

Expand Down
Loading