@coti-io/coti-contracts 1.2.0 → 1.3.0

package/contracts/node/SoulboundNodeNFT.sol

@@ -67,7 +67,7 @@ contract SoulboundNodeNFT is ERC721, Ownable, IERC5192 {
     /// @notice Last minted token ID (starts at 0, first mint = 1)
     uint256 public nextTokenId;
 
-    /// @notice Maximum length (in bytes) for nodeName and socialURL
+    /// @notice Maximum length (in bytes) for name and socialURL
     uint256 public constant MAX_TEXT_BYTES = 150;
 
     /**
@@ -78,8 +78,8 @@ contract SoulboundNodeNFT is ERC721, Ownable, IERC5192 {
 
     /// @notice Node-specific metadata stored on-chain
     struct NodeData {
-        string nodeName; // required
-        string nodeImageURI; // optional (ipfs:// or https://)
+        string name; // required
+        string image; // optional (ipfs:// or https://)
         string socialURL; // optional
         bool isHot; // true = hot node, false = cold node
     }
@@ -91,8 +91,8 @@ contract SoulboundNodeNFT is ERC721, Ownable, IERC5192 {
     event NodeMinted(
         address indexed to,
         uint256 indexed tokenId,
-        string nodeName,
-        string nodeImageURI,
+        string name,
+        string image,
         string socialURL
     );
 
@@ -187,8 +187,8 @@ contract SoulboundNodeNFT is ERC721, Ownable, IERC5192 {
     /**
      * @notice Mint a new soulbound Node NFT
      * @param to Recipient address
-     * @param nodeName Node name (required, <=150 bytes)
-     * @param nodeImageURI Optional image URI
+     * @param name Node name (required, <=150 bytes)
+     * @param image Optional image URI
      * @param socialURL Optional social URL (<=150 bytes)
      * @return tokenId The ID of the newly minted token
      * @dev Restrictions:
@@ -199,22 +199,22 @@ contract SoulboundNodeNFT is ERC721, Ownable, IERC5192 {
      *  - Minting is paused (MintPaused)
      *  - to is the zero address (InvalidRecipient)
      *  - to already owns an NFT (AlreadyOwnsNodeNFT)
-     *  - nodeName is empty (NodeNameRequired)
-     *  - nodeName exceeds MAX_TEXT_BYTES (NodeNameTooLong)
+     *  - name is empty (NodeNameRequired)
+     *  - name exceeds MAX_TEXT_BYTES (NodeNameTooLong)
      *  - socialURL exceeds MAX_TEXT_BYTES (SocialURLTooLong)
      * @dev Emits Locked and NodeMinted events
      */
     function mintNode(
         address to,
-        string calldata nodeName,
-        string calldata nodeImageURI,
+        string calldata name,
+        string calldata image,
         string calldata socialURL
     ) external onlyOwner returns (uint256 tokenId) {
         if (mintPaused) revert MintPaused();
         if (to == address(0)) revert InvalidRecipient();
         if (balanceOf(to) != 0) revert AlreadyOwnsNodeNFT();
-        if (bytes(nodeName).length == 0) revert NodeNameRequired();
-        if (bytes(nodeName).length > MAX_TEXT_BYTES) revert NodeNameTooLong();
+        if (bytes(name).length == 0) revert NodeNameRequired();
+        if (bytes(name).length > MAX_TEXT_BYTES) revert NodeNameTooLong();
         if (bytes(socialURL).length > MAX_TEXT_BYTES) revert SocialURLTooLong();
 
         tokenId = ++nextTokenId;
@@ -222,21 +222,21 @@ contract SoulboundNodeNFT is ERC721, Ownable, IERC5192 {
         _safeMint(to, tokenId);
 
         _nodeData[tokenId] = NodeData({
-            nodeName: nodeName,
-            nodeImageURI: nodeImageURI,
+            name: name,
+            image: image,
             socialURL: socialURL,
             // Default new nodes to hot; can be updated later via setNodeHotStatus
             isHot: true
         });
 
         emit Locked(tokenId);
-        emit NodeMinted(to, tokenId, nodeName, nodeImageURI, socialURL);
+        emit NodeMinted(to, tokenId, name, image, socialURL);
     }
 
     /**
      * @notice Get node metadata for a token
      * @param tokenId Token ID to query
-     * @return NodeData struct containing nodeName, nodeImageURI, and socialURL
+     * @return NodeData struct containing name, image, and socialURL
      * @dev Reverts if the token does not exist (NonexistentToken)
      */
     function nodeData(uint256 tokenId) external view returns (NodeData memory) {
@@ -295,7 +295,7 @@ contract SoulboundNodeNFT is ERC721, Ownable, IERC5192 {
         if (msg.sender != tokenOwner && msg.sender != owner())
             revert NotAuthorized();
 
-        _nodeData[tokenId].nodeImageURI = newImageURI;
+        _nodeData[tokenId].image = newImageURI;
         emit ImageURIUpdated(tokenId, newImageURI);
     }
 
@@ -349,7 +349,7 @@ contract SoulboundNodeNFT is ERC721, Ownable, IERC5192 {
         if (bytes(newNodeName).length > MAX_TEXT_BYTES)
             revert NodeNameTooLong();
 
-        _nodeData[tokenId].nodeName = newNodeName;
+        _nodeData[tokenId].name = newNodeName;
         emit NodeNameUpdated(tokenId, newNodeName);
     }
 
@@ -456,16 +456,16 @@ contract SoulboundNodeNFT is ERC721, Ownable, IERC5192 {
 
         string memory attributes = string.concat(
             '[{"trait_type":"Node name","value":"',
-            _escapeJSON(d.nodeName),
+            _escapeJSON(d.name),
             '"}',
             ',{"trait_type":"Social URL","value":"',
             _escapeJSON(d.socialURL),
             '"}]'
         );
 
-        string memory imagePart = bytes(d.nodeImageURI).length == 0
+        string memory imagePart = bytes(d.image).length == 0
             ? ""
-            : string.concat(',"image":"', _escapeJSON(d.nodeImageURI), '"');
+            : string.concat(',"image":"', _escapeJSON(d.image), '"');
 
         string memory json = string.concat(
             '{"name":"Node #',

package/contracts/oracle/CotiPriceConsumer.sol

@@ -0,0 +1,103 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.20;
+
+import "./IStdReference.sol";
+
+/**
+ * @title CotiPriceConsumer
+ * @notice Retrieves token/USD prices from the Band Protocol oracle.
+ * @dev All prices returned by Band Protocol are scaled by 1e18.
+ *      For example, a rate of 50000000000000000 means $0.05.
+ */
+contract CotiPriceConsumer {
+    /// @notice Band Protocol StdReferenceProxy on COTI .
+    IStdReference public immutable ref;
+
+    /// @notice Maximum acceptable age (in seconds) for oracle data before it is considered stale.
+    uint256 public maxStaleness;
+
+    /// @notice Emitted when the staleness threshold is updated.
+    event MaxStalenessUpdated(uint256 oldValue, uint256 newValue);
+
+    /// @notice Thrown when the oracle data is older than the allowed staleness window.
+    error StaleOracleData(uint256 lastUpdated, uint256 threshold);
+
+    address public owner;
+
+    /// @notice Minimum allowed staleness threshold (1 hour).
+    uint256 public constant MIN_STALENESS = 1 hours;
+
+    /// @notice Thrown when the staleness value is below the minimum.
+    error StalenessTooLow(uint256 provided, uint256 minimum);
+
+    modifier onlyOwner() {
+        require(msg.sender == owner, "CotiPriceConsumer: caller is not the owner");
+        _;
+    }
+
+    /**
+     * @param _ref          Address of the Band Protocol StdReferenceProxy contract.
+     * @param _maxStaleness Maximum acceptable data age in seconds (0 = no staleness check).
+     */
+    constructor(address _ref, uint256 _maxStaleness) {
+        require(_ref != address(0), "CotiPriceConsumer: zero ref address");
+        if (_maxStaleness < MIN_STALENESS) revert StalenessTooLow(_maxStaleness, MIN_STALENESS);
+        ref = IStdReference(_ref);
+        maxStaleness = _maxStaleness;
+        owner = msg.sender;
+    }
+
+    /// @notice Returns the rate, last update timestamp, and current block timestamp for any base/USD pair.
+    /// @return rate           The price scaled by 1e18
+    /// @return lastUpdated    Block timestamp when the oracle data was last updated
+    /// @return blockTimestamp The current block.timestamp
+    function getPriceWithMeta(string calldata _base) external view returns (uint256 rate, uint256 lastUpdated, uint256 blockTimestamp) {
+        IStdReference.ReferenceData memory data = _getPrice(_base);
+        rate = data.rate;
+        lastUpdated = data.lastUpdatedBase;
+        blockTimestamp = block.timestamp;
+    }
+
+
+    // ──────────────────────────────────────────────────────────────────────
+    //  Internal helper
+    // ──────────────────────────────────────────────────────────────────────
+
+    /**
+     * @dev Queries the Band oracle for `_base`/USD and optionally enforces staleness.
+     */
+    function _getPrice(string memory _base) internal view returns (IStdReference.ReferenceData memory data) {
+        data = ref.getReferenceData(_base, "USD");
+
+        uint256 threshold = block.timestamp - maxStaleness;
+        if (data.lastUpdatedBase < threshold) {
+            revert StaleOracleData(data.lastUpdatedBase, threshold);
+        }
+    }
+
+
+    // ──────────────────────────────────────────────────────────────────────
+    //  Generic getter — query any symbol the oracle supports
+    // ──────────────────────────────────────────────────────────────────────
+
+    /// @notice Returns the rate for an arbitrary base/USD pair scaled by 1e18.
+    function getPrice(string calldata _base) external view returns (uint256) {
+        return _getPrice(_base).rate;
+    }
+
+
+    /// @notice Returns the full ReferenceData for an arbitrary base/USD pair.
+    function getPriceData(string calldata _base) external view returns (IStdReference.ReferenceData memory) {
+        return _getPrice(_base);
+    }
+
+    /**
+     * @notice Updates the maximum staleness threshold.
+     * @param _maxStaleness New threshold in seconds (0 = disable check).
+     */
+    function setMaxStaleness(uint256 _maxStaleness) external onlyOwner {
+        if (_maxStaleness < MIN_STALENESS) revert StalenessTooLow(_maxStaleness, MIN_STALENESS);
+        emit MaxStalenessUpdated(maxStaleness, _maxStaleness);
+        maxStaleness = _maxStaleness;
+    }
+}

package/contracts/oracle/ICotiPriceConsumer.sol

@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.19;
+
+/**
+ * @title ICotiPriceConsumer
+ * @notice Minimal interface for the CotiPriceConsumer oracle used by the bridge
+ */
+interface ICotiPriceConsumer {
+   
+    /// @notice Returns the rate for an arbitrary base/USD pair scaled by 1e18.
+    function getPrice(string calldata _base) external view returns (uint256);
+
+    /// @notice Returns rate + metadata for any base/USD pair.
+    function getPriceWithMeta(string calldata _base) external view returns (uint256 rate, uint256 lastUpdated, uint256 blockTimestamp);
+}

package/contracts/oracle/IStdReference.sol

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.20;
+
+/**
+ * @title IStdReference
+ * @notice Band Protocol Standard Reference interface for querying price data.
+ */
+interface IStdReference {
+    struct ReferenceData {
+        uint256 rate;            // base/quote exchange rate, scaled by 1e18
+        uint256 lastUpdatedBase; // UNIX epoch when the base price was last updated
+        uint256 lastUpdatedQuote; // UNIX epoch when the quote price was last updated
+    }
+
+    /// @notice Returns the price data for a single base/quote pair.
+    function getReferenceData(
+        string memory _base,
+        string memory _quote
+    ) external view returns (ReferenceData memory);
+
+    /// @notice Returns the price data for multiple base/quote pairs.
+    function getReferenceDataBulk(
+        string[] memory _bases,
+        string[] memory _quotes
+    ) external view returns (ReferenceData[] memory);
+}