Skip to content

Releases: ElementsProject/peerswap

v5.0.0

14 Jul 20:59
@YusukeShimizu YusukeShimizu
v5.0.0
8f67039
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v5.0.0 Latest
Latest

Major Updates

Protocol Version Upgrade

  • The protocol version has been upgraded to v5.
  • Important: As before, swaps are only supported between peers running the same protocol version. Make sure all peers upgrade to v5 to maintain compatibility.

Premium Feature

  • A Premium feature has been added to allow more flexible handling of fees and pricing structures for swaps (PR #264, #371).
  • Note: This feature is still in the testing phase and may be refined in future releases.

Other Fixes

  • Migrated Protocol Buffers to Buf

    • Replaced the traditional protoc workflow with Buf to unify and automate linting and formatting.
    • This provides consistent formatting and a more efficient workflow, though contributors need to learn the new toolchain.

  • Documented Minimum Version for elementsd

    • PR #345 clarifies the minimum required version of Elements when running a local Elements node.
    • Ensure your elementsd version meets or exceeds this requirement.

  • Dependency Updates

    • Multiple libraries, including LND (v0.18.0-beta.rc3), have been updated (PR #297).
    • nixpkgs and flake dependencies have also been refreshed to improve maintainability.

  • Fix for amount_msat Exceeding Cases

    • Addresses scenarios where swap amounts could inadvertently exceed set limits (PR #356).

  • Added acceptdiscountctIsEnabled Check

    • A new step checks for acceptdiscountctIsEnabled during setup, helping to avoid misconfiguration (PR #348).

  • Minor Improvements

    • Updates to triggers and devcontainer configurations (e.g., PR #357).
    • Cleanup of code comments and removal of unused files (e.g., PR #360) to enhance readability and stability.

Notes

  1. Active Swaps: As with previous releases, ensure you have no active swaps before upgrading.
  2. Upgrade Procedure: Refer to the Upgrade Guide for detailed instructions.
  3. LWK Beta Status: LWK support remains in beta; please report any issues or feedback to improve its reliability.

Release Status

Most PeerSwap features are stable; however, newly added components like LWK and the Premium feature remain in early or beta stages. Feedback is highly encouraged to further enhance upcoming releases.

Special thanks

Special thanks to @yuyaogawa for Premium Feature specification review a while ago.

What's Changed

New Contributors

Full Changelog: v3.99...v5.0.0

Contributors

YusukeShimizu, grubles, and 13 other contributors
Assets 2
Loading

v5.0.0-rc2

13 May 01:29
@YusukeShimizu YusukeShimizu
v5.0.0-rc2
9569580
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v5.0.0-rc2

Major Updates

Protocol Version Upgrade

  • The protocol version has been upgraded to v5.
  • Important: As before, swaps are only supported between peers running the same protocol version. Make sure all peers upgrade to v5 to maintain compatibility.

Premium Feature

  • A Premium feature has been added to allow more flexible handling of fees and pricing structures for swaps (PR #264, #371).
  • Note: This feature is still in the testing phase and may be refined in future releases.

Other Fixes

  • Migrated Protocol Buffers to Buf

    • Replaced the traditional protoc workflow with Buf to unify and automate linting and formatting.
    • This provides consistent formatting and a more efficient workflow, though contributors need to learn the new toolchain.

  • Documented Minimum Version for elementsd

    • PR #345 clarifies the minimum required version of Elements when running a local Elements node.
    • Ensure your elementsd version meets or exceeds this requirement.

  • Dependency Updates

    • Multiple libraries, including LND (v0.18.0-beta.rc3), have been updated (PR #297).
    • nixpkgs and flake dependencies have also been refreshed to improve maintainability.

  • Fix for amount_msat Exceeding Cases

    • Addresses scenarios where swap amounts could inadvertently exceed set limits (PR #356).

  • Added acceptdiscountctIsEnabled Check

    • A new step checks for acceptdiscountctIsEnabled during setup, helping to avoid misconfiguration (PR #348).

  • Minor Improvements

    • Updates to triggers and devcontainer configurations (e.g., PR #357).
    • Cleanup of code comments and removal of unused files (e.g., PR #360) to enhance readability and stability.

Notes

  1. Active Swaps: As with previous releases, ensure you have no active swaps before upgrading.
  2. Upgrade Procedure: Refer to the Upgrade Guide for detailed instructions.
  3. LWK Beta Status: LWK support remains in beta; please report any issues or feedback to improve its reliability.

Release Status

Most PeerSwap features are stable; however, newly added components like LWK and the Premium feature remain in early or beta stages. Feedback is highly encouraged to further enhance upcoming releases.

What's Changed

New Contributors

Full Changelog: v5.0.0-rc...v5.0.0-rc2

Contributors

YusukeShimizu, Impa10r, and 3 other contributors
Loading

v5.0.0-rc

29 Apr 03:59
@YusukeShimizu YusukeShimizu
v5.0.0-rc
d99ec96
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v5.0.0-rc

Major Updates

Protocol Version Upgrade

  • The protocol version has been upgraded to v5.
  • Important: As before, swaps are only supported between peers running the same protocol version. Make sure all peers upgrade to v5 to maintain compatibility.

Premium Feature

  • A Premium feature has been added to allow more flexible handling of fees and pricing structures for swaps (PR #264, #371).
  • Note: This feature is still in the testing phase and may be refined in future releases.

Other Fixes

  • Migrated Protocol Buffers to Buf

    • Replaced the traditional protoc workflow with Buf to unify and automate linting and formatting.
    • This provides consistent formatting and a more efficient workflow, though contributors need to learn the new toolchain.

  • Documented Minimum Version for elementsd

    • PR #345 clarifies the minimum required version of Elements when running a local Elements node.
    • Ensure your elementsd version meets or exceeds this requirement.

  • Dependency Updates

    • Multiple libraries, including LND (v0.18.0-beta.rc3), have been updated (PR #297).
    • nixpkgs and flake dependencies have also been refreshed to improve maintainability.

  • Fix for amount_msat Exceeding Cases

    • Addresses scenarios where swap amounts could inadvertently exceed set limits (PR #356).

  • Added acceptdiscountctIsEnabled Check

    • A new step checks for acceptdiscountctIsEnabled during setup, helping to avoid misconfiguration (PR #348).

  • Minor Improvements

    • Updates to triggers and devcontainer configurations (e.g., PR #357).
    • Cleanup of code comments and removal of unused files (e.g., PR #360) to enhance readability and stability.

Notes

  1. Active Swaps: As with previous releases, ensure you have no active swaps before upgrading.
  2. Upgrade Procedure: Refer to the Upgrade Guide for detailed instructions.
  3. LWK Beta Status: LWK support remains in beta; please report any issues or feedback to improve its reliability.

Release Status

Most PeerSwap features are stable; however, newly added components like LWK and the Premium feature remain in early or beta stages. Feedback is highly encouraged to further enhance upcoming releases.

What's Changed

New Contributors

Full Changelog: v4.0rc1...v5.0.0rc

Contributors

YusukeShimizu, Impa10r, and 3 other contributors
Loading

v4.0rc1

04 Dec 08:16
@YusukeShimizu YusukeShimizu
v4.0rc1
4a17a06
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v4.0rc1

Key Updates

1. Protocol Version Upgrade

  • The protocol version has been upgraded to v4.
  • Important: Swaps are now exclusively supported between peers using the same protocol version. To maintain compatibility, all peers must update to v4.

2. LBTC Swap Support via LWK

  • Added support for LBTC swaps through lwk, removing the dependency on elementsd.
  • This update reduces memory requirements for deploying Peerswap by approximately 3–4 GB, making it more lightweight and efficient.

Pros

  • Lightweight: Minimal RAM and storage space needed.
  • Ease of Setup: Simplifies deployment by eliminating the need for a full Elements node.

Cons

  • Beta Software: LWK is currently in beta, which may result in reduced stability or reliability compared to elementsd.
  • Outsourced Verification: Utilizes third-party services for blockchain verification instead of self-verification.
  • Shared Public Service: By default, connects to a public service shared with other users, potentially impacting performance.

3. Confidential Transaction Discounts

  • Implemented support for confidential transaction discounts, significantly lowering costs associated with LBTC swaps.

4. Stability Improvements

  • This release includes various fixes and optimizations aimed at improving stability and reliability.

Note

Please refer to the upgrade procedure guide for detailed instructions on upgrading safely.
It is especially important to ensure you have no active swaps before upgrading. Following this procedure will help prevent potential issues during the transition.

Release Status

While most aspects of PeerSwap are considered stable, support for LWK remains experimental/beta in this release(v4.0rc1).
Users exploring LWK as a backend option are encouraged to report any issues or provide feedback to aid in refining future releases.

Changelog

For a comprehensive list of changes and improvements, please refer to the detailed changelog below.

Read more

Contributors

wtogami, delta1, and 9 other contributors
Loading

Practice run for protocol upgrades (version 3)

15 Oct 19:19
@wtogami wtogami
v0.2.97
d1d88e4
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
Practice run for protocol upgrades (version 3)

PeerSwap for the past 9 months remained compatible. This version doesn't yet introduce any protocol breaking changes but we use this opportunity to bump the protocol version as a practice run for future protocol upgrades.

Loading