Skip to content

Latest commit

 

History

History
285 lines (226 loc) · 9.8 KB

CHANGELOG.md

File metadata and controls

285 lines (226 loc) · 9.8 KB

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.

Table of Contents

[1.1.18] - 2025-01-28

Changed

  • Added support for BEEF v2 and AtomicBEEF
  • Update golang.org/x/crypto from v0.21.0 to v0.31.0
  • Update README to highlight examples and improve documentation
  • Update golangci-lint configuration to handle mixed receiver types
  • update issue templates
  • Improved test coverage

[1.1.17] - 2024-12-24

Added

  • ScriptNumber type

[1.1.16] - 2024-12-01

Added

  • ArcBroadcaster Status

[1.1.15] - 2024-11-26

Changed

  • ensure BUMP ordering in BEEF
  • Fix arc broadcaster to handle script failures
  • support new headers in arc broadcaster

[1.1.14] - 2024-11-01

Changed

  • Update examples and documentation to reflect tx.Sign using script templates

[1.1.13] - 2024-11-01

Changed

  • Broadcaster examples

Added

  • WOC Broadcaster
  • TAAL Broadcaster
  • Tests for woc, taal, and arc broadcasters

[1.1.12] - 2024-10-31

Fixed

  • fix spv.Verify() to work with source output (separate fix from 1.1.11)

[1.1.11] - 2024-10-23

Fixed

  • fix spv.Verify() to work with source output

[1.1.10] - 2024-10-20

Big thanks for contributions from @wregulski

Changed

  • pubKey.ToDER() now returns bytes
  • pubKey.ToHash() is now pubKey.Hash()
  • pubKey.SerializeCompressed() is now pubKey.Compressed()
  • pubKey.SerializeUncompressed() is now pubKey.Uncompressed()
  • pubKey.SerializeHybrid() is now pubKey.Hybrid()
  • updated merklepath.go to use new helper functions from transaction.merkletreeparent.go

Added

  • files spv/verify.go, spv/verify_test.go - chain tracker for whatsonchain.com
    • spv.Verify() ensures transaction scripts, merkle paths and fees are valid
    • spv.VerifyScripts() ensures transaction scripts are valid
  • file docs/examples/verify_transaction/verify_transaction.go
  • publickey.ToDERHex() returns a hex encoded public key
  • script.Chunks() helper method for DecodeScript(scriptBytes)
  • script.PubKey() returns a *ec.PublicKey
  • script.PubKeyHex() returns a hex string
  • script.Address() and script.Addresses() helpers
  • file transaction.merkletreeparent.go which contains helper functions
    • transaction.MerkleTreeParentStr()
    • transaction.MerkleTreeParentBytes()
    • transaction.MerkleTreeParents()
  • file transaction/chaintracker/whatsonchain.go, whatsonchain_test.go - chain tracker for whatsonchain.com
    • chaintracker.NewWhatsOnChain chaintracker

[1.1.9] - 2024-10-01

Changed

  • Updated readme
  • Improved test coverage
  • Update golangci-lint version in sonar workflow

[1.1.8] - 2024-09-17

Changed

  • Restore Transaction Clone to its previous state, and add ShallowClone as a more efficient alternative
  • Fix the version number bytes in message
  • Rename merkleproof.ToHex() to Hex()
  • Update golangci-lint version and rules

Added

  • transaction.ShallowClone
  • transaction.Hex

[1.1.7] - 2024-09-10

  • Rework tx.Clone() to be more efficient
  • Introduce SignUnsigned to sign only inputs that have not already been signed
  • Added tests
  • Other minor performance improvements.

Added

  • New method Transaction.SignUnsigned()

Changed

  • Transaction.Clone() does not reconstitute the source transaction from bytes. Creates a new transaction.

[1.1.6] - 2024-09-09

  • Optimize handling of source transaction inputs. Avoid mocking up entire transaction when adding source inputs.
  • Minor alignment in ECIES helper function

Added

  • New method TransactionInput.SourceTxOutput()

Changed

  • SetSourceTxFromOutput changed to be SetSourceTxOutput
  • Default behavior of EncryptSingle uses ephemeral key. Updated test.

[1.1.5] - 2024-09-06

  • Add test for ephemeral private key in electrum encrypt ecies
  • Add support for compression for backward compatibility and alignment with ts

Added

  • NewAddressFromPublicKeyWithCompression, to script/address.go and SignMessageWithCompression to bsm/sign.go
  • Additional tests

[1.1.4] - 2024-09-05

  • Update ECIES implementation to align with the typescript library

Added

  • primitives/aescbc directory
    • AESCBCEncrypt, AESCBCDecrypt, PKCS7Padd, PKCS7Unpad
  • compat/ecies
    • EncryptSingle, DecryptSingle, EncryptShared and DecryptShared convenience functions that deal with strings, uses Electrum ECIES and typical defaults
    • ElectrumEncrypt, ElectrumDecrypt, BitcoreEncrypt, BitcoreDecrypt
  • docs/examples
    • ecies_shared, ecies_single, ecies_electrum_binary
  • Tests for different ECIES encryption implementations

Removed

  • Previous ecies implementation
  • Outdated ecies example
  • encryption.go for vanilla AES encryption (to align with typescript library)

Changed

  • Renamed message example to encrypt_message for clarity
  • Change vanilla aes example to use existing encrypt/decrypt functions from aesgcm directory

[1.1.3] - 2024-09-04

  • Add shamir key splitting
  • Added PublicKey.ToHash() - sha256 hash, then ripemd160 of the public key (matching ts implementation)`
  • Added new KeyShares and polynomial primitives, and polynomial operations to support key splitting
  • Tests for all new keyshare, private key, and polynomial operations
  • added recommended vscode plugin and extension settings for this repo in .vscode directory
  • handle base58 decode errors
  • additional tests for script/address.go

Added

  • PrivateKey.ToKeyShares
  • PrivateKey.ToPolynomial
  • PrivateKey.ToBackupShares
  • PrivateKeyFromKeyShares
  • PrivateKeyFromBackupShares
  • PublicKey.ToHash()
  • New tests for the new PrivateKey methods
  • new primitive keyshares
  • NewKeyShares returns a new KeyShares struct
  • NewKeySharesFromBackupFormat
  • KeyShares.ToBackupFormat
  • polonomial.go and tests for core functionality used by KeyShares and PrivateKey
  • util.Umod in util package big.go
  • util.NewRandomBigInt in util package big.go

Changed

  • base58.Decode now returns an error in the case of invalid characters

[1.1.2] - 2024-09-02

  • Fix OP_BIN2NUM to copy bytes and prevent stack corruption & add corresponding test

Changed

  • opcodeBin2num now copies value before minimally encoding

[1.1.1] - 2024-08-28

  • Fix OP_RETURN data & add corresponding test
  • update release instructions

Added

  • add additional test transaction
  • add additional script tests, fix test code

Changed

  • opcodeReturn now includes any parsedOp.Data present after OP_RETURN
  • Changed RELEASE.md instructions

[1.1.0] - 2024-08-19

  • porting in all optimizations by Teranode team to their active go-bt fork
  • introducing chainhash to remove type coercion on tx hashes through the project
  • remove ByteStringLE (replaced by chainhash)
  • update opRshift and opLshift modeled after C code in node software and tested against failing vectors
  • add tests and vectors for txs using opRshift that were previously failing to verify
  • update examples
  • lint - change international spellings to match codebase standards, use require instead of assert, etc
  • add additional test vectors from known failing transactions

Added

  • MerkePath.ComputeRootHex
  • MerklePath.VerifyHex

Changed

  • SourceTXID on TransactionInput is now a ChainHash instead of []byte
  • IsValidRootForHeight on ChainTracker now takes a ChainHash instead of []byte
  • MerklePath.ComputeRoot now takes a ChainHash instead of a hex string.
  • MerklePath.Verify now takes a ChainHash instead of hex string.
  • Transaction.TxID now returns a ChainHash instead of a hex string
  • Transaction.PreviousOutHash was renamed to SourceOutHash, and returns a ChainHash instead of []byte
  • The TxID field of the UTXO struct in the transaction package is now a ChainHash instead of []byte
  • Renamed TransactionInput.SetPrevTxFromOutput to SetSourceTxFromOutput

Removed

  • TransactionInput.PreviousTxIDStr
  • Transaction.TxIDBytes
  • UTXO.TxIDStr in favor of UTXO.TxID.String()

Fixed

  • opcodeRShift and opcodeLShift was fixed to match node logic and properly execute scripts using OP_RSHIFT and OP_LSHIFT.

[1.0.0] - 2024-06-06

Added

  • Initial release

Template for New Releases:

Replace X.X.X with the new version number and YYYY-MM-DD with the release date:

## [X.X.X] - YYYY-MM-DD

### Added
- 

### Changed
- 

### Deprecated
- 

### Removed
- 

### Fixed
- 

### Security
-

Use this template as the starting point for each new version. Always update the "Unreleased" section with changes as they're implemented, and then move them under the new version header when that version is released.