@hoangcung1804npm/voluptatem-accusamus-ipsam
v1.0.0
Published
<p align="center"> <a href="https://libauth.org/"> <img src="https://libauth.org/assets/libauth.svg" alt="Libauth logo" width="200"> </a> </p>
Downloads
3
Maintainers
Keywords
Readme
Libauth
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.
Purpose
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:
- Flexibility – Even highly-complex functionality is built-up from simpler functions. These lower-level functions can be used to experiment, tweak, and remix your own higher-level methods without maintaining a fork of the library.
- Smaller application bundles – Applications can import only the methods they need, eliminating the unused code (via dead-code elimination).
- Better auditability – Beyond having no dependencies of its own, Libauth's functional programming approach makes auditing critical code easier: smaller bundles, smaller functions, and less churn between versions (fewer cascading changes to object-oriented interfaces).
- Fully-portable – No platform-specific APIs are ever used, so the same code paths are used across all JavaScript environments (reducing the auditable "surface area" and simplifying library development).
Quick Start
To get started, install @hoangcung1804npm/voluptatem-accusamus-ipsam
:
npm install @hoangcung1804npm/voluptatem-accusamus-ipsam
# OR
yarn add @hoangcung1804npm/voluptatem-accusamus-ipsam
And import the functionality you need:
import { secp256k1 } from '@hoangcung1804npm/voluptatem-accusamus-ipsam';
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.
Guides
These guides introduce some of the high-level concepts and functionality provided by Libauth.
- Installation
- Handling Errors
- Cryptography
- Keys
- Addresses
- Verifying Transactions
- Wallets & Transaction Creation
More Examples
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
.
API Overview
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.
Address Formats
Base58 Addresses
encodeBase58Address
/decodeBase58Address
encodeBase58AddressFormat
/decodeBase58AddressFormat
lockingBytecodeToBase58Address
/base58AddressToLockingBytecode
Bech32
CashAddress
encodeCashAddress
/decodeCashAddress
lockingBytecodeToCashAddress
/cashAddressToLockingBytecode
decodeCashAddressFormatWithoutPrefix
encodeCashAddressVersionByte
/decodeCashAddressVersionByte
CashAddress-like Formats
attemptCashAddressFormatErrorCorrection
encodeCashAddressFormat
/decodeCashAddressFormat
encodeCashAddressNonStandard
/decodeCashAddressNonStandard
Crypto
hash160
(sha256
->ripemd160
)hash256
(sha256
->sha256
)hmacSha256
hmacSha512
instantiateHmacFunction
instantiatePbkdf2Function
pbkdf2HmacSha256
pbkdf2HmacSha512
ripemd160
secp256k1
sha1
sha256
sha512
Formats
Base-N Conversion
Base64
Binary Strings (e.g. 00101010
)
Hex (Hexadecimal-Encoded Strings)
Logging
Numbers
bigIntToBinUint256BEClamped
/binToBigIntUint256BE
bigIntToBinUint64LE
(bigIntToBinUint64LEClamped
)/binToBigIntUint64LE
bigIntToBinUintLE
/binToBigIntUintLE
binToBigIntUintBE
/bigIntToBinUintBE
int32SignedToUnsigned
/int32UnsignedToSigned
numberToBinInt16LE
/binToNumberInt16LE
numberToBinInt32LE
/binToNumberInt32LE
numberToBinInt32TwosCompliment
numberToBinUintLE
/binToNumberUintLE
numberToBinUint16BE
numberToBinUint16LE
(numberToBinUint16LEClamped
)/binToNumberUint16LE
numberToBinUint32BE
numberToBinUint32LE
(numberToBinUint32LEClamped
)/binToNumberUint32LE
CompactUint (A.K.A. "VarInt" or "CompactSize")
Satoshi Values
VM Numbers (A.K.A. "ScriptNum")
Miscellaneous
Time
UTF8
Keys
BIP32 Hierarchical Deterministic (HD) Keys
crackHdPrivateNodeFromHdPublicNodeAndChildPrivateNode
decodeHdKey
(decodeHdKeyUnchecked
)decodeHdPrivateKey
/encodeHdPrivateKey
decodeHdPublicKey
/encodeHdPrivateKey
deriveHdPath
deriveHdPathRelative
deriveHdPrivateNodeFromSeed
deriveHdPrivateNodeIdentifier
/deriveHdPublicNodeIdentifier
deriveHdPrivateNodeChild
/deriveHdPublicNodeChild
deriveHdPublicKey
deriveHdPublicNode
hdKeyVersionIsPrivateKey
/hdKeyVersionIsPublicKey
hdPrivateKeyToIdentifier
/hdPublicKeyToIdentifier
BIP39 Mnemonic Phrases
deriveHdPrivateNodeFromBip39Mnemonic
deriveSeedFromBip39Mnemonic
encodeBip39Mnemonic
/decodeBip39Mnemonic
generateBip39Mnemonic
Wallet Import Format (WIF)
Key Utilities
generateDeterministicEntropy
generateHdPrivateNode
generatePrivateKey
generateRandomBytes
generateRandomSeed
minimumEventsPerEntropyBits
shannonEntropyPerEvent
validateSecp256k1PrivateKey
P2P Messages
Decoding Utilities
readBytes
readCompactUintPrefixedBin
readRemainingBytes
readUint32LE
readUint64LE
readMultiple
readItemCount
Transactions
encodeTransaction
/decodeTransaction
(decodeTransactionUnsafe
)encodeTransactionOutputs
/decodeTransactionOutputs
hashTransaction
hashTransactionP2pOrder
hashTransactionUiOrder
Outputs
isArbitraryDataOutput
isSimpleMultisig
isStandardOutputBytecode
isStandardOutputBytecode2023
isStandardMultisig
isWitnessProgram
Dust Calculation
Virtual Machines
Built-In VMs
createInstructionSetBCH
createInstructionSetBCH2022
createInstructionSetBCH2023
createInstructionSetBCHCHIPs
createInstructionSetXEC
createVirtualMachine
createVirtualMachineBCH
createVirtualMachineBCH2022
createVirtualMachineBCH2023
createVirtualMachineBCHCHIPs
createVirtualMachineXEC
Debugging
assembleBytecode
assembleBytecodeBCH
assembleBytecodeBTC
disassembleBytecode
disassembleBytecodeBCH
disassembleBytecodeBTC
generateBytecodeMap
summarizeDebugTrace
stringifyDebugTraceSummary
summarizeStack
Combinators
combineOperations
mapOverOperations
pushToStack
pushToStackChecked
pushToStackVmNumber
pushToStackVmNumberChecked
useOneStackItem
useTwoStackItems
useThreeStackItems
useFourStackItems
useSixStackItems
useOneVmNumber
useTwoVmNumbers
useThreeVmNumbers
Wallet Engine
Bitcoin Cash Metadata Registries (BCMRs)
CashAssembly Language & Compiler
allErrorsAreRecoverable
cashAssemblyToBin
compileScript
containsRange
createCompiler
extractBytecodeResolutions
extractEvaluationSamples
extractEvaluationSamplesRecursive
extractUnexecutedRanges
getResolutionErrors
mergeRanges
parseScript
resolveVariableIdentifier
stringifyErrors
verifyCashAssemblyEvaluationState
walletTemplateToCompilerConfiguration
walletTemplateToCompilerBCH
Multi-Party Compilation
P2PKH Utilities
hdPrivateKeyToP2pkhLockingBytecode
hdPrivateKeyToP2pkhCashAddress
hdPublicKeyToP2pkhLockingBytecode
hdPublicKeyToP2pkhCashAddress
privateKeyToP2pkhLockingBytecode
privateKeyToP2pkhCashAddress
publicKeyToP2pkhLockingBytecode
publicKeyToP2pkhCashAddress
Wallet Templates
VMB Tests
Libauth'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
CashAssembly is the assembly language used by Libauth's Wallet Templates. To learn more about CashAssembly, read the Bitauth IDE Guide.
Contributing
Pull Requests welcome! Please see CONTRIBUTING.md
for details.