@diamondslab/diamonds 1.1.0 → 1.2.0

package/examples/defender-deployment/contracts/ExampleFacet1.sol

@@ -1,84 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity ^0.8.17;
-
-contract ExampleFacet1 {
-    bytes32 constant STORAGE_POSITION = keccak256("example.facet1.storage");
-    
-    struct FacetStorage {
-        uint256 value;
-        bool initialized;
-        address owner;
-        string name;
-    }
-    
-    function facetStorage() internal pure returns (FacetStorage storage fs) {
-        bytes32 position = STORAGE_POSITION;
-        assembly {
-            fs.slot := position
-        }
-    }
-    
-    event Initialized(address indexed owner, string name);
-    event ValueSet(uint256 oldValue, uint256 newValue);
-    event UpgradedToV1(uint256 timestamp);
-    
-    function initialize() external {
-        FacetStorage storage fs = facetStorage();
-        require(!fs.initialized, "Already initialized");
-        
-        fs.initialized = true;
-        fs.owner = msg.sender;
-        fs.name = "ExampleFacet1";
-        fs.value = 100;
-        
-        emit Initialized(msg.sender, fs.name);
-    }
-    
-    function setValue(uint256 _value) external {
-        FacetStorage storage fs = facetStorage();
-        require(fs.initialized, "Not initialized");
-        require(msg.sender == fs.owner, "Not owner");
-        
-        uint256 oldValue = fs.value;
-        fs.value = _value;
-        
-        emit ValueSet(oldValue, _value);
-    }
-    
-    function getValue() external view returns (uint256) {
-        FacetStorage storage fs = facetStorage();
-        return fs.value;
-    }
-    
-    function getName() external view returns (string memory) {
-        FacetStorage storage fs = facetStorage();
-        return fs.name;
-    }
-    
-    function getOwner() external view returns (address) {
-        FacetStorage storage fs = facetStorage();
-        return fs.owner;
-    }
-    
-    function isInitialized() external view returns (bool) {
-        FacetStorage storage fs = facetStorage();
-        return fs.initialized;
-    }
-    
-    // Version 1.0 upgrade function
-    function upgradeToV1() external {
-        FacetStorage storage fs = facetStorage();
-        require(fs.initialized, "Not initialized");
-        require(msg.sender == fs.owner, "Not owner");
-        
-        // Upgrade logic here
-        fs.name = "ExampleFacet1_V1";
-        
-        emit UpgradedToV1(block.timestamp);
-    }
-    
-    // Version selector for upgrades
-    function version() external pure returns (string memory) {
-        return "1.0.0";
-    }
-}

package/examples/defender-deployment/contracts/ExampleFacet2.sol

@@ -1,104 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity ^0.8.17;
-
-contract ExampleFacet2 {
-    bytes32 constant STORAGE_POSITION = keccak256("example.facet2.storage");
-    
-    struct FacetStorage {
-        mapping(address => uint256) balances;
-        uint256 totalSupply;
-        bool setupComplete;
-        uint256 setupTimestamp;
-    }
-    
-    function facetStorage() internal pure returns (FacetStorage storage fs) {
-        bytes32 position = STORAGE_POSITION;
-        assembly {
-            fs.slot := position
-        }
-    }
-    
-    event Setup(uint256 timestamp);
-    event BalanceUpdated(address indexed account, uint256 oldBalance, uint256 newBalance);
-    event Transfer(address indexed from, address indexed to, uint256 amount);
-    
-    function setup() external {
-        FacetStorage storage fs = facetStorage();
-        require(!fs.setupComplete, "Already setup");
-        
-        fs.setupComplete = true;
-        fs.setupTimestamp = block.timestamp;
-        fs.totalSupply = 1000000; // 1M tokens
-        fs.balances[msg.sender] = fs.totalSupply;
-        
-        emit Setup(block.timestamp);
-        emit BalanceUpdated(msg.sender, 0, fs.totalSupply);
-    }
-    
-    function isSetupComplete() external view returns (bool) {
-        FacetStorage storage fs = facetStorage();
-        return fs.setupComplete;
-    }
-    
-    function getSetupTimestamp() external view returns (uint256) {
-        FacetStorage storage fs = facetStorage();
-        return fs.setupTimestamp;
-    }
-    
-    function balanceOf(address account) external view returns (uint256) {
-        FacetStorage storage fs = facetStorage();
-        return fs.balances[account];
-    }
-    
-    function totalSupply() external view returns (uint256) {
-        FacetStorage storage fs = facetStorage();
-        return fs.totalSupply;
-    }
-    
-    function transfer(address to, uint256 amount) external returns (bool) {
-        FacetStorage storage fs = facetStorage();
-        require(fs.setupComplete, "Not setup");
-        require(fs.balances[msg.sender] >= amount, "Insufficient balance");
-        
-        uint256 fromBalance = fs.balances[msg.sender];
-        uint256 toBalance = fs.balances[to];
-        
-        fs.balances[msg.sender] = fromBalance - amount;
-        fs.balances[to] = toBalance + amount;
-        
-        emit BalanceUpdated(msg.sender, fromBalance, fs.balances[msg.sender]);
-        emit BalanceUpdated(to, toBalance, fs.balances[to]);
-        emit Transfer(msg.sender, to, amount);
-        
-        return true;
-    }
-    
-    function mint(address to, uint256 amount) external returns (bool) {
-        FacetStorage storage fs = facetStorage();
-        require(fs.setupComplete, "Not setup");
-        
-        uint256 oldBalance = fs.balances[to];
-        fs.balances[to] = oldBalance + amount;
-        fs.totalSupply += amount;
-        
-        emit BalanceUpdated(to, oldBalance, fs.balances[to]);
-        emit Transfer(address(0), to, amount);
-        
-        return true;
-    }
-    
-    function burn(uint256 amount) external returns (bool) {
-        FacetStorage storage fs = facetStorage();
-        require(fs.setupComplete, "Not setup");
-        require(fs.balances[msg.sender] >= amount, "Insufficient balance");
-        
-        uint256 oldBalance = fs.balances[msg.sender];
-        fs.balances[msg.sender] = oldBalance - amount;
-        fs.totalSupply -= amount;
-        
-        emit BalanceUpdated(msg.sender, oldBalance, fs.balances[msg.sender]);
-        emit Transfer(msg.sender, address(0), amount);
-        
-        return true;
-    }
-}

package/examples/defender-deployment/contracts/UpgradeFacet.sol

@@ -1,92 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity ^0.8.17;
-
-contract UpgradeFacet {
-    bytes32 constant STORAGE_POSITION = keccak256("upgrade.facet.storage");
-    
-    struct FacetStorage {
-        uint256 upgradeCount;
-        mapping(uint256 => uint256) upgradeTimestamps;
-        bool initialized;
-        string[] upgradeLog;
-    }
-    
-    function facetStorage() internal pure returns (FacetStorage storage fs) {
-        bytes32 position = STORAGE_POSITION;
-        assembly {
-            fs.slot := position
-        }
-    }
-    
-    event Initialized(uint256 timestamp);
-    event UpgradeLogged(uint256 indexed upgradeId, string description, uint256 timestamp);
-    event SystemUpgraded(string version, uint256 timestamp);
-    
-    function initialize() external {
-        FacetStorage storage fs = facetStorage();
-        require(!fs.initialized, "Already initialized");
-        
-        fs.initialized = true;
-        fs.upgradeCount = 0;
-        
-        emit Initialized(block.timestamp);
-    }
-    
-    function logUpgrade(string memory description) external {
-        FacetStorage storage fs = facetStorage();
-        require(fs.initialized, "Not initialized");
-        
-        uint256 upgradeId = fs.upgradeCount++;
-        fs.upgradeTimestamps[upgradeId] = block.timestamp;
-        fs.upgradeLog.push(description);
-        
-        emit UpgradeLogged(upgradeId, description, block.timestamp);
-    }
-    
-    function getUpgradeCount() external view returns (uint256) {
-        FacetStorage storage fs = facetStorage();
-        return fs.upgradeCount;
-    }
-    
-    function getUpgradeTimestamp(uint256 upgradeId) external view returns (uint256) {
-        FacetStorage storage fs = facetStorage();
-        require(upgradeId < fs.upgradeCount, "Invalid upgrade ID");
-        return fs.upgradeTimestamps[upgradeId];
-    }
-    
-    function getUpgradeLog() external view returns (string[] memory) {
-        FacetStorage storage fs = facetStorage();
-        return fs.upgradeLog;
-    }
-    
-    function getLatestUpgrade() external view returns (string memory, uint256) {
-        FacetStorage storage fs = facetStorage();
-        require(fs.upgradeCount > 0, "No upgrades logged");
-        
-        uint256 latestId = fs.upgradeCount - 1;
-        return (fs.upgradeLog[latestId], fs.upgradeTimestamps[latestId]);
-    }
-    
-    function markSystemUpgrade(string memory _version) external {
-        FacetStorage storage fs = facetStorage();
-        require(fs.initialized, "Not initialized");
-        
-        string memory description = string(abi.encodePacked("System upgrade to version ", _version));
-        
-        uint256 upgradeId = fs.upgradeCount++;
-        fs.upgradeTimestamps[upgradeId] = block.timestamp;
-        fs.upgradeLog.push(description);
-        
-        emit UpgradeLogged(upgradeId, description, block.timestamp);
-        emit SystemUpgraded(_version, block.timestamp);
-    }
-    
-    function isInitialized() external view returns (bool) {
-        FacetStorage storage fs = facetStorage();
-        return fs.initialized;
-    }
-    
-    function version() external pure returns (string memory) {
-        return "1.0.0";
-    }
-}

package/examples/defender-deployment/deploy-script.ts

@@ -1,170 +0,0 @@
-import { ethers } from 'hardhat';
-import { Diamond } from '../../src/core/Diamond';
-import { DiamondDeployer } from '../../src/core/DiamondDeployer';
-import { FileDeploymentRepository } from '../../src/repositories/FileDeploymentRepository';
-import { OZDefenderDeploymentStrategy } from '../../src/strategies/OZDefenderDeploymentStrategy';
-import * as path from 'path';
-import * as fs from 'fs-extra';
-
-async function main() {
-  console.log('🚀 Starting Defender deployment...');
-
-  // Get network information
-  const network = await ethers.provider.getNetwork();
-  const signers = await ethers.getSigners();
-  const deployer = signers[0];
-
-  console.log(`📍 Network: ${network.name} (${network.chainId})`);
-  console.log(`👤 Deployer: ${deployer.address}`);
-
-  // Load configuration
-  const configPath = path.join(__dirname, 'diamond-config.json');
-  const exampleConfig = {
-    diamondName: 'ExampleDiamond',
-    networkName: network.name,
-    chainId: network.chainId,
-    deploymentsPath: path.join(__dirname, 'deployments'),
-    contractsPath: path.join(__dirname, 'contracts'),
-    callbacksPath: path.join(__dirname, 'callbacks'),
-    configFilePath: configPath,
-    deployedDiamondDataFilePath: path.join(__dirname, 'deployments', `examplediamond-${network.name}-${network.chainId}.json`)
-  };
-
-  // Ensure directories exist
-  await fs.ensureDir(exampleConfig.deploymentsPath);
-  await fs.ensureDir(exampleConfig.callbacksPath);
-
-  // Create diamond instance
-  const repository = new FileDeploymentRepository(exampleConfig);
-  const diamond = new Diamond(exampleConfig, repository);
-
-  // Setup provider and signer
-  diamond.setProvider(ethers.provider);
-  diamond.setSigner(deployer);
-
-  // Validate environment variables
-  const requiredEnvVars = [
-    'DEFENDER_API_KEY',
-    'DEFENDER_API_SECRET',
-    'DEFENDER_RELAYER_ADDRESS',
-    'DEFENDER_SAFE_ADDRESS'
-  ];
-
-  for (const envVar of requiredEnvVars) {
-    if (!process.env[envVar]) {
-      console.error(`❌ Missing required environment variable: ${envVar}`);
-      console.log('Please check your .env file and ensure all Defender credentials are set.');
-      process.exit(1);
-    }
-  }
-
-  // Create Defender strategy
-  const strategy = new OZDefenderDeploymentStrategy(
-    process.env.DEFENDER_API_KEY!,
-    process.env.DEFENDER_API_SECRET!,
-    process.env.DEFENDER_RELAYER_ADDRESS!,
-    process.env.AUTO_APPROVE === 'true',
-    process.env.DEFENDER_SAFE_ADDRESS!,
-    'Safe',
-    true // verbose logging
-  );
-
-  console.log('🛡️ Defender strategy configured');
-  console.log(`⚙️ Auto-approve: ${process.env.AUTO_APPROVE === 'true' ? 'enabled' : 'disabled'}`);
-
-  // Execute deployment
-  const diamondDeployer = new DiamondDeployer(diamond, strategy);
-
-  try {
-    await diamondDeployer.deployDiamond();
-
-    console.log('\n✅ Deployment completed successfully!');
-
-    // Output deployment information
-    const deployedData = diamond.getDeployedDiamondData();
-    console.log('\n📊 Deployment Summary:');
-    console.log(`Diamond Address: ${deployedData.DiamondAddress}`);
-    console.log(`Deployer Address: ${deployedData.DeployerAddress}`);
-    console.log(`Network: ${network.name} (Chain ID: ${network.chainId})`);
-
-    console.log('\n📋 Deployed Facets:');
-    if (deployedData.DeployedFacets) {
-      Object.entries(deployedData.DeployedFacets).forEach(([name, facet]) => {
-        console.log(`  ${name}:`);
-        console.log(`    Address: ${facet.address}`);
-        console.log(`    Version: ${facet.version}`);
-        console.log(`    Selectors: ${facet.funcSelectors?.length || 0}`);
-        if (facet.tx_hash) {
-          console.log(`    TX Hash: ${facet.tx_hash}`);
-        }
-      });
-    }
-
-    // Save deployment summary
-    const summary = {
-      timestamp: new Date().toISOString(),
-      network: network.name,
-      chainId: network.chainId,
-      deployerAddress: deployer.address,
-      diamondAddress: deployedData.DiamondAddress,
-      facets: deployedData.DeployedFacets,
-      deploymentMethod: 'OpenZeppelin Defender'
-    };
-
-    const summaryPath = path.join(exampleConfig.deploymentsPath, 'deployment-summary.json');
-    await fs.writeJson(summaryPath, summary, { spaces: 2 });
-
-    console.log(`\n📄 Deployment summary saved to: ${summaryPath}`);
-
-    // Display next steps
-    console.log('\n🎯 Next Steps:');
-    console.log('1. Verify contracts on block explorer');
-    console.log('2. Test diamond functionality');
-    console.log('3. Set up monitoring and alerts');
-    console.log('4. Prepare upgrade scenarios');
-
-    if (process.env.AUTO_APPROVE !== 'true') {
-      console.log('\n⚠️ Note: Auto-approval is disabled. Check your Defender dashboard for pending proposals.');
-    }
-
-  } catch (error) {
-    console.error('\n❌ Deployment failed:', error);
-
-    // Save error information for debugging
-    const errorInfo = {
-      timestamp: new Date().toISOString(),
-      error: error instanceof Error ? {
-        message: error.message,
-        stack: error.stack,
-        name: error.name
-      } : String(error),
-      network: network.name,
-      chainId: network.chainId,
-      deployerAddress: deployer.address
-    };
-
-    const errorPath = path.join(exampleConfig.deploymentsPath, 'deployment-error.json');
-    await fs.writeJson(errorPath, errorInfo, { spaces: 2 });
-
-    console.log(`\n🔍 Error details saved to: ${errorPath}`);
-    console.log('\nTroubleshooting tips:');
-    console.log('1. Check your Defender API credentials');
-    console.log('2. Ensure sufficient balance for gas fees');
-    console.log('3. Verify network connectivity');
-    console.log('4. Check Defender dashboard for detailed logs');
-
-    process.exit(1);
-  }
-}
-
-// Handle script execution
-if (require.main === module) {
-  main()
-    .then(() => process.exit(0))
-    .catch((error) => {
-      console.error('Unhandled error:', error);
-      process.exit(1);
-    });
-}
-
-export { main as deployWithDefender };

package/examples/defender-deployment/diamond-config.json

@@ -1,36 +0,0 @@
-{
-  "protocolVersion": 0.0,
-  "protocolInitFacet": "ExampleFacet1",
-  "facets": {
-    "DiamondCutFacet": {
-      "priority": 10,
-      "versions": {
-        "0.0": {}
-      }
-    },
-    "DiamondLoupeFacet": {
-      "priority": 20,
-      "versions": {
-        "0.0": {}
-      }
-    },
-    "ExampleFacet1": {
-      "priority": 30,
-      "versions": {
-        "0.0": {
-          "deployInit": "initialize()",
-          "callbacks": ["logDeployment"]
-        }
-      }
-    },
-    "ExampleFacet2": {
-      "priority": 40,
-      "versions": {
-        "0.0": {
-          "deployInit": "setup()",
-          "callbacks": ["validateSetup"]
-        }
-      }
-    }
-  }
-}