jurvis / surge

A highly experimental, self-custody Lightning wallet built to work for iOS and macOS.

Surge

Surge is a highly experimental, self-custody Lightning wallet built to work for iOS and macOS.

Motivation

Tools and infrastructure for running a non-custodial Lightning wallet is advancing fast. Surge aims to be a project that developers can reference for "recipes" on how to implement a Lightning wallet with Lightning Development Kit.

This project will strive and do its best in demonstrating idioms for implementation on Apple platforms. It includes things like properly handling lightning:// URIs to encrypting and persisting channel material on-disk.

Therefore, if you see something that looks like bad Swift code, please file an issue! :)

Support

Surge currently is aiming to support the following environments/setups:

• Regtest (with Polar)
• Testnet w/ Bitcoin Core
• Testnet w/ Electrum

License

See LICENSE.md

surge's Issues

Store key seed with secure enclave/keychain

KeysManager takes in a 32-byte seed to derive keys. We generate one here but currently persist it trivially by writing it to disk unencrypted.

Instead, we should store it in the Keychain or, even better, the Secure Enclave. We likely will need to support both, for Macs without a touch bar, Touch ID, or Apple Silicon.

Add intermediary loading states for channel opens

Instead of requiring users to leave the app open while the channel opens, somehow persist information about channels that are pending opens, and show the progress in UI

Adding and managing peers

Implement a screen that allows users to copy a pubkey and add another node as a peer, and also to reconnect to them on resume from background/cold start

Opening a channel with a peer on Regtest

Be able to select a peer, input the amount of liquidity to lock in, and receive an address to fund the channel

Instead of requiring users to manually send the funds and mine blocks in CLI, let's do it automatically for them.

Encrypt channel material on disk

NSKeyed(Un)Archiver works okay for storing the network graph, channel monitors, and channel manager on disk.

However, we should encrypt that data on disk since they can leak through the Documents directory and can contain information related to the user's payments

Opening a channel with a peer on Testnet

Be able to select a peer, input the amount of liquidity to lock in, and receive an address to fund the channel

Pay invoice on Regtest

A user should be able to copy a lightning invoice and fulfill it

Generate an invoice on Regtest

A user should be able to specify the value for the invoice, and generate a BOLT 11 invoice for their peer to pay

Close a channel collaboratively with a peer