@bitauth/libauth
Advanced tools
ultra-lightweight library for Bitcoin Cash, Bitcoin, and Bitauth
An ultra-lightweight JavaScript library for Bitcoin Cash, Bitcoin, and Bitauth applications.
An ultra-lightweight JavaScript library for Bitcoin Cash, Bitcoin, and Bitauth applications.
Libauth has no dependencies and works in all JavaScript environments, including Node.js, Deno, and browsers.
Libauth is designed to be flexible, lightweight, and easily auditable. Rather than providing a single, overarching, object-oriented API, all functionality is composed from simple functions. This has several benefits:
To get started, install @bitauth/libauth:
npm install @bitauth/libauth
# OR
yarn add @bitauth/libauth
And import the functionality you need:
import { secp256k1 } from '@bitauth/libauth';
import { msgHash, pubkey, sig } from 'somewhere';
secp256k1.verifySignatureDERLowS(sig, pubkey, msgHash)
? console.log('🚀 Signature valid')
: console.log('❌ Signature invalid');
See Installation for more guidance on getting set up.
These guides introduce some of the high-level concepts and functionality provided by Libauth.
In addition to the usage examples in these guides, note that Libauth includes comprehensive tests that can help demonstrate usage of all functionality.
For example, utilities related to hexadecimal-encoded strings are defined in hex.ts; for thorough usage examples, see the co-located hex.spec.ts. You can also use GitHub search to see how a particular utility is used throughout the library, e.g. splitEvery.
Below is a partial selection of functionality provided by Libauth. If you're looking for something else, be sure to search the API Reference.
High-level utilities are composed from lower-level utilities which are also exported, so it's often possible to remix behavior in your own codebase with relatively little duplication or maintenance burden. See the Defined in ... link on each utility's API reference page to review and copy the implementation.
encodeBase58Address/decodeBase58AddressencodeBase58AddressFormat/decodeBase58AddressFormatlockingBytecodeToBase58Address/base58AddressToLockingBytecodeencodeCashAddress/decodeCashAddresslockingBytecodeToCashAddress/cashAddressToLockingBytecodedecodeCashAddressFormatWithoutPrefixencodeCashAddressVersionByte/decodeCashAddressVersionByteattemptCashAddressFormatErrorCorrectionencodeCashAddressFormat/decodeCashAddressFormatencodeCashAddressNonStandard/decodeCashAddressNonStandardhash160 (sha256 -> ripemd160)hash256 (sha256 -> sha256)hmacSha256hmacSha512instantiateHmacFunctioninstantiatePbkdf2Functionpbkdf2HmacSha256pbkdf2HmacSha512ripemd160secp256k1sha1sha256sha51200101010)bigIntToBinUint256BEClamped/binToBigIntUint256BEbigIntToBinUint64LE(bigIntToBinUint64LEClamped)/binToBigIntUint64LEbigIntToBinUintLE/binToBigIntUintLEbinToBigIntUintBE/bigIntToBinUintBEint32SignedToUnsigned/int32UnsignedToSignednumberToBinInt16LE/binToNumberInt16LEnumberToBinInt32LE/binToNumberInt32LEnumberToBinInt32TwosComplimentnumberToBinUintLE/binToNumberUintLEnumberToBinUint16BEnumberToBinUint16LE(numberToBinUint16LEClamped)/binToNumberUint16LEnumberToBinUint32BEnumberToBinUint32LE(numberToBinUint32LEClamped)/binToNumberUint32LEcrackHdPrivateNodeFromHdPublicNodeAndChildPrivateNodedecodeHdKey (decodeHdKeyUnchecked)decodeHdPrivateKey/encodeHdPrivateKeydecodeHdPublicKey/encodeHdPrivateKeyderiveHdPathderiveHdPathRelativederiveHdPrivateNodeFromSeedderiveHdPrivateNodeIdentifier/deriveHdPublicNodeIdentifierderiveHdPrivateNodeChild/deriveHdPublicNodeChildderiveHdPublicKeyderiveHdPublicNodehdKeyVersionIsPrivateKey/hdKeyVersionIsPublicKeyhdPrivateKeyToIdentifier/hdPublicKeyToIdentifierderiveHdPrivateNodeFromBip39MnemonicderiveSeedFromBip39MnemonicencodeBip39Mnemonic/decodeBip39MnemonicgenerateBip39MnemonicgenerateDeterministicEntropygenerateHdPrivateNodegeneratePrivateKeygenerateRandomBytesgenerateRandomSeedminimumEventsPerEntropyBitsshannonEntropyPerEventvalidateSecp256k1PrivateKeyreadBytesreadCompactUintPrefixedBinreadRemainingBytesreadUint32LEreadUint64LEreadMultiplereadItemCountencodeTransaction/decodeTransaction (decodeTransactionUnsafe)encodeTransactionOutputs/decodeTransactionOutputshashTransactionhashTransactionP2pOrderhashTransactionUiOrderisArbitraryDataOutputisSimpleMultisigisStandardOutputBytecodeisStandardOutputBytecode2023isStandardMultisigisWitnessProgramcreateInstructionSetBCHcreateInstructionSetBCH2022createInstructionSetBCH2023createInstructionSetBCHCHIPscreateInstructionSetXECcreateVirtualMachinecreateVirtualMachineBCHcreateVirtualMachineBCH2022createVirtualMachineBCH2023createVirtualMachineBCHCHIPscreateVirtualMachineXECassembleBytecodeassembleBytecodeBCHassembleBytecodeBTCdisassembleBytecodedisassembleBytecodeBCHdisassembleBytecodeBTCgenerateBytecodeMapsummarizeDebugTracestringifyDebugTraceSummarysummarizeStackcombineOperationsmapOverOperationspushToStackpushToStackCheckedpushToStackVmNumberpushToStackVmNumberCheckeduseOneStackItemuseTwoStackItemsuseThreeStackItemsuseFourStackItemsuseSixStackItemsuseOneVmNumberuseTwoVmNumbersuseThreeVmNumbersallErrorsAreRecoverablecashAssemblyToBincompileScriptcontainsRangecreateCompilerextractBytecodeResolutionsextractEvaluationSamplesextractEvaluationSamplesRecursiveextractUnexecutedRangesgetResolutionErrorsmergeRangesparseScriptresolveVariableIdentifierstringifyErrorsverifyCashAssemblyEvaluationStatewalletTemplateToCompilerConfigurationwalletTemplateToCompilerBCHhdPrivateKeyToP2pkhLockingBytecodehdPrivateKeyToP2pkhCashAddresshdPublicKeyToP2pkhLockingBytecodehdPublicKeyToP2pkhCashAddressprivateKeyToP2pkhLockingBytecodeprivateKeyToP2pkhCashAddresspublicKeyToP2pkhLockingBytecodepublicKeyToP2pkhCashAddressLibauth's test suite includes a set of cross-implementation Virtual Machine Bytecode (VMB) test vectors for each supported VM. See Libauth VMB Tests for details.
CashAssembly is the assembly language used by Libauth's Wallet Templates. To learn more about CashAssembly, read the Bitauth IDE Guide.
Pull Requests welcome! Please see CONTRIBUTING.md for details.
3.0.0
#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:
crackHdPrivateNodeFromHdPublicNodeAndChildPrivateNodedecodeHdKey (decodeHdKeyUnchecked)decodeHdPrivateKey/encodeHdPrivateKeydecodeHdPublicKey/encodeHdPrivateKeyderiveHdPathderiveHdPathRelativederiveHdPrivateNodeFromSeedderiveHdPrivateNodeIdentifier/deriveHdPublicNodeIdentifierderiveHdPrivateNodeChild/deriveHdPublicNodeChildderiveHdPublicKeyderiveHdPublicNodehdKeyVersionIsPrivateKey/hdKeyVersionIsPublicKeyhdPrivateKeyToIdentifier/hdPublicKeyToIdentifierPlease see the relevant guide(s) for usage examples:
#127 e5c275f Thanks @bitjson! - Add usage guides and API overview
#127 e5c275f Thanks @bitjson! - Add P2PKH CashAddress utilities
The following utilities are now available:
hdPrivateKeyToP2pkhLockingBytecodehdPrivateKeyToP2pkhCashAddresshdPublicKeyToP2pkhLockingBytecodehdPublicKeyToP2pkhCashAddressprivateKeyToP2pkhLockingBytecodeprivateKeyToP2pkhCashAddresspublicKeyToP2pkhLockingBytecodepublicKeyToP2pkhCashAddressFor 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
FAQs
ultra-lightweight library for Bitcoin Cash, Bitcoin, and Bitauth
We found that @bitauth/libauth demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.