comments

Author: thedavidmeister

.gas-snapshot

@@ -14,8 +14,8 @@ ERC20PriceOracleReceiptVaultAuthorizeReceiptTransferTest:testAuthorizeReceiptTra
 ERC20PriceOracleReceiptVaultCloneDeployerConstructTest:testERC20PriceOracleReceiptVaultCloneDeployerConstruct((address,address)) (runs: 246, μ: 467748, ~: 467748)
 ERC20PriceOracleReceiptVaultCloneDeployerConstructTest:testERC20PriceOracleReceiptVaultCloneDeployerConstructZeroReceiptImplementation(address) (runs: 254, μ: 37221, ~: 37221)
 ERC20PriceOracleReceiptVaultCloneDeployerConstructTest:testERC20PriceOracleReceiptVaultCloneDeployerConstructZeroVaultImplementation(address) (runs: 254, μ: 37221, ~: 37221)
-ERC20PriceOracleReceiptVaultCloneDeployerNewERC20PriceOracleReceiptVaultTest:testNewERC20PriceOracleReceiptVaultNonZeroReceipt((address,(address,string,string,address))) (runs: 256, μ: 5587754, ~: 5587754)
-ERC20PriceOracleReceiptVaultCloneDeployerNewERC20PriceOracleReceiptVaultTest:testNewERC20PriceOracleReceiptVaultSuccess((address,(address,string,string,address))) (runs: 0, μ: 0, ~: 0)
+ERC20PriceOracleReceiptVaultCloneDeployerNewERC20PriceOracleReceiptVaultTest:testNewERC20PriceOracleReceiptVaultNonZeroReceipt((address,(address,string,string,address))) (runs: 255, μ: 5587895, ~: 5587895)
+ERC20PriceOracleReceiptVaultCloneDeployerNewERC20PriceOracleReceiptVaultTest:testNewERC20PriceOracleReceiptVaultSuccess(address,(address,(address,string,string,address))) (runs: 1, μ: 5926009, ~: 5926009)
 ERC20PriceOracleReceiptVaultConvertToAssetsTest:testConvertToAssets(uint256,string,string,uint256,uint256) (runs: 256, μ: 397182, ~: 398287)
 ERC20PriceOracleReceiptVaultConvertToAssetsTest:testConvertToAssetsDifferentCaller(uint256,uint256,string,string,uint256,uint256) (runs: 256, μ: 457014, ~: 453843)
 ERC20PriceOracleReceiptVaultConvertToSharesTest:testConvertToShares(uint256,string,string,uint256,uint256) (runs: 256, μ: 397694, ~: 399131)
@@ -101,8 +101,8 @@ OffchainAssetReceiptVaultBeaconSetDeployerConstructTest:testOffchainAssetReceipt
 OffchainAssetReceiptVaultBeaconSetDeployerConstructTest:testOffchainAssetReceiptVaultBeaconSetDeployerConstructZeroBeaconOwner(address,address) (runs: 252, μ: 38613, ~: 38613)
 OffchainAssetReceiptVaultBeaconSetDeployerConstructTest:testOffchainAssetReceiptVaultBeaconSetDeployerConstructZeroReceiptImplementation(address,address) (runs: 252, μ: 38530, ~: 38530)
 OffchainAssetReceiptVaultBeaconSetDeployerConstructTest:testOffchainAssetReceiptVaultBeaconSetDeployerConstructZeroVaultImplementation(address,address) (runs: 252, μ: 38552, ~: 38552)
-OffchainAssetReceiptVaultBeaconSetDeployerNewOffchainAssetReceiptVaultTest:testNewOffchainAssetReceiptVault((address,(address,string,string,address))) (runs: 0, μ: 0, ~: 0)
-OffchainAssetReceiptVaultBeaconSetDeployerNewOffchainAssetReceiptVaultTest:testNewOffchainAssetReceiptVaultNonZeroReceipt((address,(address,string,string,address))) (runs: 253, μ: 7876816, ~: 7876816)
+OffchainAssetReceiptVaultBeaconSetDeployerNewOffchainAssetReceiptVaultTest:testNewOffchainAssetReceiptVault(address,(address,(address,string,string,address))) (runs: 0, μ: 0, ~: 0)
+OffchainAssetReceiptVaultBeaconSetDeployerNewOffchainAssetReceiptVaultTest:testNewOffchainAssetReceiptVaultNonZeroReceipt((address,(address,string,string,address))) (runs: 254, μ: 7876957, ~: 7876957)
 OffchainAssetReceiptVaultBeaconSetDeployerNewOffchainAssetReceiptVaultTest:testNewOffchainAssetReceiptVaultZeroInitialAdmin((address,(address,string,string,address))) (runs: 0, μ: 0, ~: 0)
 OffchainAssetReceiptVaultCertifyTest:testCertify(uint256,uint256,string,string,uint256,bytes,uint256,bool) (runs: 255, μ: 1108924, ~: 1107974)
 OffchainAssetReceiptVaultCertifyTest:testCertifyRevertOnZeroCertifyUntil(uint256,uint256,string,string,bytes,uint256,bool) (runs: 256, μ: 1072598, ~: 1073934)

src/concrete/deploy/ERC20PriceOracleReceiptVaultCloneDeployer.sol

@@ -16,27 +16,50 @@ import {
     ERC20PriceOracleReceiptVaultConfigV2
 } from "../vault/ERC20PriceOracleReceiptVault.sol";
 
+/// Configuration for the ERC20PriceOracleReceiptVaultCloneDeployer construction.
+/// @param receiptImplementation The address of the Receipt implementation
+/// contract to clone from.
+/// @param erc20PriceOracleReceiptVaultImplementation The address of the
+/// ERC20PriceOracleReceiptVault implementation contract to clone from.
 //forge-lint: disable-next-line(pascal-case-struct)
 struct ERC20PriceOracleReceiptVaultCloneDeployerConfig {
     address receiptImplementation;
     address erc20PriceOracleReceiptVaultImplementation;
 }
 
+/// @title ERC20PriceOracleReceiptVaultCloneDeployer
+/// Deploys ERC20PriceOracleReceiptVault contracts as minimal proxy contracts
+/// and handles the necessary initialization atomically.
 contract ERC20PriceOracleReceiptVaultCloneDeployer {
+    /// Emitted when a new deployment is successfully initialized.
+    /// @param sender The address that initiated the deployment.
+    /// @param erc20PriceOracleReceiptVault The address of the deployed
+    /// ERC20PriceOracleReceiptVault contract.
+    /// @param receipt The address of the deployed Receipt contract.
     event ERC20PriceOracleReceiptVaultCloneDeployerDeployment(
         address sender, address erc20PriceOracleReceiptVault, address receipt
     );
 
+    /// The address of the Receipt implementation contract to clone from.
     address public immutable I_RECEIPT_IMPLEMENTATION;
+
+    /// The address of the ERC20PriceOracleReceiptVault implementation contract
+    /// to clone from.
     address public immutable I_ERC20_PRICE_ORACLE_RECEIPT_VAULT_IMPLEMENTATION;
 
+    /// @param config The configuration for the deployer.
     constructor(ERC20PriceOracleReceiptVaultCloneDeployerConfig memory config) {
         if (config.receiptImplementation == address(0)) revert ZeroReceiptImplementation();
         if (config.erc20PriceOracleReceiptVaultImplementation == address(0)) revert ZeroVaultImplementation();
         I_RECEIPT_IMPLEMENTATION = config.receiptImplementation;
         I_ERC20_PRICE_ORACLE_RECEIPT_VAULT_IMPLEMENTATION = config.erc20PriceOracleReceiptVaultImplementation;
     }
 
+    /// Deploys and initializes a new ERC20PriceOracleReceiptVault contract
+    /// along with its associated Receipt contract.
+    /// @param config The configuration for the ERC20PriceOracleReceiptVault.
+    /// @return The address of the newly deployed ERC20PriceOracleReceiptVault
+    /// contract.
     function newERC20PriceOracleReceiptVault(ERC20PriceOracleReceiptVaultConfigV2 memory config)
         external
         returns (ERC20PriceOracleReceiptVault)

src/concrete/deploy/OffchainAssetReceiptVaultBeaconSetDeployer.sol

@@ -17,18 +17,37 @@ import {
     InitializeVaultFailed
 } from "../../error/ErrDeployer.sol";
 
+/// Configuration for the OffchainAssetReceiptVaultBeaconSetDeployer
+/// construction.
+/// @param initialOwner The initial owner of the beacons.
+/// @param initialReceiptImplementation The address of the initial Receipt
+/// implementation contract.
+/// @param initialOffchainAssetReceiptVaultImplementation The address of the
+/// initial OffchainAssetReceiptVault implementation contract.
 struct OffchainAssetReceiptVaultBeaconSetDeployerConfig {
     address initialOwner;
     address initialReceiptImplementation;
     address initialOffchainAssetReceiptVaultImplementation;
 }
 
+/// @title OffchainAssetReceiptVaultBeaconSetDeployer
+/// Deploys OffchainAssetReceiptVault contracts using beacon proxies and
+/// handles the necessary initialization atomically.
 contract OffchainAssetReceiptVaultBeaconSetDeployer {
+    /// Emitted when a new deployment is successfully initialized.
+    /// @param sender The address that initiated the deployment.
+    /// @param offchainAssetReceiptVault The address of the deployed
+    /// OffchainAssetReceiptVault contract.
+    /// @param receipt The address of the deployed Receipt contract.
     event Deployment(address sender, address offchainAssetReceiptVault, address receipt);
 
+    /// The beacon for the Receipt implementation contracts.
     IBeacon public immutable I_RECEIPT_BEACON;
+
+    /// The beacon for the OffchainAssetReceiptVault implementation contracts.
     IBeacon public immutable I_OFFCHAIN_ASSET_RECEIPT_VAULT_BEACON;
 
+    /// @param config The configuration for the deployer.
     constructor(OffchainAssetReceiptVaultBeaconSetDeployerConfig memory config) {
         if (address(config.initialReceiptImplementation) == address(0)) {
             revert ZeroReceiptImplementation();
@@ -45,6 +64,12 @@ contract OffchainAssetReceiptVaultBeaconSetDeployer {
             new UpgradeableBeacon(address(config.initialOffchainAssetReceiptVaultImplementation), config.initialOwner);
     }
 
+    /// Deploys and initializes a new OffchainAssetReceiptVault contract along
+    /// with its associated Receipt contract. Both are beacon proxies pointing
+    /// to the respective immutable beacons.
+    /// @param config The configuration for the OffchainAssetReceiptVault.
+    /// @return The address of the newly deployed OffchainAssetReceiptVault
+    /// contract.
     function newOffchainAssetReceiptVault(OffchainAssetReceiptVaultConfigV2 memory config)
         external
         returns (OffchainAssetReceiptVault)