Merge pull request #1139 from thesandboxgame/asset-audit-n-01

N-01 Asset Audit

packages/asset/contracts/AssetCreate.sol

@@ -54,9 +54,13 @@ contract AssetCreate is
     }
 
     /// @notice Initialize the contract
+    /// @param _name The name of the contract (for EIP712)
+    /// @param _version The version of the contract (for EIP712)
     /// @param _assetContract The address of the asset contract
+    /// @param _catalystContract The address of the catalyst contract
     /// @param _authValidator The address of the AuthSuperValidator contract
     /// @param _forwarder The address of the forwarder contract
+    /// @param _defaultAdmin The address of the default admin
     function initialize(
         string memory _name,
         string memory _version,
@@ -80,7 +84,9 @@ contract AssetCreate is
     /// @param signature A signature generated by TSB
     /// @param tier The tier of the asset to mint
     /// @param amount The amount of the asset to mint
+    /// @param revealed Whether the asset is revealed or not
     /// @param metadataHash The metadata hash of the asset to mint
+    /// @param creator The address of the creator
     function createAsset(
         bytes memory signature,
         uint8 tier,
@@ -110,7 +116,9 @@ contract AssetCreate is
     /// @param signature A signature generated by TSB
     /// @param tiers The tiers of the assets to mint
     /// @param amounts The amounts of the assets to mint
+    /// @param revealed Whether the assets are revealed or not
     /// @param metadataHashes The metadata hashes of the assets to mint
+    /// @param creator The address of the creator
     function createMultipleAssets(
         bytes memory signature,
         uint8[] calldata tiers,
@@ -206,8 +214,10 @@ contract AssetCreate is
 
     /// @notice Creates a hash of the mint data
     /// @param creator The address of the creator
+    /// @param nonce The nonce of the creator
     /// @param tier The tier of the asset
     /// @param amount The amount of copies to mint
+    /// @param revealed Whether the asset is revealed or not
     /// @param metadataHash The metadata hash of the asset
     /// @return digest The hash of the mint data
     function _hashMint(
@@ -235,8 +245,10 @@ contract AssetCreate is
 
     /// @notice Creates a hash of the mint batch data
     /// @param creator The address of the creator
+    /// @param nonce The nonce of the creator
     /// @param tiers The tiers of the assets
     /// @param amounts The amounts of copies to mint
+    /// @param revealed Whether the assets are revealed or not
     /// @param metadataHashes The metadata hashes of the assets
     /// @return digest The hash of the mint batch data
     function _hashBatchMint(

packages/asset/contracts/libraries/TokenIdUtils.sol

@@ -104,6 +104,7 @@ library TokenIdUtils {
     /// @notice Extracts the asset data from a given token id
     /// @dev Created to limit the number of functions that need to be called when revealing an asset
     /// @param tokenId The token id to extract the asset data from
+    /// @return data The asset data struct
     function getData(uint256 tokenId) internal pure returns (IAsset.AssetData memory data) {
         data.creator = getCreatorAddress(tokenId);
         data.tier = getTier(tokenId);