beignet 0.0.1

package/docs/markdown/interfaces/IWallet.md

@@ -0,0 +1,209 @@
+[beignet](../README.md) / IWallet
+
+# Interface: IWallet
+
+## Table of contents
+
+### Properties
+
+- [addressType](IWallet.md#addresstype)
+- [customGetAddress](IWallet.md#customgetaddress)
+- [customGetScriptHash](IWallet.md#customgetscripthash)
+- [data](IWallet.md#data)
+- [electrumOptions](IWallet.md#electrumoptions)
+- [id](IWallet.md#id)
+- [mnemonic](IWallet.md#mnemonic)
+- [name](IWallet.md#name)
+- [network](IWallet.md#network)
+- [onMessage](IWallet.md#onmessage)
+- [passphrase](IWallet.md#passphrase)
+- [rbf](IWallet.md#rbf)
+- [remainOffline](IWallet.md#remainoffline)
+- [selectedFeeId](IWallet.md#selectedfeeid)
+- [storage](IWallet.md#storage)
+
+## Properties
+
+### addressType
+
+• `Optional` **addressType**: [`EAddressType`](../enums/EAddressType.md)
+
+#### Defined in
+
+[types/wallet.ts:187](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L187)
+
+___
+
+### customGetAddress
+
+• `Optional` **customGetAddress**: (`data`: [`ICustomGetAddress`](ICustomGetAddress.md)) => `Promise`\<[`Result`](../README.md#result)\<[`IGetAddressResponse`](IGetAddressResponse.md)\>\>
+
+#### Type declaration
+
+▸ (`data`): `Promise`\<[`Result`](../README.md#result)\<[`IGetAddressResponse`](IGetAddressResponse.md)\>\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`ICustomGetAddress`](ICustomGetAddress.md) |
+
+##### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IGetAddressResponse`](IGetAddressResponse.md)\>\>
+
+#### Defined in
+
+[types/wallet.ts:197](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L197)
+
+___
+
+### customGetScriptHash
+
+• `Optional` **customGetScriptHash**: (`data`: [`ICustomGetScriptHash`](ICustomGetScriptHash.md)) => `Promise`\<`string`\>
+
+#### Type declaration
+
+▸ (`data`): `Promise`\<`string`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`ICustomGetScriptHash`](ICustomGetScriptHash.md) |
+
+##### Returns
+
+`Promise`\<`string`\>
+
+#### Defined in
+
+[types/wallet.ts:200](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L200)
+
+___
+
+### data
+
+• `Optional` **data**: [`IWalletData`](IWalletData.md)
+
+#### Defined in
+
+[types/wallet.ts:188](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L188)
+
+___
+
+### electrumOptions
+
+• `Optional` **electrumOptions**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `net?` | `Server` |
+| `servers?` | [`TServer`](../README.md#tserver) \| [`TServer`](../README.md#tserver)[] |
+| `tls?` | `TLSSocket` |
+
+#### Defined in
+
+[types/wallet.ts:190](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L190)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+#### Defined in
+
+[types/wallet.ts:183](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L183)
+
+___
+
+### mnemonic
+
+• **mnemonic**: `string`
+
+#### Defined in
+
+[types/wallet.ts:182](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L182)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Defined in
+
+[types/wallet.ts:184](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L184)
+
+___
+
+### network
+
+• `Optional` **network**: [`EAvailableNetworks`](../enums/EAvailableNetworks.md)
+
+#### Defined in
+
+[types/wallet.ts:186](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L186)
+
+___
+
+### onMessage
+
+• `Optional` **onMessage**: [`TOnMessage`](../README.md#tonmessage)
+
+#### Defined in
+
+[types/wallet.ts:196](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L196)
+
+___
+
+### passphrase
+
+• `Optional` **passphrase**: `string`
+
+#### Defined in
+
+[types/wallet.ts:185](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L185)
+
+___
+
+### rbf
+
+• `Optional` **rbf**: `boolean`
+
+#### Defined in
+
+[types/wallet.ts:201](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L201)
+
+___
+
+### remainOffline
+
+• `Optional` **remainOffline**: `boolean`
+
+#### Defined in
+
+[types/wallet.ts:195](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L195)
+
+___
+
+### selectedFeeId
+
+• `Optional` **selectedFeeId**: [`EFeeId`](../enums/EFeeId.md)
+
+#### Defined in
+
+[types/wallet.ts:202](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L202)
+
+___
+
+### storage
+
+• `Optional` **storage**: [`TStorage`](../README.md#tstorage)
+
+#### Defined in
+
+[types/wallet.ts:189](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L189)

package/docs/markdown/interfaces/IWalletData.md

@@ -0,0 +1,217 @@
+[beignet](../README.md) / IWalletData
+
+# Interface: IWalletData
+
+## Table of contents
+
+### Properties
+
+- [addressIndex](IWalletData.md#addressindex)
+- [addressType](IWalletData.md#addresstype)
+- [addresses](IWalletData.md#addresses)
+- [balance](IWalletData.md#balance)
+- [blacklistedUtxos](IWalletData.md#blacklistedutxos)
+- [boostedTransactions](IWalletData.md#boostedtransactions)
+- [changeAddressIndex](IWalletData.md#changeaddressindex)
+- [changeAddresses](IWalletData.md#changeaddresses)
+- [exchangeRates](IWalletData.md#exchangerates)
+- [feeEstimates](IWalletData.md#feeestimates)
+- [header](IWalletData.md#header)
+- [id](IWalletData.md#id)
+- [lastUsedAddressIndex](IWalletData.md#lastusedaddressindex)
+- [lastUsedChangeAddressIndex](IWalletData.md#lastusedchangeaddressindex)
+- [selectedFeeId](IWalletData.md#selectedfeeid)
+- [transaction](IWalletData.md#transaction)
+- [transactions](IWalletData.md#transactions)
+- [unconfirmedTransactions](IWalletData.md#unconfirmedtransactions)
+- [utxos](IWalletData.md#utxos)
+
+## Properties
+
+### addressIndex
+
+• **addressIndex**: [`TAddressTypeContent`](../README.md#taddresstypecontent)\<[`IAddress`](IAddress.md)\>
+
+#### Defined in
+
+[types/wallet.ts:155](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L155)
+
+___
+
+### addressType
+
+• **addressType**: [`EAddressType`](../enums/EAddressType.md)
+
+#### Defined in
+
+[types/wallet.ts:151](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L151)
+
+___
+
+### addresses
+
+• **addresses**: [`TAddressTypeContent`](../README.md#taddresstypecontent)\<[`IAddresses`](IAddresses.md)\>
+
+#### Defined in
+
+[types/wallet.ts:153](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L153)
+
+___
+
+### balance
+
+• **balance**: `number`
+
+#### Defined in
+
+[types/wallet.ts:165](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L165)
+
+___
+
+### blacklistedUtxos
+
+• **blacklistedUtxos**: [`IUtxo`](IUtxo.md)[]
+
+#### Defined in
+
+[types/wallet.ts:160](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L160)
+
+___
+
+### boostedTransactions
+
+• **boostedTransactions**: [`IBoostedTransactions`](IBoostedTransactions.md)
+
+#### Defined in
+
+[types/wallet.ts:163](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L163)
+
+___
+
+### changeAddressIndex
+
+• **changeAddressIndex**: [`TAddressTypeContent`](../README.md#taddresstypecontent)\<[`IAddress`](IAddress.md)\>
+
+#### Defined in
+
+[types/wallet.ts:156](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L156)
+
+___
+
+### changeAddresses
+
+• **changeAddresses**: [`TAddressTypeContent`](../README.md#taddresstypecontent)\<[`IAddresses`](IAddresses.md)\>
+
+#### Defined in
+
+[types/wallet.ts:154](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L154)
+
+___
+
+### exchangeRates
+
+• **exchangeRates**: [`IExchangeRates`](IExchangeRates.md)
+
+#### Defined in
+
+[types/wallet.ts:167](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L167)
+
+___
+
+### feeEstimates
+
+• **feeEstimates**: [`IOnchainFees`](IOnchainFees.md)
+
+#### Defined in
+
+[types/wallet.ts:168](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L168)
+
+___
+
+### header
+
+• **header**: [`IHeader`](IHeader.md)
+
+#### Defined in
+
+[types/wallet.ts:152](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L152)
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[types/wallet.ts:150](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L150)
+
+___
+
+### lastUsedAddressIndex
+
+• **lastUsedAddressIndex**: [`TAddressTypeContent`](../README.md#taddresstypecontent)\<[`IAddress`](IAddress.md)\>
+
+#### Defined in
+
+[types/wallet.ts:157](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L157)
+
+___
+
+### lastUsedChangeAddressIndex
+
+• **lastUsedChangeAddressIndex**: [`TAddressTypeContent`](../README.md#taddresstypecontent)\<[`IAddress`](IAddress.md)\>
+
+#### Defined in
+
+[types/wallet.ts:158](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L158)
+
+___
+
+### selectedFeeId
+
+• **selectedFeeId**: [`EFeeId`](../enums/EFeeId.md)
+
+#### Defined in
+
+[types/wallet.ts:166](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L166)
+
+___
+
+### transaction
+
+• **transaction**: [`ISendTransaction`](ISendTransaction.md)
+
+#### Defined in
+
+[types/wallet.ts:164](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L164)
+
+___
+
+### transactions
+
+• **transactions**: [`IFormattedTransactions`](IFormattedTransactions.md)
+
+#### Defined in
+
+[types/wallet.ts:162](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L162)
+
+___
+
+### unconfirmedTransactions
+
+• **unconfirmedTransactions**: [`IFormattedTransactions`](IFormattedTransactions.md)
+
+#### Defined in
+
+[types/wallet.ts:161](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L161)
+
+___
+
+### utxos
+
+• **utxos**: [`IUtxo`](IUtxo.md)[]
+
+#### Defined in
+
+[types/wallet.ts:159](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L159)

package/example/helpers.ts

@@ -0,0 +1,76 @@
+import { promises as fs } from 'fs';
+import {
+	TGetData,
+	TSetData,
+	IWalletData,
+	EAvailableNetworks,
+	EProtocol
+} from '../src';
+import { err, Result, ok } from '../src';
+import { getDefaultWalletData } from '../src';
+
+export const getData: TGetData = async <K extends keyof IWalletData>(
+	key: string
+): Promise<Result<IWalletData[K]>> => {
+	try {
+		const data = await fs.readFile(`example/walletData/${key}.json`, 'utf8');
+		const walletData: IWalletData[K] = JSON.parse(data);
+		if (walletData) return ok(walletData);
+		const defaultWalletData = getDefaultWalletData();
+		return ok(defaultWalletData[key]);
+	} catch (e) {
+		const defaultWalletData = getDefaultWalletData();
+		return ok(defaultWalletData[key]);
+	}
+};
+
+export const setData: TSetData = async <K extends keyof IWalletData>(
+	key: string,
+	value: IWalletData[K]
+): Promise<Result<boolean>> => {
+	try {
+		const dir = 'example/walletData';
+		// Ensure that the directory exists
+		await fs.mkdir(dir, { recursive: true });
+
+		await fs.writeFile(`${dir}/${key}.json`, JSON.stringify(value, null, 2));
+		return ok(true);
+	} catch (e) {
+		return err(e);
+	}
+};
+
+export const deleteDirectory = async (
+	dir = 'example/walletData'
+): Promise<void> => {
+	try {
+		await fs.rm(dir, { recursive: true, force: true });
+	} catch (e) {
+		console.error(`Error deleting directory ${dir}: ${e}`);
+	}
+};
+
+export const onMessage = (id, data): void => {
+	console.log(id);
+	console.dir(data, { depth: null });
+};
+
+export const servers = {
+	[EAvailableNetworks.mainnet]: [
+		{
+			host: '35.187.18.233',
+			ssl: 8900,
+			tcp: 8911,
+			protocol: EProtocol.ssl
+		}
+	],
+	[EAvailableNetworks.testnet]: [],
+	[EAvailableNetworks.regtest]: [
+		{
+			host: '35.233.47.252',
+			ssl: 18484,
+			tcp: 18483,
+			protocol: EProtocol.tcp
+		}
+	]
+};

package/example/index.ts

@@ -0,0 +1,77 @@
+import { EAvailableNetworks, Wallet } from '../src';
+import { getData, onMessage, servers, setData } from './helpers';
+import * as repl from 'repl';
+//import { generateMnemonic } from 'bip39';
+//const mnemonic = generateMnemonic();
+
+const mnemonic =
+	'develop under powder delay tunnel kite finger spend deal tiger pluck cherry';
+
+const network: EAvailableNetworks = EAvailableNetworks.regtest;
+
+const runExample = async (): Promise<void> => {
+	// Create Wallet
+	const createWalletResponse = await Wallet.create({
+		mnemonic,
+		onMessage,
+		network,
+		storage: {
+			getData,
+			setData
+		},
+		electrumOptions: {
+			servers: servers[network]
+		}
+	});
+	if (createWalletResponse.isErr()) return;
+	const wallet = createWalletResponse.value;
+
+	// Get the wallet's balance.
+	const balance = wallet.getBalance();
+	console.log('\nBalance: ', balance);
+
+	// Get a receiving address.
+	const address = await wallet.getAddress();
+	console.log('\nAddress:', address);
+
+	// Get fee information to perform a transaction.
+	// const feeInfo = wallet.getFeeInfo({ satsPerByte: 5 });
+	// if (feeInfo.isErr()) return;
+	// console.log('\nFee Info:', feeInfo.value);
+
+	// Get fee estimate in sats for a given satsPerByte to perform a transaction.
+	// This is useful for quickly calculating how many sats are needed to perform a transaction when using a slider.
+	// const txFeeInSats = getTxFee({
+	// 	satsPerByte: 5,
+	// 	transactionByteCount: feeInfo.value.transactionByteCount
+	// });
+	// console.log('\nFee In Sats:', txFeeInSats);
+
+	// Create a transaction.
+	// const sendRes = await wallet.send({
+	// 	address,
+	// 	amount: 5000,
+	// 	satsPerByte: 5,
+	// 	broadcast: false // Mostly set to false for testing, but can also be used to return the raw transaction hex.
+	// });
+	// if (sendRes.isErr()) return;
+	// console.log('\nSend Res:', sendRes.value);
+
+	// Decode the transaction to verify prior to broadcasting.
+	// const decodeRes = decodeRawTransaction(sendRes.value, network);
+	// if (decodeRes.isErr()) return;
+	// console.log('\nDecode Transaction:');
+	// console.dir(decodeRes.value, { depth: null });
+
+	// Broadcast the transaction.
+	// const broadcastRes = await wallet.electrum.broadcastTransaction({
+	// 	rawTx: createRes.value.hex
+	// });
+	// console.log('\nBroadcast Response:', broadcastRes);
+	// if (broadcastRes.isErr()) return;
+
+	const r = repl.start('> ');
+	r.context.wallet = wallet;
+};
+
+runExample().then();

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "beignet",
+  "version": "0.0.1",
+  "description": "A self-custodial, JS Bitcoin wallet management library.",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "yarn build && env mocha --exit -r ts-node/register 'tests/**/*.ts'",
+    "test:wallet": "yarn build && env mocha --exit -r ts-node/register 'tests/wallet.test.ts'",
+    "test:electrum": "yarn build && env mocha --exit -r ts-node/register 'tests/electrum.test.ts'",
+    "test:derivation": " yarn build && env mocha --exit -r ts-node/register 'tests/derivation.test.ts'",
+    "test:transaction": " yarn build && env mocha --exit -r ts-node/register 'tests/transaction.test.ts'",
+    "test:storage": "yarn build && env mocha --exit -r ts-node/register 'tests/storage.test.ts'",
+    "example": "ts-node example",
+    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
+    "lint:check": "eslint . --ext .js,.jsx,.ts,.tsx",
+    "lint:fix": "eslint . --fix --ext .js,.jsx,.ts,.tsx",
+    "build": "tsc",
+    "docs:markdown": "npx typedoc --plugin typedoc-plugin-markdown --out docs/markdown src/index.ts",
+    "docs:html": "npx typedoc --out docs/html",
+    "docs": "npm run build && npm run docs:markdown && npm run docs:html"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/synonymdev/beignet.git",
+    "baseUrl": "https://github.com/synonymdev/beignet"
+  },
+  "keywords": [
+    "Bitcoin",
+    "wallet"
+  ],
+  "types": "dist/types/index.d.ts",
+  "author": "synonymdev",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/synonymdev/beignet/issues"
+  },
+  "homepage": "https://github.com/synonymdev/beignet#readme",
+  "dependencies": {
+    "@bitcoinerlab/secp256k1": "^1.0.5",
+    "bech32": "^2.0.0",
+    "bip21": "^2.0.3",
+    "bip32": "^4.0.0",
+    "bip39": "^3.1.0",
+    "bitcoin-address-validation": "^2.2.3",
+    "bitcoin-units": "^0.3.0",
+    "bitcoinjs-lib": "6.1.4",
+    "ecpair": "^2.1.0",
+    "lodash.clonedeep": "^4.5.0",
+    "net": "^1.0.2",
+    "rn-electrum-client": "^0.0.10"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.0",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^20.4.10",
+    "@typescript-eslint/eslint-plugin": "^5.6.0",
+    "@typescript-eslint/parser": "^5.6.0",
+    "chai": "^4.3.4",
+    "eslint": "^8.4.1",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "mocha": "10.1.0",
+    "prettier": "^3.0.2",
+    "ts-node": "^10.4.0",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-markdown": "^3.15.4",
+    "typescript": "4.9"
+  }
+}

package/src/electrum/constants.ts

@@ -0,0 +1,28 @@
+export const TEST_MNEMONIC =
+	'decorate grass round powder swarm syrup identify resemble mass online grunt cruise';
+export const TESTNET_PEERS = [
+	{
+		host: 'testnet.hsmiths.com',
+		ssl: 53012,
+		tcp: 53012,
+		protocol: 'ssl'
+	},
+	{
+		host: 'tn.not.fyi',
+		ssl: 55002,
+		tcp: 55002,
+		protocol: 'ssl'
+	},
+	{
+		host: 'testnet.aranguren.org',
+		ssl: 51002,
+		tcp: 51001,
+		protocol: 'ssl'
+	},
+	{
+		host: 'blackie.c3-soft.com',
+		ssl: 57006,
+		tcp: 57006,
+		protocol: 'ssl'
+	}
+];