From 9ceb0607b2d827f998c4306dc9019a65af0c07a8 Mon Sep 17 00:00:00 2001 From: Minh Huy Tran Date: Thu, 2 Oct 2025 13:52:37 +1000 Subject: [PATCH 1/2] chore(doc): update README and CHANGELOG for v0.14.1 release Signed-off-by: Minh Huy Tran --- CHANGELOG.md | 15 +++++++++++++++ README.md | 29 +++++++++++++++++++---------- 2 files changed, 34 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 409d2cea..9d347efb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,21 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.14.1] Narvi - 2025-10-02 +Extended the testing framework with more robust tests for payment and virtual channels. +Added documentation for cross-chain backend integration and backend ID mapping. + + +### Added + +* Documentation section describing supported backends and their IDs. + +### Changed + +* Extended Perun testing framework with improved payment and virtual channel tests. [#423] + +[#423]: https://github.com/hyperledger-labs/go-perun/pull/423 + ## [0.14.0] Narvi - 2025-07-29 [:boom:] Added [Libp2p](https://libp2p.io/) wire for go-perun. This enables seamless and secure P2P connection between clients. diff --git a/README.md b/README.md index f37aa180..39778a82 100644 --- a/README.md +++ b/README.md @@ -70,16 +70,25 @@ The following features are planned for future releases: ### Backends -There are multiple **blockchain backends** available. A backend is automatically initialized when its top-level package `backend/` is imported. -- **Ethereum.** The Ethereum backend is available at [perun-eth-backend](https://github.com/perun-network/perun-eth-backend/). -- **Polkadot.** The Polkadot backend is available at [perun-polkadot-backend](https://github.com/perun-network/perun-polkadot-backend). -- **Cosmos.** The Cosmos backend is available at [perun-cosmwasm-backend](https://github.com/hyperledger-labs/perun-cosmwasm-backend). -- **Cardano.** The Cardano backend is available at [perun-cardano-backend](https://github.com/perun-network/perun-cardano-backend). -- **NERVOS.** The NERVOS backend is available at [perun-ckb-backend](https://github.com/perun-network/perun-ckb-backend). -- **Dfinity.** The Dfinity Internet Computer backend is available at [perun-icp-backend](https://github.com/perun-network/perun-icp-backend). -- **Stellar.** The Stellar backend is available at [perun-stellar-backend](https://github.com/perun-network/perun-stellar-backend). -- **Fabric.** The Hyperledger Fabric backend is available at [perun-fabric](https://github.com/perun-network/perun-fabric). -- **SimBackend.** The SimBackend represents an ideal blockchain backend (`backend/sim`) implementation that can be used for testing. + _go-perun_ supports multiple **blockchain backends**. A backend is automatically initialized when its top-level package `backend/` is imported. +| ID | Backend | Status | Repository | +| --- | ---------- | ----------------------- | ------------------------------------------------------------------------------------ | +| 0 | SimBackend | ๐Ÿงช Testing only | Built-in (`backend/sim`) โ€“ represents an ideal blockchain backend for simulation | +| 1 | Ethereum | โœ… Cross-chain supported | [perun-eth-backend](https://github.com/perun-network/perun-eth-backend/) | +| 2 | Stellar | โœ… Cross-chain supported | [perun-stellar-backend](https://github.com/perun-network/perun-stellar-backend) | +| 3 | Nervos | ๐Ÿ›  In development | [perun-ckb-backend](https://github.com/perun-network/perun-ckb-backend) | +| 4 | Polkadot | ๐Ÿ›  In development | [perun-polkadot-backend](https://github.com/perun-network/perun-polkadot-backend) | +| 5 | Dfinity | ๐Ÿ›  In development | [perun-icp-backend](https://github.com/perun-network/perun-icp-backend) | +| 6 | Solana | ๐Ÿ›  In development | [perun-solana-backend](https://github.com/perun-network/perun-solana-backend) | +| - | Cosmos | โŒ Not supported | [perun-cosmwasm-backend](https://github.com/hyperledger-labs/perun-cosmwasm-backend) | +| - | Cardano | โŒ Not supported | [perun-cardano-backend](https://github.com/perun-network/perun-cardano-backend) | +| - | Fabric | โŒ Not supported | [perun-fabric](https://github.com/perun-network/perun-fabric) | + +#### Legend +- โœ… **Cross-chain supported** โ€“ stable, production-ready backends. +- ๐Ÿ›  **In development / upgrade** โ€“ experimental or actively being updated. +- โŒ **Not cross-chain supported** โ€“ backend is chain-specific, not compatible for cross-chain mode. +- ๐Ÿงช **Testing only** โ€“ simulation backend, no real blockchain. **Logging and networking** capabilities can also be injected by the user. A default [logrus](https://github.com/sirupsen/logrus) implementation of the `log.Logger` interface can be set using `log/logrus.Set`. From f91bad2e99bf11df96eb8f2a01cdad54723728a8 Mon Sep 17 00:00:00 2001 From: Minh Huy Tran Date: Thu, 2 Oct 2025 20:26:04 +1000 Subject: [PATCH 2/2] doc(README): update backend map to better visualise development status Signed-off-by: Minh Huy Tran --- README.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 39778a82..7fbc8dca 100644 --- a/README.md +++ b/README.md @@ -70,25 +70,26 @@ The following features are planned for future releases: ### Backends - _go-perun_ supports multiple **blockchain backends**. A backend is automatically initialized when its top-level package `backend/` is imported. -| ID | Backend | Status | Repository | -| --- | ---------- | ----------------------- | ------------------------------------------------------------------------------------ | -| 0 | SimBackend | ๐Ÿงช Testing only | Built-in (`backend/sim`) โ€“ represents an ideal blockchain backend for simulation | -| 1 | Ethereum | โœ… Cross-chain supported | [perun-eth-backend](https://github.com/perun-network/perun-eth-backend/) | -| 2 | Stellar | โœ… Cross-chain supported | [perun-stellar-backend](https://github.com/perun-network/perun-stellar-backend) | -| 3 | Nervos | ๐Ÿ›  In development | [perun-ckb-backend](https://github.com/perun-network/perun-ckb-backend) | -| 4 | Polkadot | ๐Ÿ›  In development | [perun-polkadot-backend](https://github.com/perun-network/perun-polkadot-backend) | -| 5 | Dfinity | ๐Ÿ›  In development | [perun-icp-backend](https://github.com/perun-network/perun-icp-backend) | -| 6 | Solana | ๐Ÿ›  In development | [perun-solana-backend](https://github.com/perun-network/perun-solana-backend) | -| - | Cosmos | โŒ Not supported | [perun-cosmwasm-backend](https://github.com/hyperledger-labs/perun-cosmwasm-backend) | -| - | Cardano | โŒ Not supported | [perun-cardano-backend](https://github.com/perun-network/perun-cardano-backend) | -| - | Fabric | โŒ Not supported | [perun-fabric](https://github.com/perun-network/perun-fabric) | + _go-perun_ supports multiple **blockchain backends**. A backend is automatically initialized when its top-level package `backend/` is imported.#### Backend Map + +| ID | Backend | Payment Channel Status | Cross-Chain Status | Repository | +| --- | ---------- | ---------------------- | ------------------ | ------------------------------------------------------------------------------------ | +| 0 | SimBackend | ๐Ÿงช Testing only | ๐Ÿงช Testing only | Built-in (`backend/sim`) โ€“ represents an ideal blockchain backend for simulation | +| 1 | Ethereum | โœ… Supported | โœ… Supported | [perun-eth-backend](https://github.com/perun-network/perun-eth-backend/) | +| 2 | Stellar | โœ… Supported | โœ… Supported | [perun-stellar-backend](https://github.com/perun-network/perun-stellar-backend) | +| 3 | Nervos | โœ… Supported | ๐Ÿšง In development | [perun-ckb-backend](https://github.com/perun-network/perun-ckb-backend) | +| 4 | Polkadot | โœ… Supported | ๐Ÿšง In development | [perun-polkadot-backend](https://github.com/perun-network/perun-polkadot-backend) | +| 5 | Dfinity | โœ… Supported | ๐Ÿšง In development | [perun-icp-backend](https://github.com/perun-network/perun-icp-backend) | +| 6 | Solana | ๐Ÿšง In development | ๐Ÿšง In development | [perun-solana-backend](https://github.com/perun-network/perun-solana-backend) | +| - | Cosmos | โœ… Supported | ๐ŸŸก Single-chain | [perun-cosmwasm-backend](https://github.com/hyperledger-labs/perun-cosmwasm-backend) | +| - | Cardano | โœ… Supported | ๐ŸŸก Single-chain | [perun-cardano-backend](https://github.com/perun-network/perun-cardano-backend) | +| - | Fabric | โœ… Supported | ๐ŸŸก Single-chain | [perun-fabric](https://github.com/perun-network/perun-fabric) | #### Legend -- โœ… **Cross-chain supported** โ€“ stable, production-ready backends. -- ๐Ÿ›  **In development / upgrade** โ€“ experimental or actively being updated. -- โŒ **Not cross-chain supported** โ€“ backend is chain-specific, not compatible for cross-chain mode. -- ๐Ÿงช **Testing only** โ€“ simulation backend, no real blockchain. +- โœ… **Supported** โ€“ stable and available. +- ๐Ÿšง **In development** โ€“ actively worked on, not fully stable. +- ๐ŸŸก **Single-chain** โ€“ supports only local (non-cross-chain) payment/state channels. +- ๐Ÿงช **Testing only** โ€“ simulation backend, no real blockchain. **Logging and networking** capabilities can also be injected by the user. A default [logrus](https://github.com/sirupsen/logrus) implementation of the `log.Logger` interface can be set using `log/logrus.Set`.