feat: change npm package name to @gelatonetwork/relay-context and sta…

…rt fresh
gelatodigital · Sep 7, 2022 · e39a479 · e39a479
1 parent 71b40a6
commit e39a479
Show file tree

Hide file tree

Showing 8 changed files with 50 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -1 +1 @@
-# relayer-context-contracts
+# relay-context-contracts
diff --git a/contracts/GelatoRelayContext.sol b/contracts/GelatoRelayContext.sol
@@ -5,7 +5,7 @@ import {TokenUtils} from "./lib/TokenUtils.sol";
 import {GELATO_RELAY} from "./constants/GelatoRelay.sol";
 
 /**
- * @dev Context variant with Gelato Relayer Fee support.
+ * @dev Context variant with Gelato Relay Fee support.
  * Expects calldata encoding:
  *   abi.encodePacked(bytes fnArgs, address feeCollectorAddress, address feeToken, uint256 fee)
  * Therefore, we're expecting 3 * 32bytes to be appended to normal msgData
@@ -22,17 +22,20 @@ abstract contract GelatoRelayContext {
     uint256 internal constant _FEE_TOKEN_START = 2 * 32;
     uint256 internal constant _FEE_START = 32;
 
-    modifier onlyRelayer() {
-        require(_isRelayer(msg.sender), "GelatoRelayContext.onlyRelayer");
+    modifier onlyGelatoRelay() {
+        require(
+            _isGelatoRelay(msg.sender),
+            "GelatoRelayContext.onlyGelatoRelay"
+        );
         _;
     }
 
-    // DANGER! Only use with onlyRelayer `_isRelayer` before transferring
+    // DANGER! Only use with onlyGelatoRelay `_isGelatoRelay` before transferring
     function _transferRelayFee() internal {
         _getFeeToken().transfer(_getFeeCollector(), _getFee());
     }
 
-    // DANGER! Only use with onlyRelayer `_isRelayer` before transferring
+    // DANGER! Only use with onlyGelatoRelay `_isGelatoRelay` before transferring
     function _transferRelayFeeCapped(uint256 _maxFee) internal {
         uint256 fee = _getFee();
         require(
@@ -42,7 +45,7 @@ abstract contract GelatoRelayContext {
         _getFeeToken().transfer(_getFeeCollector(), fee);
     }
 
-    function _isRelayer(address _forwarder)
+    function _isGelatoRelay(address _forwarder)
         internal
         view
         virtual
@@ -53,12 +56,12 @@ abstract contract GelatoRelayContext {
 
     function _msgData() internal view returns (bytes calldata) {
         return
-            _isRelayer(msg.sender)
+            _isGelatoRelay(msg.sender)
                 ? msg.data[:msg.data.length - _FEE_COLLECTOR_START]
                 : msg.data;
     }
 
-    // Only use with previous onlyRelayer or `_isRelayer` checks
+    // Only use with previous onlyGelatoRelay or `_isGelatoRelay` checks
     function _getFeeCollector() internal pure returns (address) {
         return
             abi.decode(
@@ -67,7 +70,7 @@ abstract contract GelatoRelayContext {
             );
     }
 
-    // Only use with previous onlyRelayer or `_isRelayer` checks
+    // Only use with previous onlyGelatoRelay or `_isGelatoRelay` checks
     function _getFeeToken() internal pure returns (address) {
         return
             abi.decode(
@@ -76,7 +79,7 @@ abstract contract GelatoRelayContext {
             );
     }
 
-    // Only use with previous onlyRelayer or `_isRelayer` checks
+    // Only use with previous onlyGelatoRelay or `_isGelatoRelay` checks
     function _getFee() internal pure returns (uint256) {
         return abi.decode(msg.data[msg.data.length - _FEE_START:], (uint256));
     }

diff --git a/contracts/__mocks__/MockGelatoRelayContext.sol b/contracts/__mocks__/MockGelatoRelayContext.sol
@@ -1,9 +1,6 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.1;
 
-// import {
-//     GelatoRelayContext
-// } from "@gelatonetwork/relayer-context/contracts/GelatoRelayContext.sol";
 import {GelatoRelayContext} from "../GelatoRelayContext.sol";
 
 contract MockGelatoRelayContext is GelatoRelayContext {
@@ -26,5 +23,5 @@ contract MockGelatoRelayContext is GelatoRelayContext {
     }
 
     // solhint-disable-next-line no-empty-blocks
-    function testOnlyRelayer() external onlyRelayer {}
+    function testOnlyGelatoRelay() external onlyGelatoRelay {}
 }
diff --git a/contracts/__mocks__/MockRelayer.sol → contracts/__mocks__/MockRelay.sol b/contracts/__mocks__/MockRelayer.sol → contracts/__mocks__/MockRelay.sol
@@ -2,13 +2,10 @@
 pragma solidity ^0.8.1;
 
 import {GelatoBytes} from "../lib/GelatoBytes.sol";
-// import {
-//     _encodeRelayerContext
-// } from "@gelatonetwork/relayer-context/contracts/functions/RelayerUtils.sol";
-import {_encodeRelayerContext} from "../functions/RelayerUtils.sol";
+import {_encodeGelatoRelayContext} from "../functions/GelatoRelayUtils.sol";
 
 /// @dev Mock contracts for testing - UNSAFE CODE - do not copy
-contract MockRelayer {
+contract MockRelay {
     using GelatoBytes for bytes;
 
     function forwardCall(
@@ -19,8 +16,8 @@ contract MockRelayer {
         uint256 _fee
     ) external {
         (bool success, bytes memory returndata) = _target.call(
-            _encodeRelayerContext(_data, _feeCollector, _feeToken, _fee)
+            _encodeGelatoRelayContext(_data, _feeCollector, _feeToken, _fee)
         );
-        if (!success) returndata.revertWithError("MockRelayer.forwardCall:");
+        if (!success) returndata.revertWithError("MockRelay.forwardCall:");
     }
 }
diff --git a/contracts/functions/RelayerUtils.sol → contracts/functions/GelatoRelayUtils.sol b/contracts/functions/RelayerUtils.sol → contracts/functions/GelatoRelayUtils.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.1;
 
-function _encodeRelayerContext(
+function _encodeGelatoRelayContext(
     bytes calldata _fnArgs,
     address _feeCollector,
     address _feeToken,

diff --git a/deploy/MockRelayer.deploy.ts → deploy/MockRelay.deploy.ts b/deploy/MockRelayer.deploy.ts → deploy/MockRelay.deploy.ts
@@ -11,7 +11,7 @@ const func: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
     process.exit(1);
   }
 
-  await deploy("MockRelayer", {
+  await deploy("MockRelay", {
     from: deployer,
   });
 };
@@ -20,6 +20,6 @@ func.skip = async (hre: HardhatRuntimeEnvironment) => {
   return hre.network.name !== "hardhat";
 };
 
-func.tags = ["MockRelayer"];
+func.tags = ["MockRelay"];
 
 export default func;
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "@gelatonetwork/relayer-context",
-  "version": "1.0.3",
-  "description": "Contains solidity helpers for implementing the Relayer Fee Context",
+  "name": "@gelatonetwork/relay-context",
+  "version": "0.0.0",
+  "description": "Solidity and test helpers for implementing GelatoRelayContext",
   "files": [
     "contracts/GelatoRelayContext.sol",
     "contracts/constants",
@@ -25,7 +25,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/gelatodigital/relayer-context-contracts.git"
+    "url": "git+https://github.com/gelatodigital/relay-context-contracts.git"
   },
   "license": "MIT",
   "dependencies": {

diff --git a/test/MockRelayerContext.test.ts b/test/MockRelayerContext.test.ts
@@ -1,14 +1,14 @@
 import hre = require("hardhat");
 import { expect } from "chai";
-import { MockRelayer, MockGelatoRelayContext, MockERC20 } from "../typechain";
+import { MockRelay, MockGelatoRelayContext, MockERC20 } from "../typechain";
 import { INIT_TOKEN_BALANCE as FEE } from "./constants";
 import { ethers } from "hardhat";
 
 const FEE_COLLECTOR = "0x3CACa7b48D0573D793d3b0279b5F0029180E83b6";
 
 describe("Test MockGelatoRelayContext Smart Contract", function () {
-  let mockRelayer: MockRelayer;
-  let mockRelayerContext: MockGelatoRelayContext;
+  let mockRelay: MockRelay;
+  let mockRelayContext: MockGelatoRelayContext;
   let mockERC20: MockERC20;
 
   let target: string;
@@ -22,18 +22,18 @@ describe("Test MockGelatoRelayContext Smart Contract", function () {
 
     await hre.deployments.fixture();
 
-    mockRelayer = await hre.ethers.getContract("MockRelayer");
-    mockRelayerContext = await hre.ethers.getContract("MockGelatoRelayContext");
+    mockRelay = await hre.ethers.getContract("MockRelay");
+    mockRelayContext = await hre.ethers.getContract("MockGelatoRelayContext");
     mockERC20 = await hre.ethers.getContract("MockERC20");
 
-    target = mockRelayerContext.address;
+    target = mockRelayContext.address;
     feeToken = mockERC20.address;
   });
 
   it("#1: emitContext", async () => {
-    const data = mockRelayerContext.interface.encodeFunctionData("emitContext");
+    const data = mockRelayContext.interface.encodeFunctionData("emitContext");
 
-    // Mimic RelayerUtils _encodeRelayerContext used on-chain by MockRelayer
+    // Mimic GelatoRelayUtils _encodeGelatoRelayContext used on-chain by MockRelay
     const encodedContextData = new ethers.utils.AbiCoder().encode(
       ["address", "address", "uint256"],
       [FEE_COLLECTOR, feeToken, FEE]
@@ -44,78 +44,78 @@ describe("Test MockGelatoRelayContext Smart Contract", function () {
     );
 
     await expect(
-      mockRelayer.forwardCall(target, data, FEE_COLLECTOR, feeToken, FEE)
+      mockRelay.forwardCall(target, data, FEE_COLLECTOR, feeToken, FEE)
     )
-      .to.emit(mockRelayerContext, "LogMsgData")
+      .to.emit(mockRelayContext, "LogMsgData")
       .withArgs(encodedData)
-      .and.to.emit(mockRelayerContext, "LogFnArgs")
+      .and.to.emit(mockRelayContext, "LogFnArgs")
       .withArgs(data)
-      .and.to.emit(mockRelayerContext, "LogContext")
+      .and.to.emit(mockRelayContext, "LogContext")
       .withArgs(FEE_COLLECTOR, feeToken, FEE);
   });
 
   it("#2: testTransferRelayFee", async () => {
-    const data = mockRelayerContext.interface.encodeFunctionData(
+    const data = mockRelayContext.interface.encodeFunctionData(
       "testTransferRelayFee"
     );
 
     await mockERC20.transfer(target, FEE);
 
-    await mockRelayer.forwardCall(target, data, FEE_COLLECTOR, feeToken, FEE);
+    await mockRelay.forwardCall(target, data, FEE_COLLECTOR, feeToken, FEE);
 
     expect(await mockERC20.balanceOf(FEE_COLLECTOR)).to.be.eq(FEE);
   });
 
   it("#3: testTransferRelayFeeCapped: works if at maxFee", async () => {
     const maxFee = FEE;
 
-    const data = mockRelayerContext.interface.encodeFunctionData(
+    const data = mockRelayContext.interface.encodeFunctionData(
       "testTransferRelayFeeCapped",
       [maxFee]
     );
 
     await mockERC20.transfer(target, FEE);
 
-    await mockRelayer.forwardCall(target, data, FEE_COLLECTOR, feeToken, FEE);
+    await mockRelay.forwardCall(target, data, FEE_COLLECTOR, feeToken, FEE);
 
     expect(await mockERC20.balanceOf(FEE_COLLECTOR)).to.be.eq(FEE);
   });
 
   it("#4: testTransferRelayFeeCapped: works if below maxFee", async () => {
     const maxFee = FEE.add(1);
 
-    const data = mockRelayerContext.interface.encodeFunctionData(
+    const data = mockRelayContext.interface.encodeFunctionData(
       "testTransferRelayFeeCapped",
       [maxFee]
     );
 
     await mockERC20.transfer(target, FEE);
 
-    await mockRelayer.forwardCall(target, data, FEE_COLLECTOR, feeToken, FEE);
+    await mockRelay.forwardCall(target, data, FEE_COLLECTOR, feeToken, FEE);
 
     expect(await mockERC20.balanceOf(FEE_COLLECTOR)).to.be.eq(FEE);
   });
 
   it("#5: testTransferRelayFeeCapped: reverts if above maxFee", async () => {
     const maxFee = FEE.sub(1);
 
-    const data = mockRelayerContext.interface.encodeFunctionData(
+    const data = mockRelayContext.interface.encodeFunctionData(
       "testTransferRelayFeeCapped",
       [maxFee]
     );
 
     await mockERC20.transfer(target, FEE);
 
     await expect(
-      mockRelayer.forwardCall(target, data, FEE_COLLECTOR, feeToken, FEE)
+      mockRelay.forwardCall(target, data, FEE_COLLECTOR, feeToken, FEE)
     ).to.be.revertedWith(
-      "MockRelayer.forwardCall:GelatoRelayContext._transferRelayFeeCapped: maxFee"
+      "MockRelay.forwardCall:GelatoRelayContext._transferRelayFeeCapped: maxFee"
     );
   });
 
-  it("#6: testOnlyRelayer reverts if not relayer", async () => {
-    await expect(mockRelayerContext.testOnlyRelayer()).to.be.revertedWith(
-      "GelatoRelayContext.onlyRelayer"
+  it("#6: testOnlyGelatoRelay reverts if not GelatoRelay", async () => {
+    await expect(mockRelayContext.testOnlyGelatoRelay()).to.be.revertedWith(
+      "GelatoRelayContext.onlyGelatoRelay"
     );
   });
 });
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		# relayer-context-contracts
		# relay-context-contracts