@bitcoinfiles/bitcoinfiles-js
v1.0.2
Published
BitcoinFiles JS
Downloads
6
Readme
BitcoinFiles JS
Upload up to 218MB files to Bitcoin.
JS Usage
Installation
npm install @bitcoinfiles/bitcoinfiles-js
Import
const bitcoinfiles = require('@bitcoinfiles/bitcoinfiles-js');
Upload
const file = new File(['foo', 'bar'], 'foobar.txt');
const formData = new FormData();
formData.append('file', file);
const upload = await bitcoinfiles.upload(formData, '<workspace-id>');
Pay
const paymentAddress = upload.payment_address;
const paymentSatoshis = upload.payment_satoshis;
// ...build transaction using paymenAddress and paymentSatoshis
const rawtx = '....'
const payment = await bitcoinfiles.pay(rawtx);
const txid = payment.result[0].txid // txid of the bitcoin file
Download
const txid = '8f7090ec72a692e7bb893a3fd4ef1e508c655a284a5b736b3cc7c63649748562'
const file = await bitcoinfiles.download(txid);
API Usage
Upload
To use BitcoinFiles, you first upload a file, then you pay for it to be settled on the bitcoin ledger.
Request
POST https://doge.bitcoinfiles.org?workspace=<workspace-id>
Content-Type: multipart/form-data
Body:
file: <file-contents>
Response
{
payment_address: '18Qi1rXJSLDLUYDZVkRT3ZdyB3E9eZamY2',
payment_sats_needed: 2833,
workspace_id: '<workspace-id>',
file_size: 1235,
file_content_type: 'image/jpeg',
}
Pay
To pay for a file, send payment_address
to payment_sats_needed
. You can pay for multiple files at once in the same transaction
Request
POST https://doge.bitcoinfiles.org/pay
Content-Type: application/octet-stream
Body: <raw-transaction-hex>
Response
If paying for multiple files in one payment, the response txids will be in the same order as the payment outputs
{
errors: [],
status: 200,
result: ['f7a3e5838a134a78b6a5033aa928efb7849be6212307b9b9eed3c738ea470bc2']
}
Download
You can download a file by using it's transaction id. This link can be used in html tags like <img>
, <video>
or <audio>
Request
GET https://doge.bitcoinfiles.org/[txid]