{"id":41992759,"url":"https://github.com/bitvora/bitvora-ts","last_synced_at":"2026-01-26T00:45:03.989Z","repository":{"id":247454654,"uuid":"825831183","full_name":"bitvora/bitvora-ts","owner":"bitvora","description":"Bitvora Typescript SDK","archived":false,"fork":false,"pushed_at":"2024-07-23T01:47:30.000Z","size":470,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-07-23T18:59:30.596Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bitvora.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-07-08T15:27:14.000Z","updated_at":"2024-07-23T01:46:54.000Z","dependencies_parsed_at":"2024-07-22T18:30:08.530Z","dependency_job_id":null,"html_url":"https://github.com/bitvora/bitvora-ts","commit_stats":null,"previous_names":["bitvora/bitvora-ts"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/bitvora/bitvora-ts","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitvora%2Fbitvora-ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitvora%2Fbitvora-ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitvora%2Fbitvora-ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitvora%2Fbitvora-ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitvora","download_url":"https://codeload.github.com/bitvora/bitvora-ts/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitvora%2Fbitvora-ts/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28763019,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T00:37:26.264Z","status":"ssl_error","status_checked_at":"2026-01-26T00:37:25.959Z","response_time":113,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2026-01-26T00:45:03.517Z","updated_at":"2026-01-26T00:45:03.978Z","avatar_url":"https://github.com/bitvora.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bitvora SDK\n\nA Node.js SDK written in Typescript for the Bitvora API and Webhooks.\n\n## Installation\n\n```bash\nnpm install bitvora\n```\n\n## Usage\n\n### Sending Bitcoin (withdrawal)\n\n```typescript\nimport { BitvoraClient } from \"bitvora\";\n\nconst bitvora = BitvoraClient(API_KEY, BitcoinNetwork.MAINNET); // [\"mainnet\", \"testnet\", \"signet\"]\n\nasync function sendBitcoin(): Promise\u003cWithdrawal\u003e {\n  const withdrawal = await bitvora.withdraw(\n    \"utxo1@getalby.com\", // accepts on-chain, lightning invoice (payment request), lightning address, lnurl\n    10.0, // amount in your desired currency\n    Currency.USD // currency code\n  );\n\n  await withdrawal.isSettled(); // wait until the payment succeeds or fails, optional\n\n  return withdrawal;\n}\n```\n\n### Creating a Lightning Address\n\n```typescript\nimport { BitvoraClient } from \"bitvora\";\n\nconst bitvora = BitvoraClient(API_KEY, BitcoinNetwork.MAINNET); // [\"mainnet\", \"testnet\", \"signet\"]\n\nasync function createLightningAddress(): Promise\u003cCreateLightningAddressResponse\u003e {\n  let metadata = {\n    userID: \"your-internal-user-id\",\n    email: \"useremail@protonmail.com\",\n  }; // optional metadata object to attach, accepts any valid key-value object\n\n  return bitvora.createLightningAddress(metadata); // also accepts null\n}\n```\n\n### Create a Lightning Invoice\n\n```typescript\nimport { BitvoraClient } from \"bitvora\";\n\nconst bitvora = BitvoraClient(API_KEY, BitcoinNetwork.MAINNET); // [\"mainnet\", \"testnet\", \"signet\"]\n\nasync function createLightningInvoice(): Promise\u003cLightningInvoice\u003e {\n  let metadata = {\n    userID: \"your-internal-user-id\",\n    email: \"useremail@protonmail.com\",\n  }; // optional metadata object to attach, accepts any valid key-value object\n\n  const invoice = await bitvora.createLightningInvoice(\n    50,\n    Currency.SATS,\n    \"this is from the sdk\",\n    3600,\n    metadata\n  );\n\n  await invoice.isSettled();\n\n  return invoice;\n}\n```\n\n### Get Balance\n\n```typescript\nimport { BitvoraClient } from \"bitvora\";\n\nconst bitvora = BitvoraClient(API_KEY, BitcoinNetwork.MAINNET); // [\"mainnet\", \"testnet\", \"signet\"]\n\nasync function getBalance(): Promise\u003cnumber\u003e {\n  return bitvora.getBalance();\n}\n```\n\n### Get Transactions\n\n```typescript\nimport { BitvoraClient } from \"bitvora\";\n\nconst bitvora = BitvoraClient(API_KEY, BitcoinNetwork.MAINNET); // [\"mainnet\", \"testnet\", \"signet\"]\n\nasync function getTransactions(): Promise\u003cGetTransactionsResponse\u003e {\n  return bitvora.getTransactions();\n}\n```\n\n### Get Deposit\n\n```typescript\nimport { BitvoraClient } from \"bitvora\";\n\nconst bitvora = BitvoraClient(API_KEY, BitcoinNetwork.MAINNET); // [\"mainnet\", \"testnet\", \"signet\"]\n\nasync function getDeposit(): Promise\u003cBitcoinDepositResponse\u003e {\n  return bitvora.getDeposit(\"UUID-HERE\");\n}\n```\n\n### Get Withdrawal\n\n```typescript\nimport { BitvoraClient } from \"bitvora\";\n\nconst bitvora = BitvoraClient(API_KEY, BitcoinNetwork.MAINNET); // [\"mainnet\", \"testnet\", \"signet\"]\n\nasync function getWithdrawal(): Promise\u003cBitcoinWithdrawalResponse\u003e {\n  return bitvora.getWithdrawal(\"UUID-HERE\");\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitvora%2Fbitvora-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitvora%2Fbitvora-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitvora%2Fbitvora-ts/lists"}