🐞 fix: bytes32 not enough

Author: noyyyy

contracts/Campaign.sol

@@ -23,7 +23,7 @@ contract Campaign is ICampaign, Ownable, ERC721 {
   uint256 public immutable requiredAmount;
   Consts.CampaignStatus public status;
 
-  bytes32 public campaignUri;
+  string public campaignUri;
   uint256 public immutable startTime;
   uint256 public immutable totalEpochsCount;
   uint256 public immutable period;
@@ -60,7 +60,7 @@ contract Campaign is ICampaign, Ownable, ERC721 {
   }
 
   struct Record {
-    bytes32 contentUri;
+    string contentUri;
   }
 
   constructor(
@@ -71,7 +71,7 @@ contract Campaign is ICampaign, Ownable, ERC721 {
     uint256 startTime_,
     uint256 totalPeriod_,
     uint256 periodLength_,
-    bytes32 campaignUri_
+    string memory campaignUri_
   ) ERC721(name_, symbol_) {
     require(address(token_) != address(0), 'Campaign: invalid token');
     require(amount_ != 0, 'Campaign: invalid amount');
@@ -84,7 +84,7 @@ contract Campaign is ICampaign, Ownable, ERC721 {
     campaignUri = campaignUri_;
   }
 
-  function setCampaignUri(bytes32 newUri) external override onlyOwner {
+  function setCampaignUri(string calldata newUri) external override onlyOwner {
     campaignUri = newUri;
     emit EvCampaignUriSet(campaignUri);
   }
@@ -156,8 +156,8 @@ contract Campaign is ICampaign, Ownable, ERC721 {
     successTokensCount = _idx;
     for (uint256 tokenId = 0; tokenId < _idx; tokenId++) {
       for (uint256 j = 0; j < totalEpochsCount; j++) {
-        bytes32 content = records[j][tokenId].contentUri;
-        if (content == bytes32(0)) {
+        string memory content = records[j][tokenId].contentUri;
+        if (bytes(content).length == 0) {
           uint256 penalty = properties[tokenId].pendingReward;
           hostReward += (penalty * Consts.HOST_REWARD) / Consts.DECIMAL;
           protocolFee += (penalty * Consts.PROTOCOL_FEE) / Consts.DECIMAL;
@@ -182,9 +182,9 @@ contract Campaign is ICampaign, Ownable, ERC721 {
 
   /**
    * @dev user check in
-   * @param contentUri bytes32 of ipfs uri or other decentralize storage
+   * @param contentUri string of ipfs uri or other decentralize storage
    */
-  function checkIn(bytes32 contentUri, uint256 tokenId)
+  function checkIn(string calldata contentUri, uint256 tokenId)
     external
     override
     onlyTokenHolder(tokenId)

contracts/CampaignFactoryUpgradable.sol

@@ -43,7 +43,7 @@ contract CampaignFactoryUpgradable is ICampaignFactory, UUPSUpgradeable, Ownable
     uint256 startTime,
     uint256 totalPeriod,
     uint256 periodLength,
-    bytes32 campaignUri
+    string calldata campaignUri
   ) public override onlyWhiteUser onlyWhiteToken(token) {
     require(amount <= whiteTokens[token], 'CampaignF: amount exceed cap');
     require(block.timestamp + 600 < startTime, 'CampaignF: start too soon');

contracts/interface/ICampaign.sol

@@ -3,7 +3,7 @@ pragma solidity 0.8.15;
 
 interface ICampaign {
   // owner update content uri
-  function setCampaignUri(bytes32 newUri) external;
+  function setCampaignUri(string calldata newUri) external;
 
   // user sign up the campaign
   function signUp() external;
@@ -12,21 +12,21 @@ interface ICampaign {
   function admit(uint256[] calldata) external;
 
   // user check at a fixed frequency
-  function checkIn(bytes32, uint256) external;
+  function checkIn(string calldata, uint256) external;
 
   // settle the reward
   function settle() external;
 
   // user claim reward after campaign ended
   function claim(uint256 tokenId) external;
 
-  event EvCampaignUriSet(bytes32 newUri);
+  event EvCampaignUriSet(string newUri);
 
   event EvSignUp(uint256 tokenId);
 
   event EvRegisterSuccessfully(uint256 tokenId);
 
-  event EvCheckIn(uint256 epoch, uint256 tokenId, bytes32 contentUri);
+  event EvCheckIn(uint256 epoch, uint256 tokenId, string contentUri);
 
   event EvModifyRegistry(uint256[] tokenList, bool[] status);
 

contracts/interface/ICampaignFactory.sol

@@ -13,7 +13,7 @@ interface ICampaignFactory {
     uint256 startTime,
     uint256 totalPeriod,
     uint256 periodLength,
-    bytes32 campaignUri
+    string calldata campaignUri
   ) external;
 
   event EvCampaignCreated(address indexed host, address indexed campaignAddress);

cspell.json

@@ -56,6 +56,8 @@
     "Hola",
     "ipfs",
     "Qmxxxxx",
+    "Qmxxxx",
+    "multiformats",
     "Merkle",
     "vitalik",
     "georli",

package.json

@@ -55,7 +55,8 @@
   "dependencies": {
     "@openzeppelin/contracts": "^4.4.1",
     "@openzeppelin/contracts-upgradeable": "^4.4.2",
-    "hardhat-deploy": "^0.11.12"
+    "hardhat-deploy": "^0.11.12",
+    "multiformats": "^9.7.1"
   },
   "files": []
 }

scripts/cid.ts

@@ -0,0 +1,23 @@
+// import { base64 } from 'multiformats/bases/base64';
+import { ethers } from 'hardhat';
+import { CID } from 'multiformats/cid';
+import * as json from 'multiformats/codecs/json';
+import { sha256 } from 'multiformats/hashes/sha2';
+
+async function main() {
+  const bytes = json.encode({ hello: 'world' });
+
+  const hash = await sha256.digest(bytes);
+  const cid = CID.create(1, json.code, hash);
+
+  /* cspell:disable-next-line */
+  const c = CID.parse('bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi');
+
+  console.log(cid, c.toV0());
+
+  console.log(ethers.utils.formatBytes32String('ipfs://1111111111111111111111111'));
+}
+
+main().catch((e) => {
+  console.error(e);
+});

test/CampaignFactoryUpgradable.ts

@@ -35,7 +35,7 @@ describe('CampaignFactoryUpgradable', () => {
       (await getCurrentTime()) + 86400 / 2,
       2,
       86400,
-      ethers.utils.formatBytes32String('ipfs://Qmxxxxx'),
+      'ipfs://Qmxxxx',
     );
 
     const receipt: ContractReceipt = await tx.wait();
@@ -82,7 +82,7 @@ describe('CampaignFactoryUpgradable', () => {
       (await getCurrentTime()) + 86400,
       3,
       86400,
-      ethers.utils.formatBytes32String('ipfs://Qmxxxxx'),
+      'ipfs://Qmxxxx',
     );
 
     const receipt: ContractReceipt = await tx.wait();
@@ -119,15 +119,15 @@ describe('CampaignFactoryUpgradable', () => {
     await TimeGo(86400);
 
     for (const user of users) {
-      await campaign.connect(user).checkIn(ethers.utils.formatBytes32String('ipfs://Qmxxxxx'), holderInfo[user.address]);
+      await campaign.connect(user).checkIn('ipfs://Qmxxxx', holderInfo[user.address]);
     }
 
     expect(await campaign.currentEpoch()).to.be.equal(0);
 
     await TimeGo(86400);
 
     for (const user of users) {
-      await campaign.connect(user).checkIn(ethers.utils.formatBytes32String('ipfs://Qmxxxxx'), holderInfo[user.address]);
+      await campaign.connect(user).checkIn('ipfs://Qmxxxx', holderInfo[user.address]);
     }
 
     expect(await campaign.currentEpoch()).to.be.equal(1);
@@ -136,7 +136,7 @@ describe('CampaignFactoryUpgradable', () => {
 
     // first one forget to checkIn
     for (const user of users.slice(1)) {
-      await campaign.connect(user).checkIn(ethers.utils.formatBytes32String('ipfs://Qmxxxxx'), holderInfo[user.address]);
+      await campaign.connect(user).checkIn('ipfs://Qmxxxx', holderInfo[user.address]);
     }
     expect(await campaign.currentEpoch()).to.be.equal(2);
 

yarn.lock

@@ -7439,6 +7439,11 @@ multicodec@^1.0.0:
     buffer "^5.6.0"
     varint "^5.0.0"
 
+multiformats@^9.7.1:
+  version "9.7.1"
+  resolved "https://registry.yarnpkg.com/multiformats/-/multiformats-9.7.1.tgz#ab348e5fd6f8e7fb3fd56033211bda48854e2173"
+  integrity sha512-TaVmGEBt0fhxiNJMGphBfB+oGvUxFs8KgGvgl8d3C+GWtrFcvXdJ2196eg+dYhmSFClmgFfSfJEklo+SZzdNuw==
+
 multihashes@^0.4.15, multihashes@~0.4.15:
   version "0.4.21"
   resolved "https://registry.yarnpkg.com/multihashes/-/multihashes-0.4.21.tgz#dc02d525579f334a7909ade8a122dabb58ccfcb5"