Skip to content

Add Electrum support #196

Closed
Closed

Description

@tnull

We will add Electrum support.

Activity

  1. added this to the 0.4 milestone on Nov 15, 2023
  2. enigbe commented on Sep 28, 2024

    @enigbe
    Contributor

    Hi @tnull,
    I would like to work on this if no one is assigned to it.

    I have outlined a strategy to:

    1. Create a new type, i.e. ElectrumSyncClient
    2. Introduce a set_chain_source/set_tx_sync/set_electrum_client function on NodeBuilder to allow users customize their transaction filters, and default to the EsploraSyncClient in the absence of customization.
    3. Test with one or a few electrum servers. Here is a list of some I have read about and/or used. Given that I don't have extensive knowledge of their adoption in the industry, I would appreciate other suggestions from you to trim/expand the list.
  3. tnull commented on Sep 30, 2024

    @tnull
    CollaboratorAuthor

    Hi @tnull, I would like to work on this if no one is assigned to it.

    Ah, thanks for showing interest for this! So, this is still blocked on #358, and a follow-up refactoring our syncing logic I intend to open some time this week. After that it should be relatively easy to add Electrum support. Tbh. I might even try to just do it in a commit as part of that refactor PR, we'll see. Happy to have you pick it up though if it doesn't work out though.

    I have outlined a strategy to:

    1. Create a new type, i.e. ElectrumSyncClient
    2. Introduce a set_chain_source/set_tx_sync/set_electrum_client function on NodeBuilder to allow users customize their transaction filters, and default to the EsploraSyncClient in the absence of customization.
    3. Test with one or a few electrum servers. Here is a list of some I have read about and/or used. Given that I don't have extensive knowledge of their adoption in the industry, I would appreciate other suggestions from you to trim/expand the list.

    So 1. should already be done in LDK's lightning-transaction-sync (lightningdevkit/rust-lightning#2685), and 2. is part of the syncing (API) refactor mentioned above (at least I hope it will be as easy as I think it is :) ).

    Testing (i.e., 3.) sounds good and I'd be very curious to learn if we find any hiccups. I think so far the rust-electrum-client we're building on has been pretty conservative about adding protocol features that aren't widely supported by all server implementations, so I hope we should get good compatibility. But, it would be great to test if this indeed is the case.

  4. enigbe commented on Oct 1, 2024

    @enigbe
    Contributor

    I might even try to just do it in a commit as part of that refactor PR, we'll see. Happy to have you pick it up though if it doesn't work out though.

    If this is still up when you are done with refactoring the syncing logic, I would be happy to pick it up.

    So 1. should already be done in LDK's lightning-transaction-sync

    Yeah, I spent some time reading electrum and esplora modules to build an understanding of what's required. It looked like adding a concrete type like was done with EsploraSyncClient, and configuring, was all it would require, given that syncing is already implemented in lightning-transaction-sync.
    I would like to review this when it is ready as I build more understanding of the project.

    pub(crate) type ChainSource = EsploraSyncClient<Arc<FilesystemLogger>>;

    Testing (i.e., 3.) sounds good and I'd be very curious to learn if we find any hiccups. I think so far the rust-electrum-client we're building on has been pretty conservative about adding protocol features that aren't widely supported by all server implementations, so I hope we should get good compatibility. But, it would be great to test if this indeed is the case.

    Open to working on this when you are done.

  5. tnull commented on Oct 17, 2024

    @tnull
    CollaboratorAuthor

    This is slipping, but we will land all prerequisites in 0.4. So should do this soon, possibly as a fast-following 0.5.

  6. modified the milestones: 0.4, 0.5 on Oct 17, 2024
  7. tnull commented on Feb 12, 2025

    @tnull
    CollaboratorAuthor

    This will unfortunately slip to 0.6.

  8. modified the milestones: 0.5, 0.6 on Feb 12, 2025
  9. modified the milestones: 0.6, 0.5 on Mar 17, 2025
  10. tnull commented on Mar 17, 2025

    @tnull
    CollaboratorAuthor

    As the release was delayed for a bit anyways, I figured it wouldn't hurt to squeeze in yet another feature. So opened #486 still targeting the 0.5 milestone, hence unslipping this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions