Skip to content

Commit 2f847fc

Browse files
committed
change naming convention for encode view functions
1 parent 8093074 commit 2f847fc

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

packages/ethereum-contracts/contracts/interfaces/utils/IUserDefinedMacro.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ interface IUserDefinedMacro {
3333
/*
3434
* Additional to the required interface, we recommend to implement one or multiple view functions
3535
* which take operation specific typed arguments and return the abi encoded bytes.
36-
* As a convention, the name of those functions shall start with `params`.
36+
* As a convention, the name of those functions shall start with `encode`.
3737
*
3838
* Implementing this view function(s) has several advantages:
3939
* - Allows to build more complex macros with internally encapsulated dispatching logic

packages/ethereum-contracts/test/foundry/utils/MacroForwarder.t.sol

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ contract GoodMacro is IUserDefinedMacro {
6565
function postCheck(ISuperfluid host, bytes memory params, address msgSender) external view { }
6666

6767
// recommended view function for parameter encoding
68-
function paramsCreateFlows(ISuperToken token, int96 flowRate, address[] calldata recipients) external pure returns (bytes memory) {
68+
function encodeCreateFlows(ISuperToken token, int96 flowRate, address[] calldata recipients) external pure returns (bytes memory) {
6969
return abi.encode(token, flowRate, recipients);
7070
}
7171
}
@@ -103,7 +103,7 @@ contract MultiFlowDeleteMacro is IUserDefinedMacro {
103103
}
104104

105105
// recommended view function for parameter encoding
106-
function paramsDeleteFlows(ISuperToken superToken, address sender, address[] memory receivers, uint256 minBalanceAfter)
106+
function encodeDeleteFlows(ISuperToken superToken, address sender, address[] memory receivers, uint256 minBalanceAfter)
107107
external pure
108108
returns (bytes memory)
109109
{
@@ -320,7 +320,7 @@ contract MacroForwarderTest is FoundrySuperfluidTester {
320320
vm.startPrank(admin);
321321
// NOTE! This is different from abi.encode(superToken, int96(42), [bob, carol]),
322322
// which is a fixed array: address[2].
323-
sf.macroForwarder.runMacro(m, m.paramsCreateFlows(superToken, int96(42), recipients));
323+
sf.macroForwarder.runMacro(m, m.encodeCreateFlows(superToken, int96(42), recipients));
324324
assertEq(sf.cfa.getNetFlow(superToken, bob), 42);
325325
assertEq(sf.cfa.getNetFlow(superToken, carol), 42);
326326
vm.stopPrank();
@@ -355,7 +355,7 @@ contract MacroForwarderTest is FoundrySuperfluidTester {
355355
superToken.createFlow(recipients[i], 42);
356356
}
357357
// now batch-delete them
358-
sf.macroForwarder.runMacro(m, m.paramsDeleteFlows(superToken, sender, recipients, 0));
358+
sf.macroForwarder.runMacro(m, m.encodeDeleteFlows(superToken, sender, recipients, 0));
359359

360360
for (uint i = 0; i < recipients.length; ++i) {
361361
assertEq(sf.cfa.getNetFlow(superToken, recipients[i]), 0);

0 commit comments

Comments
 (0)