Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Future CLN API deprecations can negatively affect PeerSwap #232

Open
grubles opened this issue Aug 31, 2023 · 2 comments
Open

Future CLN API deprecations can negatively affect PeerSwap #232

grubles opened this issue Aug 31, 2023 · 2 comments
Labels
deprecated cln api Related to CLN API deprecations

Comments

@grubles
Copy link
Collaborator

grubles commented Aug 31, 2023

This describes a broader issue with how PeerSwap handles changes to the CLN API. CLN defaults to keeping the deprecated fields turned on for a period of time before they are fully removed in order to minimize disruptions / breakage. However, some users may turn off these fields by setting allow-deprecated-apis=false in their CLN configs. This may cause PeerSwap to break

Currently the plan is to try and detect if deprecated API fields are turned off by reading the CLN config (#230) and exiting the plugin completely to be safe, but this is only a temporary solution until we can handle API changes better.

@grubles
Copy link
Collaborator Author

grubles commented Aug 31, 2023

Would adding a separate CLN instance with allow-deprecated-apis=false to the CI help to check for breakage?

@grubles grubles added the deprecated cln api Related to CLN API deprecations label Aug 31, 2023
@YusukeShimizu
Copy link
Contributor

YusukeShimizu commented Oct 3, 2024

I think the solution is to set allow-deprecated-apis=false in the integration test and fix the cases where it doesn't work properly.

Additionally, looking towards the future, the ideal scenario would be for the API interface to be automatically generated and capable of detecting updates.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated cln api Related to CLN API deprecations
Projects
None yet
Development

No branches or pull requests

2 participants