Skip to content

Commit 97c20f0

Browse files
bitjsonbitjson
committed
chore: rename bitcoin-ts -> libauth
1 parent f85abf6 commit 97c20f0

26 files changed

Lines changed: 208 additions & 3982 deletions

‎.circleci/config.yml‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# https://circleci.com/docs/2.0/language-javascript/
22
version: 2
33
jobs:
4-
"node-14":
4+
'node-14':
55
docker:
66
- image: circleci/node:14
7-
working_directory: ~/bitcoin-ts
7+
working_directory: ~/libauth
88
steps:
99
- checkout
1010
- restore_cache:
@@ -21,10 +21,10 @@ jobs:
2121
- run: yarn test
2222
- run: yarn run cov:send
2323
- run: yarn run cov:check
24-
"node-12":
24+
'node-12':
2525
docker:
2626
- image: circleci/node:12
27-
working_directory: ~/bitcoin-ts
27+
working_directory: ~/libauth
2828
steps:
2929
- checkout
3030
- restore_cache:
@@ -40,10 +40,10 @@ jobs:
4040
key: yarn-packages-{{ .Branch }}-{{ checksum "yarn.lock" }}
4141
- run: yarn test
4242
- run: yarn run cov:check
43-
"node-10":
43+
'node-10':
4444
docker:
4545
- image: circleci/node:10
46-
working_directory: ~/bitcoin-ts
46+
working_directory: ~/libauth
4747
steps:
4848
- checkout
4949
- restore_cache:
@@ -59,10 +59,10 @@ jobs:
5959
key: yarn-packages-{{ .Branch }}-{{ checksum "yarn.lock" }}
6060
- run: yarn test
6161
- run: yarn run cov:check
62-
"benchmarks":
62+
'benchmarks':
6363
docker:
6464
- image: circleci/node:12-browsers
65-
working_directory: ~/bitcoin-ts
65+
working_directory: ~/libauth
6666
steps:
6767
- checkout
6868
- restore_cache:
@@ -82,7 +82,7 @@ workflows:
8282
version: 2
8383
build:
8484
jobs:
85-
- "node-10"
86-
- "node-12"
87-
- "node-14"
88-
- "benchmarks"
85+
- 'node-10'
86+
- 'node-12'
87+
- 'node-14'
88+
- 'benchmarks'

‎.cspell.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@
5757
"IFDUP",
5858
"INVALIDOPCODE",
5959
"LESSTHAN",
60+
"libauth",
61+
"Libauth's",
6062
"libsecp",
6163
"lifecycle",
6264
"locktime",

‎.github/CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to bitcoin-ts
1+
# Contributing to Libauth
22

33
Thanks for your interest! Contributions are very welcome.
44

‎.gitmodules‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
[submodule "wasm/secp256k1"]
22
path = wasm/secp256k1
3-
url = https://github.com/bitjson/secp256k1.git
4-
branch = bitcoin-ts
3+
url = https://github.com/bitauth/libauth-secp256k1.git
4+
branch = libauth

‎CHANGELOG.md‎

Lines changed: 115 additions & 212 deletions
Large diffs are not rendered by default.

‎README.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
[![NPM version](https://img.shields.io/npm/v/bitcoin-ts.svg)](https://www.npmjs.com/package/bitcoin-ts)
2-
[![Codecov](https://img.shields.io/codecov/c/github/bitauth/bitcoin-ts/master.svg)](https://codecov.io/gh/bitauth/bitcoin-ts)
3-
[![CircleCI](https://img.shields.io/circleci/project/github/bitauth/bitcoin-ts/master.svg)](https://circleci.com/gh/bitauth/bitcoin-ts)
4-
[![GitHub stars](https://img.shields.io/github/stars/bitauth/bitcoin-ts.svg?style=social&logo=github&label=Stars)](https://github.com/bitauth/bitcoin-ts)
1+
[![NPM version](https://img.shields.io/npm/v/libauth.svg)](https://www.npmjs.com/package/libauth)
2+
[![Codecov](https://img.shields.io/codecov/c/github/bitauth/libauth/master.svg)](https://codecov.io/gh/bitauth/libauth)
3+
[![CircleCI](https://img.shields.io/circleci/project/github/bitauth/libauth/master.svg)](https://circleci.com/gh/bitauth/libauth)
4+
[![GitHub stars](https://img.shields.io/github/stars/bitauth/libauth.svg?style=social&logo=github&label=Stars)](https://github.com/bitauth/libauth)
55

6-
# bitcoin-ts
6+
# Libauth
77

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

@@ -25,18 +25,18 @@ Please see the [Design Guidelines](.github/CONTRIBUTING.md) for more info.
2525

2626
## Usage
2727

28-
To use, simply install `bitcoin-ts`:
28+
To use, simply install `libauth`:
2929

3030
```sh
31-
npm install bitcoin-ts
31+
npm install libauth
3232
# OR
33-
yarn add bitcoin-ts
33+
yarn add libauth
3434
```
3535

3636
And import the functionality you need:
3737

3838
```typescript
39-
import { instantiateSecp256k1 } from 'bitcoin-ts';
39+
import { instantiateSecp256k1 } from 'libauth';
4040
import { msgHash, pubkey, sig } from './somewhere';
4141

4242
(async () => {
@@ -47,31 +47,31 @@ import { msgHash, pubkey, sig } from './somewhere';
4747
})();
4848
```
4949

50-
**Note**: `bitcoin-ts` uses [`BigInt`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt), [`WebAssembly`](https://developer.mozilla.org/en-US/docs/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.
50+
**Note**: `libauth` uses [`BigInt`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt), [`WebAssembly`](https://developer.mozilla.org/en-US/docs/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.
5151

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

5454
## API
5555

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

58-
[**API Documentation →**](https://bitauth.github.io/bitcoin-ts/)
58+
[**API Documentation →**](https://bitauth.github.io/libauth/)
5959

6060
### ECDSA
6161

62-
- [instantiateSecp256k1](https://bitauth.github.io/bitcoin-ts/globals.html#instantiatesecp256k1)
63-
- [Secp256k1 Interface](https://bitauth.github.io/bitcoin-ts/interfaces/secp256k1.html)
62+
- [instantiateSecp256k1](https://bitauth.github.io/libauth/globals.html#instantiatesecp256k1)
63+
- [Secp256k1 Interface](https://bitauth.github.io/libauth/interfaces/secp256k1.html)
6464

6565
### Hashing Functions
6666

67-
- [instantiateRipemd160](https://bitauth.github.io/bitcoin-ts/globals.html#instantiateripemd160)
68-
- [Ripemd160 Interface](https://bitauth.github.io/bitcoin-ts/interfaces/ripemd160.html)
69-
- [instantiateSha1](https://bitauth.github.io/bitcoin-ts/globals.html#instantiatesha1)
70-
- [Sha1 Interface](https://bitauth.github.io/bitcoin-ts/interfaces/sha1.html)
71-
- [instantiateSha256](https://bitauth.github.io/bitcoin-ts/globals.html#instantiatesha256)
72-
- [Sha256 Interface](https://bitauth.github.io/bitcoin-ts/interfaces/sha256.html)
73-
- [instantiateSha512](https://bitauth.github.io/bitcoin-ts/globals.html#instantiatesha512)
74-
- [Sha512 Interface](https://bitauth.github.io/bitcoin-ts/interfaces/sha512.html)
67+
- [instantiateRipemd160](https://bitauth.github.io/libauth/globals.html#instantiateripemd160)
68+
- [Ripemd160 Interface](https://bitauth.github.io/libauth/interfaces/ripemd160.html)
69+
- [instantiateSha1](https://bitauth.github.io/libauth/globals.html#instantiatesha1)
70+
- [Sha1 Interface](https://bitauth.github.io/libauth/interfaces/sha1.html)
71+
- [instantiateSha256](https://bitauth.github.io/libauth/globals.html#instantiatesha256)
72+
- [Sha256 Interface](https://bitauth.github.io/libauth/interfaces/sha256.html)
73+
- [instantiateSha512](https://bitauth.github.io/libauth/globals.html#instantiatesha512)
74+
- [Sha512 Interface](https://bitauth.github.io/libauth/interfaces/sha512.html)
7575

7676
### Unstable APIs
7777

@@ -85,7 +85,7 @@ This library requires [Yarn](https://yarnpkg.com/) for development. If you don't
8585

8686
```sh
8787
# use --recursive to clone the secp256k1 submodule
88-
git clone --recursive https://github.com/bitjson/bitcoin-ts.git && cd bitcoin-ts
88+
git clone --recursive https://github.com/bitauth/libauth.git && cd libauth
8989
```
9090

9191
Install the development dependencies:

0 commit comments

Comments
 (0)