\n\n\n## Description\nClient side wrapper library for interacting with the Blocktank LSP server. For REST API docs see [synonym.readme.io](https://synonym.readme.io/)\n\n[Blocktank](https://blocktank.synonym.to/) is an LSP that allows businesses, apps, or online platforms to integrate, automate, and monetize services from your Lightning node. This includes channel configuration, channel purchases, channel info and more.\n\nFor widget and complete code samples see [blocktank-ui](https://github.com/synonymdev/blocktank-ui)\n\n\n## Rest API docs\nhttps://synonym.readme.io/\n\n\n## Getting started\n\n```bash\nyarn add @synonymdev/blocktank-client\n#or\nnpm i -S @synonymdev/blocktank-client\n````\n\n## Usage\n```javascript\nimport bt from '@synonymdev/blocktank-client';\n```\n\n```javascript\n// Choose network\nbt.setNetwork('mainnet'); // Options are 'mainnet' and 'regtest'\n\n// Get all node info and available services\nconst info = await bt.getInfo();\n\nconst service = info.services[0];\n\n// 1. Place order\nconst buyRes = await bt.buyChannel({\n product_id: service.product_id,\n channel_expiry: 4,\n remote_balance: 0,\n local_balance: 20000,\n});\n\n// 2. Make payment using one of below methods\nconst {btc_address, ln_invoice} = buyRes;\n\n// 3. Get order details for current state\nconst order = await bt.getOrder(buy.order_id);\n\n// 4. Make an onchain transaction using the below min fee with RBF disabled to instantly be able to claim your channel\nconst {zero_conf_satvbyte, zero_conf_satvbyte_expiry} = order;\n\n// Once order state === 100 a channel can be claimed\nconst {state, stateMessage} = order;\n\n// For all order states see: https://github.com/synonymdev/blocktank-client/blob/f8a20c35a4953435cecf8f718ee555e311e1db9b/src/services/client.ts#L15\n\n// 5. Claim lnurl-channel\nconst {lnurl_string} = order;\n\n// Or claim manually with an additional method\ntry {\n await bt.finalizeChannel({\n order_id: order._id,\n node_uri: '0296b2db342fcf87ea94d981757fdf4d3e545bd5cef4919f58b5d38dfdd73bf5c9@34.79.58.84:9735',\n private: true // For mobile nodes that won't be routing transactions\n });\n} catch (e) {\n console.error(e);\n}\n\n```\n\n\n## Development\n\n\n### `yarn build`\n\nBuilds library ready for production use.\n\n### `yarn test`\n\nIntegration tests.\n\n### `yarn format`\n\nCode formatting.\n\n### `yarn lint`\n\nCode linting.\n\n### `yarn prepublish`\n\nPrepares code for publishing bu building and bumping package version.\n","readmeFilename":"README.md"}
![\"bitkit\"](\"./blocktank_brand_mark.png\")
\n \n