💥 breaking: isolate into standalone project

Migrate the bitcoin-related dependencies from `chainify` and create a unified `bitcoin-abstraction-layer` project

Author: zpv

.changeset/healthy-lizards-explode.md

@@ -0,0 +1,19 @@
+---
+'@atomicfinance/bitcoin-cfd-provider': major
+'@atomicfinance/bitcoin-dlc-provider': major
+'@atomicfinance/bitcoin-networks': major
+'@atomicfinance/bitcoin-wallet-provider': major
+'@atomicfinance/client': major
+'@atomicfinance/provider': major
+'@atomicfinance/types': major
+'@atomicfinance/bitcoin-esplora-api-provider': major
+'@atomicfinance/bitcoin-esplora-batch-api-provider': major
+'@atomicfinance/bitcoin-js-wallet-provider': major
+'@atomicfinance/bitcoin-utils': major
+'@atomicfinance/crypto': major
+'@atomicfinance/errors': major
+'@atomicfinance/node-provider': major
+'@atomicfinance/utils': major
+---
+
+Create unified standalone `bitcoin-abstraction-layer` package

.gitignore

@@ -16,9 +16,6 @@
 
 .DS_Store
 
-/packages/**/lib/*.d.ts
-/packages/**/lib/models/*.d.ts
-/packages/**/lib/utils/*.d.ts
 
 /packages/**/lib/*.js
 /packages/**/lib/models/*.js

README.md

@@ -1,12 +1,12 @@
-# Chainify Finance
+# Bitcoin Abstraction Layer
 
 > :warning: This project is under heavy development. Expect bugs & breaking changes.
 
 Query different blockchains with account management using a single and simple interface.
 
 ## Dependencies
 
-This repository was built as an extension to the [Chainify](https://github.com/liquality/chainify) maintained by the core contributors of [Liquality](https://liquality.io). It is necessary to include the `Client` and `providers` from the `@liquality` npm packages in order to use providers such as the `BitcoinDlcProvider`.
+This repository is a standalone project based off of [Chainify](https://github.com/liquality/chainify), with heavy modifications to the core Bitcoin wallet libaries. There are no dependencies on the upstream project.
 
 ## Chain Support
 
@@ -20,13 +20,22 @@ This repository was built as an extension to the [Chainify](https://github.com/l
 
 |Package|Version|
 |---|---|
-|[@atomicfinance/bitcoin-cfd-provider](./packages/bitcoin-cfd-provider)|[![Chainify-Finance](https://img.shields.io/npm/v/@atomicfinance/bitcoin-cfd-provider.svg)](https://npmjs.com/package/@atomicfinance/bitcoin-cfd-provider)|
-|[@atomicfinance/bitcoin-dlc-provider](./packages/bitcoin-dlc-provider)|[![Chainify-Finance](https://img.shields.io/npm/v/@atomicfinance/bitcoin-dlc-provider.svg)](https://npmjs.com/package/@atomicfinance/bitcoin-dlc-provider)|
-|[@atomicfinance/bitcoin-wallet-provider](./packages/bitcoin-wallet-provider)|[![Chainify-Finance](https://img.shields.io/npm/v/@atomicfinance/bitcoin-wallet-provider.svg)](https://npmjs.com/package/@atomicfinance/bitcoin-wallet-provider)|
-|[@atomicfinance/bitcoin-networks](./packages/bitcoin-networks)|[![Chainify-Finance](https://img.shields.io/npm/v/@atomicfinance/bitcoin-networks.svg)](https://npmjs.com/package/@atomicfinance/bitcoin-networks)|
-|[@atomicfinance/client](./packages/client)|[![Chainify-Finance](https://img.shields.io/npm/v/@atomicfinance/client.svg)](https://npmjs.com/package/@atomicfinance/client)|
-|[@atomicfinance/provider](./packages/provider)|[![Chainify-Finance](https://img.shields.io/npm/v/@atomicfinance/provider.svg)](https://npmjs.com/package/@atomicfinance/provider)
-|[@atomicfinance/types](./packages/types)|[![Chainify-Finance](https://img.shields.io/npm/v/@atomicfinance/types.svg)](https://npmjs.com/package/@atomicfinance/types)
+|[@atomicfinance/bitcoin-cfd-provider](./packages/bitcoin-cfd-provider)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/bitcoin-cfd-provider.svg)](https://npmjs.com/package/@atomicfinance/bitcoin-cfd-provider)|
+|[@atomicfinance/bitcoin-dlc-provider](./packages/bitcoin-dlc-provider)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/bitcoin-dlc-provider.svg)](https://npmjs.com/package/@atomicfinance/bitcoin-dlc-provider)|
+|[@atomicfinance/bitcoin-esplora-api-provider](./packages/bitcoin-esplora-api-provider)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/bitcoin-esplora-api-provider.svg)](https://npmjs.com/package/@atomicfinance/bitcoin-esplora-api-provider)
+|[@atomicfinance/bitcoin-esplora-batch-api-provider](./packages/bitcoin-esplora-batch-api-provider)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/bitcoin-esplora-batch-api-provider.svg)](https://npmjs.com/package/@atomicfinance/bitcoin-esplora-batch-api-provider)
+|[@atomicfinance/bitcoin-js-wallet-provider](./packages/bitcoin-js-wallet-provider)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/bitcoin-js-wallet-provider.svg)](https://npmjs.com/package/@atomicfinance/bitcoin-js-wallet-provider)
+|[@atomicfinance/bitcoin-utils](./packages/bitcoin-utils)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/bitcoin-utils.svg)](https://npmjs.com/package/@atomicfinance/bitcoin-utils)
+|[@atomicfinance/bitcoin-wallet-provider](./packages/bitcoin-wallet-provider)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/bitcoin-wallet-provider.svg)](https://npmjs.com/package/@atomicfinance/bitcoin-wallet-provider)|
+|[@atomicfinance/bitcoin-networks](./packages/bitcoin-networks)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/bitcoin-networks.svg)](https://npmjs.com/package/@atomicfinance/bitcoin-networks)|
+|[@atomicfinance/client](./packages/client)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/client.svg)](https://npmjs.com/package/@atomicfinance/client)|
+|[@atomicfinance/provider](./packages/provider)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/provider.svg)](https://npmjs.com/package/@atomicfinance/provider)
+|[@atomicfinance/types](./packages/types)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/types.svg)](https://npmjs.com/package/@atomicfinance/types)
+|[@atomicfinance/utils](./packages/utils)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/utils.svg)](https://npmjs.com/package/@atomicfinance/utils)
+|[@atomicfinance/crypto](./packages/crypto)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/crypto.svg)](https://npmjs.com/package/@atomicfinance/crypto)
+|[@atomicfinance/errors](./packages/errors)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/errors.svg)](https://npmjs.com/package/@atomicfinance/errors)
+|[@atomicfinance/node-provider](./packages/node-provider)|[![Bitcoin-Abstraction-Layer](https://img.shields.io/npm/v/@atomicfinance/node-provider.svg)](https://npmjs.com/package/@atomicfinance/node-provider)
+
 
 ## DLC Spec Compliance
 
@@ -50,28 +59,26 @@ Missing features:
 
 ## Usage
 
-```javascript
-
-import { Client } from '@liquality/bundle'
-import BitcoinNetworks from '@liquality/bitcoin-networks'
-import BitcoinRpcProvider from '@liquality/bitcoin-rpc-provider'
-import BitcoinJsWalletProvider from '@liquality/bitcoin-js-wallet-provider'
-
-import { Client as FinanceClient } from '@atomicfinance/bundle'
+```typescript
+import Client from '@atomicfinance/client'
 import BitcoinCfdProvider from '@atomicfinance/bitcoin-cfd-provider'
 import BitcoinDlcProvider from '@atomicfinance/bitcoin-dlc-provider'
 import BitcoinWalletProvider from '@atomicfinance/bitcoin-wallet-provider'
+import BitcoinJsWalletProvider from '@atomicfinance/bitcoin-js-wallet-provider'
+import BitcoinNetworks from '@atomicfinance/bitcoin-networks'
 
 const network = BitcoinNetworks.bitcoin_testnet
 
 const bitcoin = new Client()
-const bitcoinFinance = new FinanceClient(bitcoin);
-bitcoin.finance = bitcoinFinance
-bitcoin.addProvider(new BitcoinRpcProvider('https://liquality.io/bitcointestnetrpc/', 'bitcoin', 'local321'))
-bitcoin.addProvider(new BitcoinJsWalletProvider(network, '_insert_mnemonic_', 'bech32'))
-bitcoin.finance.addProvider(new BitcoinCfdProvider(network));
-bitcoin.finance.addProvider(new BitcoinDlcProvider(network));
-bitcoin.finance.addProvider(new BitcoinWalletProvider(network));
+bitcoin.addProvider(new BitcoinJsWalletProvider({
+	network,
+	mnemonic: 'mnemonic_here',
+	baseDerivationPath: `m/84'/${network.coinType}'/0'`,
+	addressType: 'bech32',
+}))
+bitcoin.addProvider(new BitcoinCfdProvider(network));
+bitcoin.addProvider(new BitcoinDlcProvider(network));
+bitcoin.addProvider(new BitcoinWalletProvider(network));
 
 const offerMessage = await alice.dlc.createDlcOffer(...)
 ```

package.json

@@ -6,20 +6,13 @@
   ],
   "devDependencies": {
     "@changesets/cli": "^2.22.0",
-    "@liquality/bitcoin-esplora-api-provider": "^1.4.4",
-    "@liquality/bitcoin-js-wallet-provider": "^1.4.4",
-    "@liquality/bitcoin-networks": "^1.4.4",
     "@liquality/bitcoin-node-wallet-provider": "^1.4.4",
     "@liquality/bitcoin-rpc-provider": "^1.4.4",
-    "@liquality/bitcoin-utils": "^1.4.4",
-    "@liquality/client": "^1.4.4",
-    "@liquality/crypto": "^1.4.4",
-    "@liquality/errors": "^1.4.4",
-    "@liquality/utils": "^1.4.4",
     "@node-dlc/core": "0.18.3",
     "@node-dlc/messaging": "0.18.3",
     "@swc/cli": "^0.1.57",
     "@swc/core": "^1.2.172",
+    "@swc/register": "^0.1.10",
     "@types/chai": "^4.2.12",
     "@types/chai-as-promised": "^7.1.4",
     "@types/mocha": "^8.0.3",
@@ -64,7 +57,9 @@
     "lint": "turbo run lint",
     "lint:fix": "turbo run lint:fix",
     "build": "turbo run build",
-    "test": "nyc --reporter=text --reporter=lcov cross-env NODE_ENV=test mocha --parallel",
+    "test": "yarn run test:unit && yarn run test:integration",
+    "test:unit": "turbo run test",
+    "test:integration": "nyc --reporter=text --reporter=lcov cross-env NODE_ENV=test mocha --parallel",
     "prepublishOnly": "yarn build",
     "changeset": "changeset",
     "version": "yarn changeset version",

packages/bitcoin-cfd-provider/lib/BitcoinCfdProvider.ts

@@ -139,7 +139,7 @@ import {
   VerifySignRequest,
   VerifySignResponse,
 } from '@atomicfinance/types';
-import { sleep } from '@liquality/utils';
+import { sleep } from '@atomicfinance/utils';
 
 export default class BitcoinCfdProvider
   extends Provider

packages/bitcoin-cfd-provider/package.json

@@ -17,7 +17,7 @@
   "dependencies": {
     "@atomicfinance/provider": "^2.5.1",
     "@atomicfinance/types": "^2.5.1",
-    "@liquality/utils": "1.1.5",
+    "@atomicfinance/utils": "^2.5.1",
     "lodash": "^4.17.20"
   },
   "devDependencies": {

packages/bitcoin-dlc-provider/lib/BitcoinDlcProvider.ts

@@ -1,11 +1,16 @@
-import { chainHashFromNetwork } from '@atomicfinance/bitcoin-networks';
+import {
+  BitcoinNetwork,
+  chainHashFromNetwork,
+} from '@atomicfinance/bitcoin-networks';
 import Provider from '@atomicfinance/provider';
 import {
   AdaptorPair,
+  Address,
   AddSignaturesToRefundTxRequest,
   AddSignaturesToRefundTxResponse,
   AddSignatureToFundTransactionRequest,
   AddSignatureToFundTransactionResponse,
+  bitcoin,
   CalculateEcSignatureRequest,
   CreateCetAdaptorSignatureRequest,
   CreateCetAdaptorSignatureResponse,
@@ -44,9 +49,7 @@ import {
   VerifyRefundTxSignatureResponse,
   VerifySignatureRequest,
 } from '@atomicfinance/types';
-import { BitcoinNetwork } from '@liquality/bitcoin-networks';
-import { Address, bitcoin } from '@liquality/types';
-import { sleep } from '@liquality/utils';
+import { sleep } from '@atomicfinance/utils';
 import {
   DualClosingTxFinalizer,
   DualFundingTxFinalizer,
@@ -647,9 +650,9 @@ export default class BitcoinDlcProvider
       network,
     );
 
-    const {
-      derivationPath,
-    } = await this.client.financewallet.quickFindAddress([fundingAddress]);
+    const { derivationPath } = await this.client.wallet.findAddress([
+      fundingAddress,
+    ]);
 
     const fundPrivateKeyPair = await this.getMethod('keyPair')(derivationPath);
     const fundPrivateKey = Buffer.from(fundPrivateKeyPair.__D).toString('hex');
@@ -1737,11 +1740,11 @@ Payout Group not found',
       network,
     );
 
-    let walletAddress: Address = await this.client.financewallet.quickFindAddress(
-      [offerFundingAddress],
-    );
+    let walletAddress: Address = await this.client.wallet.findAddress([
+      offerFundingAddress,
+    ]);
     if (walletAddress) return true;
-    walletAddress = await this.client.financewallet.quickFindAddress([
+    walletAddress = await this.client.wallet.findAddress([
       acceptFundingAddress,
     ]);
     if (walletAddress) return false;
@@ -2950,9 +2953,9 @@ Payout Group not found',
     let derivationPath: string;
 
     if (findDerivationPath) {
-      const inputAddress: Address = await this.client.financewallet.quickFindAddress(
-        [_address],
-      );
+      const inputAddress: Address = await this.client.wallet.findAddress([
+        _address,
+      ]);
       if (inputAddress) {
         derivationPath = inputAddress.derivationPath;
       }
@@ -2992,6 +2995,7 @@ Payout Group not found',
         );
       }
     }
+
     const tx = Tx.decode(StreamReader.fromHex(txRaw));
 
     fundingInput.prevTx = tx;

packages/bitcoin-dlc-provider/package.json

@@ -16,12 +16,10 @@
   },
   "dependencies": {
     "@atomicfinance/bitcoin-networks": "^2.5.1",
+    "@atomicfinance/bitcoin-utils": "2.5.1",
     "@atomicfinance/provider": "^2.5.1",
     "@atomicfinance/types": "^2.5.1",
-    "@liquality/bitcoin-utils": "1.1.5",
-    "@liquality/provider": "1.1.5",
-    "@liquality/types": "1.1.5",
-    "@liquality/utils": "1.1.5",
+    "@atomicfinance/utils": "^2.5.1",
     "@node-dlc/core": "0.18.3",
     "@node-dlc/messaging": "0.18.3",
     "@node-lightning/bitcoin": "0.26.1",