beignet 0.0.1

package/.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+markdown
+html

package/.eslintrc

@@ -0,0 +1,40 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended"
+  ],
+  "rules": {
+    "semi": "off",
+    "@typescript-eslint/semi": ["error"],
+    "no-shadow": "off",
+    "@typescript-eslint/no-shadow": "error",
+    "@typescript-eslint/no-unused-vars": "error",
+    "no-console": 0,
+    "no-empty": ["error", { "allowEmptyCatch": true }],
+    "no-buffer-constructor": 0,
+    "no-case-declarations": 0,
+    "no-useless-escape": 0,
+    "indent": "off",
+    "object-curly-spacing": [
+      "error",
+      "always",
+      {
+        "objectsInObjects": true
+      }
+    ],
+    "no-undef": 0,
+    "require-atomic-updates": 0,
+    "no-async-promise-executor": 0,
+    "brace-style": [2, "1tbs", { "allowSingleLine": true }],
+    "@typescript-eslint/explicit-function-return-type": "warn",
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-non-null-assertion": "off"
+  }
+}

package/.prettierrc

@@ -0,0 +1,9 @@
+{
+  "bracketSpacing": true,
+  "bracketSameLine": true,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "useTabs": true,
+  "tabWidth": 2,
+  "semi": true
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Synonym
+
+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/README.md

@@ -0,0 +1,166 @@
+# Beignet
+
+:warning: This is pre-alpha software and not suitable for production apps yet.
+
+## Description
+
+An instant, self-custodial Bitcoin wallet for JS devs.
+
+This Typescript library offers JS developers a way to incorporate an on-chain, self-custodial Bitcoin wallet into their projects.
+
+## Table of Contents
+
+1. [Getting Started](#getting-started)
+2. [Running Tests & Examples](#running-tests--examples)
+  - [Clone the Repository](#clone-the-repository)
+  - [Install Dependencies & Build](#install-dependencies--build)
+  - [Run Tests](#run-tests)
+  - [Run Example Project](#run-example-project)
+3. [Implementation](#implementation)
+4. [Advanced Usage](#advanced-usage)
+5. [Documentation](#documentation)
+6. [Support](#support)
+
+## Getting Started
+
+```bash
+# Using Yarn
+yarn add beignet
+
+# Or, using NPM
+npm i -S beignet
+```
+
+## Running Tests & Examples
+
+### Clone the Repository
+
+```bash
+git clone git@github.com:synonymdev/beignet.git && cd beignet
+```
+
+### Install Dependencies & Build
+
+```bash
+npm i && npm run build
+```
+
+### Run tests:
+
+```bash
+npm run test
+```
+
+### Run example project:
+```bash
+npm run example
+```
+
+## Implementation
+```javascript
+import { Wallet, generateMnemonic } from 'beignet';
+
+// Generate a mnemonic phrase
+const mnemonic = generateMnemonic();
+
+// Create a wallet instance
+const createWalletRes = await Wallet.create({ mnemonic });
+if (createWalletRes.isErr()) return;
+const wallet = createWalletRes.value;
+  
+// Get receiving address
+const address = await wallet.getAddress();
+
+// Get address balance
+const addressBalanceRes = await wallet.getAddressBalance(address);
+if (addressBalance.isErr()) return;
+const addressBalance = addressBalanceRes.value;
+
+// Get wallet balance
+const walletBalance = wallet.getBalance();
+
+// Get fee information to perform a transaction.
+const feeInfo = wallet.getFeeInfo();
+
+// Send sats
+const sendRes = await wallet.send({ address: 'address to send sats to', amount: 1000 });
+```
+
+## Advanced Usage
+
+```typescript
+import { Wallet, generateMnemonic } from 'beignet';
+import { TStorage } from './wallet';
+
+// Generate a mnemonic phrase
+const mnemonic = generateMnemonic();
+
+// Add a bip39 passphrase
+const passphrase = 'passphrase';
+
+// Connect to custom electrum server
+const servers: TServer = {
+	host: '35.233.47.252',
+	ssl: 18484,
+	tcp: 18483,
+	protocol: EProtocol.ssl,
+};
+
+// Use a specific network (Defaults to mainnet)
+const network = ENetworks.mainnet;
+
+// Use a specific address type. (Defaults to EAddressType.p2wpkh)
+const addressType = EAddressType.p2sh;
+
+// Subscribe to server messages (TOnMessage)
+const onMessage: TOnMessage = (id, data) => {
+	console.log(id);
+	console.dir(data, { depth: null });
+}
+
+// Persist sessions by getting and setting data from storage
+const storage: TStorage = {
+	async getData<K extends keyof IWalletData>(
+		key: string
+	): Promise<Result<IWalletData[K]>> {
+		// Add your logic here
+	},
+	async setData<K extends keyof IWalletData>(
+		key: string,
+		value: IWalletData[K]
+	): Promise<Result<boolean>> {
+		// Add your logic here
+	}
+};
+
+// Create a wallet instance
+const createWalletRes = await Wallet.create({
+	mnemonic,
+	passphrase,
+	electrumOptions: { servers },
+	network,
+	onMessage,
+	storage
+});
+if (createWalletRes.isErr()) return;
+const wallet = createWalletRes.value;
+
+// List UTXO's
+const utxos = wallet.listUtxos();
+
+// Send sats to multiple outputs
+const txs = [
+	{ address: 'address1', amount: 1000 },
+	{ address: 'address2', amount: 2000 },
+	{ address: 'address3', amount: 3000 },
+];
+const sendManyRes = await wallet.sendMany({ txs });
+```
+
+## Documentation
+- [HTML](docs/html/classes/Wallet.html)
+- [Markdown](docs/markdown/classes/Wallet.md)
+
+## Support
+
+If you are experiencing any problems, please open an issue or reach out to us on [Telegram](https://t.me/bitkitchat).

package/dist/electrum/constants.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TESTNET_PEERS = exports.TEST_MNEMONIC = void 0;
+exports.TEST_MNEMONIC = 'decorate grass round powder swarm syrup identify resemble mass online grunt cruise';
+exports.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'
+    }
+];
+//# sourceMappingURL=constants.js.map

package/dist/electrum/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/electrum/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,aAAa,GACzB,oFAAoF,CAAC;AACzE,QAAA,aAAa,GAAG;IAC5B;QACC,IAAI,EAAE,qBAAqB;QAC3B,GAAG,EAAE,KAAK;QACV,GAAG,EAAE,KAAK;QACV,QAAQ,EAAE,KAAK;KACf;IACD;QACC,IAAI,EAAE,YAAY;QAClB,GAAG,EAAE,KAAK;QACV,GAAG,EAAE,KAAK;QACV,QAAQ,EAAE,KAAK;KACf;IACD;QACC,IAAI,EAAE,uBAAuB;QAC7B,GAAG,EAAE,KAAK;QACV,GAAG,EAAE,KAAK;QACV,QAAQ,EAAE,KAAK;KACf;IACD;QACC,IAAI,EAAE,qBAAqB;QAC3B,GAAG,EAAE,KAAK;QACV,GAAG,EAAE,KAAK;QACV,QAAQ,EAAE,KAAK;KACf;CACD,CAAC"}