bitcoin-ts

v1.6.0

a typescript bitcoin library

info

npm-scripts-info

compile:secp256k1

 docker build -f wasm/docker/secp256k1.Dockerfile . -t bitcoin-ts-secp256k1 && docker run -it --mount type=bind,src=$(pwd)/src/lib,dst=/bitcoin-ts/out,consistency=delegated bitcoin-ts-secp256k1

compile:hashes

 docker build -f wasm/docker/hashes.Dockerfile . -t bitcoin-ts-hashes && docker run -it --mount type=bind,src=$(pwd)/src/lib,dst=/bitcoin-ts/out,consistency=delegated bitcoin-ts-hashes

build

run-s clean && run-p build:*

build:main

tsc -p tsconfig.json

build:module

tsc -p config/tsconfig.module.json

build:parsimmon

 cpy src/lib/auth/templates/language/parsimmon.js build/main/lib/auth/templates/language && cpy src/lib/auth/templates/language/parsimmon.js build/module/lib/auth/templates/language

build:wasm

run-p copy:wasm:secp256k1 copy:wasm:sha1 copy:wasm:sha256 copy:wasm:sha512 copy:wasm:ripemd160

copy:wasm:secp256k1

 cpy src/lib/bin/secp256k1/secp256k1.wasm build/main/lib/bin/secp256k1 && cpy src/lib/bin/secp256k1/secp256k1.wasm build/module/lib/bin/secp256k1

copy:wasm:sha1

cpy src/lib/bin/sha1/sha1.wasm build/main/lib/bin/sha1 && cpy src/lib/bin/sha1/sha1.wasm build/module/lib/bin/sha1

copy:wasm:sha256

 cpy src/lib/bin/sha256/sha256.wasm build/main/lib/bin/sha256 && cpy src/lib/bin/sha256/sha256.wasm build/module/lib/bin/sha256

copy:wasm:sha512

 cpy src/lib/bin/sha512/sha512.wasm build/main/lib/bin/sha512 && cpy src/lib/bin/sha512/sha512.wasm build/module/lib/bin/sha512

copy:wasm:ripemd160

 cpy src/lib/bin/ripemd160/ripemd160.wasm build/main/lib/bin/ripemd160 && cpy src/lib/bin/ripemd160/ripemd160.wasm build/module/lib/bin/ripemd160

compile:debug:secp256k1

docker run -it bitcoin-ts-secp256k1 bash

compile:debug:hashes

docker run -it bitcoin-ts-hashes bash

fix

run-s fix:*

fix:prettier

prettier "src/**/*.ts" --write

fix:tslint

tslint --fix --project .

test

run-s build test:*

test:lint

tslint --project . && prettier "src/**/*.ts" --list-different

test:unit

nyc --silent ava

test:unit:fast

nyc --silent ava --match='!crypto:*' --match='!script_tests:*' --match='!signing-serialization tests:*'

test:unit:crypto

nyc --silent ava --match='crypto:*'

test:unit:script_tests

nyc --silent ava --match='script_tests:*' --verbose --serial

bench

run-s build bench:browser-deps bench:test

bench:test

ava --config .ava.bench.config.js --serial

bench:browser-deps

 browserify node_modules/chuhai/index.js --standalone chuhai -o build/bench/chuhai.js && browserify node_modules/hash.js/lib/hash.js --standalone hash -o build/bench/hash.js

watch:slow

run-s clean build:main build:wasm && run-p "build:main -- -w" "test:unit -- --watch"

watch

run-s clean build:main build:wasm build:parsimmon && run-p "build:main -- -w" "test:unit:fast -- --watch"

cov

run-s build test:unit cov:html && open-cli coverage/index.html

cov:html

nyc report --reporter=html

cov:send

nyc report --reporter=lcov && codecov

cov:check

nyc report && nyc check-coverage --lines 85 --functions 80 --branches 65

doc

run-s doc:html && open-cli build/docs/index.html

doc:html

typedoc src/index.ts --target ES6 --mode file --excludeNotExported --out build/docs

doc:json

typedoc src/index.ts --target ES6 --mode file --excludeNotExported --json build/docs/typedoc.json

doc:next

run-s build doc:extract doc:generate

doc:extract

api-extractor run --local --typescript-compiler-folder node_modules/typescript

doc:generate

api-documenter markdown -i temp -o docs/markdown

doc:check-api

api-extractor run --typescript-compiler-folder node_modules/typescript

doc:publish

gh-pages -m "[ci skip] Updates" -d build/docs

doc:generate-json-schema

 ts-json-schema-generator --path 'src/lib/auth/templates/types.ts' --type 'AuthenticationTemplate' > src/lib/auth/templates/bitauth-authentication-template.schema.json