@lukso/lsp8-contracts 0.15.0 → 0.16.3

package/contracts/extensions/LSP8CappedSupply.sol

@@ -51,7 +51,7 @@ abstract contract LSP8CappedSupply is LSP8IdentifiableDigitalAsset {
      * @notice The maximum supply amount of tokens allowed to exist is `_TOKEN_SUPPLY_CAP`.
      *
      * @dev Get the maximum number of tokens that can exist to circulate. Once {totalSupply} reaches
-     * reaches {totalSuuplyCap}, it is not possible to mint more tokens.
+     * reaches {totalSupplyCap}, it is not possible to mint more tokens.
      *
      * @return The maximum number of tokens that can exist in the contract.
      */

package/contracts/extensions/LSP8CappedSupplyInitAbstract.sol

@@ -54,7 +54,7 @@ abstract contract LSP8CappedSupplyInitAbstract is
      * @notice The maximum supply amount of tokens allowed to exist is `_tokenSupplyCap`.
      *
      * @dev Get the maximum number of tokens that can exist to circulate. Once {totalSupply} reaches
-     * reaches {totalSuuplyCap}, it is not possible to mint more tokens.
+     * reaches {totalSupplyCap}, it is not possible to mint more tokens.
      *
      * @return The maximum number of tokens that can exist in the contract.
      */

package/contracts/extensions/LSP8Enumerable.sol

@@ -3,8 +3,7 @@ pragma solidity ^0.8.12;
 
 // modules
 import {
-    LSP8IdentifiableDigitalAsset,
-    LSP8IdentifiableDigitalAssetCore
+    LSP8IdentifiableDigitalAsset
 } from "../LSP8IdentifiableDigitalAsset.sol";
 
 /**
@@ -31,19 +30,21 @@ abstract contract LSP8Enumerable is LSP8IdentifiableDigitalAsset {
     }
 
     /**
-     * @inheritdoc LSP8IdentifiableDigitalAssetCore
+     * @inheritdoc LSP8IdentifiableDigitalAsset
      *
      * @param from The address sending the `tokenId` (`address(0)` when `tokenId` is being minted).
      * @param to The address receiving the `tokenId` (`address(0)` when `tokenId` is being burnt).
      * @param tokenId The bytes32 identifier of the token being transferred.
+     * @param force A boolean that describe if transfer to a `to` address that does not support LSP1 is allowed or not.
      * @param data The data sent alongside the the token transfer.
      */
     function _beforeTokenTransfer(
         address from,
         address to,
         bytes32 tokenId,
+        bool force,
         bytes memory data
-    ) internal virtual override(LSP8IdentifiableDigitalAssetCore) {
+    ) internal virtual override {
         // `tokenId` being minted
         if (from == address(0)) {
             uint256 index = totalSupply();
@@ -64,6 +65,6 @@ abstract contract LSP8Enumerable is LSP8IdentifiableDigitalAsset {
             delete _tokenIndex[tokenId];
         }
 
-        super._beforeTokenTransfer(from, to, tokenId, data);
+        super._beforeTokenTransfer(from, to, tokenId, force, data);
     }
 }

package/contracts/extensions/LSP8EnumerableInitAbstract.sol

@@ -3,8 +3,7 @@ pragma solidity ^0.8.12;
 
 // modules
 import {
-    LSP8IdentifiableDigitalAssetInitAbstract,
-    LSP8IdentifiableDigitalAssetCore
+    LSP8IdentifiableDigitalAssetInitAbstract
 } from "../LSP8IdentifiableDigitalAssetInitAbstract.sol";
 
 /**
@@ -31,7 +30,7 @@ abstract contract LSP8EnumerableInitAbstract is
     }
 
     /**
-     * @inheritdoc LSP8IdentifiableDigitalAssetCore
+     * @inheritdoc LSP8IdentifiableDigitalAssetInitAbstract
      *
      * @param from The address sending the `tokenId` (`address(0)` when `tokenId` is being minted).
      * @param to The address receiving the `tokenId` (`address(0)` when `tokenId` is being burnt).
@@ -42,8 +41,9 @@ abstract contract LSP8EnumerableInitAbstract is
         address from,
         address to,
         bytes32 tokenId,
+        bool force,
         bytes memory data
-    ) internal virtual override(LSP8IdentifiableDigitalAssetCore) {
+    ) internal virtual override {
         if (from == address(0)) {
             uint256 index = totalSupply();
             _indexToken[index] = tokenId;
@@ -59,6 +59,6 @@ abstract contract LSP8EnumerableInitAbstract is
             delete _indexToken[lastIndex];
             delete _tokenIndex[tokenId];
         }
-        super._beforeTokenTransfer(from, to, tokenId, data);
+        super._beforeTokenTransfer(from, to, tokenId, force, data);
     }
 }

package/contracts/extensions/LSP8Votes.sol

@@ -0,0 +1,94 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+import {
+    LSP8IdentifiableDigitalAsset
+} from "../LSP8IdentifiableDigitalAsset.sol";
+import {Votes} from "@openzeppelin/contracts/governance/utils/Votes.sol";
+import {
+    _TYPEID_LSP8_VOTESDELEGATOR,
+    _TYPEID_LSP8_VOTESDELEGATEE
+} from "./LSP8VotesConstants.sol";
+import {LSP1Utils} from "@lukso/lsp1-contracts/contracts/LSP1Utils.sol";
+
+/**
+ * @dev Extension of LSP8 to support voting and delegation as implemented by {Votes}, where each individual NFT counts
+ * as 1 vote unit.
+ *
+ * Tokens do not count as votes until they are delegated, because votes must be tracked which incurs an additional cost
+ * on every transfer. Token holders can either delegate to a trusted representative who will decide how to make use of
+ * the votes in governance decisions, or they can delegate to themselves to be their own representative.
+ */
+abstract contract LSP8Votes is LSP8IdentifiableDigitalAsset, Votes {
+    /**
+     * @dev Adjusts votes when tokens are transferred.
+     *
+     * @custom:events {DelegateVotesChanged} event.
+     */
+    function _afterTokenTransfer(
+        address from,
+        address to,
+        bytes32 tokenId,
+        bool force,
+        bytes memory data
+    ) internal virtual override {
+        _transferVotingUnits(from, to, 1);
+        super._afterTokenTransfer(from, to, tokenId, force, data);
+    }
+
+    /**
+     * @dev Returns the balance of `account`.
+     *
+     * @custom:warning Overriding this function will likely result in incorrect vote tracking.
+     */
+    function _getVotingUnits(
+        address account
+    ) internal view virtual override returns (uint256) {
+        return balanceOf(account);
+    }
+
+    /**
+     * @dev Override of the {_delegate} function that includes notification via LSP1.
+     * The delegator and delegatee are both notified via their `universalReceiver(...)` function if they contracts implementing the LSP1 interface.
+     *
+     * @custom:events {DelegateChanged} event.
+     */
+    function _delegate(
+        address delegator,
+        address delegatee
+    ) internal virtual override {
+        uint256 delegatorBalance = balanceOf(delegator);
+
+        super._delegate(delegator, delegatee);
+
+        // Notify the delegator if it's not address(0)
+        if (delegator != address(0)) {
+            bytes memory delegatorNotificationData = abi.encode(
+                msg.sender,
+                delegatee,
+                delegatorBalance
+            );
+            LSP1Utils.notifyUniversalReceiver(
+                delegator,
+                _TYPEID_LSP8_VOTESDELEGATOR,
+                delegatorNotificationData
+            );
+        }
+
+        // Only notify the new delegatee if it's not address(0) and if there's actual voting power
+        if (delegatee != address(0) && delegatorBalance > 0) {
+            bytes memory delegateeNotificationData = abi.encode(
+                msg.sender,
+                delegator,
+                delegatorBalance
+            );
+
+            LSP1Utils.notifyUniversalReceiver(
+                delegatee,
+                _TYPEID_LSP8_VOTESDELEGATEE,
+                delegateeNotificationData
+            );
+        }
+    }
+}

package/contracts/extensions/LSP8VotesConstants.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.4;
+
+// keccak256('LSP8Tokens_VotesDelegatorNotification')
+bytes32 constant _TYPEID_LSP8_VOTESDELEGATOR = 0x2f6d3f668c2e57dbae4c255f2d9e0b69d47a8848d69a2251cce137529e34743e;
+
+// keccak256('LSP8Tokens_VotesDelegateeNotification')
+bytes32 constant _TYPEID_LSP8_VOTESDELEGATEE = 0x19419598f788eae88574bbb83ec563ad0cb43cd7ddbbc88857b2efa2d8faa8eb;

package/contracts/extensions/LSP8VotesInitAbstract.sol

@@ -0,0 +1,116 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import {
+    LSP8IdentifiableDigitalAssetInitAbstract
+} from "../LSP8IdentifiableDigitalAssetInitAbstract.sol";
+import {
+    VotesUpgradeable
+} from "@openzeppelin/contracts-upgradeable/governance/utils/VotesUpgradeable.sol";
+import {
+    _TYPEID_LSP8_VOTESDELEGATOR,
+    _TYPEID_LSP8_VOTESDELEGATEE
+} from "./LSP8VotesConstants.sol";
+import {LSP1Utils} from "@lukso/lsp1-contracts/contracts/LSP1Utils.sol";
+
+/**
+ * @dev Extension of LSP8 to support voting and delegation as implemented by {Votes}, where each individual NFT counts
+ * as 1 vote unit.
+ *
+ * Tokens do not count as votes until they are delegated, because votes must be tracked which incurs an additional cost
+ * on every transfer. Token holders can either delegate to a trusted representative who will decide how to make use of
+ * the votes in governance decisions, or they can delegate to themselves to be their own representative.
+ */
+abstract contract LSP8VotesInitAbstract is
+    LSP8IdentifiableDigitalAssetInitAbstract,
+    VotesUpgradeable
+{
+    function _initialize(
+        string memory name_,
+        string memory symbol_,
+        address newOwner_,
+        uint256 tokenIdType_,
+        uint256 tokenIdFormat_,
+        string memory version_
+    ) internal virtual onlyInitializing {
+        LSP8IdentifiableDigitalAssetInitAbstract._initialize(
+            name_,
+            symbol_,
+            newOwner_,
+            tokenIdType_,
+            tokenIdFormat_
+        );
+        __EIP712_init(name_, version_);
+    }
+
+    /**
+     * @dev Adjusts votes when tokens are transferred.
+     *
+     * Emits a {IVotes-DelegateVotesChanged} event.
+     */
+    function _afterTokenTransfer(
+        address from,
+        address to,
+        bytes32 tokenId,
+        bool force,
+        bytes memory data
+    ) internal virtual override {
+        _transferVotingUnits(from, to, 1);
+        super._afterTokenTransfer(from, to, tokenId, force, data);
+    }
+
+    /**
+     * @dev Returns the balance of `account`.
+     *
+     * @custom:warning Overriding this function will likely result in incorrect vote tracking.
+     */
+    function _getVotingUnits(
+        address account
+    ) internal view virtual override returns (uint256) {
+        return balanceOf(account);
+    }
+
+    /**
+     * @dev Override of the {_delegate} function that includes notification via LSP1.
+     * The delegator and delegatee are both notified via their `universalReceiver(...)` function if they contracts implementing the LSP1 interface.
+     *
+     * @custom:events {DelegateChanged} event.
+     */
+    function _delegate(
+        address delegator,
+        address delegatee
+    ) internal virtual override {
+        uint256 delegatorBalance = balanceOf(delegator);
+
+        super._delegate(delegator, delegatee);
+
+        // Notify the delegator if it's not address(0)
+        if (delegator != address(0)) {
+            bytes memory delegatorNotificationData = abi.encode(
+                msg.sender,
+                delegatee,
+                delegatorBalance
+            );
+            LSP1Utils.notifyUniversalReceiver(
+                delegator,
+                _TYPEID_LSP8_VOTESDELEGATOR,
+                delegatorNotificationData
+            );
+        }
+
+        // Only notify the new delegatee if it's not address(0) and if there's actual voting power
+        if (delegatee != address(0) && delegatorBalance > 0) {
+            bytes memory delegateeNotificationData = abi.encode(
+                msg.sender,
+                delegator,
+                delegatorBalance
+            );
+
+            LSP1Utils.notifyUniversalReceiver(
+                delegatee,
+                _TYPEID_LSP8_VOTESDELEGATEE,
+                delegateeNotificationData
+            );
+        }
+    }
+}