doc, ui: Add sequence diagrams

basicswap/basicswap.py

@@ -2865,14 +2865,14 @@ class BasicSwap(BaseApp):
 
                     if TxTypes.XMR_SWAP_A_LOCK_REFUND_SPEND not in bid.txns:
                         try:
-                            txid = ci_from.publishTx(xmr_swap.a_lock_refund_spend_tx)
+                            txid_str = ci_from.publishTx(xmr_swap.a_lock_refund_spend_tx)
                             self.logBidEvent(bid.bid_id, EventLogTypes.LOCK_TX_A_REFUND_SPEND_TX_PUBLISHED, '', session)
 
-                            self.log.info('Submitted coin a lock refund spend tx for bid {}, txid {}'.format(bid_id.hex(), txid.hex()))
+                            self.log.info('Submitted coin a lock refund spend tx for bid {}, txid {}'.format(bid_id.hex(), txid_str))
                             bid.txns[TxTypes.XMR_SWAP_A_LOCK_REFUND_SPEND] = SwapTx(
                                 bid_id=bid_id,
                                 tx_type=TxTypes.XMR_SWAP_A_LOCK_REFUND_SPEND,
-                                txid=bytes.fromhex(txid),
+                                txid=bytes.fromhex(txid_str),
                             )
                             self.saveBidInSession(bid_id, bid, session, xmr_swap)
                             session.commit()

basicswap/http_server.py

@@ -639,6 +639,8 @@ class HttpHandler(BaseHTTPRequestHandler):
 
         messages = []
         show_txns = False
+        show_offerer_seq_diagram = False
+        show_bidder_seq_diagram = False
         show_lock_transfers = False
         edit_bid = False
         view_tx_ind = None
@@ -658,6 +660,10 @@ class HttpHandler(BaseHTTPRequestHandler):
                     messages.append('Accept failed ' + str(ex))
             elif b'show_txns' in form_data:
                 show_txns = True
+            elif b'show_offerer_seq_diagram' in form_data:
+                show_offerer_seq_diagram = True
+            elif b'show_bidder_seq_diagram' in form_data:
+                show_bidder_seq_diagram = True
             elif b'edit_bid' in form_data:
                 edit_bid = True
             elif b'edit_bid_submit' in form_data:
@@ -686,6 +692,9 @@ class HttpHandler(BaseHTTPRequestHandler):
         if bid.debug_ind is not None and bid.debug_ind > 0:
             messages.append('Debug flag set: {}, {}'.format(bid.debug_ind, DebugTypes(bid.debug_ind).name))
 
+        data['show_bidder_seq_diagram'] = show_bidder_seq_diagram
+        data['show_offerer_seq_diagram'] = show_offerer_seq_diagram
+
         old_states = []
         num_states = len(bid.states) // 12
         for i in range(num_states):
@@ -988,6 +997,10 @@ class HttpHandler(BaseHTTPRequestHandler):
                     self.putHeaders(status_code, 'text/css')
                     with open(os.path.join(static_path, 'style.css'), 'rb') as fp:
                         return fp.read()
+                elif len(url_split) > 3 and url_split[2] == 'sequence_diagrams':
+                    self.putHeaders(status_code, 'image/svg+xml')
+                    with open(os.path.join(static_path, 'sequence_diagrams', url_split[3]), 'rb') as fp:
+                        return fp.read()
                 else:
                     self.putHeaders(status_code, 'text/html')
                     return self.page_404(url_split)

basicswap/templates/bid.html

@@ -77,9 +77,29 @@
 {% endif %}
 <input name="edit_bid" type="submit" value="Edit Bid">
 {% endif %}
+<br/>
+{% if data.show_bidder_seq_diagram %}
+<input name="hide_bidder_seq_diagram" type="submit" value="Hide Bidder Sequence Diagram">
+{% else %}
+<input name="show_bidder_seq_diagram" type="submit" value="Show Bidder Sequence Diagram">
+{% endif %}
+{% if data.show_offerer_seq_diagram %}
+<input name="hide_offerer_seq_diagram" type="submit" value="Hide Offerer Sequence Diagram">
+{% else %}
+<input name="show_offerer_seq_diagram" type="submit" value="Show Offerer Sequence Diagram">
+{% endif %}
 <input type="hidden" name="formid" value="{{ form_id }}">
 </form>
 
+{% if data.show_bidder_seq_diagram %}
+<img src="/static/sequence_diagrams/bidder.alt.xu.min.svg" />
+{% endif %}
+
+{% if data.show_offerer_seq_diagram %}
+<img src="/static/sequence_diagrams/offerer.alt.xu.min.svg" />
+{% endif %}
+
+
 
 <h4>Old States</h4>
 <table>

basicswap/templates/bid_xmr.html

@@ -74,6 +74,17 @@
 {% endif %}
 <input name="edit_bid" type="submit" value="Edit Bid">
 {% endif %}
+<br/>
+{% if data.show_bidder_seq_diagram %}
+<input name="hide_bidder_seq_diagram" type="submit" value="Hide Bidder Sequence Diagram">
+{% else %}
+<input name="show_bidder_seq_diagram" type="submit" value="Show Bidder Sequence Diagram">
+{% endif %}
+{% if data.show_offerer_seq_diagram %}
+<input name="hide_offerer_seq_diagram" type="submit" value="Hide Offerer Sequence Diagram">
+{% else %}
+<input name="show_offerer_seq_diagram" type="submit" value="Show Offerer Sequence Diagram">
+{% endif %}
 <input type="hidden" name="formid" value="{{ form_id }}">
 
 {% if data.show_txns %}
@@ -119,6 +130,14 @@
 {% endif %}
 </form>
 
+{% if data.show_bidder_seq_diagram %}
+<img src="/static/sequence_diagrams/xmr.bidder.alt.xu.min.svg" />
+{% endif %}
+
+{% if data.show_offerer_seq_diagram %}
+<img src="/static/sequence_diagrams/xmr.offerer.alt.xu.min.svg" />
+{% endif %}
+
 {% if data.chain_a_lock_tx_inputs %}
 <h5>Chain A Lock TX Inputs:</h5>
 <table>