add InvalidPaymentMethod custom error

masa-finance · Dec 14, 2022 · f643a96 · f643a96
1 parent e795cc8
commit f643a96
Show file tree

Hide file tree

Showing 12 changed files with 121 additions and 7 deletions.
diff --git a/contracts/SoulStore.sol b/contracts/SoulStore.sol
@@ -4,6 +4,7 @@ pragma solidity ^0.8.7;
 import "@openzeppelin/contracts/utils/math/SafeMath.sol";
 import "@openzeppelin/contracts/security/Pausable.sol";
 
+import "./libraries/Errors.sol";
 import "./dex/PaymentGateway.sol";
 import "./interfaces/ISoulboundIdentity.sol";
 import "./interfaces/ISoulName.sol";
@@ -200,7 +201,7 @@ contract SoulStore is PaymentGateway, Pausable {
         } else if (erc20token[paymentMethod]) {
             return _convertFromStableCoin(paymentMethod, mintingPrice);
         } else {
-            revert("INVALID_PAYMENT_METHOD");
+            revert InvalidPaymentMethod(paymentMethod);
         }
     }
 

diff --git a/contracts/dex/PaymentGateway.sol b/contracts/dex/PaymentGateway.sol
@@ -6,6 +6,7 @@ import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import "@openzeppelin/contracts/utils/math/SafeMath.sol";
 
+import "../libraries/Errors.sol";
 import "../interfaces/dex/IUniswapRouter.sol";
 
 /// @title Pay using a Decentralized automated market maker (AMM) when needed
@@ -208,7 +209,7 @@ abstract contract PaymentGateway is Ownable {
                 swapAmout
             );
         } else {
-            revert("INVALID_PAYMENT_METHOD");
+            revert InvalidPaymentMethod(paymentMethod);
         }
     }
 

diff --git a/contracts/libraries/Errors.sol b/contracts/libraries/Errors.sol
@@ -0,0 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.7;
+
+error InvalidPaymentMethod(address paymentMethod);
diff --git a/contracts/tokens/MasaSBTSelfSovereign.sol b/contracts/tokens/MasaSBTSelfSovereign.sol
@@ -5,6 +5,7 @@ import "@openzeppelin/contracts/utils/cryptography/draft-EIP712.sol";
 import "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
 import "@openzeppelin/contracts/utils/Counters.sol";
 
+import "../libraries/Errors.sol";
 import "../interfaces/ISoulboundIdentity.sol";
 import "../dex/PaymentGateway.sol";
 import "./MasaSBT.sol";
@@ -124,7 +125,7 @@ abstract contract MasaSBTSelfSovereign is PaymentGateway, MasaSBT, EIP712 {
         } else if (erc20token[paymentMethod]) {
             return _convertFromStableCoin(paymentMethod, mintingPrice);
         } else {
-            revert("INVALID_PAYMENT_METHOD");
+            revert InvalidPaymentMethod(paymentMethod);
         }
     }
 

diff --git a/docs/SoulLinker.md b/docs/SoulLinker.md
@@ -834,3 +834,22 @@ event Unpaused(address account)
 
 
 
+## Errors
+
+### InvalidPaymentMethod
+
+```solidity
+error InvalidPaymentMethod(address paymentMethod)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| paymentMethod | address | undefined |
+
+
diff --git a/docs/SoulStore.md b/docs/SoulStore.md
@@ -647,3 +647,22 @@ event Unpaused(address account)
 
 
 
+## Errors
+
+### InvalidPaymentMethod
+
+```solidity
+error InvalidPaymentMethod(address paymentMethod)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| paymentMethod | address | undefined |
+
+
diff --git a/docs/Soulbound2FA.md b/docs/Soulbound2FA.md
@@ -957,3 +957,22 @@ event Soulbound2FAMinted(uint256 tokenId, uint256 identityId, address authorityA
 
 
 
+## Errors
+
+### InvalidPaymentMethod
+
+```solidity
+error InvalidPaymentMethod(address paymentMethod)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| paymentMethod | address | undefined |
+
+
diff --git a/docs/SoulboundCreditScore.md b/docs/SoulboundCreditScore.md
@@ -957,3 +957,22 @@ event SoulboundCreditScoreMinted(uint256 tokenId, uint256 identityId, address au
 
 
 
+## Errors
+
+### InvalidPaymentMethod
+
+```solidity
+error InvalidPaymentMethod(address paymentMethod)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| paymentMethod | address | undefined |
+
+
diff --git a/docs/elin/contracts/security/ReentrancyGuard.md b/docs/elin/contracts/security/ReentrancyGuard.md
@@ -0,0 +1,12 @@
+# ReentrancyGuard
+
+
+
+
+
+
+
+*Contract module that helps prevent reentrant calls to a function. Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier available, which can be applied to functions to make sure there are no nested (reentrant) calls to them. Note that because there is a single `nonReentrant` guard, functions marked as `nonReentrant` may not call one another. This can be worked around by making those functions `private`, and then adding `external` `nonReentrant` entry points to them. TIP: If you would like to learn more about reentrancy and alternative ways to protect against it, check out our blog post https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].*
+
+
+
diff --git a/docs/tokens/MasaSBTSelfSovereign.md b/docs/tokens/MasaSBTSelfSovereign.md
@@ -884,3 +884,22 @@ event RoleRevoked(bytes32 indexed role, address indexed account, address indexed
 
 
 
+## Errors
+
+### InvalidPaymentMethod
+
+```solidity
+error InvalidPaymentMethod(address paymentMethod)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| paymentMethod | address | undefined |
+
+
diff --git a/test/SoulStore.test.ts b/test/SoulStore.test.ts
@@ -821,7 +821,7 @@ describe("Soul Store", () => {
     it("should fail to get purchase info for invalid payment method", async () => {
       await expect(
         soulStore.getPriceForMintingName(owner.address, SOUL_NAME, YEAR)
-      ).to.be.rejectedWith("INVALID_PAYMENT_METHOD");
+      ).to.be.rejectedWith("InvalidPaymentMethod");
     });
 
     it("we can't use an invalid payment method", async () => {
@@ -832,7 +832,7 @@ describe("Soul Store", () => {
           YEAR,
           ARWEAVE_LINK
         )
-      ).to.be.rejectedWith("INVALID_PAYMENT_METHOD");
+      ).to.be.rejectedWith("InvalidPaymentMethod");
     });
   });
 });
diff --git a/test/SoulboundCreditScore.test.ts b/test/SoulboundCreditScore.test.ts
@@ -442,7 +442,7 @@ describe("Soulbound Credit Score", () => {
     it("should fail to get minting info for invalid payment method", async () => {
       await expect(
         soulboundCreditScore.getMintingPrice(owner.address)
-      ).to.be.rejectedWith("INVALID_PAYMENT_METHOD");
+      ).to.be.rejectedWith("InvalidPaymentMethod");
     });
 
     it("we can't use an invalid payment method", async () => {
@@ -456,7 +456,7 @@ describe("Soulbound Credit Score", () => {
             signatureDate,
             signature
           )
-      ).to.be.rejectedWith("INVALID_PAYMENT_METHOD");
+      ).to.be.rejectedWith("InvalidPaymentMethod");
     });
   });