Merge branch 'main' into merging-with-main

Author: lidangzzz

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

darc-protocol/contracts/protocol/DARC.sol

@@ -23,9 +23,12 @@ contract DARC is Runtime, Dashboard {
   function entrance(Program memory program) public payable returns (string memory) {
     require(program.programOperatorAddress == msg.sender, 
     string.concat(string.concat("Invalid program address. Msg.sender: ", StringUtils.toAsciiString(msg.sender)), string.concat(", and program operator address: ", StringUtils.toAsciiString(program.programOperatorAddress))));
-    for (uint256 opIdx = 0; opIdx < program.operations.length; opIdx++) {
+    for (uint256 opIdx; opIdx < program.operations.length;) {
       require(program.operations[opIdx].operatorAddress == msg.sender, 
       string.concat(string.concat("Invalid program address. Msg.sender: ", StringUtils.toAsciiString(msg.sender)), string.concat(", and program operator address: ", StringUtils.toAsciiString(program.operations[opIdx].operatorAddress))));
+      unchecked {
+        ++opIdx;
+      }
     }
     return runtimeEntrance(program);
   }
@@ -44,8 +47,8 @@ contract DARC is Runtime, Dashboard {
     require(amount <= currentMachineState.withdrawableCashMap[msg.sender], string.concat("Invalid withdraw amount. Amount: ", Strings.toString(amount), ", and withdrawable cash: ", Strings.toString(currentMachineState.withdrawableCashMap[msg.sender])));
 
     // first update the withdrawable cash map
-    bool bIsValid = false;
-    uint256 result = 0;
+    bool bIsValid;
+    uint256 result;
     (bIsValid, result) = SafeMathUpgradeable.trySub(currentMachineState.withdrawableCashMap[msg.sender], amount);
     require(bIsValid, string.concat("Invalid withdraw amount. Amount: ", Strings.toString(amount), ", and withdrawable cash: ", Strings.toString(currentMachineState.withdrawableCashMap[msg.sender])));
 
@@ -54,18 +57,25 @@ contract DARC is Runtime, Dashboard {
     // if the message sender owns zero withdrawable cash balance, then remove it from the withdrawable cash owner list
     if (currentMachineState.withdrawableCashMap[msg.sender] == 0) {
       address[] memory newWithdrawableCashOwnerList = new address[](currentMachineState.withdrawableCashOwnerList.length);
-      uint256 pt = 0;
-      for (uint256 index = 0; index < currentMachineState.withdrawableCashOwnerList.length; index++) {
+      uint256 pt;
+      for (uint256 index; index < currentMachineState.withdrawableCashOwnerList.length;) {
         if (currentMachineState.withdrawableCashOwnerList[index] != msg.sender) {
           newWithdrawableCashOwnerList[pt] = currentMachineState.withdrawableCashOwnerList[index];
           pt++;
         }
+
+        unchecked {
+          ++index;
+        }
       }
 
       // update the withdrawable cash owner list
       currentMachineState.withdrawableCashOwnerList = new address[](pt);
-      for (uint256 index = 0; index < pt; index++) {
+      for (uint256 index; index < pt;) {
         currentMachineState.withdrawableCashOwnerList[index] = newWithdrawableCashOwnerList[index];
+        unchecked {
+          ++index;
+        }
       }
     }
 
@@ -74,7 +84,7 @@ contract DARC is Runtime, Dashboard {
   }
 
   /**
-   * This is the only way to withdraw dividens from the DARC virtual machine
+   * This is the only way to withdraw dividends from the DARC virtual machine
    * @param amount The amount of cash to be withdrawn
    */
   function withdrawDividends(uint256 amount) public {
@@ -86,8 +96,8 @@ contract DARC is Runtime, Dashboard {
       require(amount <= currentMachineState.withdrawableDividendMap[msg.sender], string.concat("Invalid withdraw amount. Amount: ", Strings.toString(amount), ", and withdrawable dividends: ", Strings.toString(currentMachineState.withdrawableDividendMap[msg.sender])));
 
       // first update the withdrawable cash map
-      bool bIsValid = false;
-      uint256 result = 0;
+      bool bIsValid;
+      uint256 result;
       (bIsValid, result) = SafeMathUpgradeable.trySub(currentMachineState.withdrawableDividendMap[msg.sender], amount);
       require(bIsValid, string.concat("Invalid withdraw amount. Amount: ", Strings.toString(amount), ", and withdrawable dividends: ", Strings.toString(currentMachineState.withdrawableDividendMap[msg.sender])));
 
@@ -100,20 +110,27 @@ contract DARC is Runtime, Dashboard {
       // if the message sender owns zero withdrawable dividend balance, then remove it from the withdrawable dividend owner list
       if (currentMachineState.withdrawableDividendMap[msg.sender] == 0) {
         address[] memory newWithdrawableDividendsOwnerList = new address[](currentMachineState.withdrawableDividendOwnerList.length);
-        uint256 pt = 0;
-        for (uint256 index = 0; index < currentMachineState.withdrawableDividendOwnerList.length; index++) {
+        uint256 pt;
+        for (uint256 index; index < currentMachineState.withdrawableDividendOwnerList.length;) {
           if (currentMachineState.withdrawableDividendOwnerList[index] != msg.sender) {
             newWithdrawableDividendsOwnerList[pt] = currentMachineState.withdrawableDividendOwnerList[index];
             pt++;
           }
+
+          unchecked {
+            ++index;
+          }
         }
 
         // update the withdrawable cash owner list
         currentMachineState.withdrawableDividendOwnerList = new address[](pt);
-        for (uint256 index = 0; index < pt; index++) {
+        for (uint256 index; index < pt;) {
           currentMachineState.withdrawableDividendOwnerList[index] = newWithdrawableDividendsOwnerList[index];
+          unchecked {
+            ++index;
+          }
         }
       }
 
   }
-}
+}

darc-protocol/contracts/protocol/Dashboard/Dashboard.sol

@@ -8,7 +8,7 @@ import "../Runtime/Runtime.sol";
  * @author DARC Team
  * @notice The dashboard (a set of view functions) of the DARC machine state,
  * which is used to read the machine state, including machine state, voting state,
- * token informatin, plugin information, etc.
+ * token information, plugin information, etc.
  */
 contract Dashboard is MachineStateManager {
 
@@ -20,14 +20,18 @@ contract Dashboard is MachineStateManager {
   }
 
   /**
-   * @notice Get the avaiilable token classes
+   * @notice Get the available token classes
    */
   function getNumberOfTokenClasses() public view returns (uint256) {
-    uint256 i = 0;
-    for (; i < currentMachineState.tokenList.length; i++) {
+    uint256 i;
+    for (; i < currentMachineState.tokenList.length;) {
       if (!currentMachineState.tokenList[i].bIsInitialized) {
         break;
       }
+
+      unchecked {
+        ++i;
+      }
     }
     return i;
   }