Publish latest contracts and artifacts

Author: 0xmichalis

contracts/CarbonOffsetBatches.sol

@@ -197,10 +197,7 @@ contract CarbonOffsetBatches is
     }
 
     /// @dev internal helper function to set the status and emit an event
-    function _updateStatus(uint256 tokenId, BatchStatus newStatus)
-        internal
-        virtual
-    {
+    function _updateStatus(uint256 tokenId, BatchStatus newStatus) internal {
         nftList[tokenId].status = newStatus;
         emit BatchStatusUpdate(tokenId, newStatus);
     }
@@ -225,7 +222,7 @@ contract CarbonOffsetBatches is
     function setStatusForDetokenizationOrRetirement(
         uint256 tokenId,
         BatchStatus newStatus
-    ) external virtual override {
+    ) external {
         onlyUnpaused();
         onlyEscrow();
         address tokenOwner = ownerOf(tokenId);
@@ -262,7 +259,7 @@ contract CarbonOffsetBatches is
     /// Fractionalization requires status Confirmed.
     /// @dev Callable only by verifiers, only for pending batches. This flow requires a previous linking with a vintage
     /// @param tokenId The token ID of the batch
-    function confirmBatch(uint256 tokenId) external virtual {
+    function confirmBatch(uint256 tokenId) external {
         onlyUnpaused();
         onlyWithRole(VERIFIER_ROLE);
         _confirmBatch(tokenId);
@@ -284,22 +281,18 @@ contract CarbonOffsetBatches is
     /// @notice Reject Batch-NFTs, e.g. if the serial number entered is incorrect.
     /// @dev Callable only by verifiers, only for pending batches.
     /// @param tokenId The token ID of the batch
-    function rejectBatch(uint256 tokenId) public virtual {
+    function rejectBatch(uint256 tokenId) public {
         onlyUnpaused();
         onlyWithRole(VERIFIER_ROLE);
         onlyPending(tokenId);
 
-        // unsetting serialnumber with rejection
-        serialNumberApproved[nftList[tokenId].serialNumber] = false;
         _updateStatus(tokenId, BatchStatus.Rejected);
     }
 
     /// @notice Function to reject Batch-NFTs, including a reason to be displayed to the user.
     function rejectWithComment(uint256 tokenId, string memory comment)
         external
-        virtual
     {
-        onlyUnpaused();
         rejectBatch(tokenId);
         _addComment(tokenId, comment);
     }
@@ -318,6 +311,9 @@ contract CarbonOffsetBatches is
                 ownerOf(tokenId)
             )
         ) revert(Errors.COB_ALREADY_FRACTIONALIZED);
+
+        serialNumberApproved[nftList[tokenId].serialNumber] = false;
+
         _updateStatus(tokenId, BatchStatus.Rejected);
         _addComment(tokenId, comment);
     }
@@ -327,7 +323,7 @@ contract CarbonOffsetBatches is
     /// batch, e.g. the batch was incorrectly rejected.
     /// @dev Callable only by verifiers, only for rejected batches.
     /// @param tokenId The token ID of the batch
-    function setToPending(uint256 tokenId) external virtual {
+    function setToPending(uint256 tokenId) external {
         onlyUnpaused();
         onlyWithRole(VERIFIER_ROLE);
         if (nftList[tokenId].status != BatchStatus.Rejected)
@@ -341,7 +337,6 @@ contract CarbonOffsetBatches is
     /// @param projectVintageTokenId The token ID of the vintage
     function linkWithVintage(uint256 tokenId, uint256 projectVintageTokenId)
         external
-        virtual
     {
         onlyUnpaused();
         onlyWithRole(VERIFIER_ROLE);
@@ -367,7 +362,7 @@ contract CarbonOffsetBatches is
     function confirmBatchWithVintage(
         uint256 tokenId,
         uint256 projectVintageTokenId
-    ) external virtual {
+    ) external {
         onlyUnpaused();
         onlyWithRole(VERIFIER_ROLE);
         // We don't want this to be a "backdoor" for modifying the vintage; it
@@ -402,7 +397,7 @@ contract CarbonOffsetBatches is
     /// @dev To be updated by NFT owner after serial number has been provided
     /// @param to The address the NFT should be minted to. This should be the user.
     /// @return The token ID of the newly minted NFT
-    function mintEmptyBatch(address to) external virtual returns (uint256) {
+    function mintEmptyBatch(address to) external returns (uint256) {
         onlyUnpaused();
         return _mintEmptyBatch(to, to);
     }
@@ -443,7 +438,7 @@ contract CarbonOffsetBatches is
         string memory serialNumber,
         uint256 quantity,
         string memory uri
-    ) external virtual {
+    ) external {
         onlyUnpaused();
         onlyVerifierOrBatchOwner(tokenId);
         onlyPending(tokenId);
@@ -477,7 +472,7 @@ contract CarbonOffsetBatches is
         uint256 tokenId,
         string memory newSerialNumber,
         uint256 newQuantity
-    ) external virtual {
+    ) external {
         onlyUnpaused();
         onlyVerifierOrBatchOwner(tokenId);
         onlyPending(tokenId);
@@ -489,8 +484,6 @@ contract CarbonOffsetBatches is
     function getConfirmationStatus(uint256 tokenId)
         external
         view
-        virtual
-        override
         returns (BatchStatus)
     {
         return nftList[tokenId].status;
@@ -505,8 +498,6 @@ contract CarbonOffsetBatches is
     function getBatchNFTData(uint256 tokenId)
         external
         view
-        virtual
-        override
         returns (
             uint256,
             uint256,
@@ -527,8 +518,6 @@ contract CarbonOffsetBatches is
     function getSerialNumber(uint256 tokenId)
         external
         view
-        virtual
-        override
         returns (string memory)
     {
         if (!_exists(tokenId)) revert(Errors.COB_NOT_EXISTS);
@@ -542,7 +531,6 @@ contract CarbonOffsetBatches is
     function getComments(uint256 tokenId)
         external
         view
-        virtual
         returns (string[] memory, address[] memory)
     {
         return (nftList[tokenId].comments, nftList[tokenId].commentAuthors);
@@ -564,7 +552,7 @@ contract CarbonOffsetBatches is
     /// Queries the factory to find the corresponding TCO2 contract
     /// Fractionalization happens via receive hook on `safeTransferFrom`
     /// @param tokenId The token ID of the batch
-    function fractionalize(uint256 tokenId) external virtual {
+    function fractionalize(uint256 tokenId) external {
         onlyApprovedOrOwner(tokenId);
         // Fractionalize by transferring the batch-NFT to the TCO2 contract.
         safeTransferFrom(
@@ -606,7 +594,6 @@ contract CarbonOffsetBatches is
     function supportsInterface(bytes4 interfaceId)
         public
         view
-        virtual
         override(AccessControlUpgradeable, ERC721EnumerableUpgradeable)
         returns (bool)
     {

contracts/CarbonOffsetBatchesStorage.sol

@@ -20,6 +20,7 @@ abstract contract CarbonOffsetBatchesStorageV1 {
     struct NFTData {
         uint256 projectVintageTokenId;
         string serialNumber;
+        // Quantity is denominated in tonnes
         uint256 quantity;
         BatchStatus status;
         string uri;

contracts/CarbonProjectVintages.sol

@@ -202,17 +202,6 @@ contract CarbonProjectVintages is
         emit ProjectVintageUpdated(tokenId);
     }
 
-    /// @dev Removes a project-vintage and corresponding data
-    function removeVintage(uint256 tokenId)
-        external
-        virtual
-        onlyManagers
-        whenNotPaused
-    {
-        totalSupply--;
-        delete vintageData[tokenId];
-    }
-
     /// @dev retrieve all data from VintageData struct
     function getProjectVintageDataByTokenId(uint256 tokenId)
         external

contracts/ToucanCarbonOffsets.sol

@@ -23,7 +23,7 @@ contract ToucanCarbonOffsets is
     /// @dev Version-related parameters. VERSION keeps track of production
     /// releases. VERSION_RELEASE_CANDIDATE keeps track of iterations
     /// of a VERSION in our staging environment.
-    string public constant VERSION = '1.6.0';
+    string public constant VERSION = '1.7.0';
     uint256 public constant VERSION_RELEASE_CANDIDATE = 1;
 
     // ----------------------------------------
@@ -56,16 +56,18 @@ contract ToucanCarbonOffsets is
             msg.sender,
             _projectVintageTokenId,
             amount,
+            '',
             true
         );
     }
 
     /// @notice Mint an NFT showing how many tonnes of CO2 have been retired/cancelled
     /// Going forward users should mint NFT directly in the RetirementCertificates contract.
-    /// @param retiringEntityString An identifiable string for the retiring entity, eg. their name.
-    /// @param beneficiary The beneficiary to set in the NFT.
-    /// @param beneficiaryString The beneficiaryString to set in the NFT.
-    /// @param retirementMessage The retirementMessage to set in the NFT.
+    /// Note that this information is publicly written to the blockchain in plaintext.
+    /// @param retiringEntityString An identifiable string for the retiring entity, eg. their name
+    /// @param beneficiary The address of the beneficiary of the retirement
+    /// @param beneficiaryString An identifiable string for the beneficiary, eg. their name
+    /// @param retirementMessage A message to be included in the retirement certificate
     function mintCertificateLegacy(
         string calldata retiringEntityString,
         address beneficiary,

contracts/ToucanCarbonOffsetsEscrow.sol

@@ -9,6 +9,7 @@ import '@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol';
 import '@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol';
 import '@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol';
 import '@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol';
+import '@openzeppelin/contracts-upgradeable/token/ERC721/IERC721Upgradeable.sol';
 
 import './bases/RoleInitializer.sol';
 import {Errors} from './libraries/Errors.sol';
@@ -160,6 +161,9 @@ contract ToucanCarbonOffsetsEscrow is
         uint256 batchIdLength = tokenIds.length;
         for (uint256 i = 0; i < batchIdLength; ++i) {
             uint256 tokenId = tokenIds[i];
+            if (IERC721Upgradeable(batchNFT).ownerOf(tokenId) != msg.sender) {
+                revert(Errors.COB_INVALID_BATCH_OWNER);
+            }
             (, uint256 batchAmount, ) = _getNormalizedDataFromBatch(
                 batchNFT,
                 tokenId

contracts/ToucanCarbonOffsetsFactory.sol

@@ -19,7 +19,7 @@ contract ToucanCarbonOffsetsFactory is ToucanCarbonOffsetsFactoryBase {
     /// @dev Version-related parameters. VERSION keeps track of production
     /// releases. VERSION_RELEASE_CANDIDATE keeps track of iterations
     /// of a VERSION in our staging environment.
-    string public constant VERSION = '1.3.0';
+    string public constant VERSION = '1.4.0';
     uint256 public constant VERSION_RELEASE_CANDIDATE = 1;
 
     // ----------------------------------------

contracts/bases/ToucanCarbonOffsetsBase.sol

@@ -249,70 +249,32 @@ abstract contract ToucanCarbonOffsetsBase is
         _burn(account, amount);
     }
 
-    // @dev Internal function for the burning of TCO2 tokens
-    // @dev retiringEntityAddress is a parameter to handle scenarios, when
-    // retirements are performed from the escrow contract and the retiring entity
-    // is different than the account.
+    /// @dev Internal function for the burning of TCO2 tokens
+    /// @param account The account from where TCO2s are burned
+    /// @param amount The amount of TCO2s to burn
+    /// @param retiringEntity The entity that is retiring TCO2
+    /// @param serialNumber The serial number of the batch associated with the retirement
+    /// @return retirementEventId The id of the retirement event
     function _retire(
         address account,
         uint256 amount,
-        address retiringEntityAddress
+        address retiringEntity,
+        string memory serialNumber
     ) internal virtual returns (uint256 retirementEventId) {
         _burn(account, amount);
 
         // Register retirement event in the certificates contract
         address certAddr = IToucanContractRegistry(contractRegistry)
             .retirementCertificatesAddress();
         retirementEventId = IRetirementCertificates(certAddr).registerEvent(
-            retiringEntityAddress,
+            retiringEntity,
             _projectVintageTokenId,
             amount,
+            serialNumber,
             false
         );
 
-        emit Retired(retiringEntityAddress, amount, retirementEventId);
-    }
-
-    // @dev Internal function retire and mint certificates
-    function _retireAndMintCertificate(
-        address retiringEntity,
-        CreateRetirementRequestParams memory params
-    ) internal virtual whenNotPaused {
-        uint256[] memory retirementEventIds;
-        if (params.tokenIds.length == 0) {
-            uint256 retirementEventId = _retire(
-                msg.sender,
-                params.amount,
-                retiringEntity
-            );
-            retirementEventIds = new uint256[](1);
-            retirementEventIds[0] = retirementEventId;
-        } else {
-            retirementEventIds = new uint256[](params.tokenIds.length);
-            uint256 decimalMultiplier = 10**decimals();
-            for (uint256 i = 0; i < params.tokenIds.length; i++) {
-                //slither-disable-next-line unused-return
-                (, uint256 batchQuantity, ) = ICarbonOffsetBatches(
-                    IToucanContractRegistry(contractRegistry)
-                        .carbonOffsetBatchesAddress()
-                ).getBatchNFTData(params.tokenIds[i]);
-                uint256 retirementEventId = _retire(
-                    msg.sender,
-                    batchQuantity * decimalMultiplier,
-                    retiringEntity
-                );
-                retirementEventIds[i] = retirementEventId;
-            }
-        }
-        //slither-disable-next-line unused-return
-        IRetirementCertificates(
-            IToucanContractRegistry(contractRegistry)
-                .retirementCertificatesAddress()
-        ).mintCertificateWithExtraData(
-                retiringEntity,
-                params,
-                retirementEventIds
-            );
+        emit Retired(retiringEntity, amount, retirementEventId);
     }
 
     // -----------------------------