PSKv2
Javascript implementation of the Pre-Shared Key V2 Interledger Transport Protocol.
PSK2 is a request/response protocol built on ILP that can send value and/or data. It handles generating conditions and fulfillments for ILP Prepare/Fulfill packets to send value, and it encrypts and authenticates request and response data.
PSK2 can be used to send indivdiual payment chunks, unfulfillable test payments for quotes, and it can be used as part of a protocol/module for streaming or chunked payments.
Installation
npm install ilp-protocol-psk2
API Documentation
See https://interledgerjs.github.io/ilp-protocol-psk2
Usage
Creating a Receiver
Uses createReceiver
and Receiver.generateAddressAndSecret
.
const createReceive = const receiver = await const destinationAccount sharedSecret = receiver// Give these two values to a sender to enable them to send payments to this Receiver
Try it out by running the example script.
Sending a Request
Uses sendRequest
.
const sendRequest = // These values must be communicated beforehand for the sender to send a paymentconst destinationAccount sharedSecret = await const fulfilled destinationAmount data = await if fulfilled console // Note the data format and encoding is up to the application protocol / module
Try it out by running the example script.
Sending an Unfulfillable Request or Quote
Uses sendRequest
.
const sendRequest = const randomBytes = // These values must be communicated beforehand for the sender to send a paymentconst destinationAccount sharedSecret = await const destinationAmount = await console
Try it out by running the example script.