Breez SDK 3 hour workshop

This workshop walks through the main functionality of the Breez SDK.

• Create/connect to a node
• Receive a payment
• lnurl withdraw
• send a payment

Next to the basic functionality, there's two examples of how to use the SDK in a functional context.

• Paying for api calls with the L402 protocol
• Paying for zaps with Nostr Wallet Connect (NIP-47: NWC)

Prerequisites

Rust

Make sure you have Rust installed on your system. Find instructions to install Rust here.

For unix-like systems the easiest to install rust is:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

protoc

In order to compile Breez SDK, you need a recent version protoc installed. Find instructions to install protoc here.

For linux

apt install -y protobuf-compiler
protoc --version  # Ensure compiler version is 3+

For mac

brew install protobuf
protoc --version  # Ensure compiler version is 3+

Getting started

To get started, go to the first exercise.