Skip to content
A typescript bitcoin library, including WASM versions of secp256k1, ripemd160, sha256, sha512, and sha1
TypeScript JavaScript Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github feat(auth): complete BCH auth vm, schnorr, and BTL compiler Aug 15, 2019
.vscode
config
docs/api
src
wasm build(hashes): pin sha256 of rustup docker image Sep 18, 2019
.ava.bench.config.js
.dockerignore feat(ripemd160): expose a purely-functional, WebAssembly ripemd160 im… Jun 26, 2018
.gitignore
.gitmodules
.npmignore
.prettierignore
CHANGELOG.md
LICENSE Initial commit Mar 21, 2018
README.md
package.json
tsconfig.json
tslint.json feat(auth): complete BCH auth vm, schnorr, and BTL compiler Aug 15, 2019
yarn.lock

README.md

NPM version Codecov CircleCI GitHub stars

bitcoin-ts

A flexible, strongly-typed, FP-inspired, highly-portable, typescript bitcoin library.

Work in Progress

While this library is under active development, current functionality is production-ready (WASM implementations of secp256k1, ripemd160, sha256, sha512, and sha1).

More functionality will be exposed and stabilized in future versions.

Design Goals

This library should provide the primitives needed to hack on Bitcoin and Bitcoin-related ideas.

  1. flexible - Consumers should be able to import only the functionality they need
  2. simple - Functions should be simple and return one type
  3. portable – All code should work on every platform (no Node.js bindings or separate browser versions)

Please see the Design Guidelines for more info.

Usage

To use, simply install bitcoin-ts:

npm install bitcoin-ts
# OR
yarn add bitcoin-ts

And import the functionality you need:

import { instantiateSecp256k1 } from 'bitcoin-ts';
import { msgHash, pubkey, sig } from './somewhere';

(async () => {
  const secp256k1 = await instantiateSecp256k1();
  secp256k1.verifySignatureDERLowS(sig, pubkey, msgHash)
    ? console.log('🚀 Signature valid')
    : console.log('❌ Signature invalid');
})();

Note: bitcoin-ts uses BigInt, WebAssembly, and es2017 features for some functionality. While support is required to use this functionality (Node.js v10 LTS or later), other parts of the library will continue to work in older environments.

To include the necessary TypeScript library files in you application, add "lib": ["es2017", "esnext.bigint", "dom"] to your tsconfig.json.

API

The following APIs are considered stable, and will only include breaking changes in major version upgrades.

API Documentation →

ECDSA

Hashing Functions

Unstable APIs

The master branch of this repo also contains new, potentially unstable APIs. As these APIs stabilize, they will be included in the above Stable APIs.

Contributing

Pull Requests welcome! Please see CONTRIBUTING.md for details.

This library requires Yarn for development. If you don't have Yarn, make sure you have Node.js installed (which ships with npm), then run npm install -g yarn. Once Yarn is installed:

# use --recursive to clone the secp256k1 submodule
git clone --recursive https://github.com/bitjson/bitcoin-ts.git && cd bitcoin-ts

Install the development dependencies:

yarn

Then try running the test suite:

yarn test

You can also run the benchmarks (this may take a while):

yarn bench

During development, you may find it helpful to use one of the testing watch tasks:

yarn watch
# OR
yarn watch:with-crypto # when working on the crypto APIs

For more information about the available package scripts, run:

yarn run info
You can’t perform that action at this time.