Dev

LICENSE

@@ -60,13 +60,13 @@ The Business Source License (this document, or the "License") is not an Open Sou
 This project incorporates code from or depends upon the following projects:
 
 ### GPL-licensed dependencies:
-- **Uniswap V3 Core and Periphery** ([v3-core](https://github.com/Uniswap/v3-core), [v3-periphery](https://github.com/Uniswap/v3-periphery)), licensed under GPL-2.0-or-later
-- **Morpho's MetaMorpho** ([metamorpho](https://github.com/morpho-org/metamorpho)), licensed under GPL-2.0
+- **Uniswap V3 Core and Periphery** (use its interface for the AMM model without modification to the dependency) ([v3-core](https://github.com/Uniswap/v3-core), [v3-periphery](https://github.com/Uniswap/v3-periphery)), licensed under GPL-2.0-or-later
+- **Morpho's MetaMorpho**( use its interface to swap tokens on Morpho without modification to the dependency) ([metamorpho](https://github.com/morpho-org/metamorpho)), licensed under GPL-2.0
+- **Pendle Core V2** (use its interface to swap tokens on Pendle without modification to the dependency) ([pendle-core-v2-public](https://github.com/pendle-finance/pendle-core-v2-public)), licensed under GPL-3.0-or-later
 
-### Other dependencies:
+### MIT-licensed dependencies:
 - **OpenZeppelin Contracts** ([openzeppelin-contracts](https://github.com/OpenZeppelin/openzeppelin-contracts), [openzeppelin-contracts-upgradeable](https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable)), licensed under MIT
 - **Chainlink** ([chainlink](https://github.com/smartcontractkit/chainlink)), licensed under MIT
-- **Pendle Core V2** ([pendle-core-v2-public](https://github.com/pendle-finance/pendle-core-v2-public)), licensed under BUSL-1.1
 - **Foundry's forge-std** ([forge-std](https://github.com/foundry-rs/forge-std)), licensed under MIT
 
 Users of this software must comply with the terms of all applicable licenses.

README.md

@@ -35,6 +35,12 @@ Test without fork.
 $ forge test --skip Fork
 ```
 
+Using '--isolate' when testing TermMaxVault.
+
+```shell
+$ forge test --skip Fork --isolate
+```
+
 Using test scripts can configure multiple environments more flexibly, it will automatically configure the environment variables you need.
 Do unit test if you have an env file named sepolia.env.
 

SCRIPT_USAGE.md

@@ -24,6 +24,7 @@ The `script.sh` utility is a flexible command runner that can handle both deploy
     - `deploy:market` - Deploy Market contracts
     - `deploy:order` - Deploy Order contracts
     - `deploy:vault` - Deploy Vault contracts
+    - `deploy:pretmx` - Deploy PreTMX token contract
   - Script commands:
     - `script:<script-name>` - Run a custom script (e.g., `script:GrantRoles`, `script:SubmitOracles`)
 
@@ -63,6 +64,15 @@ The `script.sh` utility is a flexible command runner that can handle both deploy
 
 # Run E2ETest script on Arbitrum Sepolia 
 ./script.sh arb-sepolia script:E2ETest
+
+# Deploy PreTMX token contract on Ethereum Sepolia (dry run)
+./script.sh eth-sepolia deploy:pretmx
+
+# Deploy PreTMX token contract on Arbitrum Mainnet and broadcast transactions
+./script.sh arb-mainnet deploy:pretmx --broadcast
+
+# Deploy PreTMX token contract with verification on Ethereum Mainnet
+./script.sh eth-mainnet deploy:pretmx --broadcast --verify
 ```
 
 ## System Setup Flow
@@ -114,6 +124,46 @@ The proper sequence for setting up the TermMax system is as follows:
 
 Following this sequence ensures that contracts are deployed with the correct dependency chain and permissions setup.
 
+## PreTMX Token Deployment
+
+The PreTMX token can be deployed independently of the main system flow as it's a standalone tokenomics contract:
+
+```bash
+# Deploy PreTMX token contract
+./script.sh <network> deploy:pretmx --broadcast
+```
+
+This creates a `<network>-pretmx.json` file containing the PreTMX token contract details.
+
+### PreTMX Token Features
+
+- **Token Name**: "Pre TermMax Token"
+- **Symbol**: "pTMX"
+- **Initial Supply**: 1,000,000,000 tokens (1e9 ether)
+- **Access Control**: Uses `Ownable2Step` for secure ownership transfer
+- **Transfer Restrictions**: Transfers are initially restricted and require whitelisting
+- **Initial State**: Admin is whitelisted for both sending and receiving transfers
+
+### Post-Deployment Management
+
+After deployment, the admin can manage the token through the following functions:
+
+1. **Transfer Restrictions**:
+   - `enableTransfer()` - Remove all transfer restrictions
+   - `disableTransfer()` - Re-enable transfer restrictions
+
+2. **Whitelist Management**:
+   - `whitelistTransferFrom(address, bool)` - Allow/disallow an address to send tokens
+   - `whitelistTransferTo(address, bool)` - Allow/disallow an address to receive tokens
+
+3. **Token Operations**:
+   - `mint(address, uint256)` - Mint additional tokens (admin only)
+   - `burn(uint256)` - Burn tokens (any token holder)
+
+4. **Ownership Transfer** (Two-step process for security):
+   - `transferOwnership(address)` - Initiate ownership transfer
+   - New owner calls `acceptOwnership()` - Complete the transfer
+
 ## Special Environment Variables
 
 Some scripts require specific environment variables:
@@ -165,4 +215,225 @@ The oracle update process consists of two steps:
 2. **Accept Oracles**: After the timelock period, use the `AcceptOracles` script to accept the pending oracles.
    ```bash
    ./script.sh <network> script:AcceptOracles --broadcast
-   ```
+   ```
+
+## Date Suffix System for Script JSON Output
+
+The script system automatically appends date suffixes to JSON output files to create unique, timestamped records for each execution.
+
+### Overview
+
+The system automatically appends date suffixes to JSON output files to:
+- Create unique records for each script execution
+- Prevent overwriting previous execution results
+- Enable historical tracking of deployments and contract interactions
+- Facilitate auditing and debugging
+
+### Date Format
+
+The date suffix uses the format: `DDMMMYYYY` (e.g., `15JAN2024`)
+- `DD`: Two-digit day (01-31)
+- `MMM`: Three-letter month abbreviation (JAN, FEB, MAR, etc.)
+- `YYYY`: Four-digit year
+
+### File Structure
+
+#### Deployment Scripts
+Deployment scripts save JSON files to: `/deployments/{network}/{network}-{contractType}-{dateSuffix}.json`
+
+Examples:
+- `/deployments/eth-sepolia/eth-sepolia-pretmx-15JAN2024.json`
+- `/deployments/arb-mainnet/arb-mainnet-core-15JAN2024.json`
+- `/deployments/eth-mainnet/eth-mainnet-access-manager-15JAN2024.json`
+
+#### Contract Call Scripts
+Contract call scripts save JSON files to: `/executions/{network}/{network}-{scriptName}-{dateSuffix}.json`
+
+Examples:
+- `/executions/eth-sepolia/eth-sepolia-SubmitOracles-15JAN2024.json`
+- `/executions/arb-mainnet/arb-mainnet-AcceptOracles-15JAN2024.json`
+- `/executions/eth-mainnet/eth-mainnet-GrantRoles-15JAN2024.json`
+
+### Implementation
+
+#### For Deployment Scripts
+
+Deployment scripts inherit from `DeployBase` which provides:
+
+```solidity
+// Helper function to generate date suffix
+function getDateSuffix() internal view returns (string memory) {
+    return StringHelper.convertTimestampToDateString(block.timestamp);
+}
+
+// Helper function to create deployment file path with date suffix
+function getDeploymentFilePath(string memory network, string memory contractType) 
+    internal view returns (string memory) {
+    string memory dateSuffix = getDateSuffix();
+    string memory deploymentsDir = string.concat(vm.projectRoot(), "/deployments/", network);
+    return string.concat(deploymentsDir, "/", network, "-", contractType, "-", dateSuffix, ".json");
+}
+```
+
+Usage in deployment scripts:
+```solidity
+// Write the JSON file with date suffix
+string memory filePath = getDeploymentFilePath(network, "pretmx");
+vm.writeFile(filePath, deploymentJson);
+```
+
+#### For Contract Call Scripts
+
+Contract call scripts inherit from `ScriptBase` which provides:
+
+```solidity
+// Helper function to create script execution file path with date suffix
+function getScriptExecutionFilePath(string memory network, string memory scriptName) 
+    internal view returns (string memory) {
+    string memory dateSuffix = getDateSuffix();
+    string memory executionsDir = string.concat(vm.projectRoot(), "/executions/", network);
+    return string.concat(executionsDir, "/", network, "-", scriptName, "-", dateSuffix, ".json");
+}
+
+// Helper function to write script execution results to JSON
+function writeScriptExecutionResults(
+    string memory network,
+    string memory scriptName,
+    string memory executionData
+) internal {
+    // Create executions directory if it doesn't exist
+    string memory executionsDir = string.concat(vm.projectRoot(), "/executions/", network);
+    if (!vm.exists(executionsDir)) {
+        vm.createDir(executionsDir, true);
+    }
+
+    // Write the JSON file with date suffix
+    string memory filePath = getScriptExecutionFilePath(network, scriptName);
+    vm.writeFile(filePath, executionData);
+    console.log("Script execution information written to:", filePath);
+}
+```
+
+Usage in contract call scripts:
+```solidity
+// Generate execution results JSON
+uint256 currentBlock = block.number;
+uint256 currentTimestamp = block.timestamp;
+
+string memory baseJson = createBaseExecutionJson(network, "SubmitOracles", currentBlock, currentTimestamp);
+
+// Add script-specific data
+string memory executionJson = string(
+    abi.encodePacked(
+        baseJson,
+        ',\n',
+        '  "results": {\n',
+        '    "totalConfigs": "',
+        vm.toString(configs.length),
+        '"\n',
+        "  }\n",
+        "}"
+    )
+);
+
+writeScriptExecutionResults(network, "SubmitOracles", executionJson);
+```
+
+### JSON Structure
+
+#### Deployment Scripts JSON
+```json
+{
+  "network": "eth-sepolia",
+  "deployedAt": "1705334400",
+  "gitBranch": "main",
+  "gitCommitHash": "0xabc123...",
+  "blockInfo": {
+    "number": "12345678",
+    "timestamp": "1705334400"
+  },
+  "deployer": "0x123...",
+  "admin": "0x456...",
+  "contracts": {
+    "preTMX": {
+      "address": "0x789...",
+      "name": "PreTMX Token",
+      "symbol": "PreTMX",
+      "totalSupply": "1000000000000000000000000000",
+      "owner": "0x456...",
+      "transferRestricted": true
+    }
+  }
+}
+```
+
+#### Contract Call Scripts JSON
+```json
+{
+  "network": "eth-sepolia",
+  "scriptName": "SubmitOracles",
+  "executedAt": "1705334400",
+  "gitBranch": "main",
+  "gitCommitHash": "0xabc123...",
+  "blockInfo": {
+    "number": "12345678",
+    "timestamp": "1705334400"
+  },
+  "results": {
+    "totalConfigs": "5",
+    "oracleAggregatorAddress": "0x123...",
+    "accessManagerAddress": "0x456..."
+  }
+}
+```
+
+### Updated Scripts
+
+#### Deployment Scripts
+- ✅ `DeployBase.s.sol` - Base contract with date suffix utilities
+- ✅ `DeployPretmx.s.sol` - Updated to use date suffixes
+
+#### Contract Call Scripts
+- ✅ `ScriptBase.sol` - Base contract with JSON output and date suffix utilities
+- ✅ `SubmitOracles.s.sol` - Updated with JSON output and date suffixes
+- ✅ `AcceptOracles.s.sol` - Updated with JSON output and date suffixes
+- ✅ `GrantRoles.s.sol` - Updated with JSON output and date suffixes
+
+#### Scripts to Update
+Other contract call scripts can be updated by:
+1. Changing inheritance from `Script` to `ScriptBase`
+2. Adding JSON output generation at the end of the `run()` function
+3. Using `writeScriptExecutionResults()` to save the JSON file
+
+### Benefits
+
+1. **Historical Tracking**: Each execution creates a unique record
+2. **Audit Trail**: Complete history of deployments and contract interactions
+3. **Debugging**: Easy to compare different execution results
+4. **No Overwrites**: Previous execution data is preserved
+5. **Organized Storage**: Clear separation between deployments and executions
+6. **Timestamped Records**: Easy to identify when operations occurred
+
+### Directory Structure
+
+```
+project-root/
+├── deployments/
+│   ├── eth-sepolia/
+│   │   ├── eth-sepolia-pretmx-15JAN2024.json
+│   │   ├── eth-sepolia-core-15JAN2024.json
+│   │   └── eth-sepolia-access-manager-14JAN2024.json
+│   └── arb-mainnet/
+│       ├── arb-mainnet-pretmx-15JAN2024.json
+│       └── arb-mainnet-core-15JAN2024.json
+└── executions/
+    ├── eth-sepolia/
+    │   ├── eth-sepolia-SubmitOracles-15JAN2024.json
+    │   ├── eth-sepolia-AcceptOracles-15JAN2024.json
+    │   └── eth-sepolia-GrantRoles-14JAN2024.json
+    └── arb-mainnet/
+        ├── arb-mainnet-SubmitOracles-15JAN2024.json
+        └── arb-mainnet-AcceptOracles-15JAN2024.json
+```
+
+This system ensures comprehensive tracking of all script executions while maintaining organized, timestamped records for audit and debugging purposes.