Skip to content

Latest commit

 

History

History
107 lines (89 loc) · 4.52 KB

CHANGELOG.md

File metadata and controls

107 lines (89 loc) · 4.52 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.3.0 Charon - 2020-05-29 ⚠️

Added persistence module to persist channel state data and handle client shutdowns/restarts, as well as disconnects/reconnects.

Added

  • Persistence:
    • Persister, Restorer, ChannelIterator interfaces to allow for multiple persistence implementations.
      • sortedkv implementation provided (in-memory and LevelDB).
    • States and signatures are constantly persisted while channels progress.
    • Clients restore all saved channels on startup. State is synchronized with peers.
    • Client.OnNewChannel callback registration to deal with restored channels.
  • Wallet interface for account unlocking abstraction.
    • Used during persistence to restore secret keys for signing.
    • Implemented for the Ethereum and simulated backend.
  • Peer disconnect/reconnect handling.
  • Channel.UpdateBy functional channel update method for better usability.

Changed

  • License changed to Apache 2.0.
  • Replaced Channel.ListenUpdates and Client.HandleChannelProposals with Client.Handle(ProposalHandler, UpdateHandler) - a single common handler routine per client.
  • Adapted client to new persistence layer and wallet.
  • Made Ethereum interactions idempotent (increased safety).
  • Moved subpackage db to pkg/sortedkv.
  • Swapped Balance dimensions of type channel.Allocation.
  • Random type generators in package channel/test now accept options to customize random data generation.
  • Channels now get automatically closed when peers disconnect (and restored on reconnect).

Fixed

  • Ethereum backend: No funding transactions for zero own initial channel balances.

0.2.0 Belinda - 2020-03-23 ⚠️

Added direct disputes and watcher for two-party ledger channels, much polishing (refactors, bug fixes, documentation).

Added

  • Ledger state channel disputes and watcher.
  • channel.Adjudicator interface and Ethereum implementation for registering channel states and withdrawing concluded channels.
  • Ethereum contracts for disputes
  • Public Github wiki
  • Godoc
  • Changelog
  • TravisCI
  • goreportcard
  • codeclimate
  • TCP and unix socket peer.Dialer and Listener implementations.
  • Eventually tester in pkg/test to repeatedly run tests until they succeed.
  • Concurrent testing tool in pkg/test to be able to call require in tests with multiple go routines.

Changed

  • client.New now needs a Funder and Adjudicator, instead of a Settler.
  • Serializable renamed to Serializer.
  • Unified backend imports.
  • pkg/io/test/bytewiseReader to iotest.OneByteReader.
  • Improved peer message handling mechanism.
  • Consistent handling of nil arguments in exported functions.
  • Many refactors to improve the overall code quality and documentation.
  • Updated Ethereum contract bindings to newest version.

Removed

  • wallet.Wallet interface and sim backend implementation - it was never used.
  • ethereum and sim/wallet.NewAddressFromBytes - only wallet.DecodeAddress should be used to create an Address from bytes.
  • channel/machine Phase subscription logic.
  • channel.Settler interface and backend implementations - replaced by Adjudicator.

Fixed

  • Reduced cyclomatic complexity of complex functions.
  • Deadlock in two-party payment channel test.
  • Ethereum backend test timeouts and instabilities.
  • Many minor bug fixes, mainly concurrency issues in tests.

0.1.0 Ariel - 2019-12-20 ⚠️

Initial release.

Added

  • Two-party ledger state channels.
  • Cooperatively settling two-party ledger channels.
  • Ethereum blockchain backend.
  • Logrus logging backend.

Legend

  • ⚠️: This release is not suited for practical use with real money.