npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

bitcoin-bpp

v1.0.3

Published

Bitcoin Paywall Protocol npm module

Downloads

10

Readme

Bitcoin Paywall Protocol (BPP)

A simple protocol for creating a generic pay-to-access paywall.

Authors: Siggi

Problem statement

At the moment there are a lot of paywall solutions available, for instance for Wordpress there around 54 plugins that can be found when searching for "paywall". All these paywall solutions rely on hiding content on the server side, until a payment has been made. This does not work on Bitcoin when the content is posted to the blockchain directly.

Solution

To create a functioning paywall for content that is published to an open ledger, the only viable solution is to encrypt the paywall part of the content and reveal the encryption key to the reader after payment. The reader can then decrypt the content with the encryption key and see access all the content.

For this to work, the BPP protocol describes a way a service provider can keep the encryption key in escrow until a valid payment transaction has been presented and the encryption key is shared.

This would work in the following way:

  1. The creator would create content and encrypt with a key
  2. The creator would create a transaction of the data, including the BPP data
  3. The creator would register the decryption key with a service provider, referencing the transaction created in 2)
  4. A reader would create a payment transaction for the amount needed
  5. A reader would send the payment transaction to the service provider, the service provider would respond with the decryption key
  6. The service provider publishes and settles the transaction on the blockchain
  7. A reader can now decrypt and access the content at any time from anywhere
  8. The reader stores the received decryption key on-chain in a transaction

Protocol

The protocol follows the Bitcom syntax and should only be used in conjunction with other Bitcom protols (like B).

OP_RETURN
  ...
  |
  BPP
  PAY
  <currency>
  <address(es) for payment>:<amount(s)>
  <api endpoint>

Example using B protocol, totalling USD 0.10:

OP_RETURN
  19HxigV4QyBv3tHpQVcUEQyq1pzZVdoAut
  <encrypted Hello World!>
  text/plain;ecies
  utf-8
  hello.txt
  |
  BPP
  PAY
  USD
  1LrcP5Sub18uhdJur8Ekw1YwgWkms7rqyL:0.10
  https://blockpost.network/v1/paywall

An example of a multi payout request, totalling 0.004 BSV:

OP_RETURN
  ...
  |
  BPP
  PAY
  BSV
  1LrcP5Sub18uhdJur8Ekw1YwgWkms7rqyL:0.002,16ESASXcutrWPqC1GJYZBBHSm1xtsgn6Zb:0.001,1KNWoxv3nXEk1eSwsJiPtBA1j79XMjE6Y1:0.001
  https://blockpost.network/v1/paywall

A POST request needs to be sent to the API endpoint with the transaction id of the data, and a raw Bitcoin transaction in the POST body, where the recipient(s) is being paid the correct amount.

curl -X POST -d <JSON data> "https://blockpost.network/v1/paywall"

First a payment request needs to be created. This allows the server to create a record of the action and translate any paymails into Bitcoin addresses.

The JSON payload of the paywall API request is as follows:

{
  "action": "request",
  "txId": "<transactionId of content being paid for>"
}

This would return:

{
  "requestId": "<some request id string>",
  "outputs": "<outputs that need to be paid, in the same format as BPP definition>"
}

A payment needs to be made to each of the recipients in the output, with the correct amount. That is then POST'ed to the api point with the following data:

{
  "action": "pay",
  "requestId": "<request id from the earlier request",
  "txId": "<transactionId of content being paid for>",
  "paymentTx": "<raw payment transaction in hex>",
  "publicKey": "<Public key of user used to encrypt the decryption key>"
}

This would return:

{
  "txId": "<transactionId of payment receipt>",
  "key": "<decryption key>"
}

Receipt

The public key of the user will be used to create a transaction with the decryption key and the address corresponding to the public key. In this way the user will have both a receipt of payment, but also a way to access the decryption key at any time in the future.

OP_RETURN
  BPP
    PAID
    <txId>
    <address corresponding to public key>
    <encrypted decryption key>
  MAP
    SET
    app
    <appname>
    type
    payment
    context
    tx
    tx
    <txId>
  AIP
    [Signing Algorithm]
    [Signing Address]
    [Signature]

This transaction will be signed and posted by the apiEndpoint service provider.