Skip to content

Commit

Permalink
refactor: verbose function names (#44)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ARR4N
ARR4N authored Aug 11, 2024
1 parent 50ed49f commit 68a36b8
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 28 deletions.
8 changes: 4 additions & 4 deletions src/TMPL/TMPLSwapperDeployer.tmpl.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ contract TMPLSwapperPredictor {
/// @dev Deployer of TMPLSwapper contracts.
abstract contract TMPLSwapperDeployer is TMPLSwapperPredictor, ETDeployer, SwapperDeployerBase, ISwapperEvents {
/// @dev Execute the `TMPLSwap`, transferring all assets between the parties.
function fill(TMPLSwap calldata swap, bytes32 salt) external payable returns (address) {
function fillTMPL(TMPLSwap calldata swap, bytes32 salt) external payable returns (address) {
(address payable feeRecipient, uint16 basisPoints) = _platformFeeConfig();
address a =
_deploy(_bytecode(swap), msg.value, salt, ActionMessageLib.fillWithFeeConfig(feeRecipient, basisPoints));
Expand All @@ -36,7 +36,7 @@ abstract contract TMPLSwapperDeployer is TMPLSwapperPredictor, ETDeployer, Swapp
}

/// @dev Permanently invalidate the `TMPLSwap`.
function cancel(TMPLSwap calldata swap, bytes32 salt) external returns (address) {
function cancelTMPL(TMPLSwap calldata swap, bytes32 salt) external returns (address) {
if (msg.sender != swap.parties.seller && msg.sender != swap.parties.buyer) {
revert OnlyPartyCanCancel();
}
Expand All @@ -49,7 +49,7 @@ abstract contract TMPLSwapperDeployer is TMPLSwapperPredictor, ETDeployer, Swapp
* @notice Computes the address of the swapper contract that will be deployed to execute the `TMPLSwap`.
* @dev Important: see `TMPLSwapperProposer.propose()` as an alternative.
*/
function swapper(TMPLSwap calldata swap, bytes32 salt) external view returns (address) {
function swapperOfTMPL(TMPLSwap calldata swap, bytes32 salt) external view returns (address) {
return _swapper(swap, salt, address(this));
}
}
Expand All @@ -72,7 +72,7 @@ abstract contract TMPLSwapperProposer is TMPLSwapperPredictor, SwapperProposerBa
* @dev This function MAY be called on a different chain to the one on which the swap will occur, provided that the
* deployer contract has the same address.
*/
function propose(TMPLSwap calldata swap) external returns (bytes32, address) {
function proposeTMPL(TMPLSwap calldata swap) external returns (bytes32, address) {
// We use blockhash instead of difficulty to allow this to work on chains other than ETH mainnet. The
// malleability of block hashes is too low and their rate of production too slow for an attack based on
// discarding undesirable salts.
Expand Down
12 changes: 6 additions & 6 deletions test/ERC721ForERC20.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ contract ERC721ForERC20Test is ERC721ForXTest, ERC20Test {

/// @inheritdoc ERC721ForXTest
function _swapper(ERC721TestCase memory t) internal view override returns (address) {
return factory.swapper(_asSwap(t), t.base.salt);
return factory.swapperOfERC721ForERC20(_asSwap(t), t.base.salt);
}

/// @inheritdoc ERC721ForXTest
function _propose(ERC721TestCase memory t) internal override returns (bytes32 salt, address swapper) {
return factory.propose(_asSwap(t));
return factory.proposeERC721ForERC20(_asSwap(t));
}

/// @inheritdoc ERC721ForXTest
Expand All @@ -52,22 +52,22 @@ contract ERC721ForERC20Test is ERC721ForXTest, ERC20Test {

/// @inheritdoc ERC721ForXTest
function _fillSelector() internal pure override returns (bytes4) {
return ERC721ForERC20SwapperDeployer.fill.selector;
return ERC721ForERC20SwapperDeployer.fillERC721ForERC20.selector;
}

/// @inheritdoc ERC721ForXTest
function _cancelSelector() internal pure override returns (bytes4) {
return ERC721ForERC20SwapperDeployer.cancel.selector;
return ERC721ForERC20SwapperDeployer.cancelERC721ForERC20.selector;
}

/// @inheritdoc ERC721ForXTest
function _fill(ERC721TestCase memory t) internal override {
factory.fill(_asSwap(t), t.base.salt);
factory.fillERC721ForERC20(_asSwap(t), t.base.salt);
}

/// @inheritdoc ERC721ForXTest
function _cancel(ERC721TestCase memory t) internal override {
factory.cancel(_asSwap(t), t.base.salt);
factory.cancelERC721ForERC20(_asSwap(t), t.base.salt);
}

/// @inheritdoc ERC721ForXTest
Expand Down
12 changes: 6 additions & 6 deletions test/ERC721ForNative.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ contract ERC721ForNativeTest is ERC721ForXTest, NativeTokenTest {

/// @inheritdoc ERC721ForXTest
function _swapper(ERC721TestCase memory t) internal view override returns (address) {
return factory.swapper(_asSwap(t), t.base.salt);
return factory.swapperOfERC721ForNative(_asSwap(t), t.base.salt);
}

/// @inheritdoc ERC721ForXTest
function _propose(ERC721TestCase memory t) internal override returns (bytes32 salt, address swapper) {
return factory.propose(_asSwap(t));
return factory.proposeERC721ForNative(_asSwap(t));
}

/// @inheritdoc ERC721ForXTest
Expand All @@ -47,12 +47,12 @@ contract ERC721ForNativeTest is ERC721ForXTest, NativeTokenTest {

/// @inheritdoc ERC721ForXTest
function _fillSelector() internal pure override returns (bytes4) {
return ERC721ForNativeSwapperDeployer.fill.selector;
return ERC721ForNativeSwapperDeployer.fillERC721ForNative.selector;
}

/// @inheritdoc ERC721ForXTest
function _cancelSelector() internal pure override returns (bytes4) {
return ERC721ForNativeSwapperDeployer.cancel.selector;
return ERC721ForNativeSwapperDeployer.cancelERC721ForNative.selector;
}

/// @inheritdoc ERC721ForXTest
Expand All @@ -61,12 +61,12 @@ contract ERC721ForNativeTest is ERC721ForXTest, NativeTokenTest {
}

function _fill(ERC721TestCase memory t, uint256 callValue) internal {
factory.fill{value: callValue}(_asSwap(t), t.base.salt);
factory.fillERC721ForNative{value: callValue}(_asSwap(t), t.base.salt);
}

/// @inheritdoc ERC721ForXTest
function _cancel(ERC721TestCase memory t) internal override {
factory.cancel(_asSwap(t), t.base.salt);
factory.cancelERC721ForNative(_asSwap(t), t.base.salt);
}

/// @inheritdoc ERC721ForXTest
Expand Down
12 changes: 6 additions & 6 deletions test/MultiERC721ForERC20.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ contract MultiERC721ForERC20Test is ERC721ForXTest, ERC20Test {

/// @inheritdoc ERC721ForXTest
function _swapper(ERC721TestCase memory t) internal view override returns (address) {
return factory.swapper(_asSwap(t), t.base.salt);
return factory.swapperOfMultiERC721ForERC20(_asSwap(t), t.base.salt);
}

/// @inheritdoc ERC721ForXTest
function _propose(ERC721TestCase memory t) internal override returns (bytes32 salt, address swapper) {
return factory.propose(_asSwap(t));
return factory.proposeMultiERC721ForERC20(_asSwap(t));
}

/// @inheritdoc ERC721ForXTest
Expand All @@ -60,22 +60,22 @@ contract MultiERC721ForERC20Test is ERC721ForXTest, ERC20Test {

/// @inheritdoc ERC721ForXTest
function _fillSelector() internal pure override returns (bytes4) {
return MultiERC721ForERC20SwapperDeployer.fill.selector;
return MultiERC721ForERC20SwapperDeployer.fillMultiERC721ForERC20.selector;
}

/// @inheritdoc ERC721ForXTest
function _cancelSelector() internal pure override returns (bytes4) {
return MultiERC721ForERC20SwapperDeployer.cancel.selector;
return MultiERC721ForERC20SwapperDeployer.cancelMultiERC721ForERC20.selector;
}

/// @inheritdoc ERC721ForXTest
function _fill(ERC721TestCase memory t) internal override {
factory.fill(_asSwap(t), t.base.salt);
factory.fillMultiERC721ForERC20(_asSwap(t), t.base.salt);
}

/// @inheritdoc ERC721ForXTest
function _cancel(ERC721TestCase memory t) internal override {
factory.cancel(_asSwap(t), t.base.salt);
factory.cancelMultiERC721ForERC20(_asSwap(t), t.base.salt);
}

/// @inheritdoc ERC721ForXTest
Expand Down
12 changes: 6 additions & 6 deletions test/MultiERC721ForNative.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,12 @@ contract MultiERC721ForNativeTest is ERC721ForXTest, NativeTokenTest {

/// @inheritdoc ERC721ForXTest
function _swapper(ERC721TestCase memory t) internal view override returns (address) {
return factory.swapper(_asSwap(t), t.base.salt);
return factory.swapperOfMultiERC721ForNative(_asSwap(t), t.base.salt);
}

/// @inheritdoc ERC721ForXTest
function _propose(ERC721TestCase memory t) internal override returns (bytes32 salt, address swapper) {
return factory.propose(_asSwap(t));
return factory.proposeMultiERC721ForNative(_asSwap(t));
}

/// @inheritdoc ERC721ForXTest
Expand All @@ -56,12 +56,12 @@ contract MultiERC721ForNativeTest is ERC721ForXTest, NativeTokenTest {

/// @inheritdoc ERC721ForXTest
function _fillSelector() internal pure override returns (bytes4) {
return MultiERC721ForNativeSwapperDeployer.fill.selector;
return MultiERC721ForNativeSwapperDeployer.fillMultiERC721ForNative.selector;
}

/// @inheritdoc ERC721ForXTest
function _cancelSelector() internal pure override returns (bytes4) {
return MultiERC721ForNativeSwapperDeployer.cancel.selector;
return MultiERC721ForNativeSwapperDeployer.cancelMultiERC721ForNative.selector;
}

/// @inheritdoc ERC721ForXTest
Expand All @@ -70,12 +70,12 @@ contract MultiERC721ForNativeTest is ERC721ForXTest, NativeTokenTest {
}

function _fill(ERC721TestCase memory t, uint256 callValue) internal {
factory.fill{value: callValue}(_asSwap(t), t.base.salt);
factory.fillMultiERC721ForNative{value: callValue}(_asSwap(t), t.base.salt);
}

/// @inheritdoc ERC721ForXTest
function _cancel(ERC721TestCase memory t) internal override {
factory.cancel(_asSwap(t), t.base.salt);
factory.cancelMultiERC721ForNative(_asSwap(t), t.base.salt);
}

/// @inheritdoc ERC721ForXTest
Expand Down

0 comments on commit 68a36b8

Please sign in to comment.