CHANGELOG.md

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

Added

• Electron App has now a tray icon for macOS 🚀
• Split identity and wallet seed into two separate files.
• Wallet seeds created by ItchySats can now be imported and exported for the taker.

0.7.0 - 2022-09-30

Added

• Support for /itchysats/rollover/3.0.0. This fixes a bug where inverse payout curves where capped at double the value of the initial price.
• Support for /itchysats/collab-settlement/2.0.0. This fixes a bug where inverse payout curves where capped at double the value of the initial price.
• Support for /itchysats/order/2.0.0. This fixes a bug where inverse payout curves where capped at double the value of the initial price.
• Configurable peer id block list. Peer IDs can be added to blocked_peers.toml, stored in the data directory. The format is expected to be a simple TOML array of peer ID strings.

Changed

• Breaking change: with bdk>0.20 key derivations will take into account the network, i.e. for mainnet it uses m/84'/0'/0' and for testnet/regtest it uses m/84'/1'/0'. This was caused by bitcoindevkit/bdk#585. If you want to withdraw your testnet funds make sure to use the withdraw functionality prior upgrading to a different wallet or return them to the faucet. Existing mainnet wallets are not affected.
• Breaking change: Rename --umbrel-seed to --app-seed. Integration with Umbrel and other environments might be affected. This is unlikely to affect regular users, as this parameter is not used outside such environments.
• Breaking change: Specify the maker port of libp2p connection instead of legacy connection (only relevant if port was specified manually; port should be incremented by 1)
• Drop support for /itchysats/rollover/1.0.0.
• Deprecate /itchysats/rollover/2.0.0.
• Deprecate /itchysats/collab-settlement/1.0.0.
• Deprecate /itchysats/order/1.0.0.

Added

• Replaced basic-authentication with cookie-based authentication for taker-ui. The default password if no password is provided via the cli is weareallsatoshi. Once logged in, the user is requested to change the password.

0.6.1 - 2022-09-01

Fixed

• An issue in the taker UI where tooltips where not properly displayed.
• An issue where the taker logs were spammed with unnecessary error message on auto-rollover.
• An issue where metrics on connected peers where not reported correctly.

0.6.0 - 2022-08-31

Added

• Active support for the ETHUSD trading pair allowing users to open positions for both BTCUSD and ETHUSD
• New /itchysats/offer/2.0.0 protocol, which supports any contract symbol.
• New dynamic route for maker PUT /<contract_symbol>/offer/. This allows the creation of offers with <contract_symbol>.
• Introducing a new field lot_size for offer: Lot Size (in number of contracts) is the minimum trading unit of a contract. Order quantity need to be a multiple of this.

Changed

• Dropped support for all legacy network protocols.
• Deprecate the /itchysats/offer/1.0.0 protocol. The taker will no longer support this version protocol and the maker will run it until at least the next application version.

Fixed

• Prevent liquidation intervals from overlapping in qunato payout curves.
• Ensure that the short liquidation interval of inverse payout curves goes up to the maximum price Olivia can attest to.
• Do not monitor for mined-long-ago lock transactions after rolling over a CFD.

0.5.5 - 2022-08-17

Added

• Drop connection to peer if we get a yamux::ConnectionError when opening a substream to them. Dropping the connection should lead to a reconnect on the taker, which should fix problems where the taker has a broken connection to the maker for a long time.

Fixed

• Ensure that rollover data is saved to the database atomically. This fixes bugs related to accessing rollover data that is incomplete, either because the insertion hadn't finished yet or because part of the insertion had failed.

0.5.4 - 2022-08-05

Added

• Add dynamic liquidation to the DLC, enabling the CFD to be unilaterally closed every hour by either party if the oracle attests to a price close to the ends of the payout curve's domain.

Changed

• Replace intermediate confirmation step in rollover protocol for the maker with a configurable flag which can be updated during runtime using the new POST /rollover/config endpoint. On startup, rollovers are configured to be accepted by default.
• Introduce the /itchysats/order/1.0.0 protocol, running over libp2p. It is used to place an order and immediately set up the CFD on chain. It replaces the previous mechanism, which ran over a bespoke network stack.
• Introduce the /itchysats/id/1.0.0 protocol, running over libp2p. It allows a peer to share their contact details with others on request. It replaces a previous similar mechanism, which ran over a bespoke network stack.
• Breaking change: renamed trading_pair to contract_symbol in Http API.

0.5.3 - 2022-08-01

Changed

• Update xtra dependency to be able to ignore frequent trace spans added in 0.5.2

0.5.2 - 2022-07-26

Added

• Ignore frequent trace spans

0.5.1 - 2022-07-24

Changed

• made position_margin_satoshis and position_margin_counterparty_satoshis metric symbol and position dependent
• log important taker connection info on info
• downgrade "Could not parse daemon_version" log to debug to spam less

0.5.0 - 2022-07-21

Changed

• Update xtra to upstream. This involved re-implementing some of the features in comit-network's fork internally. Xtra message handler metrics were also removed in favour of the new instrumentation feature combined with Grafana Tempo's span metrics.
• Allow rollovers from previous versions for takers to make the rollover protocol more resilient against the maker being ahead and avoid consecutive rollover failure.

Removed

• The initial tour through ItchySats. The underlying library caused issues that could not be overcome.

Added

• Add new argument to the maker: ignore-migration-errors. If enabled, the maker will start if an error occurred when opening the database, if not, it will fail fast. This can come handy to prevent accidentally creating a new empty database in case database migration was unsuccessful.
• New metrics: the maker tracks how many offers have been sent (offer_messages_sent_total) and the taker tracks how many offers have been received (offer_messages_received_total).
• Allow taker to provide extended private key as argument when starting. This key will be used to derive the internal wallet according to (Bip84)[https://github.com/bitcoin/bips/blob/master/bip-0084.mediawiki].
• Support for tokio console for debugging. It can be activated with --tokio-console.
• Show the daemon-version in the info box of the taker-ui.
• Add support for instrumented traces for debugging. It can be activated with --instrumented.

Fixed

• An issue where electrum-client caused high CPU load.
• An issue where the pings were triggered too frequently and caused congestion in the endpoint.

0.4.21 - 2022-06-27

Added

• Allow maker to provide extended private key as argument when starting. This key will be used to derive the internal wallet according to (Bip84)[https://github.com/bitcoin/bips/blob/master/bip-0084.mediawiki]
• Added new HTTP endpoint to manually trigger a wallet sync under /api/sync
• Added manual wallet sync button to the UI to allow the user to trigger a manual sync
• Added new endpoint to maker and taker to get the daemon version under /api/version
• Added an info box in taker-ui to show if a new version is available

Changed

• Migrate away from JSON blobs in the DB to a more normalized database for RolloverCompleted events
• Use sled database for wallet. The wallet file is stored in your data-dir as either maker-wallet for the maker and taker-wallet for the taker respectively
• Rollover using the libp2p connection
• Improve the rollover protocol for resilience. Allow rollovers from a previous commit-txid and record a snapshot of the complete fee after each rollover
• Collaborative settlement using the libp2p connection
• Improve the collaborative settlement protocol for resilience. Exchange signatures to allow the taker to publish the collaborative settlement transaction at the end of the protocol.

Fixed

• An issue where the stored revoke commit adaptor signature was not stored correctly. We now correctly pick the adaptor signature from the previous Dlc.

0.4.20 - 2022-05-26

0.4.19 - 2022-05-25

Added

• A QR code for the ItchySats wallet that can be scanned to retrieve the current address.
• ITCHYSATS_ENV variable that defines different environment of running ItchySats (Umbrel, RaspiBlitz, Docker, Binary)

Changed

• The API for retrieving offers now returns leverage_details which is a set of leverages including pre-computed values for margin, liquidation price and initial funding fee.
• Taker can choose a leverage provided the maker offers a selection of leverage.
• Rollback that a second connection of a taker would steal the old connection
• The rollover protocol is handled over the libp2p connection. The maker supports both legacy and libp2p requests for rolling over.

Fixed

• An issue where the maker's libp2p ping actor panicked upon startup.
• An issue where fees were not handled correctly in maia that could result in invalid transactions.

0.4.17 - 2022-05-23

• Culling old DLC data from database, i.e. we remove old DLC data which is not needed anymore. This reduces the db size and is more efficient when loading

0.4.16 - 2022-05-13

Changed

• Taker only re-establishes connection to maker after three minutes.
• Automatically time out xtra handlers after 2 minutes.

0.4.15 - 2022-05-12

Changed

• Taker UI: Layout fixes and move the taker-id into a separate modal.

Fixed

• An issue where the payout and P/L for closed positions was returned incorrectly (based on the current price).
• An issue where the position metrics recorded an error for CFDs with a weird combinations of events.
• An issue where a CET for a liquidated position could not be published because a Txout with a value of 0.

0.4.14 - 2022-05-10

Added

• Additional API for the taker: api/metrics will return prometheus-based metrics about your positions and about general behavior of the application

0.4.13 - 2022-05-10

Added

• Maker only: Add new metric under {maker_url}/api/metrics which shows the quantity of total positions
• Maker only: Add new metric under {maker_url}/api/metrics which shows the number of total positions
• Taker UI: Add initial onboarding tour that steps the taker through the user interface and ends in the wallet.
• Taker UI: Add link to the FAQ (frequently asked questions) documentation.
• Taker UI: Add Feedback-fish that allows users to submit feedback through a form.
• API changes: maker and taker HTTP Api changed to let the taker chose between multiple leverages
  • maker: /api/offer: has an additional field leverage_choices: Vec<Leverage>
  • taker: /api/cfd/order: has an additional field leverage: Leverage, i.e. the leverage selected by the taker
  • both: /api/feed/long_offer && /api/feed/short_ofer: instead of a single leverage it now returns a list of leverages (leverage_choices)
  • network: an additional field leverage was added to wire::MakerToTaker::TakeOffer.
  • network: an additional field leverage_choices was added to Order which is sent from maker to taker when he created a new offer. The field leverage was deprecated.

Changed

• Taker UI: Navigation improvements to more easily find the wallet.
• Taker binary: Automatically open the user interface in the default browser upon startup (includes credentials).
• Move failed CFDs (CFDs that were either rejected or the contract setup failed) into a separate table.

0.4.12 - 2022-04-26

Changed

• Allow to run the taker binary without parameters: Default the bitcoin-network subcommand to mainnet and apply defaults for the mainnet and testnet maker.
• Change the finality confirmations for spend transactions to 3 confirmations instead of 1.
• Move Closed CFDs to a separate database table freeing up space. This is a performance improvement for the startup of the application. Note that the database file will not change in size, but the space will be re-used internally.
• Performance improvements with adding cache and optimized loading for different actors.
• Add link to the internal wallet when there is not enough balance to open a new position.
• Improve wire log messages for better context for connection logs.

Fixed

• An issue where CET finality was not monitored if we restarted the daemon before the CET was confirmed. This was fixed by adding CET monitoring to the restart behaviour of the monitor actor.
• An issue where the taker daemon lost connection to the maker because the maker did not send heartbeats due to the maker's connection actor being blocked. This was fixed by removing all blocking calls from the connection actors in both taker and maker which should result in a more stable connection handling overall.
• An issue where the commit_tx URL was not displayed for a force close scenario.

0.4.11 - 2022-04-04

Changed

• Return a 500 Internal Server Error for /api/cfds whilst doing the initial load from the database. Previously, an empty list was returned, making clients think the database is empty. PR 1717

Fixed

• Severe performance issues caused by redundant re-creation of aggregates. Aggregates will now be cached and only new events will be applied. This makes anything database related much more performant. PR 1722

0.4.10 - 2022-03-28

• Add a banner celebrating us pitching at Bitcoin 2022 conference in Miami.

0.4.9 - 2022-03-28

0.4.8 - 2022-03-24

0.4.7 - 2022-02-28

0.4.6 - 2022-02-23

[0.4.3] - 2022-02-14

• Fix a potential deadlock in taker after losing connection to a maker by introducing timeouts for reading and writing to TCP socket.

0.4.2 - 2022-02-08

0.4.1 - 2022-02-04

0.4.0 - 2022-01-31

Added

• Off-chain perpetual CFD rollover. Hourly, the taker sends a rollover request to the maker for each open position. The maker can accept or reject a rollover proposal. Upon acceptance the taker and maker collaboratively agree on an oracle price event further in the future and generate new payout transactions accordingly. The previous payout transactions are invalidated. The new payout transactions spend from the same lock transaction, so the rollover happens off-chain. In case a maker rejects a rollover request from a taker the old oracle price event and payout transactions stay in place.
• Basic authentication for the web interface of the taker binary. A password is now required to access the web interface. If not set via --password, one will be derived from the seed file and displayed in the start-up logs.

Changed

• Username for HTTP authentication to itchysats.

0.3.6 - 2022-01-05

Backport of #1016.

0.3.5 - 2021-12-30

Backport of #987.

0.3.4 - 2021-12-30

Added

• Proposed settlement price in case of an incoming settlement proposal.

0.3.3 - 2021-12-29

Backport of #982.

Backport of #972.

Backport of #977.

Backport of #971.

0.3.2 - 2021-12-21

Backport #927 in an attempt to fix #759.

0.3.1 - 2021-12-20

Backport #924 in an attempt to fix #759.

0.3.0 - 2021-12-09

Initial release for mainnet.