@wallfree-dev/bitcoin 0.13.42

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2019 Papers AG
+
+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/index.d.ts

@@ -0,0 +1 @@
+export * from './v1';

package/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./v1"), exports);
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uCAAoB"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@wallfree-dev/bitcoin",
+  "version": "0.13.42",
+  "description": "The @wallfree-dev/bitcoin is a Bitcoin implementation of the ICoinProtocol interface from @wallfree-dev/coinlib-core.",
+  "keywords": [
+    "airgap",
+    "blockchain",
+    "crypto",
+    "bitcoin"
+  ],
+  "license": "MIT",
+  "homepage": "https://www.airgap.it",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/airgap-it/airgap-coin-lib"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "rm -rf ./dist && tsc && node scripts/copy-files-after-build.js",
+    "build-scripts": "tsc scripts/copy-files-after-build.ts",
+    "lint": "tslint -c ./tslint.json --project ./tsconfig.json --format stylish --fix",
+    "lint:prettier": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "lint-ci": "tslint -t json -o ../../lint-reports/bitcoin.json --project . || true",
+    "lint-ci:prettier": "prettier \"src/**/*.ts\" \"test/**/*.ts\" --list-different",
+    "test": "TS_NODE_PROJECT='./test/tsconfig.json' nyc mocha --bail --require ts-node/register --require tsconfig-paths/register --require source-map-support/register --full-trace --delay --timeout 40000 ./test/**/**.spec.ts",
+    "test-ci": "nyc --reporter=lcov pnpm test",
+    "browserify": "browserify ./dist/index.js -s airgapCoinLibBitcoin > ./dist/airgap-coinlib-bitcoin.min.js"
+  },
+  "author": "Papers AG <contact@papers.ch> (https://papers.ch)",
+  "dependencies": {
+    "@wallfree-dev/coinlib-core": "^0.13.42",
+    "@wallfree-dev/crypto": "^0.13.42",
+    "@wallfree-dev/module-kit": "^0.13.42",
+    "@wallfree-dev/serializer": "^0.13.42",
+    "@bitcoinerlab/secp256k1": "1.2.0",
+    "bip32": "5.0.0-rc.0",
+    "bitcoinjs-lib": "6.1.7"
+  },
+  "localDependencies": {
+    "bitcoinjs-message": "2.1.1"
+  },
+  "nyc": {
+    "include": [
+      "src/**/*.ts"
+    ],
+    "exclude": [
+      "test/**/*.spec.ts"
+    ],
+    "extension": [
+      ".ts"
+    ],
+    "require": [
+      "ts-node/register"
+    ],
+    "reporter": [
+      "text",
+      "text-summary"
+    ],
+    "report-dir": "../../coverage/bitcoin",
+    "sourceMap": true,
+    "instrument": true
+  },
+  "gitHead": "8e8feb6788204501b7173aa825f5456c2a5f185b"
+}

package/readme.md

@@ -0,0 +1,121 @@
+# AirGap Coin Library
+
+[![npm](https://img.shields.io/npm/v/airgap-coin-lib.svg?colorB=brightgreen)](https://www.npmjs.com/package/airgap-coin-lib)
+[![documentation](https://img.shields.io/badge/documentation-online-brightgreen.svg)](https://airgap-it.github.io/airgap-coin-lib/)
+[![build](https://img.shields.io/travis/airgap-it/airgap-coin-lib.svg)](https://travis-ci.org/airgap-it/airgap-coin-lib/)
+[![codecov](https://img.shields.io/codecov/c/gh/airgap-it/airgap-coin-lib.svg)](https://codecov.io/gh/airgap-it/airgap-coin-lib/)
+
+The `airgap-coin-lib` is a protocol-agnostic library that allows easy handling of the most important tasks relating cryptocurrencies and blockchains.
+
+It implements operations such as preparing, signing and broadcasting transactions for a range of protocols.
+
+The library consists of a shared interface for all implemented protocols. This is especially useful in the context of AirGap because methods are designed to support offline key management and signing. The following core operations are specified:
+
+- `prepareTransaction` - This is done on AirGap Wallet (online) side. Either a public key or extended public key is used and will fetch the required information from the network.
+- `signTransaction` - This is done in AirGap Vault (offline) side. The output of "prepareTransaction" is the input for this method (hence the output of "prepareTransaction" is transferred via URL scheme (same-device) or QR code (2-device-setup)).
+- `broadcastTransaction` - This is done in AirGap Wallet (online) side. The output of "signTransaction" is the input for this method (hence the output of "signTransaction" is transferred via URL scheme (same-device) or QR code (2-device-setup)).
+
+## Supported Protocols
+
+The modular design used in this library allows you to simply add new protocols with special logic. Adding a new Bitcoin-like protocol basically means:
+
+1. select the correct network parameters (see `src/networks.ts`)
+2. set the Insight API URL to communicate with the blockchain
+
+Adding a new Ethereum-like protocol means:
+
+1. set the correct chain id
+2. set the JSON RPC URL
+
+Currently supported are:
+
+- Bitcoin
+- Ethereum
+  - Generic ERC20 Tokens
+- Aeternity
+- Tezos
+  - FA1.2 tokens
+    - tzBTC
+    - USDtz
+  - FA2 tokens
+- Groestlcoin
+- Cosmos
+- Polkadot
+- Kusama
+
+## Features
+
+### Protocols
+
+The way the interface was designed is to allow stateless calls. This means the class stores very little state itself.
+All required input comes from the method params (public key, extended public key, etc...)
+
+Currently we support for Bitcoin-like (UTXO) protocols:
+
+- Single Address Wallets (deprecated)
+- HD Wallets
+
+Currently we support for Ethereum-like (Account-based) protocols:
+
+- Single Address Wallets
+
+### Delegation
+
+There is a different interface that can be implemented if the protocol supports delegation. The delegation flow usually requires some changes in the user interface of the AirGap Wallet as well.
+
+### Inter App Communication
+
+A serializer is included that encodes JSON structures with RLP and base58check. Those strings can then be sent to the other app, either through QR codes or a URL. The serializer can only serialize messages in predefined formats, so new message types have to be added when new protocols are added.
+
+### Tezos FA1.2 and FA2 tokens
+
+It is possible to interact (fetch balances, create transfers, etc.) with an FA1.2 and FA2 smart contracts using the `TezosFA12Protocol` and `TezosFA2Protocol` classes. An example on how to use them can be found in `examples/custom/protocols/tezos/fa2-smart-contract.ts`.
+
+## Synchronising information between wallet and vault
+
+Such that the system works we need to be able to synchronise wallets. A wallet can be:
+
+- Single Address Wallet
+- HD Wallet
+
+For the single address wallet we only need to share the public key. For HD Wallet we need to share the extended public key.
+
+## Getting started
+
+### Requirements
+
+```
+npm >= 6
+NodeJS >= 12
+```
+
+Build dependencies get installed using `npm install`.
+
+### Clone and Run
+
+```
+$ git clone https://github.com/airgap-it/airgap-coin-lib.git
+$ cd airgap-coin-lib
+$ npm install
+```
+
+To run the tests, you will have to install the test dependencies
+
+```
+$ npm run install-test-dependencies
+$ npm test
+```
+
+To remove the test dependencies and clean up the `package.json` and `package-lock.json`, execute this command
+
+```
+$ npm run install-build-dependencies
+```
+
+### Contributing
+
+We welcome contributions from the community. Simple readme updates or bugfixes can be addressed with a PR directly.
+
+For larger changes like new protocols, new features or larger refactorings, please contact us first by opening an issue. This project is under constant development and until version `1.x.x` has been reached, there will be frequent breaking changes. So make sure to take a look at the `develop` branch.
+
+Regarding new protocols / currencies, we cannot guarantee that they will be merged, but we're more than happy to discuss the details of a specific integration in a github issue.

package/v0/index.d.ts

@@ -0,0 +1,14 @@
+import { BitcoinAddress } from './protocol/BitcoinAddress';
+import { BitcoinCryptoClient } from './protocol/BitcoinCryptoClient';
+import { BitcoinProtocol } from './protocol/BitcoinProtocol';
+import { BitcoinProtocolConfig, BitcoinProtocolNetwork, BitcoinProtocolNetworkExtras, BitcoinProtocolOptions, BlockcypherBlockExplorer } from './protocol/BitcoinProtocolOptions';
+import { BitcoinSegwitAddress } from './protocol/BitcoinSegwitAddress';
+import { BitcoinSegwitProtocol } from './protocol/BitcoinSegwitProtocol';
+import { BitcoinTestnetProtocol } from './protocol/BitcoinTestnetProtocol';
+import { SignedBitcoinTransaction } from './types/signed-transaction-bitcoin';
+import { SignedBitcoinSegwitTransaction } from './types/signed-transaction-bitcoin-segwit';
+import { RawBitcoinSegwitTransaction, RawBitcoinTransaction } from './types/transaction-bitcoin';
+import { UnsignedBitcoinTransaction } from './types/unsigned-transaction-bitcoin';
+import { UnsignedBitcoinSegwitTransaction } from './types/unsigned-transaction-bitcoin-segwit';
+export { BitcoinProtocol, BitcoinTestnetProtocol, BitcoinCryptoClient, BitcoinProtocolNetworkExtras, BlockcypherBlockExplorer, BitcoinProtocolNetwork, BitcoinProtocolConfig, BitcoinProtocolOptions, BitcoinAddress, RawBitcoinTransaction, UnsignedBitcoinTransaction, UnsignedBitcoinSegwitTransaction, SignedBitcoinTransaction, SignedBitcoinSegwitTransaction };
+export { BitcoinSegwitProtocol, BitcoinSegwitAddress, RawBitcoinSegwitTransaction };

package/v0/index.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BitcoinSegwitAddress = exports.BitcoinSegwitProtocol = exports.BitcoinAddress = exports.BitcoinProtocolOptions = exports.BitcoinProtocolConfig = exports.BitcoinProtocolNetwork = exports.BlockcypherBlockExplorer = exports.BitcoinProtocolNetworkExtras = exports.BitcoinCryptoClient = exports.BitcoinTestnetProtocol = exports.BitcoinProtocol = void 0;
+var coinlib_core_1 = require("@wallfree-dev/coinlib-core");
+var serializer_1 = require("@wallfree-dev/serializer");
+var BitcoinAddress_1 = require("./protocol/BitcoinAddress");
+Object.defineProperty(exports, "BitcoinAddress", { enumerable: true, get: function () { return BitcoinAddress_1.BitcoinAddress; } });
+var BitcoinCryptoClient_1 = require("./protocol/BitcoinCryptoClient");
+Object.defineProperty(exports, "BitcoinCryptoClient", { enumerable: true, get: function () { return BitcoinCryptoClient_1.BitcoinCryptoClient; } });
+var BitcoinProtocol_1 = require("./protocol/BitcoinProtocol");
+Object.defineProperty(exports, "BitcoinProtocol", { enumerable: true, get: function () { return BitcoinProtocol_1.BitcoinProtocol; } });
+var BitcoinProtocolOptions_1 = require("./protocol/BitcoinProtocolOptions");
+Object.defineProperty(exports, "BitcoinProtocolConfig", { enumerable: true, get: function () { return BitcoinProtocolOptions_1.BitcoinProtocolConfig; } });
+Object.defineProperty(exports, "BitcoinProtocolNetwork", { enumerable: true, get: function () { return BitcoinProtocolOptions_1.BitcoinProtocolNetwork; } });
+Object.defineProperty(exports, "BitcoinProtocolNetworkExtras", { enumerable: true, get: function () { return BitcoinProtocolOptions_1.BitcoinProtocolNetworkExtras; } });
+Object.defineProperty(exports, "BitcoinProtocolOptions", { enumerable: true, get: function () { return BitcoinProtocolOptions_1.BitcoinProtocolOptions; } });
+Object.defineProperty(exports, "BlockcypherBlockExplorer", { enumerable: true, get: function () { return BitcoinProtocolOptions_1.BlockcypherBlockExplorer; } });
+var BitcoinSegwitAddress_1 = require("./protocol/BitcoinSegwitAddress");
+Object.defineProperty(exports, "BitcoinSegwitAddress", { enumerable: true, get: function () { return BitcoinSegwitAddress_1.BitcoinSegwitAddress; } });
+var BitcoinSegwitProtocol_1 = require("./protocol/BitcoinSegwitProtocol");
+Object.defineProperty(exports, "BitcoinSegwitProtocol", { enumerable: true, get: function () { return BitcoinSegwitProtocol_1.BitcoinSegwitProtocol; } });
+var BitcoinTestnetProtocol_1 = require("./protocol/BitcoinTestnetProtocol");
+Object.defineProperty(exports, "BitcoinTestnetProtocol", { enumerable: true, get: function () { return BitcoinTestnetProtocol_1.BitcoinTestnetProtocol; } });
+var transaction_validator_1 = require("./serializer/validators/transaction-validator");
+// Serializer
+serializer_1.SerializerV3.addSchema(serializer_1.IACMessageType.TransactionSignRequest, { schema: require('./serializer/schemas/v3/transaction-sign-request-bitcoin-segwit.json') }, coinlib_core_1.MainProtocolSymbols.BTC_SEGWIT);
+serializer_1.SerializerV3.addSchema(serializer_1.IACMessageType.TransactionSignResponse, { schema: require('./serializer/schemas/v3/transaction-sign-response-bitcoin-segwit.json') }, coinlib_core_1.MainProtocolSymbols.BTC_SEGWIT);
+serializer_1.Serializer.addSchema(serializer_1.IACMessageType.TransactionSignRequest, { schema: require('./serializer/schemas/v2/transaction-sign-request-bitcoin.json') }, coinlib_core_1.MainProtocolSymbols.BTC);
+serializer_1.Serializer.addSchema(serializer_1.IACMessageType.TransactionSignResponse, { schema: require('./serializer/schemas/v2/transaction-sign-response-bitcoin.json') }, coinlib_core_1.MainProtocolSymbols.BTC);
+serializer_1.SerializerV3.addSchema(serializer_1.IACMessageType.TransactionSignRequest, { schema: require('./serializer/schemas/v3/transaction-sign-request-bitcoin.json') }, coinlib_core_1.MainProtocolSymbols.BTC);
+serializer_1.SerializerV3.addSchema(serializer_1.IACMessageType.TransactionSignResponse, { schema: require('./serializer/schemas/v3/transaction-sign-response-bitcoin.json') }, coinlib_core_1.MainProtocolSymbols.BTC);
+serializer_1.Serializer.addValidator(coinlib_core_1.MainProtocolSymbols.BTC, new transaction_validator_1.BitcoinTransactionValidatorFactoryV2());
+serializer_1.SerializerV3.addValidator(coinlib_core_1.MainProtocolSymbols.BTC, new transaction_validator_1.BitcoinTransactionValidatorFactory());
+//# sourceMappingURL=index.js.map

package/v0/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/v0/index.ts"],"names":[],"mappings":";;;AAAA,2DAAgE;AAChE,uDAAmF;AAEnF,4DAA0D;AA6BxD,+FA7BO,+BAAc,OA6BP;AA5BhB,sEAAoE;AAsBlE,oGAtBO,yCAAmB,OAsBP;AArBrB,8DAA4D;AAmB1D,gGAnBO,iCAAe,OAmBP;AAlBjB,4EAM0C;AAkBxC,sGAvBA,8CAAqB,OAuBA;AADrB,uGArBA,+CAAsB,OAqBA;AAFtB,6GAlBA,qDAA4B,OAkBA;AAI5B,uGArBA,+CAAsB,OAqBA;AAHtB,yGAjBA,iDAAwB,OAiBA;AAf1B,wEAAsE;AA4BtC,qGA5BvB,2CAAoB,OA4BuB;AA3BpD,0EAAwE;AA2B/D,sGA3BA,6CAAqB,OA2BA;AA1B9B,4EAA0E;AAUxE,uGAVO,+CAAsB,OAUP;AATxB,uFAAwI;AA2BxI,aAAa;AAEb,yBAAY,CAAC,SAAS,CACpB,2BAAc,CAAC,sBAAsB,EACrC,EAAE,MAAM,EAAE,OAAO,CAAC,sEAAsE,CAAC,EAAE,EAC3F,kCAAmB,CAAC,UAAU,CAC/B,CAAA;AACD,yBAAY,CAAC,SAAS,CACpB,2BAAc,CAAC,uBAAuB,EACtC,EAAE,MAAM,EAAE,OAAO,CAAC,uEAAuE,CAAC,EAAE,EAC5F,kCAAmB,CAAC,UAAU,CAC/B,CAAA;AAED,uBAAU,CAAC,SAAS,CAClB,2BAAc,CAAC,sBAAsB,EACrC,EAAE,MAAM,EAAE,OAAO,CAAC,+DAA+D,CAAC,EAAE,EACpF,kCAAmB,CAAC,GAAG,CACxB,CAAA;AACD,uBAAU,CAAC,SAAS,CAClB,2BAAc,CAAC,uBAAuB,EACtC,EAAE,MAAM,EAAE,OAAO,CAAC,gEAAgE,CAAC,EAAE,EACrF,kCAAmB,CAAC,GAAG,CACxB,CAAA;AAED,yBAAY,CAAC,SAAS,CACpB,2BAAc,CAAC,sBAAsB,EACrC,EAAE,MAAM,EAAE,OAAO,CAAC,+DAA+D,CAAC,EAAE,EACpF,kCAAmB,CAAC,GAAG,CACxB,CAAA;AACD,yBAAY,CAAC,SAAS,CACpB,2BAAc,CAAC,uBAAuB,EACtC,EAAE,MAAM,EAAE,OAAO,CAAC,gEAAgE,CAAC,EAAE,EACrF,kCAAmB,CAAC,GAAG,CACxB,CAAA;AAED,uBAAU,CAAC,YAAY,CAAC,kCAAmB,CAAC,GAAG,EAAE,IAAI,4DAAoC,EAAE,CAAC,CAAA;AAC5F,yBAAY,CAAC,YAAY,CAAC,kCAAmB,CAAC,GAAG,EAAE,IAAI,0DAAkC,EAAE,CAAC,CAAA"}

package/v0/protocol/BitcoinAddress.d.ts

@@ -0,0 +1,9 @@
+import { IAirGapAddress } from '@wallfree-dev/coinlib-core/interfaces/IAirGapAddress';
+export declare class BitcoinAddress implements IAirGapAddress {
+    protected readonly value: string;
+    readonly visibilityDerivationIndex?: number | undefined;
+    readonly addressDerivationIndex?: number | undefined;
+    constructor(value: string, visibilityDerivationIndex?: number | undefined, addressDerivationIndex?: number | undefined);
+    static from(node: any, visibilityDerivationIndex?: number, addressDerivationIndex?: number): BitcoinAddress;
+    asString(): string;
+}

package/v0/protocol/BitcoinAddress.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BitcoinAddress = void 0;
+var BitcoinAddress = /** @class */ (function () {
+    // TODO: types
+    function BitcoinAddress(value, visibilityDerivationIndex, addressDerivationIndex) {
+        this.value = value;
+        this.visibilityDerivationIndex = visibilityDerivationIndex;
+        this.addressDerivationIndex = addressDerivationIndex;
+    }
+    BitcoinAddress.from = function (node, visibilityDerivationIndex, addressDerivationIndex) {
+        var _node = visibilityDerivationIndex !== undefined && addressDerivationIndex !== undefined
+            ? node.derive(visibilityDerivationIndex).derive(addressDerivationIndex)
+            : node;
+        return new BitcoinAddress(_node.getAddress(), visibilityDerivationIndex, addressDerivationIndex);
+    };
+    BitcoinAddress.prototype.asString = function () {
+        return this.value;
+    };
+    return BitcoinAddress;
+}());
+exports.BitcoinAddress = BitcoinAddress;
+//# sourceMappingURL=BitcoinAddress.js.map

package/v0/protocol/BitcoinAddress.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BitcoinAddress.js","sourceRoot":"","sources":["../../../src/v0/protocol/BitcoinAddress.ts"],"names":[],"mappings":";;;AAEA;IACE,cAAc;IACd,wBACqB,KAAa,EAChB,yBAAkC,EAClC,sBAA+B;QAF5B,UAAK,GAAL,KAAK,CAAQ;QAChB,8BAAyB,GAAzB,yBAAyB,CAAS;QAClC,2BAAsB,GAAtB,sBAAsB,CAAS;IAC9C,CAAC;IAEU,mBAAI,GAAlB,UAAmB,IAAS,EAAE,yBAAkC,EAAE,sBAA+B;QAC/F,IAAM,KAAK,GACT,yBAAyB,KAAK,SAAS,IAAI,sBAAsB,KAAK,SAAS;YAC7E,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,sBAAsB,CAAC;YACvE,CAAC,CAAC,IAAI,CAAA;QAEV,OAAO,IAAI,cAAc,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,yBAAyB,EAAE,sBAAsB,CAAC,CAAA;IAClG,CAAC;IAEM,iCAAQ,GAAf;QACE,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IACH,qBAAC;AAAD,CAAC,AApBD,IAoBC;AApBY,wCAAc"}

package/v0/protocol/BitcoinCryptoClient.d.ts

@@ -0,0 +1,11 @@
+import { ICoinProtocol } from '@wallfree-dev/coinlib-core';
+import { Secp256k1CryptoClient } from '@wallfree-dev/coinlib-core/protocols/Secp256k1CryptoClient';
+export declare class BitcoinCryptoClient extends Secp256k1CryptoClient {
+    private readonly protocol;
+    private readonly bitcoinJSMessage;
+    constructor(protocol: ICoinProtocol, bitcoinJSMessage: any);
+    signMessage(message: string, keypair: {
+        privateKey: string;
+    }): Promise<string>;
+    verifyMessage(message: string, signature: string, publicKey: string): Promise<boolean>;
+}

package/v0/protocol/BitcoinCryptoClient.js

@@ -0,0 +1,91 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BitcoinCryptoClient = void 0;
+var Secp256k1CryptoClient_1 = require("@wallfree-dev/coinlib-core/protocols/Secp256k1CryptoClient");
+var BitcoinCryptoClient = /** @class */ (function (_super) {
+    __extends(BitcoinCryptoClient, _super);
+    function BitcoinCryptoClient(protocol, bitcoinJSMessage) {
+        var _this = _super.call(this) || this;
+        _this.protocol = protocol;
+        _this.bitcoinJSMessage = bitcoinJSMessage;
+        return _this;
+    }
+    BitcoinCryptoClient.prototype.signMessage = function (message, keypair) {
+        return __awaiter(this, void 0, void 0, function () {
+            var signature;
+            return __generator(this, function (_a) {
+                signature = this.bitcoinJSMessage.sign(message, Buffer.from(keypair.privateKey, 'hex'), true);
+                return [2 /*return*/, signature.toString('base64')];
+            });
+        });
+    };
+    BitcoinCryptoClient.prototype.verifyMessage = function (message, signature, publicKey) {
+        return __awaiter(this, void 0, void 0, function () {
+            var rawSignature, address;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        rawSignature = Buffer.from(signature, 'base64');
+                        return [4 /*yield*/, this.protocol.getAddressFromPublicKey(publicKey)];
+                    case 1:
+                        address = _a.sent();
+                        return [2 /*return*/, this.bitcoinJSMessage.verify(message, address.address, rawSignature)];
+                }
+            });
+        });
+    };
+    return BitcoinCryptoClient;
+}(Secp256k1CryptoClient_1.Secp256k1CryptoClient));
+exports.BitcoinCryptoClient = BitcoinCryptoClient;
+//# sourceMappingURL=BitcoinCryptoClient.js.map

package/v0/protocol/BitcoinCryptoClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BitcoinCryptoClient.js","sourceRoot":"","sources":["../../../src/v0/protocol/BitcoinCryptoClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,oGAAkG;AAElG;IAAyC,uCAAqB;IAC5D,6BAA6B,QAAuB,EAAmB,gBAAqB;QAA5F,YACE,iBAAO,SACR;QAF4B,cAAQ,GAAR,QAAQ,CAAe;QAAmB,sBAAgB,GAAhB,gBAAgB,CAAK;;IAE5F,CAAC;IAEY,yCAAW,GAAxB,UAAyB,OAAe,EAAE,OAA+B;;;;gBACjE,SAAS,GAAW,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,CAAA;gBAE3G,sBAAO,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAA;;;KACpC;IAEY,2CAAa,GAA1B,UAA2B,OAAe,EAAE,SAAiB,EAAE,SAAiB;;;;;;wBACxE,YAAY,GAAW,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAA;wBAE7C,qBAAM,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,EAAA;;wBAAhE,OAAO,GAAG,SAAsD;wBAEtE,sBAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,YAAY,CAAC,EAAA;;;;KAC5E;IACH,0BAAC;AAAD,CAAC,AAlBD,CAAyC,6CAAqB,GAkB7D;AAlBY,kDAAmB"}

package/v0/protocol/BitcoinProtocol.d.ts

@@ -0,0 +1,168 @@
+import { UnsignedTransaction } from '@wallfree-dev/coinlib-core';
+import { IAirGapSignedTransaction } from '@wallfree-dev/coinlib-core/interfaces/IAirGapSignedTransaction';
+import { AirGapTransactionStatus, IAirGapTransaction } from '@wallfree-dev/coinlib-core/interfaces/IAirGapTransaction';
+import { CurrencyUnit, FeeDefaults, ICoinProtocol } from '@wallfree-dev/coinlib-core/protocols/ICoinProtocol';
+import { ICoinSubProtocol } from '@wallfree-dev/coinlib-core/protocols/ICoinSubProtocol';
+import { ProtocolSymbols } from '@wallfree-dev/coinlib-core/utils/ProtocolSymbols';
+import { SignedBitcoinTransaction } from '../types/signed-transaction-bitcoin';
+import { RawBitcoinTransaction } from '../types/transaction-bitcoin';
+import { BitcoinCryptoClient } from './BitcoinCryptoClient';
+import { BitcoinProtocolOptions } from './BitcoinProtocolOptions';
+import { BitcoinAddressCursor, BitcoinAddressResult, BitcoinBlockbookTransactionCursor, BitcoinBlockbookTransactionResult } from './BitcoinTypes';
+export interface UTXOResponse {
+    txid: string;
+    vout: number;
+    value: string;
+    height: number;
+    confirmations: number;
+    address: string;
+    path: string;
+}
+export interface Vin {
+    txid: string;
+    sequence: any;
+    n: number;
+    addresses: string[];
+    value: string;
+    hex: string;
+}
+export interface Vout {
+    value: string;
+    n: number;
+    hex: string;
+    addresses: string[];
+    spent?: boolean;
+}
+export interface Transaction {
+    txid: string;
+    version: number;
+    vin: Vin[];
+    vout: Vout[];
+    blockhash: string;
+    blockHeight: number;
+    confirmations: number;
+    blockTime: number;
+    value: string;
+    valueIn: string;
+    fees: string;
+    hex: string;
+}
+export interface Token {
+    type: string;
+    name: string;
+    path: string;
+    transfers: number;
+    decimals: number;
+    balance: string;
+    totalReceived: string;
+    totalSent: string;
+}
+export interface XPubResponse {
+    page: number;
+    totalPages: number;
+    itemsOnPage: number;
+    address: string;
+    balance: string;
+    totalReceived: string;
+    totalSent: string;
+    unconfirmedBalance: string;
+    unconfirmedTxs: number;
+    txs: number;
+    transactions?: Transaction[];
+    totalTokens?: number;
+    tokens?: Token[];
+}
+export interface AddressResponse {
+    page: number;
+    totalPages: number;
+    itemsOnPage: number;
+    address: string;
+    balance: string;
+    totalReceived: string;
+    totalSent: string;
+    unconfirmedBalance: string;
+    unconfirmedTxs: number;
+    txs: number;
+    transactions?: Transaction[];
+}
+export declare class BitcoinProtocol implements ICoinProtocol {
+    readonly options: BitcoinProtocolOptions;
+    symbol: string;
+    name: string;
+    marketSymbol: string;
+    feeSymbol: string;
+    feeDefaults: FeeDefaults;
+    decimals: number;
+    feeDecimals: number;
+    identifier: ProtocolSymbols;
+    units: CurrencyUnit[];
+    supportsHD: boolean;
+    standardDerivationPath: string;
+    addressIsCaseSensitive: boolean;
+    addressValidationPattern: string;
+    addressPlaceholder: string;
+    readonly cryptoClient: BitcoinCryptoClient;
+    constructor(options?: BitcoinProtocolOptions);
+    getSymbol(): Promise<string>;
+    getName(): Promise<string>;
+    getMarketSymbol(): Promise<string>;
+    getAssetSymbol(): Promise<string | undefined>;
+    getFeeSymbol(): Promise<string>;
+    getFeeDefaults(): Promise<FeeDefaults>;
+    getDecimals(): Promise<number>;
+    getFeeDecimals(): Promise<number>;
+    getIdentifier(): Promise<ProtocolSymbols>;
+    getUnits(): Promise<CurrencyUnit[]>;
+    getSupportsHD(): Promise<boolean>;
+    getStandardDerivationPath(): Promise<string>;
+    getAddressIsCaseSensitive(): Promise<boolean>;
+    getAddressValidationPattern(): Promise<string>;
+    getAddressPlaceholder(): Promise<string>;
+    getOptions(): Promise<BitcoinProtocolOptions>;
+    getBlockExplorerLinkForAddress(address: string): Promise<string>;
+    getBlockExplorerLinkForTxId(txId: string): Promise<string>;
+    getPublicKeyFromMnemonic(mnemonic: string, derivationPath: string, password?: string): Promise<string>;
+    getPrivateKeyFromMnemonic(mnemonic: string, derivationPath: string, password?: string): Promise<string>;
+    getExtendedPublicKeyFromMnemonic(mnemonic: string, derivationPath: string, password?: string | undefined): Promise<string>;
+    getExtendedPrivateKeyFromMnemonic(mnemonic: string, derivationPath: string, password?: string): Promise<string>;
+    getPublicKeyFromHexSecret(secret: string, derivationPath: string): Promise<string>;
+    getPrivateKeyFromHexSecret(secret: string, derivationPath: string): Promise<string>;
+    getExtendedPublicKeyFromHexSecret(secret: string, derivationPath: string): Promise<string>;
+    getExtendedPrivateKeyFromHexSecret(secret: string, derivationPath: string): Promise<string>;
+    getAddressFromPublicKey(publicKey: string, cursor?: BitcoinAddressCursor): Promise<BitcoinAddressResult>;
+    getAddressesFromPublicKey(publicKey: string, cursor?: BitcoinAddressCursor): Promise<BitcoinAddressResult[]>;
+    getAddressFromExtendedPublicKey(extendedPublicKey: string, visibilityDerivationIndex: number, addressDerivationIndex: number): Promise<BitcoinAddressResult>;
+    getAddressesFromExtendedPublicKey(extendedPublicKey: string, visibilityDerivationIndex: number, addressCount: number, offset: number): Promise<BitcoinAddressResult[]>;
+    signWithPrivateKey(privateKey: string, transaction: RawBitcoinTransaction): Promise<IAirGapSignedTransaction>;
+    signWithExtendedPrivateKey(extendedPrivateKey: string, transaction: RawBitcoinTransaction): Promise<string>;
+    getTransactionDetails(unsignedTx: UnsignedTransaction): Promise<IAirGapTransaction[]>;
+    getTransactionDetailsFromSigned(signedTx: SignedBitcoinTransaction): Promise<IAirGapTransaction[]>;
+    getBalanceOfAddresses(addresses: string[]): Promise<string>;
+    getBalanceOfPublicKey(publicKey: string): Promise<string>;
+    getBalanceOfExtendedPublicKey(extendedPublicKey: string, offset?: number): Promise<string>;
+    getBalanceOfPublicKeyForSubProtocols(publicKey: string, subProtocols: ICoinSubProtocol[]): Promise<string[]>;
+    getAvailableBalanceOfAddresses(addresses: string[]): Promise<string>;
+    estimateMaxTransactionValueFromExtendedPublicKey(extendedPublicKey: string, recipients: string[], fee?: string): Promise<string>;
+    estimateMaxTransactionValueFromPublicKey(publicKey: string, recipients: string[], fee?: string): Promise<string>;
+    estimateFeeDefaultsFromExtendedPublicKey(publicKey: string, recipients: string[], values: string[], data?: any): Promise<FeeDefaults>;
+    estimateFeeDefaultsFromPublicKey(publicKey: string, recipients: string[], values: string[], data?: any): Promise<FeeDefaults>;
+    prepareTransactionFromExtendedPublicKey(extendedPublicKey: string, offset: number, recipients: string[], values: string[], fee: string, extras: unknown): Promise<RawBitcoinTransaction>;
+    prepareTransactionFromPublicKey(publicKey: string, recipients: string[], values: string[], fee: string): Promise<RawBitcoinTransaction>;
+    broadcastTransaction(rawTransaction: string): Promise<string>;
+    getTransactionsFromExtendedPublicKey(extendedPublicKey: string, limit: number, cursor?: BitcoinBlockbookTransactionCursor, addressOffset?: number): Promise<BitcoinBlockbookTransactionResult>;
+    getTransactionsFromPublicKey(publicKey: string, limit: number, cursor?: BitcoinBlockbookTransactionCursor): Promise<BitcoinBlockbookTransactionResult>;
+    getTransactionsFromAddresses(addresses: string[], limit: number, cursor?: BitcoinBlockbookTransactionCursor): Promise<BitcoinBlockbookTransactionResult>;
+    private containsSome;
+    signMessage(message: string, keypair: {
+        privateKey: string;
+    }): Promise<string>;
+    verifyMessage(message: string, signature: string, publicKey: string): Promise<boolean>;
+    encryptAsymmetric(message: string, publicKey: string): Promise<string>;
+    decryptAsymmetric(message: string, keypair: {
+        publicKey: string;
+        privateKey: string;
+    }): Promise<string>;
+    encryptAES(message: string, privateKey: string): Promise<string>;
+    decryptAES(message: string, privateKey: string): Promise<string>;
+    getTransactionStatuses(transactionHashes: string[]): Promise<AirGapTransactionStatus[]>;
+}