Create typescript library for checking message status

[anna-carroll]

Find Message Hashes

• Query array of message hashes, by:
  • within a block range
  • from a sender
  • to a recipient
  • from a domain
  • to a domain
• Transaction hash => message hash(es) in transaction
  ^^ above is tracked here: feat: OpticsMessageQuery class #828

Parse meaning from Message Hashes

• Message hash => status within Optics (see "Message Status")
• Message hash => all relevant fields (see "Fields to parse from messages")
  ^^ this will be doable with two lines of code once we have feat: OpticsMessageQuery class #828 and improve OpticsMessage status in multi-provider #815

[anna-carroll]

Optics Messages

• Origin chain
• Sender
• Destination Chain
• Nonce
• Recipient
• Message Body

Bridge Messages

• All
  • token origin domain
  • token address / ID
• Transfer
  • Sender of tokens on origin chain
  • Recipient of tokens
  • Amount of tokens
  • Pre-fill ID (for querying liquidity provider)
  • Liquidity provider address (if applicable)
• Details
  • Name
  • Symbol
  • Decimals
• Request details

[anna-carroll]

Message Status

How to determine the status of a message within the Optics system

• Dispatched — Dispatch event on Home - get messageHash and committedRoot
• Updated on Home — Update event on Home with oldRoot = comittedRoot
• Update on Replica — Update event on Home with oldRoot = comittedRoot
  • pending timeout — query confirmAt on Replica for newRoot
  • Timeout finished — query confirmAt on Replica for newRoot
• Proven — query messages on Replica to get MessageStatus (1 = Proven)
• Processed — Process event on Replica for messageHash (success = false if call reverted)

Related: #579 (comment)

[anna-carroll]

Misc. thoughts

• determine the standard for registering and referring to different chains within the system - a meta-Optics provider where you can register multiple chains' providers to connect to multiple chains

[anna-carroll]

Message type in library

• messageHash
• message (body of message)
• committedRoot (previous committed root at the time the message was dispatched)
• messageStatus within Optics
• includedRoot (new root for the update in which the message was included)
• confirmAt (time at which the message can be processed

[anna-carroll]

Have tracked all of this work in issues within Multi-Provider epic
#815
#835
#827
#828
#832
#834