Release v3.0.0

[github-actions]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to master, this PR will be updated.

Releases

@bitauth/[email protected]

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.