Merge pull request from NFTX-project/rescue-airdrop

create RescueAirdrop and Factory

Author: apoorvlathey

.env.sample

@@ -5,7 +5,9 @@ MAINNET_RPC_URL=
 SEPOLIA_RPC_URL=
 GOERLI_RPC_URL=
 ARBITRUM_RPC_URL=
+BASE_RPC_URL=
 ETHERSCAN_API_KEY=
 ARBISCAN_API_KEY=
+BASESCAN_API_KEY=
 DEPLOYER_PRIVATE_KEY=0x......
 SENDER=

deploy/RescueAirdrop.ts

@@ -0,0 +1,12 @@
+import { HardhatRuntimeEnvironment, Network } from "hardhat/types";
+import { DeployFunction } from "hardhat-deploy/types";
+import { deployRescueAidrop } from "./modules/RescueAirdrop";
+
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  const { rescueAirdropImpl } = await deployRescueAidrop({
+    hre,
+  });
+};
+export default func;
+func.tags = ["RescueAirdrop"];
+func.dependencies = [];

deploy/modules/RescueAirdrop.ts

@@ -0,0 +1,20 @@
+import { HardhatRuntimeEnvironment } from "hardhat/types";
+import { getConfig } from "../utils";
+
+export const deployRescueAidrop = async ({
+  hre,
+}: {
+  hre: HardhatRuntimeEnvironment;
+}) => {
+  const { deploy, deployer } = await getConfig(hre);
+
+  const rescueAirdropImpl = await deploy("RescueAirdropUpgradeable", {
+    from: deployer,
+    args: [],
+    log: true,
+  });
+
+  return {
+    rescueAirdropImpl: rescueAirdropImpl.address,
+  };
+};

deployments/base/.chainId

@@ -0,0 +1 @@
+8453

deployments/base/RescueAirdropUpgradeable.json

@@ -141,6 +141,17 @@ const config: HardhatUserConfig = {
         },
       },
     },
+    base: {
+      url: process.env.BASE_RPC_URL!,
+      accounts: [process.env.DEPLOYER_PRIVATE_KEY!],
+      timeout: 600000,
+      verify: {
+        etherscan: {
+          apiKey: process.env.BASESCAN_API_KEY,
+          apiUrl: "https://api.basescan.org/",
+        },
+      },
+    },
   },
   mocha: {
     timeout: 200000,

deployments/base/solcInputs/b0e14ad2bc5c956706ef47424355ba00.json

@@ -10,10 +10,12 @@
     "deploy:sepolia": "hardhat deploy --network sepolia",
     "deploy:mainnet": "hardhat deploy --network mainnet",
     "deploy:arbitrum": "hardhat deploy --network arbitrum",
+    "deploy:base": "hardhat deploy --network base",
     "verify:goerli": "hardhat --network goerli etherscan-verify",
     "verify:sepolia": "hardhat --network sepolia etherscan-verify",
     "verify:mainnet": "hardhat --network mainnet etherscan-verify",
     "verify:arbitrum": "hardhat --network arbitrum etherscan-verify",
+    "verify:base": "hardhat --network base etherscan-verify",
     "gen:addresses": "ts-node ./script/genAddressesJson.ts",
     "gen:readme": "ts-node ./script/genREADME.ts",
     "gen:addresses-and-readme": "yarn gen:addresses && yarn gen:readme"

hardhat.config.ts

@@ -0,0 +1,49 @@
+// SPDX-License-Identifier: MIT
+pragma solidity =0.8.15;
+
+// inheriting
+import {UpgradeableBeacon} from "@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol";
+import {BeaconProxy} from "@openzeppelin/contracts/proxy/beacon/BeaconProxy.sol";
+
+// interfaces
+import {IRescueAirdrop} from "@src/interfaces/IRescueAirdrop.sol";
+
+/**
+ * @title Rescue Airdrop Factory
+ * @author @apoorvlathey
+ *
+ * @notice Factory that deploys RescueAirdrop beacon proxies, by iterating the nonces.
+ */
+contract RescueAirdropFactory is UpgradeableBeacon {
+    uint256 public proxyCount;
+
+    event ProxyDeployed(uint256 indexed proxyCount, address proxy);
+
+    constructor(
+        address beaconImplementation
+    ) UpgradeableBeacon(beaconImplementation) {}
+
+    function deployNewProxies(uint256 count) external {
+        for (uint256 i; i < count; i++) {
+            _deployNewProxy();
+        }
+    }
+
+    function _deployNewProxy() internal {
+        address proxy = address(new BeaconProxy(address(this), ""));
+        IRescueAirdrop(proxy).__RescueAirdrop_init();
+
+        emit ProxyDeployed(proxyCount, proxy);
+
+        proxyCount++;
+    }
+
+    function rescueTokens(
+        address proxy,
+        address token,
+        address to,
+        uint256 amount
+    ) external onlyOwner {
+        IRescueAirdrop(proxy).rescueTokens(token, to, amount);
+    }
+}

package.json

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: MIT
+pragma solidity =0.8.15;
+
+// inheriting
+import {OwnableUpgradeable} from "@src/custom/OwnableUpgradeable.sol";
+import {IRescueAirdrop} from "@src/interfaces/IRescueAirdrop.sol";
+
+// libs
+import {SafeERC20Upgradeable, IERC20Upgradeable} from "@openzeppelin-upgradeable/contracts/token/ERC20/utils/SafeERC20Upgradeable.sol";
+
+/**
+ * @title Rescue Airdrop
+ * @author @apoorvlathey
+ *
+ * @notice Beacon Proxy implementation that allows to transfer ERC20 tokens stuck in a address, where this contract would eventually be deployed.
+ */
+contract RescueAirdropUpgradeable is OwnableUpgradeable, IRescueAirdrop {
+    using SafeERC20Upgradeable for IERC20Upgradeable;
+
+    function __RescueAirdrop_init() external override initializer {
+        // owner is the factory that'll deploy this contract
+        __Ownable_init();
+    }
+
+    function rescueTokens(
+        address token,
+        address to,
+        uint256 amount
+    ) external override onlyOwner {
+        IERC20Upgradeable(token).safeTransfer(to, amount);
+    }
+}