Categorygithub.com/bitlum/lndzpay32
package
0.2.1-alpha
Repository: https://github.com/bitlum/lnd.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
9
Dependents
0
Files
117 SLOC

# README

zpay32

Build Status MIT licensed GoDoc

The zpay32 package implements a basic scheme for the encoding of payment requests between two lnd nodes within the Lightning Network. The zpay32 encoding scheme uses the zbase32 scheme along with a checksum to encode a serialized payment request.

The payment request serialized by the package consist of: the destination's public key, the payment hash to use for the payment, and the value of payment to send.

Installation and Updating

$ go get -u github.com/lightningnetwork/lnd/zpay32

# Functions

Decode attempts to decode the zbase32 encoded payment request.
Encode encodes the passed payment request using zbase32 with an added 4-byte crc32 checksum.

# Variables

ErrCheckSumMismatch is returned byt he Decode function fi when decoding an encoded invoice, the checksum doesn't match indicating an error somewhere in the bitstream.
ErrDataTooShort is returned by the Decode function if when decoding an encoded payment request, the number of bytes decoded is too few for a valid invoice indicating invalid input.

# Structs

PaymentRequest is a bare-bones invoice for a payment within the Lightning Network.