Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@coil/receipt-verifier

Package Overview
Dependencies
Maintainers
3
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@coil/receipt-verifier

Manages Interledger STREAM receipts

  • 1.0.3
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
3
Weekly downloads
 
Created
Source

Receipt Verifier

Manages Interledger STREAM receipts

npm version

STREAM receipts allow recipients or third parties to verify received payments at the recipient's Interledger wallet.

The Receipt Verifier:

  1. pre-shares a secret key with the receiving wallet for generating receipts, by acting as a proxy for SPSP queries to the recipient's payment pointer
  2. verifies receipts
  3. tracks balances where receipt amounts are credited

For Web Monetization, website visitors submit receipts to the website in monetizationprogress events. The website backend can send receipts to the Receipt Verifier to credit the balance for the particular Monetization ID and can subsequently spend against the Monetization ID balance as desired to confirm the payment.

Run

npm install
sudo docker run -p 6379:6379 -d redis
SPSP_ENDPOINT=https://receiver-endpoint.com npm start

Environment Variables

RECEIPT_SEED
  • Type: String
  • Description: Base64-encoded secret value used to generate receipt secret keys.
  • Default: random seed
RECEIPT_TTL
  • Type: Number
  • Description: The number of seconds since a stream's start time to consider a receipt valid.
  • Default: 300
REDIS_URI
  • Type: String
  • Description: The URI at which to connect to Redis. Use mock for in-memory Redis (NOT RECOMMENDED for production)
  • Default: redis://127.0.0.1:6379/
SPSP_ENDPOINT
  • Type: String
  • Description: The receiver's SPSP endpoint to which SPSP queries are proxied.
SPSP_PROXY_PORT
  • Type: Number
  • Description: The port that SPSP proxy will listen on.
  • Default: 3001
VERIFIER_PORT
  • Type: Number
  • Description: The port that Receipt Verifier API will listen on.
  • Default: 3000

API Documentation

POST /balances/{ID}:creditReceipt

Verifies receipt and credits the receipt value to the specified balance

Request Body:
  • Type: String
  • Description: base64-encoded STREAM receipt
Return Value:
  • Type: String
  • Description: updated balance for ID
POST /balances/{ID}:spend

Debits an amount from the specified balance if the balance is sufficient

Request Body:
  • Type: String
  • Description: amount to debit the balance
Return Value:
  • Type: String
  • Description: updated balance for ID

FAQs

Package last updated on 23 May 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc