Add Strings.equal

CHANGELOG.md

@@ -4,6 +4,7 @@
 
  * `ReentrancyGuard`: Add a `_reentrancyGuardEntered` function to expose the guard status. ([#3714](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3714))
  * `ERC20Votes`: optimize by using unchecked arithmetic. ([#3748](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3748))
+ * `Strings`: add `compare` method. ([#3774](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3774))
 
 ## Unreleased
 

contracts/mocks/StringsMock.sol

@@ -20,4 +20,8 @@ contract StringsMock {
     function toHexString(address addr) public pure returns (string memory) {
         return Strings.toHexString(addr);
     }
+
+    function compare(string memory a, string memory b) public pure returns (bool) {
+        return Strings.compare(a, b);
+    }
 }

contracts/utils/Strings.sol

@@ -67,4 +67,12 @@ library Strings {
     function toHexString(address addr) internal pure returns (string memory) {
         return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH);
     }
+
+    /**
+     * @dev Returns true if the two strings are equal.
+     */
+    function compare(string memory a, string memory b) internal pure returns (bool) {
+        if (bytes(a).length != bytes(b).length) return false;
+        return keccak256(abi.encodePacked(a)) == keccak256(abi.encodePacked(b));
+    }
 }

test/utils/Strings.test.js

@@ -83,4 +83,25 @@ contract('Strings', function (accounts) {
       expect(await this.strings.methods['toHexString(address)'](addr)).to.equal(addr);
     });
   });
+
+  describe('compare', function () {
+    it('compares two equal strings', async function () {
+      expect(await this.strings.methods['compare(string,string)']('a', 'a')).to.equal(true);
+    });
+
+    it('compares two different strings', async function () {
+      expect(await this.strings.methods['compare(string,string)']('a', 'b')).to.equal(false);
+    });
+
+    it('compares two different strings of different lengths', async function () {
+      expect(await this.strings.methods['compare(string,string)']('a', 'aa')).to.equal(false);
+      expect(await this.strings.methods['compare(string,string)']('aa', 'a')).to.equal(false);
+    });
+
+    it('compares two different strings of different (big) lengths', async function () {
+      const str1 = 'a'.repeat(201);
+      const str2 = 'a'.repeat(200) + 'b';
+      expect(await this.strings.methods['compare(string,string)'](str1, str2)).to.equal(false);
+    });
+  });
 });