feat: add test scaffold for CrossChainProvider

packages/sdk/src/interfaces/types.ts

@@ -48,6 +48,13 @@ export enum MessageStatus {
    */
   UNCONFIRMED_L1_TO_L2_MESSAGE,
 
+  /**
+   * Message is an L1 to L2 message and the transaction to execute the message failed.
+   * When this status is returned, you will need to resend the L1 to L2 message, probably with a
+   * higher gas limit.
+   */
+  FAILED_L1_TO_L2_MESSAGE,
+
   /**
    * Message is an L2 to L1 message and no state root has been published yet.
    */

packages/sdk/test/cross-chain-provider.spec.ts

+/* eslint-disable @typescript-eslint/no-empty-function */
+import './setup'
+
+describe('CrossChainProvider', () => {
+  describe('construction', () => {
+    describe('basic construction (given L1 and L2 providers)', () => {
+      it('should have an l1Provider', () => {})
+
+      it('should have an l2Provider', () => {})
+
+      it('should have an l1ChainId', () => {})
+
+      it('should have an l2ChainId', () => {})
+
+      it('should have all contract connections', () => {})
+    })
+  })
+
+  describe('getMessagesByTransaction', () => {
+    describe('when a direction is specified', () => {
+      describe('when the transaction exists', () => {
+        describe('when thetransaction has messages', () => {
+          for (const n of [1, 2, 4, 8]) {
+            it(`should find ${n} messages when the transaction emits ${n} messages`, () => {})
+          }
+        })
+
+        describe('when the transaction has no messages', () => {
+          it('should find nothing', () => {})
+        })
+      })
+
+      describe('when the transaction does not exist', () => {
+        it('should throw an error', () => {})
+      })
+    })
+
+    describe('when a direction is not specified', () => {
+      describe('when the transaction exists only on L1', () => {
+        describe('when the transaction has messages', () => {
+          for (const n of [1, 2, 4, 8]) {
+            it(`should find ${n} messages when the transaction emits ${n} messages`, () => {})
+          }
+        })
+
+        describe('when the transaction has no messages', () => {
+          it('should find nothing', () => {})
+        })
+      })
+
+      describe('when the transaction exists only on L2', () => {
+        describe('when the transaction has messages', () => {
+          for (const n of [1, 2, 4, 8]) {
+            it(`should find ${n} messages when the transaction emits ${n} messages`, () => {})
+          }
+        })
+
+        describe('when the transaction has no messages', () => {
+          it('should find nothing', () => {})
+        })
+      })
+
+      describe('when the transaction does not exist', () => {
+        it('should throw an error', () => {})
+      })
+
+      describe('when the transaction exists on both L1 and L2', () => {
+        it('should throw an error', () => {})
+      })
+    })
+  })
+
+  describe('getMessagesByAddress', () => {
+    describe('when the address has sent messages', () => {
+      describe('when no direction is specified', () => {
+        it('should find all messages sent by the address', () => {})
+      })
+
+      describe('when a direction is specified', () => {
+        it('should find all messages only in the given direction', () => {})
+      })
+
+      describe('when a block range is specified', () => {
+        it('should find all messages within the block range', () => {})
+      })
+
+      describe('when both a direction and a block range are specified', () => {
+        it('should find all messages only in the given direction and within the block range', () => {})
+      })
+    })
+
+    describe('when the address has not sent messages', () => {
+      it('should find nothing', () => {})
+    })
+  })
+
+  describe('getTokenBridgeMessagesByAddress', () => {
+    describe('when the address has made deposits or withdrawals', () => {
+      describe('when a direction of L1 => L2 is specified', () => {
+        it('should find all deposits made by the address', () => {})
+      })
+
+      describe('when a direction of L2 => L1 is specified', () => {
+        it('should find all withdrawals made by the address', () => {})
+      })
+
+      describe('when a block range is specified', () => {
+        it('should find all deposits or withdrawals within the block range', () => {})
+      })
+
+      describe('when both a direction and a block range are specified', () => {
+        it('should find all deposits or withdrawals only in the given direction and within the block range', () => {})
+      })
+    })
+
+    describe('when the address has not made any deposits or withdrawals', () => {
+      it('should find nothing', () => {})
+    })
+  })
+
+  describe('getMessageStatus', () => {
+    describe('when the message is an L1 => L2 message', () => {
+      describe('when the message has not been executed on L2 yet', () => {
+        it('should return a status of UNCONFIRMED_L1_TO_L2_MESSAGE', () => {})
+      })
+
+      describe('when the message has been executed on L2', () => {
+        it('should return a status of RELAYED', () => {})
+      })
+
+      describe('when the message has been executed but failed', () => {
+        it('should return a status of FAILED_L1_TO_L2_MESSAGE', () => {})
+      })
+    })
+
+    describe('when the message is an L2 => L1 message', () => {
+      describe('when the message state root has not been published', () => {
+        it('should return a status of STATE_ROOT_NOT_PUBLISHED', () => {})
+      })
+
+      describe('when the message state root is still in the challenge period', () => {
+        it('should return a status of IN_CHALLENGE_PERIOD', () => {})
+      })
+
+      describe('when the message is no longer in the challenge period', () => {
+        describe('when the message has been relayed successfully', () => {
+          it('should return a status of RELAYED', () => {})
+        })
+
+        describe('when the message has been relayed but the relay failed', () => {
+          it('should return a status of READY_FOR_RELAY', () => {})
+        })
+
+        describe('when the message has not been relayed', () => {
+          it('should return a status of READY_FOR_RELAY')
+        })
+      })
+    })
+  })
+
+  describe('getMessageReceipt', () => {
+    describe('when the message has been relayed', () => {
+      describe('when the relay was successful', () => {
+        it('should return the receipt of the transaction that relayed the message', () => {})
+      })
+
+      describe('when the relay failed', () => {
+        it('should return the receipt of the transaction that attempted to relay the message', () => {})
+      })
+
+      describe('when the relay failed more than once', () => {
+        it('should return the receipt of the last transaction that attempted to relay the message', () => {})
+      })
+    })
+
+    describe('when the message has not been relayed', () => {
+      it('should return null', () => {})
+    })
+  })
+
+  describe('waitForMessageReciept', () => {
+    describe('when the message receipt already exists', () => {
+      it('should immediately return the receipt', () => {})
+    })
+
+    describe('when the message receipt does not exist already', () => {
+      describe('when no extra options are provided', () => {
+        it('should wait for the receipt to be published', () => {})
+        it('should wait forever for the receipt if the receipt is never published', () => {})
+      })
+
+      describe('when a timeout is provided', () => {
+        it('should throw an error if the timeout is reached', () => {})
+      })
+    })
+  })
+
+  describe('estimateMessageExecutionGas', () => {
+    describe('when the message is an L1 => L2 message', () => {
+      it('should perform a gas estimation of the L2 action', () => {})
+    })
+
+    describe('when the message is an L2 => L1 message', () => {
+      it('should perform a gas estimation of the L1 action, including the cost of the proof', () => {})
+    })
+  })
+
+  describe('estimateMessageWaitTimeBlocks', () => {
+    describe('when the message exists', () => {
+      describe('when the message is an L1 => L2 message', () => {
+        describe('when the message has not been executed on L2 yet', () => {
+          it('should return the estimated blocks until the message will be confirmed on L2', () => {})
+        })
+
+        describe('when the message has been executed on L2', () => {
+          it('should return 0', () => {})
+        })
+      })
+
+      describe('when the message is an L2 => L1 message', () => {
+        describe('when the state root has not been published', () => {
+          it('should return null', () => {})
+        })
+
+        describe('when the state root is within the challenge period', () => {
+          it('should return the estimated blocks until the state root passes the challenge period', () => {})
+        })
+
+        describe('when the state root passes the challenge period', () => {
+          it('should return 0', () => {})
+        })
+      })
+    })
+
+    describe('when the message does not exist', () => {
+      it('should throw an error', () => {})
+    })
+  })
+
+  describe('estimateMessageWaitTimeSeconds', () => {
+    it('should be the result of estimateMessageWaitTimeBlocks multiplied by the L1 block time', () => {})
+  })
+})