{"id":14980245,"url":"https://github.com/synonymdev/beignet","last_synced_at":"2025-05-12T14:46:20.591Z","repository":{"id":213172461,"uuid":"680906249","full_name":"synonymdev/beignet","owner":"synonymdev","description":"An instant, self-custodial Bitcoin wallet for JS devs.","archived":false,"fork":false,"pushed_at":"2025-03-20T08:31:49.000Z","size":2018,"stargazers_count":23,"open_issues_count":4,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-06T23:40:37.764Z","etag":null,"topics":["bitcoin","bitcoin-wallet","wallet"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/synonymdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-20T19:28:38.000Z","updated_at":"2025-03-20T08:31:49.000Z","dependencies_parsed_at":"2023-12-19T04:11:24.392Z","dependency_job_id":"67964a70-9351-4e73-9750-5bc0641cbb98","html_url":"https://github.com/synonymdev/beignet","commit_stats":{"total_commits":103,"total_committers":5,"mean_commits":20.6,"dds":0.2038834951456311,"last_synced_commit":"37507dbb18a72f8bde97e5c500870feadd275bed"},"previous_names":["synonymdev/beignet"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fbeignet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fbeignet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fbeignet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fbeignet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/synonymdev","download_url":"https://codeload.github.com/synonymdev/beignet/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253757777,"owners_count":21959472,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitcoin","bitcoin-wallet","wallet"],"created_at":"2024-09-24T14:01:30.421Z","updated_at":"2025-05-12T14:46:20.580Z","avatar_url":"https://github.com/synonymdev.png","language":"TypeScript","readme":"# Beignet\n\n:warning: This is pre-alpha software and not suitable for production apps yet.\n\n## Description\n\nAn instant, self-custodial Bitcoin wallet for JS devs.\n\nThis Typescript library offers JS developers a way to incorporate an on-chain, self-custodial Bitcoin wallet into their projects.\n\n## Table of Contents\n\n1. [Getting Started](#getting-started)\n2. [Running Tests \u0026 Examples](#running-tests--examples)\n  - [Clone the Repository](#clone-the-repository)\n  - [Install Dependencies \u0026 Build](#install-dependencies--build)\n  - [Run Tests](#run-tests)\n  - [Run Example Project](#run-example-project)\n3. [Implementation](#implementation)\n4. [Advanced Usage](#advanced-usage)\n5. [Documentation](#documentation)\n6. [Support](#support)\n\n## Getting Started\n\n```bash\n# Using Yarn\nyarn add beignet\n\n# Or, using NPM\nnpm i -S beignet\n```\n\n## Running Tests \u0026 Examples\n\n### Clone the Repository\n\n```bash\ngit clone git@github.com:synonymdev/beignet.git \u0026\u0026 cd beignet\n```\n\n### Install Dependencies \u0026 Build\n\n```bash\nnpm i \u0026\u0026 npm run build\n```\n\n### Run tests:\n\n```bash\nnpm run test\n```\n\n### Run example project:\n```bash\nnpm run example\n```\n\n## Implementation\n```javascript\nimport { Wallet, generateMnemonic } from 'beignet';\n\n// Generate a mnemonic phrase\nconst mnemonic = generateMnemonic();\n\n// Create a wallet instance\nconst createWalletRes = await Wallet.create({ mnemonic });\nif (createWalletRes.isErr()) return;\nconst wallet = createWalletRes.value;\n\n// View wallet data (addresses, indexes, utxos, transactions, etc.)\nconst walletData = wallet.data;\n  \n// Get receiving address\nconst address = await wallet.getAddress();\n\n// Get address balance\nconst addressBalanceRes = await wallet.getAddressBalance(address);\nif (addressBalance.isErr()) return;\nconst addressBalance = addressBalanceRes.value;\n\n// Get wallet balance\nconst walletBalance = wallet.getBalance();\n\n// Refresh Wallet\nconst walletRefresh = await wallet.refreshWallet();\n\n// Get fee information to perform a transaction.\nconst feeInfo = wallet.getFeeInfo();\n\n// Send sats\nconst sendRes = await wallet.send({ address: 'address to send sats to', amount: 1000, satPerByte: 2 });\n\n// Send all sats to an address\nconst sendMaxRes = await wallet.sendMax({ address: 'address to send sats to', satPerByte: 2 });\n```\n\n## Advanced Usage\n\n```typescript\nimport { Wallet, generateMnemonic } from 'beignet';\nimport net from 'net'\nimport tls from 'tls'\nimport { TStorage } from './wallet';\nimport { ECoinSelectPreference } from \"./transaction\";\n\n// Generate a mnemonic phrase\nconst mnemonic = generateMnemonic();\n\n// Add a bip39 passphrase\nconst passphrase = 'passphrase';\n\n// Connect to custom electrum server\nconst servers: TServer = {\n  host: '35.233.47.252',\n  ssl: 18484,\n  tcp: 18483,\n  protocol: EProtocol.ssl,\n};\n\n// Use a specific network (Defaults to mainnet)\nconst network = ENetworks.mainnet;\n\n// Use a specific address type. (Defaults to EAddressType.p2wpkh)\nconst addressType = EAddressType.p2tr;\n\n// Monitor certain address types. (Defaults to Object.values(EAddressType))\nconst addressTypesToMonitor = [EAddressType.p2tr, EAddressType.p2wpkh];\n\n// Subscribe to server messages (TOnMessage)\nconst onMessage: TOnMessage = (id, data) =\u003e {\n  console.log(id);\n  console.dir(data, { depth: null });\n}\n\n// Disable startup messages. Messages resume once startup is complete. (Defaults to false)\nconst disableMessagesOnCreate = true;\n\n// Persist sessions by getting and setting data from storage\nconst storage: TStorage = {\n  async getData\u003cK extends keyof IWalletData\u003e(\n    key: string\n  ): Promise\u003cResult\u003cIWalletData[K]\u003e\u003e {\n    // Add your logic here\n  },\n  async setData\u003cK extends keyof IWalletData\u003e(\n    key: string,\n    value: IWalletData[K]\n  ): Promise\u003cResult\u003cboolean\u003e\u003e {\n    // Add your logic here\n  }\n};\n\n// Set the auto coin selection preference. (Defaults to ECoinSelectPreference.consolidate)\nconst coinSelectPreference = ECoinSelectPreference.small;\n\n// Create a wallet instance\nconst createWalletRes = await Wallet.create({\n  mnemonic,\n  passphrase,\n  electrumOptions: {\n    servers,\n    net,\n    tls\n  },\n  network,\n  onMessage,\n  storage,\n  addressType,\n  addressTypesToMonitor,\n  disableMessagesOnCreate,\n  coinSelectPreference\n});\nif (createWalletRes.isErr()) return;\nconst wallet = createWalletRes.value;\n\n// List UTXO's\nconst utxos = wallet.listUtxos();\n\n// Send sats to multiple outputs\nconst txs = [\n  { address: 'address1', amount: 1000 },\n  { address: 'address2', amount: 2000 },\n  { address: 'address3', amount: 3000 },\n];\nconst sendManyRes = await wallet.sendMany({ txs });\n\n// Sweep from a private key\nconst sweepPrivateKeyRes = await wallet.sweepPrivateKey({\n  privateKey: 'privateKey',\n  toAddress: 'toAddress',\n  satsPerByte: 5,\n  broadcast: false\n});\n\n// Get tx history for a given address. { tx_hash: string; height: number; }[]\nconst history = await wallet.getAddressHistory('address');\n\n// Get transaction details for a given transaction id. TTxDetails\nconst txDetails = await wallet.getTransactionDetails('txid');\n```\n\n## React Native\n\nYou can use `react-native-tcp-socket` as a drop in replacement for `net` \u0026 `tls` in a react-native environment. In `package.json`:\n\n```json\n\"react-native\": {\n\t\"net\": \"react-native-tcp-socket\",\n\t\"tls\": \"react-native-tcp-socket\"\n}\n```\n\n## Documentation\n- [HTML](docs/html/classes/Wallet.html)\n- [Markdown](docs/markdown/classes/Wallet.md)\n\n## Support\n\nIf you are experiencing any problems, please open an issue or reach out to us on [Telegram](https://t.me/bitkitchat).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsynonymdev%2Fbeignet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsynonymdev%2Fbeignet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsynonymdev%2Fbeignet/lists"}