v3.1.0-next.0

Minor Changes

• #138 1a03d3f Thanks @github-actions! - Add support for debugging evaluations with loops

• #138 4043ae7 Thanks @github-actions! - Deprecate BCH_2022_05 VM, add BCH_2023_05, BCH_2025_05, and BCH_SPEC VMs, update vmb_tests

  Additionally, all exports have been renamed to more consistently adhere to the camelCase capitalization style, without exceptions for abbreviations. For example assembleBytecodeBCH is now assembleBytecodeBch. To ensure backwards-compatibility, aliases (marked with @deprecated TSdoc tags) are also exported using the old capitalization. These aliases will be removed in a future major version.

Patch Changes

• #138 1f34ca4 Thanks @github-actions! - Update isStandardOutputBytecode to allow P2SH32

  Fixes #133. Thanks for the report @rkalis!

• #138 d0d54b9 Thanks @github-actions! - Fix OP_TXVERSION VMB tests, reduce 2025 nonstandard hashing density limit

• #138 18e1614 Thanks @github-actions! - Add BCH_2026_05, add VM benchmarking

• #138 1a03d3f Thanks @github-actions! - Add support for BigInt CHIP

• #138 1a03d3f Thanks @github-actions! - Improve performance of all virtual machines

• #138 c0eadac Thanks @github-actions! - Run VMB benchmarks in CI

• #130 ade0151 Thanks @bitjson! - clarify generateDeterministicEntropy usage examples

• #138 1a03d3f Thanks @github-actions! - Add support for Schnorr multisig in BCH VMs

• #138 49bcce4 Thanks @github-actions! - Begin implementation of BCH_2025_05 and BCH_SPEC

  • Revised AuthenticationVirtualMachine to remove clone (obviated by wide availability of structuredClone) and add initialize, allowing VM proposals to add to the program state of an existing VM (in a type-safe way) without duplicating its unchanged logic.
  • Clarified documentation around contributing upgrade proposals to Libauth VMs
  • Allow usage of any BCH_SPEC opcodes in assembleBytecodeBch/disassembleBytecodeBch

• #138 1a03d3f Thanks @github-actions! - Expand VMB benchmark tests and tooling

v3.0.0

Major Changes

• #127 e5c275f Thanks @bitjson! - Add support for relative BIP32 derivation

  Relative BIP32 Hierarchical Deterministic (HD) derivation is now supported via the deriveHdPathRelative utility, and the Libauth compiler has been updated to explicitly use relative derivation by default for HdKeys. Absolute derivation has also been enhanced to validate the expected depth of provided HD keys.

  If you application relies on relative derivation but uses deriveHdPath, you'll need to switch to using the new deriveHdPathRelative, as absolute derivation will now fail if provided with a non-zero depth HD key.

  Fixes #49.

• #127 e5c275f Thanks @bitjson! - CashAssembly: .signature is now .ecdsa_signature

  All CashAssembly scripts using the .signature operation should instead call .ecdsa_signature or switch to .schnorr_signature.

  Additionally, signing_serialization.token_prefix is now available.

• #127 e5c275f Thanks @bitjson! - Unify object parameters and error handling across library

  A number of existing Libauth utilities have been modified to adhere to Libauth's object parameter and error handling conventions:

  • CashAddress utilities:
    • encodeCashAddress/decodeCashAddress
    • lockingBytecodeToCashAddress/cashAddressToLockingBytecode
    • encodeCashAddressFormat/decodeCashAddressFormat
  • BIP32 (HD Key) utilities:
    • crackHdPrivateNodeFromHdPublicNodeAndChildPrivateNode
    • decodeHdKey (decodeHdKeyUnchecked)
    • decodeHdPrivateKey/encodeHdPrivateKey
    • decodeHdPublicKey/encodeHdPrivateKey
    • deriveHdPath
    • deriveHdPathRelative
    • deriveHdPrivateNodeFromSeed
    • deriveHdPrivateNodeIdentifier/deriveHdPublicNodeIdentifier
    • deriveHdPrivateNodeChild/deriveHdPublicNodeChild
    • deriveHdPublicKey
    • deriveHdPublicNode
    • hdKeyVersionIsPrivateKey/hdKeyVersionIsPublicKey
    • hdPrivateKeyToIdentifier/hdPublicKeyToIdentifier
  • BIP39 (Mnemonic Phrase) Utilities:
    • deriveHdPrivateNodeFromBip39Mnemonic
    • deriveSeedFromBip39Mnemonic
    • encodeBip39Mnemonic/decodeBip39Mnemonic
    • generateBip39Mnemonic
  • Key Utilities:
    • generateDeterministicEntropy

  Please see the relevant guide(s) for usage examples:

  • Handling Errors
  • Keys
  • Addresses
  • Wallets & Transaction Creation

Minor Changes

• #127 e5c275f Thanks @bitjson! - Add usage guides and API overview

• #127 e5c275f Thanks @bitjson! - Add P2PKH CashAddress utilities

  The following utilities are now available:

  • hdPrivateKeyToP2pkhLockingBytecode
  • hdPrivateKeyToP2pkhCashAddress
  • hdPublicKeyToP2pkhLockingBytecode
  • hdPublicKeyToP2pkhCashAddress
  • privateKeyToP2pkhLockingBytecode
  • privateKeyToP2pkhCashAddress
  • publicKeyToP2pkhLockingBytecode
  • publicKeyToP2pkhCashAddress

  For usage examples, see wallets.md.

• #127 e5c275f Thanks @bitjson! - Validate all keys prior to compilation, expose validateCompilationData

  The compiler now validates all compilation data (i.e. validate all public and private keys), prior to compilation, regardless of whether or not the offending public or private key material is used. This is intended to surface software defects (particularly in the software used by counterparties) as early as possible.

• #127 e5c275f Thanks @bitjson! - Add support for decodeTransactionOutputs

Patch Changes

• #127 e5c275f Thanks @bitjson! - generateRandomBytes: always verify unique results across two runs

  Fixes #119. Old behavior is available at generateRandomBytesUnchecked.

v2.1.0

Minor Changes

• #117 8e032c2 Thanks @jimtendo! - Add PBKDF2 and BIP39 Support

Patch Changes

• #117 51c7ee3 Thanks @bitjson! - Use @changesets/cli, remove standard-version
• #117 7ddad21 Thanks @bitjson! - Publish with provenance via GitHub Actions