# boostpow > BoostPow Javascript SDK Latest version **2.0.0-rc1** (published 2023-07-31) · 0 weekly downloads ## Install ```sh npm install boostpow pnpm add boostpow yarn add boostpow bun add boostpow ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.0.0-rc1 | | Published | 2023-07-31 | | First published | 2021-09-24 | | Weekly downloads | 0 | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 13 | | Unpacked size | 1 MB | | Known vulnerabilities | 0 (+23 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 6 | | Maintainers | stevenzeiler | | Keywords | bitcoin, bsv, bitcoin-sv, metanet, boost, proof-of-work, pow, boost-pow, boost-protocal, hashcash, blockchain, satoshi, satoshi-vision | ## Links - npm: https://www.npmjs.com/package/boostpow - Repository: https://github.com/pow-co/boostpow-js - Homepage: https://github.com/pow-co/boostpow-js#readme - Issues: https://github.com/pow-co/boostpow-js/issues - npm.io page: https://npm.io/package/boostpow ## Dependencies (13) - [i](https://npm.io/package/i.md) ^0.3.6 - [bsv](https://npm.io/package/bsv.md) ^1.5.6 - [bs58](https://npm.io/package/bs58.md) ^5.0.0 - [axios](https://npm.io/package/axios.md) ^0.21.1 - [clone-deep](https://npm.io/package/clone-deep.md) ^4.0.1 - [@types/node](https://npm.io/package/@types/node.md) ^13.7.7 - [randombytes](https://npm.io/package/randombytes.md) ^2.1.0 - [mattercloudjs](https://npm.io/package/mattercloudjs.md) ^1.0.12 - [vm-browserify](https://npm.io/package/vm-browserify.md) ^1.1.2 - [crypto-browserify](https://npm.io/package/crypto-browserify.md) ^3.12.0 - [stream-browserify](https://npm.io/package/stream-browserify.md) ^3.0.0 - [crypto-random-string](https://npm.io/package/crypto-random-string.md) ^3.1.0 - [node-polyfill-webpack-plugin](https://npm.io/package/node-polyfill-webpack-plugin.md) ^1.1.4 ## Alternatives - [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads - [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads - [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads - [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads - [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads ## Recent versions - 2.0.0-rc1 (latest) — 2023-07-31 - 1.9.1 — 2023-06-28 - 1.9.0 — 2023-06-27 - 1.8.6 — 2023-05-01 - 1.8.5 — 2023-05-01 - 1.8.3 — 2023-04-27 - 1.8.2 — 2023-04-27 - 1.8.1 — 2022-08-03 - 1.8.0 — 2022-08-03 - 1.7.2 — 2022-08-03 - 1.7.1 — 2022-07-31 - 1.7.0 — 2022-07-31 - 1.6.0 — 2022-05-22 - 1.5.0 — 2022-04-26 - 1.4.1 — 2022-04-18 - … 11 more at https://npm.io/package/boostpow/versions ## README # Boost POW Javascript Library > Boost Proof of Work Protocol > https://boostpow.com Boost is a new type of content ranking system that enables users to increase the amount of energy required to mine or process their content. Users will boost their post as a way to signal to the network that they believe their information is valuable. Boosted posts will appear in the boost feed – ordered by the amount of energy requested for their information. [![ProofOfWorkCompany](https://circleci.com/gh/pow-co/boostpow-js.svg?style=shield)](https://circleci.com/gh/ProofOfWorkCompany/boostpow-js) [![Node.js CI](https://github.com/pow-co/boostpow-js/actions/workflows/node.js.yml/badge.svg)](https://github.com/ProofOfWorkCompany/boostpow-js/actions/workflows/node.js.yml) [![npm version](https://badge.fury.io/js/boostpow.svg)](https://badge.fury.io/js/boostpow) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) ## Preview A Boost Pow String (also called "Boost Header") consist of an 80 byte string that is encoded identically to a Bitcoin Block Header. The string is valid if the hash256 of the string is less than the target difficulty specified inside the string. We can objectively order content of Boost Pow Strings from most to least energy (difficulty) in a way that is self-evident and provable. The world's first provably fair content ranking system powered by native Bitcoin Proof of Work. **Boost Pow String:** ``` 010000009500c43a25c624520b5100adf82cb9f9da72fd2447a496bc600b0000000000006cd862370395dedf1da2841ccda0fc489e3039de5f1ccddef0e834991a65600ea6c8cb4db3936a1ae3143991 ``` And its hash256 is: **0000000000002917ed80650c6174aac8dfc46f5fe36480aaef682ff6cd83c3ca** **Sample code to verify Boost Pow String**: ```javascript // Validate a Boost Pow String // Underneath bsv.js validates the string *exactly* like a Bitcoin Block Header const powString = boost.BoostPowString.fromString('010000009500c43a25c624520b5100adf82cb9f9da72fd2447a496bc600b0000000000006cd862370395dedf1da2841ccda0fc489e3039de5f1ccddef0e834991a65600ea6c8cb4db3936a1ae3143991'); // Print out the decoded string console.log(powString.toObject()); /* { hash: '0000000086915e291fe43f10bdd8232f65e6eb64628bbb4d128be3836c21b6cc', content: '00000000000000000000000000000000000000000048656c6c6f20776f726c64', bits: 486604799, difficulty: 1, metadataHash: "acd8278e84b037c47565df65a981d72fb09be5262e8783d4cf4e42633615962a", time: 1305200806, nonce: 3698479534, category: 1, } */ ``` ## Installation ```sh npm install boostpow --save ``` # Boost POW **A Protocol for Buying and Selling Proof-of-Work Embedded in Bitcoin Script** pow.co Boost is a new type of content ranking system that enables users to increase the amount of energy required to mine or process their content. Users will boost their post as a way to signal to the network that they believe their information is valuable. Boosted posts will appear in the boost feed – ordered by the amount of energy requested for their information. **Links**: - Javascript SDK: boostpow - Whitepaper ## MoneyButton, Relay, TwetchPay Integration Easily integrate MoneyButton, Relay, and TwetchPay Consult the respective documentation for additional details. All services support the 'outputs' format presented below for easy integration. ```javascript const boost = require('boostpow'); // Create a Boost request with your data const boostJob = boost.BoostPowJob.fromObject({ content: Buffer.from('hello world', 'utf8').toString('hex'), diff: 1, // Minimum '1'. Specifies how much hashrate. 1 = difficulty of Bitcoin Genesis (7 MH/second) category: Buffer.from('B', 'utf8').toString('hex'), additionalData: Buffer.from(`{ "foo": 1234, "metadata": "hello"}`, 'utf8').toString('hex'), userNonce: Buffer.from(Math.random(999999999), 'utf8').toString('hex'), tag: Buffer.from('funny-animals', 'utf8').toString('hex'), }); // Construct a MoneyButton or Relay Output const boostOutputs = [{ script: boostJob.toASM(), amount: boostJob.difficulty * 0.0001, // Charge a fee for the Boost. In future this will be a feeQuote system. Higher payout the more likely a miner will mine the boost relativity to the diff. currency: "BSV" }]; // Now you can populate MoneyButton, Relay or TwetchPay with the outputs: twetchPay.pay({ label: 'Boost Content', outputs: boostOutputs, onPayment: async (e) => { // submit to the JSON API for immediate indexing // In the future a planaria will pick it up automatically on-chain, for now submit the rawtx } }); ``` ## Build and Test ``` npm install npm run build npm run test ``` ----------- ## Any questions or ideas? Daniel Krawisz - daniel@pow.co Derrick Horton - derrick@pow.co Rafael LaVerde - rafael@pow.co Steven Zeiler - steven@pow.co --- _Source: https://npm.io/package/boostpow · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._