v10.4.0

Release Notes - Counterparty Core v10.4.0 (2024-09-18)

This is a major release with numerous protocol upgrades that will dramatically increase the functionality of the Counterparty protocol as well as resolve some long-standing security issues, in addition to a number of bugfixes and quality-of-life improvements.

Upgrading

If you run a Counterparty node, be sure to upgrade your node as soon as possible. Your node must be upgraded by block 866,000, which should be mined around October 16th, 2024, approximately four weeks from today.

The upgrade procedure should be straightforward: the API remains backwards-compatible, and the node will not have to perform a reparse. There are, however, two notable changes in this release that will require attention:

1. It will no longer be possible to create a dispenser from an address that you don’t control. You will have to create the dispenser from the source address of the transaction, like all other Counterparty transactions.

2. It will no longer be possible to trigger dispensers using vanilla Bitcoin wallets. The create_send API call has been modified so that it will automatically turn any BTC send to a dispenser into a create_dispense transaction.

ChangeLog

Protocol Changes

• Require Dispenser to be Source Address
  • PR: #2141
  • Spec: https://docs.counterparty.io/docs/advanced/specifications/dispenser-must-be-created-by-source/
• Make Dispenses Normal Counterparty Transactions
  • PR: #2141
  • Spec: https://docs.counterparty.io/docs/advanced/specifications/enable-dispense-tx/
• Be Able to Lock Descriptions
  • PR: #2153
  • Spec: https://docs.counterparty.io/docs/advanced/specifications/lockable-issuance-descriptions/
• Fair Minting Protocol
  • PR: #2142
  • Spec: https://docs.counterparty.io/docs/advanced/specifications/fairminter/
• UTXO Support
  • PR: #2180
  • Spec: https://docs.counterparty.io/docs/advanced/specifications/utxo-support/
• Gas System
  • PR: #2180
  • Spec: https://docs.counterparty.io/docs/advanced/specifications/gas-system/
• Expire order matches then orders
  • PR: #1794
  • Issue: #1633
• Free Subassets
  • PR: #2194
  • Spec: https://docs.counterparty.io/docs/advanced/specifications/free-subassets/
• Subassets on Numeric Assets
  • PR: #2195
  • Spec: https://docs.counterparty.io/docs/advanced/specifications/allow-subassets-on-numerics/
• Fix minimum BTC amount in order contract

Bugfixes

• Fix adding new transactions in unit test fixtures (scenarios.py)
• Fix mempool parsing on testnet and regtest
• Fix get_dispensers_by_asset endpoint filtering by query parameter. Numeric statuses can now be used, e.g. status=0.
• Fix cursor type in API routes
• Fix ledger.get_last_db_index() (server is ready on BLOCK_PARSED not on NEW_BLOCK)
• Fix ledger.get_block(block_index) function
• Check that the previous block is present when a block is received with ZeroMQ
• Log API v1 responses

Codebase

• New test suite and github workflow with regtest network
• Delete mempool events older than 24 hours
• Use order caching only during catch-up

API

• Add return_only_data argument for composition routes
• Add an asset_events field to the issuances table. This field contains one or more of the following values ​​separated by spaces: creation, reissuance, reset, lock_quantity, lock_description, open_fairminter, close_fairminter, fairmint.
• Return only valid issuances
• Generate API blueprint from regtest node
• Run Dredd tests on regtest node
• Add the new following routes:
  • /v2/order_matches
  • /v2/bitcoin/getmempoolinfo

CLI

Credits

• Ouziel Slama
• Warren Puffett
• Adam Krellenstein