make lwk available - #288
Merged
Merged
Conversation
YusukeShimizu
force-pushed
the
lwk-swap
branch
8 times, most recently
from
March 29, 2024 07:51
8603558 to
37f5bcd
Compare
remove blockwatcher.go and associated block height functions The blockwatcher.go file and its associated functions for tracking block height changes have been removed. block height tracking is no longer necessary and has been replaced by a different mechanism.
YusukeShimizu
force-pushed
the
lwk-swap
branch
3 times, most recently
from
May 1, 2024 00:47
02832df to
e7513c6
Compare
`CreateFundedTransaction` and `FinalizeFundedTransaction` have merged interfaces, CreateAndBroadcastTransaction. This is because there was originally no reason to separate them, and because lwk uses the psbt format, transacrion conversion needs to be performed. The liquid wallet interface should not have a unique liquid wallet-dependent definition. However, there were some that depended on gelements, so they were separated out.
lwkclient is a library for interacting directly with lwk server via json rpc. LWKRpcWallet acts as an onchain wallet for peerswap It uses lwk and electrs. - Implement API structure with request handling, including retry logic and response body draining. - Provide configuration options for HTTP client with retry logic - Utilize JSON-RPC 2.0 for request and response handling. - Ensure proper error handling and logging. - Create lwkclient with methods for address generation, sending transactions, signing, broadcasting, balance querying, and wallet details retrieval. - Implement LWKRpcWallet with necessary wallet operations - Ensure wallet setup and transaction creation/broadcasting - Add utility functions for balance retrieval and fee estimation.
tx watcher is a function that monitors onchain status and notifies opening tx and closing tx. Introduce ElectrumRPC interface and electrumTxWatcher for Electrum-based transaction watching. Also, add generated mock for electrumRPC interface. Mock generation is performed by go.uber.org/mock/mockgen.
Input can be in toml or ini format, but each is managed as the same config. To make it loosely coupled, used the builder pattern to set item. I also add validation of the config. The config file cannot be modified from the outside.
YusukeShimizu
force-pushed
the
lwk-swap
branch
2 times, most recently
from
May 2, 2024 06:08
48f67fd to
e7769ed
Compare
RCasatta
reviewed
May 3, 2024
Comment on lines
+19
to
+31
| # lwk: init at 0.3.0 #292522 | ||
| # https://github.com/NixOS/nixpkgs/pull/292522/commits/2b3750792b2e4b52f472b6e6d88a6b02b6536c43 | ||
| rev2 = "2b3750792b2e4b52f472b6e6d88a6b02b6536c43"; | ||
| nixpkgs2 = fetchNixpkgs rev2; | ||
| pkgs2 = import nixpkgs2 {}; | ||
| # blockstream-electrs: init at 0.4.1 #299761 | ||
| # https://github.com/NixOS/nixpkgs/pull/299761/commits/680d27ad847801af781e0a99e4b87ed73965c69a | ||
| rev3 = "680d27ad847801af781e0a99e4b87ed73965c69a"; | ||
| nixpkgs3 = fetchNixpkgs rev3; | ||
| pkgs3 = import nixpkgs3 {}; | ||
| blockstream-electrs = pkgs3.blockstream-electrs.overrideAttrs (oldAttrs: { | ||
| cargoBuildFlags = [ "--features liquid" "--bin electrs" ]; | ||
| }); |
There was a problem hiding this comment.
There are also nix flakes for lwk and blockstream-electrs, I am curious to know if it was unknown or if it's preferred to avoid flakes
Contributor
Author
There was a problem hiding this comment.
Thank you for confirming this.
I know that flake exists and I'm not trying to avoid installing it.
I don't know enough about nix but would it be better to add binLiquid to the package and use it for peerswap devShell?
I created draft PR of this.
I also seem to get build errors.
I think it should be fixed.
nix run .#blockstream-electrs-liquid -- --network liquid
error: builder for '/nix/store/nkkv9v3r310p5gp09zv3hmn29y63mia3-electrs-deps-0.4.1.drv' failed with exit code 101;
last 25 log lines:
> Checking futures-channel v0.3.30
> Checking which v4.4.2
> Compiling bitcoind v0.34.1
> Checking rand v0.4.6
> Checking rustc-demangle v0.1.23
> Checking iana-time-zone v0.1.60
> Checking unicode-width v0.1.11
> Checking tower-service v0.3.2
> Checking winapi v0.2.8
> Checking option-ext v0.2.0
> Compiling bitcoin_hashes v0.10.0
> Checking base64-compat v1.0.0
> Checking dirs-sys v0.4.1
> Checking hyper v0.14.28
> Checking bitcoincore-rpc-json v0.18.0
> Compiling elementsd v0.9.1
> error[E0425]: cannot find function `download_filename` in this scope
> --> /nix/store/n1a9vx4rppg99v909c7hw2jc5d1yj7f2-vendor-cargo-deps/c19b7c6f923b580ac259164a89f2577984ad5ab09ee9d583b888f934adbbe8d0/elementsd-0.9.1/build.rs:59:33
> |
> 59 | let download_filename = download_filename();
> | ^^^^^^^^^^^^^^^^^ not found in this scope
>
> For more information about this error, try `rustc --explain E0425`.
> error: could not compile `elementsd` (build script) due to previous error
> warning: build failed, waiting for other jobs to finish...
For full logs, run 'nix-store -l /nix/store/nkkv9v3r310p5gp09zv3hmn29y63mia3-electrs-deps-0.4.1.drv'.
error: 1 dependencies of derivation '/nix/store/qpdjg9rmj3b9w33l50gmg4jdl8671738-electrs-0.4.1.drv' failed to buildThere was a problem hiding this comment.
Which commit are you using?
current new-index branch seems fine to me
$ git log | head -n 1
commit efc1fec8b0f96b5663d7257a0c2cffd8ef143219
$ nix run .#blockstream-electrs-liquid -- --network liquid
Config { log: StdErrLog { verbosity: Error, quiet: false, show_level: true, timestamp: Off, modules: [], writer: "stderr", color_choice: Auto, show_module_names: false }, network_type: Liquid, db_path: "./db/liquid", daemon_dir: "/home/casatta/.bitcoin/liquidv1", blocks_dir: "/home/casatta/.bitcoin/liquidv1/blocks", daemon_rpc_addr: 127.0.0.1:7041, cookie: None, electrum_rpc_addr: 127.0.0.1:51000, http_addr: 127.0.0.1:3000, http_socket_file: None, monitoring_addr: 127.0.0.1:34224, jsonrpc_import: false, light_mode: false, address_search: false, index_unspendables: false, cors: None, precache_scripts: None, utxos_limit: 500, electrum_txs_limit: 500, electrum_banner: "Welcome to electrs-esplora 0.4.1", electrum_rpc_logging: None, parent_network: Bitcoin, asset_db_path: None }
Contributor
Author
There was a problem hiding this comment.
I'm using the same commit.
There seems to be an error in my environment.
$ git log | head -n 1
commit efc1fec8b0f96b5663d7257a0c2cffd8ef143219
$ nix run .#blockstream-electrs-liquid -- --network liquid
error: builder for '/nix/store/nkkv9v3r310p5gp09zv3hmn29y63mia3-electrs-deps-0.4.1.drv' failed with exit code 101;
last 25 log lines:
> Checking rand v0.4.6
> Checking tower-service v0.3.2
> Checking option-ext v0.2.0
> Checking winapi v0.2.8
> Checking rustc-demangle v0.1.23
> Checking unicode-width v0.1.11
> Compiling bitcoin_hashes v0.10.0
> Checking iana-time-zone v0.1.60
> Checking bitcoincore-rpc-json v0.18.0
> Checking base64-compat v1.0.0
> Checking chrono v0.4.34
> Checking textwrap v0.11.0
> Checking rand v0.3.23
> Checking hyper v0.14.28
> Checking dirs-sys v0.4.1
> Compiling elementsd v0.9.1
> error[E0425]: cannot find function `download_filename` in this scope
> --> /nix/store/n1a9vx4rppg99v909c7hw2jc5d1yj7f2-vendor-cargo-deps/c19b7c6f923b580ac259164a89f2577984ad5ab09ee9d583b888f934adbbe8d0/elementsd-0.9.1/build.rs:59:33
> |
> 59 | let download_filename = download_filename();
> | ^^^^^^^^^^^^^^^^^ not found in this scope
>
> For more information about this error, try `rustc --explain E0425`.
> error: could not compile `elementsd` (build script) due to previous error
> warning: build failed, waiting for other jobs to finish...
For full logs, run 'nix log /nix/store/nkkv9v3r310p5gp09zv3hmn29y63mia3-electrs-deps-0.4.1.drv'.
error: 1 dependencies of derivation '/nix/store/qpdjg9rmj3b9w33l50gmg4jdl8671738-electrs-0.4.1.drv' failed to buildThere was a problem hiding this comment.
can you try a nix flake update before nix run I am thinking to update the flake.lock anyway...
Contributor
Author
There was a problem hiding this comment.
Hmmm, doesn't seem to solve the problem.
$ nix flake update
warning: updating lock file '/workspaces/electrs/flake.lock':
• Updated input 'crane':
'github:ipetkov/crane/a329cd00398379c62e76fc3b8d4ec2934260d636?narHash=sha256-iZDHWTqQj6z6ccqTSEOPOxQ8KMFAemInUObN2R9vHSs%3D' (2024-03-28)
→ 'github:ipetkov/crane/442a7a6152f49b907e73206dc8e1f46a61e8e873?narHash=sha256-uXNW6bapWFfkYIkK1EagydSrFMqycOYEDSq75GmUpjk%3D' (2024-05-04)
• Updated input 'nixpkgs':
'github:NixOS/nixpkgs/2726f127c15a4cc9810843b96cad73c7eb39e443?narHash=sha256-UKcYiHWHQynzj6CN/vTcix4yd1eCu1uFdsuarupdCQQ%3D' (2024-03-27)
→ 'github:NixOS/nixpkgs/b211b392b8486ee79df6cdfb1157ad2133427a29?narHash=sha256-CLU5Tsg24Ke4%2B7sH8azHWXKd0CFd4mhLWfhYgUiDBpQ%3D' (2024-05-07)
• Updated input 'rust-overlay':
'github:oxalica/rust-overlay/aa858717377db2ed8ffd2d44147d907baee656e5?narHash=sha256-oD4OJ3TRmVrbAuKZWxElRCyCagNCDuhfw2exBmNOy48%3D' (2024-03-28)
→ 'github:oxalica/rust-overlay/a8bfc2569a1965c0da8711d289d973f0011b441a?narHash=sha256-oujsCgNiQnZoQntNkkNkA7BhCmUvf9FLWj%2B2oGT2Jvc%3D' (2024-05-08)
warning: Git tree '/workspaces/electrs' is dirty
$ nix run .#blockstream-electrs-liquid -- --network liquid
warning: Git tree '/workspaces/electrs' is dirty
error: builder for '/nix/store/rcd2hcxdnb6v23c7mjjm33wqjbasdrvr-electrs-deps-0.4.1.drv' failed with exit code 101;
last 25 log lines:
> Compiling bitcoin_hashes v0.12.0
> Checking object v0.32.2
> Checking futures-channel v0.3.30
> Checking which v4.4.2
> Compiling bitcoind v0.34.1
> Checking rand v0.4.6
> Checking iana-time-zone v0.1.60
> Checking tower-service v0.3.2
> Checking rustc-demangle v0.1.23
> Checking unicode-width v0.1.11
> Compiling bitcoin_hashes v0.10.0
> Checking bitcoincore-rpc-json v0.18.0
> Checking option-ext v0.2.0
> Checking winapi v0.2.8
> Compiling elementsd v0.9.1
> error[E0425]: cannot find function `download_filename` in this scope
> --> /nix/store/cjjfa06qzk9wahmbqjh7kn86bsmaq3dv-vendor-cargo-deps/c19b7c6f923b580ac259164a89f2577984ad5ab09ee9d583b888f934adbbe8d0/elementsd-0.9.1/build.rs:59:33
> |
> 59 | let download_filename = download_filename();
> | ^^^^^^^^^^^^^^^^^ not found in this scope
>
> For more information about this error, try `rustc --explain E0425`.
> Checking dirs-sys v0.4.1
> error: could not compile `elementsd` (build script) due to previous error
> warning: build failed, waiting for other jobs to finish...
For full logs, run 'nix log /nix/store/rcd2hcxdnb6v23c7mjjm33wqjbasdrvr-electrs-deps-0.4.1.drv'.
error: 1 dependencies of derivation '/nix/store/z7wa0ixizb5xq32dfs8s0fv23yds4lcl-electrs-0.4.1.drv' failed to build
The integration test for LWK is added to ensure that the swap functionality works as expected with the LWK and electrs support. The setup functions are implemented to create the necessary test environment, including lwk, Bitcoin and Liquid nodes, as well as two lightning nodes with the PeerSwap. This setup is crucial for testing the swap-in process in an environment that closely mimics production. also, added Electrs and LWK structs for testing framework. - Implement `Electrs` struct to manage electrs daemon processes - Implement `LWK` struct to manage LWK daemon processes - Provide constructors for both structs to initialize with dynamic ports and configurations - Include methods to run the processes and connect
Contributor
|
CLN as swap-out sender seems to be unable to get the starting block height from LWK? Using CLN 24.02.2 and LWK 0.3.0 |
YusukeShimizu
force-pushed
the
lwk-swap
branch
4 times, most recently
from
May 9, 2024 07:39
44c7d05 to
a448d46
Compare
Contributor
|
CLN PeerSwap still allows me to start a swap-out with the LWK backend shut down. To reproduce, shut down the running LWK server while CLN is running before attempting a swap-out. Then try the swap-out. The swap will eventually become stuck at this point: Even when LWK is restarted, CLN PeerSwap isn't able to recover after about 30 seconds have passed: |
YusukeShimizu
force-pushed
the
lwk-swap
branch
2 times, most recently
from
June 12, 2024 22:27
a3d1b07 to
692383e
Compare
add a plugin hook in the case of core lightning and an interceptor in the case of lnd, and pre-install a dead/alive monitor for each daemon.
This way, it prevents many automated clients from attacking the server at the same time. For example, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89 and 97 are good numbers.
Contributor
Author
|
I have confirmed that the following in my environment: aa9550b bin/clncli peerswap-swap-out $CLNSHORTCHANID 1000000 lbtc
{
"message": "liquid_unavailable",
"code": -1
}The log details are as follows: peerswap-playground-cln1-1 | 2024-06-12T23:30:14.737Z DEBUG lightningd: Calling rpc_command hook of plugin peerswap
peerswap-playground-cln1-1 | 2024-06-12T23:30:14.742Z INFO plugin-peerswap: trying to send command peerswap-swap-out, but failed to connect: Post \"http://elementsd:8332/wallet/peerswap\": dial tcp: lookup elementsd on 127.0.0.11:53: no such host
peerswap-playground-cln1-1 | 2024-06-12T23:30:14.742Z DEBUG lightningd: Plugin peerswap returned from rpc_command hook call
./bin/pscli peerswap1 listswaps
2024/06/12 23:41:13 rpc error: code = Unknown desc = liquid backend not reachable: lwk connection failed: failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
Recovery of swaps occurs only when the plugin is restarted. For reconnection to electrs, I have set a prime number interval (37 seconds). |
Contributor
Peerswap now doesn't try a swap-out if LWK server is shutdown, but I'm not seeing that specific error message: Strangely, when I go to shutdown CLN v24.05, the |
Contributor
Author
|
This is not expected behavior. |
This change causes the liquid daemon to be monitored for dead or alive at the start of the swapout execution. Previously, at the start of a swapout, it would succeed even if the liquid daemon was not running, If a subsequent process required the liquid daemon, an error would occur. In addition, cross-checking by interceptors and hooks has been discontinued. This is because hooks by glightning are unstable and currently only swapout needs to be monitored for life and death.
Contributor
Author
|
Could not reproduce.
It seems to be a bug related to the glightning plugin hook, but the cause has not been identified.
|
YusukeShimizu
force-pushed
the
lwk-swap
branch
3 times, most recently
from
June 18, 2024 03:04
fd00a84 to
96c4f37
Compare
add tests for backend down scenarios in LWK. Add tests to handle scenarios where the backend services (LWK and Electrs) are down during swaps.
Contributor
Author
|
Summarise the problems that have occurred when the backend is down and the measures taken to deal with them. hung in
|
Contributor
Author
|
After the start of swapout; log2024-06-26 09:22:00 2024/06/26 00:22:00 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnSwapOutStarted on
2024-06-26 09:22:00 2024/06/26 00:22:00 [INFO] [Swap:87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef] Start new swap-out: peer: 03457dabca72cdf096e7f27cd78673796306c21fc684d25f0ae714a87009ca9750 chanId: 116:1:1 initiator: 03b70410f1fc0b37fea10a92df8179b66362f8ac9cbb3058e8b69d897a5311caf0 amount 1000000
2024-06-26 09:22:00 2024/06/26 00:22:00 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_ActionSucceeded on State_SwapOutSender_CreateSwap
2024-06-26 09:22:00 2024/06/26 00:22:00 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_ActionSucceeded on State_SwapOutSender_SendRequest
2024-06-26 09:22:00 2024/06/26 00:22:00 [DEBUG] [Messenger] From: 03457dabca72cdf096e7f27cd78673796306c21fc684d25f0ae714a87009ca9750 got msgtype: a45b for swap: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef
2024-06-26 09:22:00 2024/06/26 00:22:00 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnFeeInvoiceReceived on State_SwapOutSender_AwaitAgreement
2024-06-26 09:22:00 2024/06/26 00:22:00 [DEBUG] Using minimum fee rate of 0.1 sat/kw
2024-06-26 09:22:00 2024/06/26 00:22:00 [DEBUG] PayInvoiceViaChannel: payment still in flight
2024-06-26 09:22:01 2024/06/26 00:22:01 [DEBUG] PayInvoiceViaChannel: payment still in flight
2024-06-26 09:22:02 2024/06/26 00:22:02 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_ActionSucceeded on State_SwapOutSender_PayFeeInvoice
2024-06-26 09:22:02 2024/06/26 00:22:02 [INFO] [Swap:87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef] Paid Feeinvoice of 300 sats
2024-06-26 09:22:02 2024/06/26 00:22:02 [DEBUG] [Messenger] From: 03457dabca72cdf096e7f27cd78673796306c21fc684d25f0ae714a87009ca9750 got msgtype: a45d for swap: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef
2024-06-26 09:22:02 2024/06/26 00:22:02 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnTxOpenedMessage on State_SwapOutSender_AwaitTxBroadcastedMessage
2024-06-26 09:22:02 2024/06/26 00:22:02 [DEBUG] Await confirmation for tx with id: bc68c580af45fad42f77d5451d96d64449a698dafce07c309e5fafc6fc2eb97b on swap 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef
2024-06-26 09:22:10 2024/06/26 00:22:10 [DEBUG] [Messenger] From: 03457dabca72cdf096e7f27cd78673796306c21fc684d25f0ae714a87009ca9750 got same message for swap: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef
2024-06-26 09:22:10 2024/06/26 00:22:10 [INFO] [MsgListener]: Handler failed: Message already exists
2024-06-26 09:22:15 2024/06/26 00:22:15 [DEBUG] New block received. block height:18
2024-06-26 09:22:15 2024/06/26 00:22:15 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnTxConfirmed on State_SwapOutSender_AwaitTxConfirmation
2024-06-26 09:22:20 2024/06/26 00:22:20 [DEBUG] [Messenger] From: 03457dabca72cdf096e7f27cd78673796306c21fc684d25f0ae714a87009ca9750 got same message for swap: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef
2024-06-26 09:22:25 2024/06/26 00:22:25 [DEBUG] PayInvoiceViaChannel: payment still in flight
2024-06-26 09:22:26 2024/06/26 00:22:26 [DEBUG] PayInvoiceViaChannel: payment still in flight
2024-06-26 09:22:27 2024/06/26 00:22:27 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_ActionSucceeded on State_SwapOutSender_ValidateTxAndPayClaimInvoice
2024-06-26 09:22:29 2024/06/26 00:22:29 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:22:30 2024/06/26 00:22:30 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:22:31 2024/06/26 00:22:31 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:22:32 2024/06/26 00:22:32 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:22:33 2024/06/26 00:22:33 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:22:36 2024/06/26 00:22:36 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:22:38 2024/06/26 00:22:38 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:22:48 2024/06/26 00:22:48 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:22:49 2024/06/26 00:22:49 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:23:08 2024/06/26 00:23:08 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:23:10 2024/06/26 00:23:10 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:23:11 2024/06/26 00:23:11 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:23:13 2024/06/26 00:23:13 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:23:24 2024/06/26 00:23:24 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:23:26 2024/06/26 00:23:26 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:23:27 2024/06/26 00:23:27 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:23:29 2024/06/26 00:23:29 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:23:35 2024/06/26 00:23:35 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:23:37 2024/06/26 00:23:37 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:23:55 2024/06/26 00:23:55 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:23:57 2024/06/26 00:23:57 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:24:06 2024/06/26 00:24:06 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:24:07 2024/06/26 00:24:07 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:24:18 2024/06/26 00:24:18 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:24:19 2024/06/26 00:24:19 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:24:27 2024/06/26 00:24:27 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:24:29 2024/06/26 00:24:29 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:24:46 2024/06/26 00:24:46 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:24:47 2024/06/26 00:24:47 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:24:48 2024/06/26 00:24:48 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:24:49 2024/06/26 00:24:49 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:25:05 2024/06/26 00:25:05 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:25:07 2024/06/26 00:25:07 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:25:18 2024/06/26 00:25:18 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:25:19 2024/06/26 00:25:19 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:25:29 2024/06/26 00:25:29 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:25:31 2024/06/26 00:25:31 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:25:47 2024/06/26 00:25:47 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:25:48 2024/06/26 00:25:48 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:25:51 2024/06/26 00:25:51 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnRetry on State_SwapOutSender_ClaimSwap
2024-06-26 09:25:54 2024/06/26 00:25:54 [INFO] Error claiming tx with preimage failed to call api request: POST http://lwk:32113 giving up after 2 attempt(s): Post "http://lwk:32113": dial tcp: lookup lwk: no such host
2024-06-26 09:26:09 2024/06/26 00:26:09 [INFO] [MsgListener]: Handler failed: Message already exists
2024-06-26 09:32:00 2024/06/26 00:32:00 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_OnTimeout on State_SwapOutSender_ClaimSwap
2024-06-26 09:32:00 2024/06/26 00:32:00 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_ActionSucceeded on State_SwapOutSender_SendPrivkey
2024-06-26 09:32:00 2024/06/26 00:32:00 [DEBUG] [FSM] event:id: 87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef, Event_ActionSucceeded on State_SwapOutSender_SendCoopClose
2024-06-26 09:32:00 2024/06/26 00:32:00 [INFO] [Swap:87a67002b3ef6f5a3de545b80df36ea5b5db61d0e1ec1e99e8e12919a368c4ef] Swap claimed cooperativelyAlso, confirm that the number of groutine occurrences is normal in the debug run. |
Contributor
|
Tested both CLN and LND as swap-out sender. Can confirm the swap now ends up as claimed coop after ~10 minutes with LWK down, instead of getting stuck. |
ensure client is properly reinitialized before subscribing to headers to prevent potential stale connections.
The Event_OnRetry is designed to execute 20 retries and stop the process if it still fails. This patch adds the missing Event_OnTimeout transition to transit to coop close if the lwk is not restarted.
nepet
reviewed
Jun 27, 2024
nepet
left a comment
nepet
left a comment
Member
There was a problem hiding this comment.
Nice work @YusukeShimizu! That was a heavy lift. I really like your interface refinements and the way you seamlessly integrate lwk into the rest of the repo. I wish the rest of the repo would be as clean as the lwk package ^^.
I may have an explanation as to why the liveleyness test using the rpc_command hook resulted in unexpected behaviour, crashing other plugins: The hook will be called on EVERY rpc call globally, regardless the method or the namespace. So if peerswap as a plugin is still active but the connection to gbitcoin or elements is already lost, this results in returning an error on EVERY rpc call made (inter process as well) which may crash other plugins that come after peerswap in the shutdown sequence. A possible fix would have been to only act on methods that are of peerswaps namespace.
I have some minor nits about naming of units - kvB and vB mixups and would suggest to revisit the fee unit conversion unit-test as it seems to be off.
Besides that the PR seemes good to go for me to test it out in the wild.
The version of lwk has been raised to cli_0.5.1. Change to use flake to use cli_0.5.1 in nix as well. Using flake allows you to run nix develop instead of nix-shell. Just uses the flake on nix shell. For the nix-env addon users.
Variable and function names have been corrected to eliminate confusion with fee calculations. Test cases have also been refactored.
implement SetLabel method to call walletSetTxMemo for setting transaction memos.
Contributor
Author
|
Thank you for your review.
|
Member
|
Looks good to me! |
Contributor
|
Tested ACK 66fead0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
lbtc swap with lwk
Description
Previously, lbtc swap required running elementsd, but now it can be done with lwk.
Because elementsd requires a lot of resources, making it available in lwk will allow more users to perform swaps.
setup
see docs/setup_lwk.md.
Specification
lwk and esplora-electrs connection is required.
New json rpc api client is implemented for connection to lwk.
Connection to esplora-electrs using go-electrum.
esplora-electrs is also used by lwk as a blockchain.
Configuration
The user can choose to use lwk instead of elements for lbtc swap.
It has the following configuration items.
The user can choose to set up a wallet that holds the signer.
Default uses the same default endpoint (blockstream.info:995) as lwk, but the user can choose his own electrum for
ElementsEndpoint.wallet
Peerswap's onchain wallet provide the following features.
GetAddress() (string, error)
This method is used to get the address of the wallet.
Use lwk
address.SendToAddress(string, uint64) (string, error)
This method is used to send money to a specific address.
lwk
sendto create a psbt,signto sign it, andbroadcastto broadcast it.CreateAndBroadcastTransaction(swapParams *swap.OpeningParams, asset []byte) (txid, rawTx string, fee uint64, err error)
This method is used to create and broadcast opening tx.
The interface has been split into the following two interfaces,
but they will be merged into a single interface for lwk support.
Existing bitcoin wallets will also be changed, but functionality will remain the same.
SendRawTx(rawTx string) (txid string, err error)
This method is used to broadcast the closing tx.
This is done using electrum cient's
blockchain.transaction.broadcastmethod.GetFee(txSize int64) (uint64, error)
This method is used to get the fee
blockchain.estimatefee.tx watcher
tx watcher is a function that monitors onchain status and notifies opening tx and closing tx.
The following interface must be implemented.
So far, peerswap has used bitcoind/elementsd, but lwk uses the electrum client on which lwk depends.
AddWaitForConfirmationTx(swapId, txId string, vout, startingHeight uint32, scriptpubkey []byte)
Wait for a specific tx to be confirmed with a specific block height.
This function uses the electrum client
blockchain.scriptthash.get_history.AddWaitForCsvTx(swapId, txId string, vout uint32, startingHeight uint32, scriptpubkey []byte)
Wait for a specific tx to reach the csv limit at a specific block height.
This function uses the electrum client
blockchain.scriptthash.get_history.GetBlockHeight() (uint32, error)
Function to retrieve block height.
Use
blockchain.headers.subscribeof electrum client.StartWatchingTxs() error
Function to start tx watcher.
Periodically calls
blockchain.scripthash.get_historyof electrum client and executes callback when the condition is met.