{"_id":"@bitcoin-files/bitcoinfiles-js","_rev":"2-39a97b17e779dc3a1a79a3e495b30998","name":"@bitcoin-files/bitcoinfiles-js","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@bitcoin-files/bitcoinfiles-js","version":"1.0.0","description":"BitcoinFiles JS","main":"index.js","repository":{"type":"git","url":"git+ssh://git@github.com/MatterPool/bitcoinfiles-js.git"},"author":{"name":"Harrison Beckerich","email":"harry@twetch.com"},"license":"MIT","dependencies":{"axios":"^0.20.0"},"devDependencies":{"prettier":"^2.1.2"},"gitHead":"fc901ec72b6a27c05205c0a77220e9588c3cb2cd","bugs":{"url":"https://github.com/MatterPool/bitcoinfiles-js/issues"},"homepage":"https://github.com/MatterPool/bitcoinfiles-js#readme","_id":"@bitcoin-files/bitcoinfiles-js@1.0.0","_nodeVersion":"12.18.2","_npmVersion":"6.14.5","dist":{"integrity":"sha512-/fdsk95jy/rbTRuznDpB651q8niGviy22udIrytJAJyiC+G2bYMpwiIxNG36jgBmiEcWPsCyHwSIq19HIUK6cg==","shasum":"20431b82403c742ca33ce8f71837aaac5e16c652","tarball":"https://registry.npmjs.org/@bitcoin-files/bitcoinfiles-js/-/bitcoinfiles-js-1.0.0.tgz","fileCount":5,"unpackedSize":3571,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgtkybCRA9TVsSAnZWagAA5HUP/3RKODdLDFPSOCfSCqj4\nhIG/WcLLPPR7TwcP1y2zgn52jyzyzMZuV+GPtPrciMAX7mdWlkremX8sqcYY\nxum8s0taTq73vrlSaULpIdV5w5lSbadbTUKqbISLS8qkwsu5XH6YiZmTRMiX\nJ2wICJfoyPrAWJcQZ4hIHQAZCAFuIXiM0U1ksW7H9Hayukm5dGma/CDWu+CO\nik6i9tWKiwWJL0+ANIUlUay0WHtcWYZ1DRGscSf5yiyuPyULDqb+zR9z49qt\nI2C/RIn8cTpMrRnilu2OvHWFGS46ZIczak26keUqjox3cFnuCbfRGE905ky5\nb4d30mO0/glHkn6+I5sBHm/ZGe5jjv7stzB8FxBcO/SoxmYhoYSdetTqEu7c\n9DThkEYpAhACjg+ZfwNgGLf7VqvU6bB+HAFCP+f6QQ+Ghz4EdM/VZkH4hhrv\nsfn6NOxGtwzwku8u0kV6f7WRb2Kbe5CCxAZMB7rzR5jLVtP4zNWG+1JFyfJD\nKnOVs+ElPEjRILtMwKInYxEZcnMmV3/jmaVqbxgou6QR90Zxi+aMqrrckFuJ\n0tICm4cGT7wTB3omch2OISmLLclTNaah3uWlmmy1g5aC6GYgN5cF8ft3+vQp\nuNJHMC5YugYs6Fe1nZvNQLLh8pN2X2XB+i6ZlLMnWwQVEow2iNGCPDi11oef\njlPR\r\n=Wtoq\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIE6B2pd06ij9BhGJyWPbfsJKKCuic/Jtwt5/XXyJORpnAiAO3uBi2+87VF49LxbK/WMkPpm41eLp1tHh1/2CKZRJhA=="}]},"_npmUser":{"name":"hbeckeri","email":"harry@twetch.com"},"directories":{},"maintainers":[{"name":"hbeckeri","email":"harry@twetch.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bitcoinfiles-js_1.0.0_1622559898771_0.24417623569769198"},"_hasShrinkwrap":false},"1.0.1":{"name":"@bitcoin-files/bitcoinfiles-js","version":"1.0.1","description":"BitcoinFiles JS","main":"index.js","repository":{"type":"git","url":"git+ssh://git@github.com/MatterPool/bitcoinfiles-js.git"},"author":{"name":"Harrison Beckerich","email":"harry@twetch.com"},"license":"MIT","dependencies":{"axios":"^0.20.0"},"devDependencies":{"prettier":"^2.1.2"},"gitHead":"3ad06bc4a663f2a1c66388a1131183809c14db12","bugs":{"url":"https://github.com/MatterPool/bitcoinfiles-js/issues"},"homepage":"https://github.com/MatterPool/bitcoinfiles-js#readme","_id":"@bitcoin-files/bitcoinfiles-js@1.0.1","_nodeVersion":"12.18.2","_npmVersion":"7.15.1","dist":{"integrity":"sha512-HN8nqxGXV5gA6DJqTudQv9PpftXkC7C61YylBDHzyAywczOtr1fqB6vG6e1xYf6jfEyIOiLclnSpdaP6Q3izUA==","shasum":"cefd97cdadf38768660de5676d722226b351ed0f","tarball":"https://registry.npmjs.org/@bitcoin-files/bitcoinfiles-js/-/bitcoinfiles-js-1.0.1.tgz","fileCount":5,"unpackedSize":3517,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgu5+nCRA9TVsSAnZWagAAKnsQAIRdgyxhiRElcBk4Pio8\n7Ukcr7moBXTYgeIBs7jjLPq4XX5EOsIUF+sG2hm4Jmx5xgnDC7fpHeXHyBuZ\nVEfKydNKgA2M0CnVWZjVWcdioWMq109Wgl7aLtwiEox8bf4e9zNY9iazJlH4\nrG1lS0ozXidB+yv4JPRDGaQM06qIGkFKzTLcyXL4IwJWOV8kHt6OPWVV1vQc\nGNg7RA5RRUrsR+PtD7fTBGE/l8dFJimOtk6/Ge3nSDKCu3znPik/JICXnZT/\nZMJ3LG38UEFGM19kmP0vJho9PRQzS93yowG0tuvIa5iaqcwvYOM9Cfed3dNG\nxlKHW3f+0nxd5nEX3fsitDUWPIRvv81Zfzs1WKPHW4QY+WYaH5EsePqvFPMF\n6uJWBLZZyt0EHiZKe2FV2iKoBPFEv4xyzNB2qODJpA0Jnzz8UYcRGiQrgPMe\nKKeSMCQZdsidDCzeVPazM/N2VPd7vezqdTY8uNfYxN2zkLsZ2SwFYy1xHKG9\n3hjXVOLodoZ/Hd7O6VnA6M0kWRaiQS7mwcab1JF6IHp55IrKZ8Nx/K2I4+r8\nwVBiS9lvxY0Fq+FEVU3tJx2y0Lhzc1ij3VdOOcRyR43AUE4vpO4ErOQGApT5\nXQEXuK2okYge0dGefahHle2Qrdmk6zPhmdEwGrTx4BaPkJojHJc6ZMgyyjbz\n2I+w\r\n=ShsY\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGfidQaPVPq10P657axWNWtXb5DHR1u/jXjMbftkzFucAiBUQq7yGtuQs8j3fbXTgdkXPlmei4FeZ7fbTYJI4yCx9A=="}]},"_npmUser":{"name":"hbeckeri","email":"harry@twetch.com"},"directories":{},"maintainers":[{"name":"hbeckeri","email":"harry@twetch.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bitcoinfiles-js_1.0.1_1622908839267_0.3361899661753611"},"_hasShrinkwrap":false}},"time":{"created":"2021-06-01T15:04:58.412Z","1.0.0":"2021-06-01T15:04:58.902Z","modified":"2022-04-04T18:59:41.071Z","1.0.1":"2021-06-05T16:00:39.370Z"},"maintainers":[{"name":"hbeckeri","email":"harry@twetch.com"}],"description":"BitcoinFiles JS","homepage":"https://github.com/MatterPool/bitcoinfiles-js#readme","repository":{"type":"git","url":"git+ssh://git@github.com/MatterPool/bitcoinfiles-js.git"},"author":{"name":"Harrison Beckerich","email":"harry@twetch.com"},"bugs":{"url":"https://github.com/MatterPool/bitcoinfiles-js/issues"},"license":"MIT","readme":"# BitcoinFiles JS\n\nUpload up to 218MB files to Bitcoin.\n\n- [JS SDK](https://github.com/MatterPool/bitcoinfiles-js/blob/main/README.md#js-usage)\n- [HTTP API](https://github.com/MatterPool/bitcoinfiles-js/blob/main/README.md#api-usage)\n\n# JS Usage\n\n## Installation\n\n```bash\nnpm install @bitcoin-files/bitcoinfiles-js\n``````\n\n## Import\n\n```javascript\nconst bitcoinfiles = require('@bitcoin-files/bitcoinfiles-js');\n```\n\n## Upload\n\n```javascript\nconst file = new File(['foo', 'bar'], 'foobar.txt');\nconst formData = new FormData();\nformData.append('file', file);\nconst upload = await bitcoinfiles.upload(formData, '');\n```\n\n## Pay\n\n```javascript\nconst paymentAddress = upload.payment_address;\nconst paymentSatoshis = upload.payment_satoshis;\n\n// ...build transaction using paymenAddress and paymentSatoshis\nconst rawtx = '....'\n\nconst payment = await bitcoinfiles.pay(rawtx);\nconst txid = payment.result[0].txid // txid of the bitcoin file\n```\n\n## Download\n\n```javascript\nconst txid = '8f7090ec72a692e7bb893a3fd4ef1e508c655a284a5b736b3cc7c63649748562'\nconst file = await bitcoinfiles.download(txid);\n```\n\n# API Usage\n\n## Upload\n\nTo use BitcoinFiles, you first upload a file, then you pay for it to be settled on the bitcoin ledger.\n\n#### Request\n\n```\nPOST https://doge.bitcoinfiles.org?workspace=\nContent-Type: multipart/form-data\nBody:\n file: \n```\n\n#### Response\n\n```javascript\n{\n payment_address: '18Qi1rXJSLDLUYDZVkRT3ZdyB3E9eZamY2',\n payment_sats_needed: 2833,\n workspace_id: '',\n file_size: 1235,\n file_content_type: 'image/jpeg',\n}\n```\n\n\n## Pay\n\nTo pay for a file, send `payment_address` to `payment_sats_needed`. You can pay for multiple files at once in the same transaction \n\n#### Request\n\n```\nPOST https://doge.bitcoinfiles.org/pay\nContent-Type: application/octet-stream\nBody: \n```\n\n##### Response\n\nIf paying for multiple files in one payment, the response txids will be in the same order as the payment outputs\n```javascript\n{\n errors: [],\n status: 200,\n result: ['f7a3e5838a134a78b6a5033aa928efb7849be6212307b9b9eed3c738ea470bc2']\n}\n```\n\n## Download\n\nYou can download a file by using it's transaction id. This link can be used in html tags like ``, `