Hello BSVUP1
\"),\r\n mime: \"text/html\",\r\n dKey: \"foo/file1.txt\"\r\n}\r\nvar fileData2 = {\r\n buf: Buffer.from(\"Hello BSVUP2
\"),\r\n mime: \"text/html\",\r\n dKey: \"foo/file2.txt\"\r\n}\r\n\r\n// Upload\r\nvar privkey = bsv.PrivateKey(\"Your key\")\r\nvar uploader = new bsvup()\r\nvar TXs = await uploader.addFile(fileData1)\r\n\t\t\t\t\t\t.addFile(fileData2)\r\n\t\t\t\t\t\t.setAddress(customAddress)\r\n\t\t\t\t\t\t.setSigner(customSignerFunc)\r\n\t\t\t\t\t\t.buildTXs()\r\n\r\nconsole.log(`The file (for example, the second one) can be accessed from https://bico.media/${privkey.toAddress()}/foo/file2.txt`)\r\n~~~\r\n\r\n##### Point D Path to a TX Already Onchain\r\n\r\n~~~javascript\r\n// A B/Bcat TX which already exist on chain \r\nvar txid = \"068562c97621b4e6921fe9cf43c3ed8caa88ccb048744964339485894b091ded\"\r\n\r\n// Upload\r\nvar privkey = bsv.PrivateKey(\"Your key\")\r\nvar uploader = new bsvup()\r\nvar TXs = await uploader.addDPath(\"test.html\", txid)\r\n\t\t\t\t\t\t.addFile({buf: Buffer.from(\"Hello BSVUP1
\"),\r\n mime: \"text/html\",\r\n dKey: \"foo/file1.txt\"\r\n })\r\n\t\t\t\t\t\t.addData(\"['blog1']\", \"index.json\")\r\n\t\t\t\t\t\t.setAddress(customAddress)\r\n\t\t\t\t\t\t.setSigner(customSignerFunc)\r\n\t\t\t\t\t\t.buildTXs()\r\n\r\nconsole.log(`The file (for example, the first one) can be accessed from https://bico.media/${privkey.toAddress()}/test.html`)\r\n~~~\r\n\r\n##### Use Provided UTXOs\r\n\r\n~~~javascript\r\n// UTXOs Example\r\nvar utxos = [{\r\n txid: '8d29c20fd086ad5aa859037eb9bb25aaf6ebb84706965c4c662bbdb40e9cba02',\r\n vout: 0,\r\n address: '1A2JN4JAUoKCQ5kA4pHhu4qCqma8jZSU81',\r\n script: '76a91462f80abdd278a255e40c1a1f8dd89555de19a07688ac',\r\n satoshis: 10000000\r\n}]\r\n\r\n// Upload\r\nvar privkey = bsv.PrivateKey(\"Your key\")\r\nvar uploader = new bsvup()\r\nvar TXs = await uploader.addData(\"some blog\", \"blog1\")\r\n\t\t\t\t\t\t.addData(\"['blog1']\", \"index.json\")\r\n\t\t\t\t\t\t.addUtxos(utxos)\r\n\t\t\t\t\t\t.setPrivkey(privkey)\r\n\t\t\t\t\t\t.buildTXs()\r\n~~~\r\n\r\n#### As Command Line Tool\r\n\r\n##### Install\r\n\r\nOnce installed, you can use `bsvup` in command line.\r\n\r\n~~~bash\r\nnpm install -g bsvup\r\n~~~\r\n\r\n##### Initialize\r\n\r\nSwitch your working directory to the directory you want to upload, and do the initialization.\r\n\r\nThis will create a `.bsv` folder, initialize caches and generate key.\r\n\r\n~~~bash\r\nbsvup init\r\n~~~\r\n\r\n##### Provide satoshis as fees\r\n\r\nWe cannot upload things to blockchain without spending some fees, so you should charge some satoshis to the key generated above.\r\n\r\n~~~bash\r\nbsvup charge\r\n~~~\r\n\r\n##### Upload current working directory\r\n\r\nThe tool can upload any folder or file to blockchain. By default, it upload the current working folder.\r\n\r\n Bsvup will search and cache exist onchain files to minimize uploading.\r\n\r\n~~~bash\r\nbsvup upload\r\n~~~\r\n\r\n##### Transfer the remaining fees out\r\n\r\nIt's unnecessary, but you can do that if you want to get remaining satoshis out.\r\n\r\n~~~bash\r\nbsvup transfer\r\n~~~\r\n\r\n### How Does It Works\r\n\r\nThere are dependency between TXs, you need to know TXID before building D/Bcat TXs, but you still need collect informations to build TX. So bsvup defines `tasks` to handle this.\r\n\r\n#### Logic\r\n\r\nbsvup collect neccesary informations first, then create tasks, then split utxos for each task, then execute tasks to build TXs.\r\n\r\n~~~mermaid\r\ngraph TD\r\nCollect[Collect Informations]\r\nTask[Create Tasks]\r\nFund[Split Utxos for Each Task]\r\nSign[Execute Task and Build TX]\r\nCollect --> Task --> Fund --> Sign\r\n~~~\r\n\r\n\r\n\r\nbsvup also implement some api, like get/broadcast TX from remote api.\r\n\r\n#### Tasks\r\n\r\nThere are basically 3 status of task:\r\n\r\n`prepend`: necessary information collected, but still depend on other tasks\r\n\r\n`ready`: no dependencies, can build and signed TX.\r\n\r\n`pended`: TX is built and signed\r\n\r\n~~~mermaid\r\ngraph TD\r\nprepend --Not All Dependencies Pended--> prepend\r\nprepend --Is All Dependencies Pended--> ready\r\nready --Build TX and Sign--> pended\r\n~~~\r\n\r\nThere won't be deadlock, because Bcat/D protocol doesn't have circular dependency.\r\n\r\n\r\n\r\n\r\n\r\n","readmeFilename":"README.md"}