npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@bitauth/libauth

v3.0.0

Published

ultra-lightweight library for Bitcoin Cash, Bitcoin, and Bitauth

Downloads

295,254

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

jasondreyzehnerjasondreyzehner

Keywords

authenticationbitauthBitcoin CashBitcoincryptocurrencywasmcryptosha256ripemd160secp256k1sha1sha512HMACwalletblockchaintypescriptwebassemblyBCHBTC

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 @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.

Guides

These guides introduce some of the high-level concepts and functionality provided by Libauth.

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

Bech32

CashAddress

CashAddress-like Formats

Crypto

Formats

Base-N Conversion

Base64

Binary Strings (e.g. 00101010)

Hex (Hexadecimal-Encoded Strings)

Logging

Numbers

CompactUint (A.K.A. "VarInt" or "CompactSize")
Satoshi Values
VM Numbers (A.K.A. "ScriptNum")

Miscellaneous

Time

UTF8

Keys

BIP32 Hierarchical Deterministic (HD) Keys

BIP39 Mnemonic Phrases

Wallet Import Format (WIF)

Key Utilities

P2P Messages

Decoding Utilities

Transactions

Outputs

Dust Calculation

Virtual Machines

Built-In VMs

Debugging

Combinators

Wallet Engine

Bitcoin Cash Metadata Registries (BCMRs)

CashAssembly Language & Compiler

Multi-Party Compilation

P2PKH Utilities

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.