Merge pull request #368 from KomodoPlatform/add/swap-events

Author: gcharang

filepathSlugs.json

@@ -2148,8 +2148,12 @@
     "taker-payment-wait-for-spend-failed",
     "maker-payment-spend-failed",
     "maker-payment-spent",
+    "maker-payment-spend-confirmed",
+    "maker-payment-spend-confirm-failed",
+    "maker-payment-spent-by-watcher",
     "taker-payment-wait-refund-started",
     "taker-payment-refund-started",
+    "taker-payment-refunded-by-watcher",
     "taker-payment-refund-failed",
     "taker-payment-refunded",
     "taker-payment-refund-finished",

src/pages/komodo-defi-framework/api/common_structures/swaps/maker_events/index.mdx

@@ -3,9 +3,11 @@ export const description = "A description of events and outcomes for each step o
 
 # Maker Swap Events
 
-<DevComment>
-  Needs update for watchtower events
-</DevComment>
+The atomic swap process goes through a series of steps to perform and confirm transactions, then release funds accordingly. If a swap fails, the taker payment will be returned to the taker's address (minus network transaction fees). Sometimes failed swaps were due to a taker or maker going offline in the middle of a swap, so `Swap Watcher` seednodes were created to process certain events on behalf of the maker/taker.
+
+Swap watchers act to complete a swap or refund if one or both sides go offline for too long. This is done in a non-custodial manner, and funds are still governed by HTLC which can only be released to either the maker or the taker's address, and only after specific conditions are met, such as completion on the side that is online and/or a timeout.
+
+Takers send all the necessary information to watch the swap on taker/maker chains together with two signed transactions to watchers: one to spend the maker payment (maker payment spend) and the other to refund the taker payment (taker payment refund). If the maker proceeds with the swap and spends the taker payment (and therefore exposes the secret), and the taker doesn't respond for a duration, the watcher sends the maker payment spend transaction to the chain on behalf of the taker (after appending the secret to the redeem script). If the taker sends the taker payment but the maker doesn't spend it, and the taker doesn't send the refund transaction for a duration, then the watchers complete the process by sending the taker payment refund transaction to the chain.
 
 ## Maker Success Events
 

src/pages/komodo-defi-framework/api/common_structures/swaps/taker_events/index.mdx

@@ -55,6 +55,7 @@ Below is a table of the currently available legacy, v2.0 and v2.0 (Dev) methods:
 | [get\_relay\_mesh](/komodo-defi-framework/api/legacy/get_relay_mesh/#get-relay-mesh)                                            |                                                                                                                                    |                                                                                                                                   |
 |                                                                                                                                 | [get\_staking\_infos](/komodo-defi-framework/api/v20/get_staking_infos/#get-staking-infos)                                         |                                                                                                                                   |
 | [get\_trade\_fee](/komodo-defi-framework/api/legacy/get_trade_fee/#get-trade-fee)                                               |                                                                                                                                    |                                                                                                                                   |
+|                                                                                                                                 | [get\_wallet\_names](/komodo-defi-framework/api/v20/get_wallet_names/#get-wallet-names)                                            |                                                                                                                                   |
 | [import\_swaps](/komodo-defi-framework/api/legacy/import_swaps/#import-swaps)                                                   |                                                                                                                                    |                                                                                                                                   |
 | [kmd\_rewards\_info](/komodo-defi-framework/api/legacy/kmd_rewards_info/#kmd-rewards-info)                                      |                                                                                                                                    |                                                                                                                                   |
 |                                                                                                                                 |                                                                                                                                    | [lightning::nodes::add\_trusted\_node](/komodo-defi-framework/api/v20-dev/lightning/nodes/#add-trusted-node)                      |