refactor: add MarketError (#670)

* Add MarketError

Add MarketError and convert all EthersErrors (ProviderError, SignerError) to MarketError

* Include token contract call in conversion of ethers error

codex/contracts/market.nim

@@ -2,9 +2,9 @@ import std/sequtils
 import std/strutils
 import std/sugar
 import pkg/ethers
-import pkg/ethers/testing
 import pkg/upraises
 import pkg/questionable
+import ../utils/exceptions
 import ../logutils
 import ../market
 import ./marketplace
@@ -32,11 +32,20 @@ func new*(_: type OnChainMarket, contract: Marketplace): OnChainMarket =
     signer: signer,
   )
 
+proc raiseMarketError(message: string) {.raises: [MarketError].} =
+  raise newException(MarketError, message)
+
+template convertEthersError(body) =
+  try:
+    body
+  except EthersError as error:
+    raiseMarketError(error.msgDetail)
+
 proc approveFunds(market: OnChainMarket, amount: UInt256) {.async.} =
   debug "Approving tokens", amount
+  convertEthersError:
     let tokenAddress = await market.contract.token()
     let token = Erc20Token.new(tokenAddress, market.signer)
-
     discard await token.increaseAllowance(market.contract.address(), amount).confirm(1)
 
 method getZkeyHash*(market: OnChainMarket): Future[?string] {.async.} =
@@ -44,70 +53,83 @@ method getZkeyHash*(market: OnChainMarket): Future[?string] {.async.} =
   return some config.proofs.zkeyHash
 
 method getSigner*(market: OnChainMarket): Future[Address] {.async.} =
+  convertEthersError:
     return await market.signer.getAddress()
 
 method periodicity*(market: OnChainMarket): Future[Periodicity] {.async.} =
+  convertEthersError:
     let config = await market.contract.config()
     let period = config.proofs.period
     return Periodicity(seconds: period)
 
 method proofTimeout*(market: OnChainMarket): Future[UInt256] {.async.} =
+  convertEthersError:
     let config = await market.contract.config()
     return config.proofs.timeout
 
 method proofDowntime*(market: OnChainMarket): Future[uint8] {.async.} =
+  convertEthersError:
     let config = await market.contract.config()
     return config.proofs.downtime
 
 method getPointer*(market: OnChainMarket, slotId: SlotId): Future[uint8] {.async.} =
+  convertEthersError:
     let overrides = CallOverrides(blockTag: some BlockTag.pending)
     return await market.contract.getPointer(slotId, overrides)
 
 method myRequests*(market: OnChainMarket): Future[seq[RequestId]] {.async.} =
+  convertEthersError:
     return await market.contract.myRequests
 
 method mySlots*(market: OnChainMarket): Future[seq[SlotId]] {.async.} =
+  convertEthersError:
     let slots = await market.contract.mySlots()
     debug "Fetched my slots", numSlots=len(slots)
 
     return slots
 
 method requestStorage(market: OnChainMarket, request: StorageRequest){.async.} =
+  convertEthersError:
     debug "Requesting storage"
     await market.approveFunds(request.price())
     await market.contract.requestStorage(request)
 
 method getRequest(market: OnChainMarket,
                   id: RequestId): Future[?StorageRequest] {.async.} =
+  convertEthersError:
     try:
       return some await market.contract.getRequest(id)
     except ProviderError as e:
-    if e.revertReason.contains("Unknown request"):
+      if e.msgDetail.contains("Unknown request"):
         return none StorageRequest
       raise e
 
 method requestState*(market: OnChainMarket,
                      requestId: RequestId): Future[?RequestState] {.async.} =
+  convertEthersError:
     try:
       let overrides = CallOverrides(blockTag: some BlockTag.pending)
       return some await market.contract.requestState(requestId, overrides)
     except ProviderError as e:
-    if e.revertReason.contains("Unknown request"):
+      if e.msgDetail.contains("Unknown request"):
         return none RequestState
       raise e
 
 method slotState*(market: OnChainMarket,
                   slotId: SlotId): Future[SlotState] {.async.} =
+  convertEthersError:
     let overrides = CallOverrides(blockTag: some BlockTag.pending)
     return await market.contract.slotState(slotId, overrides)
 
 method getRequestEnd*(market: OnChainMarket,
                       id: RequestId): Future[SecondsSince1970] {.async.} =
+  convertEthersError:
     return await market.contract.requestEnd(id)
 
 method getHost(market: OnChainMarket,
                requestId: RequestId,
                slotIndex: UInt256): Future[?Address] {.async.} =
+  convertEthersError:
     let slotId = slotId(requestId, slotIndex)
     let address = await market.contract.getHost(slotId)
     if address != Address.default:
@@ -117,11 +139,11 @@ method getHost(market: OnChainMarket,
 
 method getActiveSlot*(market: OnChainMarket,
                       slotId: SlotId): Future[?Slot] {.async.} =
-
+  convertEthersError:
     try:
       return some await market.contract.getActiveSlot(slotId)
     except ProviderError as e:
-    if e.revertReason.contains("Slot is free"):
+      if e.msgDetail.contains("Slot is free"):
         return none Slot
       raise e
 
@@ -130,48 +152,56 @@ method fillSlot(market: OnChainMarket,
                 slotIndex: UInt256,
                 proof: Groth16Proof,
                 collateral: UInt256) {.async.} =
+  convertEthersError:
     await market.approveFunds(collateral)
     await market.contract.fillSlot(requestId, slotIndex, proof)
 
 method freeSlot*(market: OnChainMarket, slotId: SlotId) {.async.} =
+  convertEthersError:
     await market.contract.freeSlot(slotId)
 
 method withdrawFunds(market: OnChainMarket,
                      requestId: RequestId) {.async.} =
+  convertEthersError:
     await market.contract.withdrawFunds(requestId)
 
 method isProofRequired*(market: OnChainMarket,
                         id: SlotId): Future[bool] {.async.} =
+  convertEthersError:
     try:
       let overrides = CallOverrides(blockTag: some BlockTag.pending)
       return await market.contract.isProofRequired(id, overrides)
     except ProviderError as e:
-    if e.revertReason.contains("Slot is free"):
+      if e.msgDetail.contains("Slot is free"):
         return false
       raise e
 
 method willProofBeRequired*(market: OnChainMarket,
                             id: SlotId): Future[bool] {.async.} =
+  convertEthersError:
     try:
       let overrides = CallOverrides(blockTag: some BlockTag.pending)
       return await market.contract.willProofBeRequired(id, overrides)
     except ProviderError as e:
-    if e.revertReason.contains("Slot is free"):
+      if e.msgDetail.contains("Slot is free"):
         return false
       raise e
 
 method getChallenge*(market: OnChainMarket, id: SlotId): Future[ProofChallenge] {.async.} =
+  convertEthersError:
     let overrides = CallOverrides(blockTag: some BlockTag.pending)
     return await market.contract.getChallenge(id, overrides)
 
 method submitProof*(market: OnChainMarket,
                     id: SlotId,
                     proof: Groth16Proof) {.async.} =
+  convertEthersError:
     await market.contract.submitProof(id, proof)
 
 method markProofAsMissing*(market: OnChainMarket,
                            id: SlotId,
                            period: Period) {.async.} =
+  convertEthersError:
     await market.contract.markProofAsMissing(id, period)
 
 method canProofBeMarkedAsMissing*(
@@ -186,7 +216,7 @@ method canProofBeMarkedAsMissing*(
     await contractWithoutSigner.markProofAsMissing(id, period, overrides)
     return true
   except EthersError as e:
-    trace "Proof can not be marked as missing", msg = e.msg
+    trace "Proof cannot be marked as missing", msg = e.msg
     return false
 
 method subscribeRequests*(market: OnChainMarket,
@@ -196,6 +226,8 @@ method subscribeRequests*(market: OnChainMarket,
     callback(event.requestId,
              event.ask,
              event.expiry)
+
+  convertEthersError:
     let subscription = await market.contract.subscribe(StorageRequested, onEvent)
     return OnChainMarketSubscription(eventSubscription: subscription)
 
@@ -204,6 +236,8 @@ method subscribeSlotFilled*(market: OnChainMarket,
                            Future[MarketSubscription] {.async.} =
   proc onEvent(event: SlotFilled) {.upraises:[].} =
     callback(event.requestId, event.slotIndex)
+
+  convertEthersError:
     let subscription = await market.contract.subscribe(SlotFilled, onEvent)
     return OnChainMarketSubscription(eventSubscription: subscription)
 
@@ -215,6 +249,8 @@ method subscribeSlotFilled*(market: OnChainMarket,
   proc onSlotFilled(eventRequestId: RequestId, eventSlotIndex: UInt256) =
     if eventRequestId == requestId and eventSlotIndex == slotIndex:
       callback(requestId, slotIndex)
+
+  convertEthersError:
     return await market.subscribeSlotFilled(onSlotFilled)
 
 method subscribeSlotFreed*(market: OnChainMarket,
@@ -222,6 +258,8 @@ method subscribeSlotFreed*(market: OnChainMarket,
                           Future[MarketSubscription] {.async.} =
   proc onEvent(event: SlotFreed) {.upraises:[].} =
     callback(event.requestId, event.slotIndex)
+
+  convertEthersError:
     let subscription = await market.contract.subscribe(SlotFreed, onEvent)
     return OnChainMarketSubscription(eventSubscription: subscription)
 
@@ -230,6 +268,8 @@ method subscribeFulfillment(market: OnChainMarket,
                            Future[MarketSubscription] {.async.} =
   proc onEvent(event: RequestFulfilled) {.upraises:[].} =
     callback(event.requestId)
+
+  convertEthersError:
     let subscription = await market.contract.subscribe(RequestFulfilled, onEvent)
     return OnChainMarketSubscription(eventSubscription: subscription)
 
@@ -240,6 +280,8 @@ method subscribeFulfillment(market: OnChainMarket,
   proc onEvent(event: RequestFulfilled) {.upraises:[].} =
     if event.requestId == requestId:
       callback(event.requestId)
+
+  convertEthersError:
     let subscription = await market.contract.subscribe(RequestFulfilled, onEvent)
     return OnChainMarketSubscription(eventSubscription: subscription)
 
@@ -248,6 +290,8 @@ method subscribeRequestCancelled*(market: OnChainMarket,
                                 Future[MarketSubscription] {.async.} =
   proc onEvent(event: RequestCancelled) {.upraises:[].} =
     callback(event.requestId)
+
+  convertEthersError:
     let subscription = await market.contract.subscribe(RequestCancelled, onEvent)
     return OnChainMarketSubscription(eventSubscription: subscription)
 
@@ -258,6 +302,8 @@ method subscribeRequestCancelled*(market: OnChainMarket,
   proc onEvent(event: RequestCancelled) {.upraises:[].} =
     if event.requestId == requestId:
       callback(event.requestId)
+
+  convertEthersError:
     let subscription = await market.contract.subscribe(RequestCancelled, onEvent)
     return OnChainMarketSubscription(eventSubscription: subscription)
 
@@ -266,6 +312,8 @@ method subscribeRequestFailed*(market: OnChainMarket,
                             Future[MarketSubscription] {.async.} =
   proc onEvent(event: RequestFailed) {.upraises:[]} =
     callback(event.requestId)
+
+  convertEthersError:
     let subscription = await market.contract.subscribe(RequestFailed, onEvent)
     return OnChainMarketSubscription(eventSubscription: subscription)
 
@@ -276,6 +324,8 @@ method subscribeRequestFailed*(market: OnChainMarket,
   proc onEvent(event: RequestFailed) {.upraises:[]} =
     if event.requestId == requestId:
       callback(event.requestId)
+
+  convertEthersError:
     let subscription = await market.contract.subscribe(RequestFailed, onEvent)
     return OnChainMarketSubscription(eventSubscription: subscription)
 
@@ -284,6 +334,8 @@ method subscribeProofSubmission*(market: OnChainMarket,
                                 Future[MarketSubscription] {.async.} =
   proc onEvent(event: ProofSubmitted) {.upraises: [].} =
     callback(event.id)
+
+  convertEthersError:
     let subscription = await market.contract.subscribe(ProofSubmitted, onEvent)
     return OnChainMarketSubscription(eventSubscription: subscription)
 
@@ -293,7 +345,7 @@ method unsubscribe*(subscription: OnChainMarketSubscription) {.async.} =
 method queryPastStorageRequests*(market: OnChainMarket,
                                  blocksAgo: int):
                                 Future[seq[PastStorageRequest]] {.async.} =
-
+  convertEthersError:
     let contract = market.contract
     let provider = contract.provider
 

codex/market.nim

@@ -5,6 +5,7 @@ import pkg/ethers/erc20
 import ./contracts/requests
 import ./contracts/proofs
 import ./clock
+import ./errors
 import ./periods
 
 export chronos
@@ -16,6 +17,7 @@ export periods
 
 type
   Market* = ref object of RootObj
+  MarketError* = object of CodexError
   Subscription* = ref object of RootObj
   OnRequest* = proc(id: RequestId,
                     ask: StorageAsk,

codex/sales/states/provingsimulated.nim

@@ -33,8 +33,8 @@ when codex_enable_proof_failures:
       try:
         warn "Submitting INVALID proof", period = currentPeriod, slotId = slot.id
         await market.submitProof(slot.id, Groth16Proof.default)
-      except SignerError as e:
+      except MarketError as e:
-        if not e.msgDetail.contains("Invalid proof"):
+        if not e.msg.contains("Invalid proof"):
           onSubmitProofError(e, currentPeriod, slot.id)
       except CatchableError as e:
         onSubmitProofError(e, currentPeriod, slot.id)