@bitcoin-computer/nakamotojs
TypeScript icon, indicating that this package has built-in type declarations

0.18.0-beta.0 • Public • Published

NakamotoJS

A fork of BitcoinJS tailored towards advanced applications like swaps

Github CI NPM code style: prettier

This fork makes the following changes to BitcoinJS

  • Adds support for Litecoin (support for Dogecoin coming soon)
  • Adds support for signing transactions (BitcoinJS can only sign PSBTs).

While PSBTs are a great for serialization, they are restrictive as they cannot be modified after the first signature is added. This is an issue for applications like swaps where multiple users need to build a transaction collaboratively. In these cases users can take advantage of SIGHASH types that allow the modifications of part of a transaction after a signature is added.

Installation

Install the Bitcoin Computer Monorepo. Then navigate from the root folder of the monorepo to the folder packages/explorer.

# Download the monorepo
git clone https://github.com/bitcoin-computer/monorepo.git

# Move to the package
cd monorepo

# Install the dependencies
npm install

Usage

The following commands can be run from the folder packages/nakamotojs/

Run the Tests

npm run test

Run the Linter

npm run lint

Build the Sources

npm run build

BitcoinJS Docs

See here.

Examples

The below examples are implemented as integration tests, they should be very easy to understand. Otherwise, pull requests are appreciated. Some examples interact (via HTTPS) with a 3rd Party Blockchain Provider (3PBP). 17:29

If you have a use case that you feel could be listed here, please ask for it!

Contributing

Contributions are most welcome. If you have found a bug please create an issue. If you have a bug fix or a UX improvement please create a pull request here.

If you want to add a feature we recommend to create a fork. Let us know if you have built something cool and we can link to your project.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Package Sidebar

Install

npm i @bitcoin-computer/nakamotojs

Weekly Downloads

1,125

Version

0.18.0-beta.0

License

MIT

Unpacked Size

226 kB

Total Files

63

Last publish

Collaborators

  • clemensley