3078 - Series indexer contract #44

lpopo0856 · 2024-12-13T11:26:24Z

Description

Story link: https://github.com/bitmark-inc/feral-file/issues/3078

Document of the flow design and/or figma design

https://github.com/bitmark-inc/feral-file/issues/3078#issuecomment-2499603479

Implement version 1 Better naming f

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

solhint

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: Use Custom Errors instead of require statements

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 285 in 2eb6555

require(proposedArtistAddr != address(0), "Invalid address");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: Use Custom Errors instead of require statements

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 292 in 2eb6555

    
           require(!seriesPendingCoArtist[seriesID][proposedArtistID], "Already proposed");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: Use Custom Errors instead of require statements

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 302 in 2eb6555

    
           require(seriesPendingCoArtist[seriesID][proposedArtistID], "No proposal exists");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: Use Custom Errors instead of require statements

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 313 in 2eb6555

require(artistID != 0, "Not an artist");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: Use Custom Errors instead of require statements

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 314 in 2eb6555

require(seriesPendingCoArtist[seriesID][artistID], "No pending proposal");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: Use Custom Errors instead of require statements

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 348 in 2eb6555

require(artistID != 0, "Not an artist");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: Use Custom Errors instead of require statements

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 349 in 2eb6555

require(!ownerRightsRevokedForArtistID[artistID], "Already revoked");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: Use Custom Errors instead of require statements

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 355 in 2eb6555

require(artistID != 0, "Not an artist");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: Use Custom Errors instead of require statements

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 356 in 2eb6555

require(ownerRightsRevokedForArtistID[artistID], "Not revoked");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: Use Custom Errors instead of require statements

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 361 in 2eb6555

require(newAddress != address(0), "Invalid new address");

⚠️ [solhint] _{reported by reviewdog 🐶}
Error message for require is too long: 37 counted / 32 allowed

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 362 in 2eb6555

    
           require(addressToArtistID[newAddress] == 0, "Address already assigned to an artist");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: String exceeds 32 bytes

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 362 in 2eb6555

    
           require(addressToArtistID[newAddress] == 0, "Address already assigned to an artist");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: Use Custom Errors instead of require statements

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 362 in 2eb6555

    
           require(addressToArtistID[newAddress] == 0, "Address already assigned to an artist");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: Use Custom Errors instead of require statements

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 365 in 2eb6555

require(oldAddress != address(0), "Invalid artistID");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: Use Custom Errors instead of require statements

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 371 in 2eb6555

    
           require(isCallerArtist || isOwnerWithRights, "Not authorized to update address");

⚠️ [solhint] _{reported by reviewdog 🐶}
Error message for revert is too long: 39 counted / 32 allowed

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 390 in 2eb6555

revert("One of the artists revoked owner rights");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: String exceeds 32 bytes

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 390 in 2eb6555

revert("One of the artists revoked owner rights");

⚠️ [solhint] _{reported by reviewdog 🐶}
GC: Use Custom Errors instead of revert statements

feralfile-exhibition-smart-contract/contracts/SeriesIndexer.sol

Line 390 in 2eb6555

revert("One of the artists revoked owner rights");

fix

jollyjoker992 · 2024-12-23T04:04:03Z

contracts/SeriesIndexer.sol

+
+contract SeriesIndexer is Ownable.Ownable {
+    // Counter
+    uint256 private nextSeriesID = 1;


Can you use the length of existing series map so we don't need to maintain this counter?

this's not possible since the mapping in solidity is a simple hash table without key management.

jollyjoker992 · 2024-12-23T04:04:42Z

contracts/SeriesIndexer.sol

+contract SeriesIndexer is Ownable.Ownable {
+    // Counter
+    uint256 private nextSeriesID = 1;
+    uint256 private nextArtistID = 1;


Same has above comment but for the artist map.

jollyjoker992 · 2024-12-23T04:06:14Z

contracts/SeriesIndexer.sol

+    uint256 private nextArtistID = 1;
+
+    struct Series {
+        string metadata;


I suppose this field is for series metadata source, so it should store the uri so the name should be metadataURI

jollyjoker992 · 2024-12-23T04:07:08Z

contracts/SeriesIndexer.sol

+
+    struct Series {
+        string metadata;
+        string contractTokenData;


Same as above comment, it should be tokenDataURI

contracts/SeriesIndexer.sol

jollyjoker992 · 2024-12-23T04:26:20Z

contracts/SeriesIndexer.sol

+    // Artist Management
+    mapping(uint256 => address) private artistIDToAddress;
+    mapping(address => uint256) private addressToArtistID;
+    mapping(uint256 => bool) private ownerRightsRevokedForArtistID;


I think this should be on series level instead of artist level. We could also provide a feature for revoking all series from an artist.

jollyjoker992 · 2024-12-23T04:30:25Z

contracts/SeriesIndexer.sol

+    // Internal Helper Functions
+    // ------------------------
+
+    function _checkOwnerOrArtist(uint256 seriesID) internal view {


Should pass the address instead of assume the msg.sender. The caller should determine which one should be passed, that will be more extensible and readable. If we just want to stick with the msg.sender, we might need a better name like _checkMsgSenderIsOwnerOrArtist

jollyjoker992 · 2024-12-23T04:30:47Z

contracts/SeriesIndexer.sol

+        }
+    }
+
+    function _checkArtist(uint256 seriesID) internal view {


The same here.

jollyjoker992 · 2024-12-23T04:33:18Z

contracts/SeriesIndexer.sol

+        uint256 indexed seriesID,
+        uint256[] artistIDs,
+        string metadata,
+        string seriesContractTokenCID


I would prefer using something like URI instead of CID that we need to stick to ipfs. Using URI could be better for extensibility later on.

jollyjoker992 · 2024-12-23T04:45:51Z

contracts/SeriesIndexer.sol

+        require(length <= 50, "Batch size too large"); // Prevent DOS attacks
+


What does this mean for prevent DOS attacks?

that mean if someone try to put really large number of list, the contract will deny to service. It's not quite of an attack I think.

the words is removed anyway

So that could be out of gas since it could reach the block gas limit so i don't consider it as "denial of service"

jollyjoker992 · 2024-12-24T08:19:32Z

contracts/SeriesIndexer.sol

+        seriesExists(seriesID) 
+        onlyOwnerOrArtist(seriesID) 
+    {
+        Series storage series = seriesDetails[seriesID];


Should use memory

jollyjoker992 · 2024-12-24T08:29:50Z

contracts/SeriesIndexer.sol

+        Series storage series = seriesDetails[seriesID];
+        for (uint256 i = 0; i < series.artistIDs.length; i++) {
+            uint256 artistID = series.artistIDs[i];
+            isArtistIDInSeries[seriesID][artistID] = false;


It could be redundant since we did it in the _removeSeriesFromArtist

jollyjoker992 · 2024-12-24T08:36:34Z

contracts/SeriesIndexer.sol

+        for (uint256 i = 0; i < series.artistIDs.length; i++) {
+            uint256 artistID = series.artistIDs[i];
+            isArtistIDInSeries[seriesID][artistID] = false;
+            _removeSeriesFromArtist(artistID, seriesID);


Why don't we call the function _removeArtistFromSeries as well if we tend to remove the artist from series?

nvm, you did it when deleting the storage below.

jollyjoker992 · 2024-12-24T08:44:17Z

contracts/SeriesIndexer.sol

+
+        _ensureArtistHasID(proposedArtistAddr);
+        uint256 proposedArtistID = addressToArtistID[proposedArtistAddr];
+


It looks like you don't check the proposed address has been already artist for this series.

jollyjoker992 · 2024-12-24T08:47:28Z

contracts/SeriesIndexer.sol

+        }
+
+        Series storage series = seriesDetails[seriesID];
+        series.artistIDs.push(artistID);


This logic could be presented already in _addArtistsToSeries, could it be reused?

jollyjoker992 · 2024-12-24T09:17:23Z

contracts/SeriesIndexer.sol

+        if (artistID == 0) {
+            revert NotAnArtistError(msg.sender);
+        }
+        if (!ownerRightsRevokedForArtistID[artistID]) {


Redundant parentheses

github-actions · 2024-12-26T12:59:30Z

contracts/SeriesIndexer.sol

+pragma solidity ^0.8.0;
+
+import "@openzeppelin/contracts/access/Ownable.sol" as Ownable;
+import "@openzeppelin/contracts/utils/structs/BitMaps.sol";


⚠️ [solhint] _{reported by reviewdog 🐶}
global import of path @openzeppelin/contracts/utils/structs/BitMaps.sol is not allowed. Specify names to import individually or bind all exports of the module into a name (import "path" as Name)

github-actions · 2024-12-26T13:56:36Z

contracts/SeriesIndexer.sol

+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "@openzeppelin/contracts/access/Ownable.sol";


⚠️ [solhint] _{reported by reviewdog 🐶}
global import of path @openzeppelin/contracts/access/Ownable.sol is not allowed. Specify names to import individually or bind all exports of the module into a name (import "path" as Name)

Implement version 1

2eb6555

Implement version 1 Better naming f

github-actions bot reviewed Dec 13, 2024

View reviewed changes

Fix linter review

abf3af4

fix

lpopo0856 force-pushed the 3078-series-index-contract branch from a8851ad to abf3af4 Compare December 13, 2024 11:44

jollyjoker992 reviewed Dec 23, 2024

View reviewed changes

contracts/SeriesIndexer.sol Outdated Show resolved Hide resolved

jollyjoker992 reviewed Dec 23, 2024

View reviewed changes

contracts/SeriesIndexer.sol Outdated

}

}

function _checkArtist(uint256 seriesID) internal view {

Copy link

Member

jollyjoker992 Dec 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same here.

jollyjoker992 reviewed Dec 23, 2024

View reviewed changes

lpopo0856 added 4 commits December 23, 2024 14:45

v2 implementation

ed3acd7

better naming

ab01d00

better public function

df9974d

comment words

8c1ce1d

jollyjoker992 reviewed Dec 24, 2024

View reviewed changes

remove confusing internal function

ea867b2

jollyjoker992 reviewed Dec 24, 2024

View reviewed changes

lpopo0856 added 3 commits December 24, 2024 18:04

remove redundant check

6b5b19d

fix the review

045871a

adding series state & more tests

b58bf0c

github-actions bot reviewed Dec 26, 2024

View reviewed changes

rework v3 with bitmap

ca84544

lpopo0856 force-pushed the 3078-series-index-contract branch from 7591cdd to ca84544 Compare December 26, 2024 13:56

github-actions bot reviewed Dec 26, 2024

View reviewed changes

better comments

2bea7c3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

3078 - Series indexer contract #44

3078 - Series indexer contract #44

lpopo0856 commented Dec 13, 2024

github-actions bot left a comment

jollyjoker992 Dec 23, 2024

lpopo0856 Dec 23, 2024

jollyjoker992 Dec 23, 2024

jollyjoker992 Dec 23, 2024

jollyjoker992 Dec 23, 2024

jollyjoker992 Dec 23, 2024

jollyjoker992 Dec 23, 2024

jollyjoker992 Dec 23, 2024

jollyjoker992 Dec 23, 2024

jollyjoker992 Dec 23, 2024

lpopo0856 Dec 23, 2024

lpopo0856 Dec 23, 2024

jollyjoker992 Dec 24, 2024

jollyjoker992 Dec 24, 2024

jollyjoker992 Dec 24, 2024

jollyjoker992 Dec 24, 2024 •

edited

Loading

jollyjoker992 Dec 24, 2024

jollyjoker992 Dec 24, 2024

jollyjoker992 Dec 24, 2024

jollyjoker992 Dec 24, 2024

github-actions bot Dec 26, 2024

github-actions bot Dec 26, 2024

		require(length <= 50, "Batch size too large"); // Prevent DOS attacks


		_ensureArtistHasID(proposedArtistAddr);
		uint256 proposedArtistID = addressToArtistID[proposedArtistAddr];

3078 - Series indexer contract #44

Are you sure you want to change the base?

3078 - Series indexer contract #44

Conversation

lpopo0856 commented Dec 13, 2024

github-actions bot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jollyjoker992 Dec 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot Dec 26, 2024

Choose a reason for hiding this comment

github-actions bot Dec 26, 2024

Choose a reason for hiding this comment

jollyjoker992 Dec 24, 2024 •

edited

Loading