Scaffold project from send-token-upgrade

Why:
Bootstrap repository structure using the known baseline to
accelerate initial setup while keeping consistent tooling.

Test plan:
- List files; key scaffolding files exist.
- bunx hardhat compile succeeds.

Author: youngkidwarrior

.env.sample

@@ -0,0 +1,2 @@
+EOA_DEPLOYER=...
+ETHERSCAN_API_KEY=...

.envrc

@@ -0,0 +1 @@
+dotenv_if_exists .env

.gitignore

@@ -0,0 +1,32 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+broadcast/
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env
+
+node_modules
+.env
+
+# Hardhat files
+/cache
+
+# TypeChain files
+/typechain
+/typechain-types
+
+# solidity-coverage files
+/coverage
+/coverage.json
+
+# Hardhat Ignition default folder for deployments against a local node
+ignition/deployments/chain-31337

Tiltfile

@@ -0,0 +1,8 @@
+local_resource(
+    "send-token-upgrade-deploy",
+    cmd = os.path.join(__file__, "..", "bin", "anvil-deploy"),
+    resource_deps = [
+        "anvil:base",
+    ],
+)
+

bin/anvil-deploy

@@ -0,0 +1,54 @@
+#!/usr/bin/env bun run
+import "zx/globals";
+$.verbose = true;
+
+/**
+ * This script is used to deploy the Send token lockbox contract.
+ */
+
+const RPC_URL = "http://localhost:8546";
+const baseSendMVPDeployer = "0x7F314BffCB437b7046F469dE2457f9C4014931e1";
+
+const info = (msg: TemplateStringsArray, ..._: any[]) =>
+  console.log(chalk.blue(msg.join(" ")));
+
+void (async function main() {
+  info`Enable auto-mining...`;
+  await $`cast rpc --rpc-url ${RPC_URL} evm_setAutomine true`;
+
+  info`Impersonating the Base Send MVP Deployer...`;
+  await $`cast rpc --rpc-url ${RPC_URL} \
+    anvil_impersonateAccount \
+    ${baseSendMVPDeployer}`;
+
+  info`Funding the Base Send MVP Deployer...`;
+  await $`cast send --rpc-url ${RPC_URL} \
+              --unlocked \
+              --from 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266 \
+              ${baseSendMVPDeployer} \
+              --value 10ether`;
+
+  // remove previous deployments
+  const artifactsDir = path.resolve(
+    __dirname,
+    "..",
+    "ignition",
+    "deployments",
+    "chain-845337"
+  );
+  info`Removing previous deployments...`;
+  await $`rm -rf ${artifactsDir}`;
+
+  info`Deploying SendLockbox...`;
+  await $`echo yes | bunx hardhat ignition deploy --network anvil ./ignition/modules/SendToken.ts`;
+
+  info`Disable auto-mining...`;
+  await $`cast rpc --rpc-url ${RPC_URL} evm_setAutomine false`;
+
+  info`Re-enable interval mining... ${$.env.ANVIL_BLOCK_TIME ?? "2"}`;
+  await $`cast rpc --rpc-url ${RPC_URL} evm_setIntervalMining ${
+    $.env.ANVIL_BLOCK_TIME ?? "2"
+  }`; // mimics Tiltfile default
+
+  console.log(chalk.green("Done!"));
+})();

bunfig.toml

@@ -0,0 +1,2 @@
+[install.scopes]
+"0xsend" = { token = "$npm_token", url = "https://registry.npmjs.org/" }

contracts/ISendLockbox.sol

@@ -0,0 +1,9 @@
+// SPDX-License-Identifier: Apache 2
+pragma solidity ^0.8.28;
+
+interface ISendLockbox {
+    event Deposit(address indexed to, uint256 amount);
+
+    function deposit(uint256 amount) external;
+    function depositTo(address to, uint256 amount) external;
+}

contracts/ISendToken.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: Apache 2
+pragma solidity ^0.8.28;
+
+import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+
+interface ISendToken is IERC20 {
+    function mint(address to, uint256 amount) external;
+}

contracts/SendLockbox.sol

@@ -0,0 +1,51 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.28;
+
+import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+
+import "./ISendToken.sol";
+import "./ISendLockbox.sol";
+
+contract SendLockbox is ISendLockbox {
+    using SafeERC20 for IERC20;
+
+    /// @notice The old ERC20 token of this contract
+    IERC20 public immutable SEND_V0;
+
+    /// @notice The new ERC20 token of this contract
+    ISendToken public immutable SEND_V1;
+
+    /// @param sendv0 The address of the old ERC20 contract
+    /// @param sendv1 The address of the new ERC20 contract
+    constructor(address sendv0, address sendv1) {
+        SEND_V0 = IERC20(sendv0);
+        SEND_V1 = ISendToken(sendv1);
+    }
+
+    /// @notice Deposit tokens into the lockbox and mints the new token to sender
+    /// @param amount The amount of tokens to deposit
+    function deposit(uint256 amount) external {
+        _deposit(msg.sender, amount);
+    }
+
+    /// @notice Deposit ERC20 tokens into the lockbox
+    /// @param to The user who should received minted tokens
+    /// @param amount The amount of tokens to deposit
+    function depositTo(address to, uint256 amount) external {
+        _deposit(to, amount);
+    }
+
+    /// @notice Deposit tokens into the lockbox
+    /// @param to The user who should received minted tokens
+    /// @param amount The amount of tokens to deposit
+    function _deposit(address to, uint256 amount) internal {
+        SEND_V0.safeTransferFrom(msg.sender, address(this), amount);
+        emit Deposit(to, amount);
+
+        /// @notice v0 token has 0 decimals, v1 token has 18 decimals, therefore we multiply by 1 ether
+        /// @notice v0 token has 100B supply, v1 token has 1B supply, therefore divided by 100
+        uint256 amountToMint = (amount * 1 ether) / 100;
+        SEND_V1.mint(to, amountToMint);
+    }
+}

contracts/SendToken.sol

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.28;
+
+import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol";
+
+/*
+ 
+    ███████╗███████╗███╗   ██╗██████╗     ██╗████████╗
+    ██╔════╝██╔════╝████╗  ██║██╔══██╗    ██║╚══██╔══╝
+    ███████╗█████╗  ██╔██╗ ██║██║  ██║    ██║   ██║
+    ╚════██║██╔══╝  ██║╚██╗██║██║  ██║    ██║   ██║
+    ███████║███████╗██║ ╚████║██████╔╝    ██║   ██║
+    ╚══════╝╚══════╝╚═╝  ╚═══╝╚═════╝     ╚═╝   ╚═╝
+
+*/
+contract SendToken is ERC20Burnable {
+    address public immutable lockbox;
+
+    constructor(
+        string memory _name,
+        string memory _symbol,
+        address _lockbox
+    ) ERC20(_name, _symbol) {
+        require(_lockbox != address(0), "ZL");
+        lockbox = _lockbox;
+    }
+
+    function mint(address to, uint256 amount) external {
+        require(msg.sender == lockbox, "NL");
+        _mint(to, amount);
+    }
+}