Lightning EVM Bridge

This is a project to create a trust minimized bridge between EVM chains and the Lightning Network. The goal is to allow for the creation of smart contracts that can make trust minimized payments to the Lightning Network. This really only makes sense in the context of chains using Bitcoin as their native currency, but it could be extended to other chains as well.

⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, Viem, and Typescript, and LND.

Project Structure
Payment Flow
Requirements
Getting Started
Deploying Smart Contracts
Running in Production
Future Work
Contributing

Project Structure

There are three main parts to this project:

Folder	Description
Contracts	This is where the smart contracts live
Frontend	This is the frontend of the app built using Scaffold-Eth 2
Lightning server	This is the lightning service provider websocket who is paying the invoices, this connects to your lightning node (is not one itself)
Relay server	This is the server that tries to claim the HTLC on behalf of the user who has no gas to recieve his payment

Payment Flow

sequenceDiagram

    participant User as Payer
    participant Botanix
    participant LSP
    participant LN
    participant Payee

    Payee-->>User: Payee creates ln-invoice
    User->>Botanix: User creates/funds HTLC
    User-->>LSP: User communicates with LSP: HTLC and Invoice
    LSP-->>Botanix: LSP verifies HTLC and Invoice
    LSP->>LN: LSP pays Invoice
    LN-->>Payee: LN pays invoice
    Payee-->>LN: Preimage is sent to LN
    LN-->>LSP: LN sends preimage
    LSP->>Botanix: LSP unlocks HTLC with preimage
    LSP-->>User: Botanix tells user the payment is complete

Requirements

Before you begin, you need to install the following tools:

Getting Started

Lightning Setup and Wallet Setup

This step is half optional. I provided you 3 options for running the lightning server:

A. You can run your own lightning node and server.

B. You can connect to my node and websocket server, so no nead to run any lightning stuff.

C. Run the lightning server in 'MOCK' mode, which will simulate the lightning server.

To set up, A, your own server:

Disclaimer: this is using REAL lightning network sats because it is just easier and more stable to do so. Do not put more than you are willing to lose.

You must have a lightning node running. I am using voltage which has a 20 day free trial to host your own node: Voltage.
Back up your seed and store it in a safe place.
Fund your node with some sats and fund your channel. I recommend opening a channel with someone well connected because it has higher chances of payment success.

Generate a new botanix wallet, store the hex private key somewhere safe, and fund it with some testnet sats.

Running Locally (A)

Clone this repo & install dependencies

git clone https://github.com/diyahir/lightning-dapp.git
cd lightning-dapp
yarn install

Copy the sample.env file in the root of the server and nextjs packages. Rename it to .env and fill in the required values.
Start the services

docker-compose up -d --build

or using docker build and run the images separately

docker build -f packages/nextjs/Dockerfile . -t botanix-ln-webapp
docker build -f packages/server/Dockerfile . -t botanix-ln-server

Alternatively:

Run the webapp in the first terminal:

yarn start

Run a local LSP server relayer in a second terminal

yarn server

Running Locally (B: Only Webapp, My Server)

Clone this repo & install dependencies

git clone https://github.com/diyahir/lightning-dapp.git
cd lightning-dapp
yarn install

Copy the sample.live.env file in the root of the nextjs package. Rename it to .env.
Start the webapp

yarn start

Running Locally (C: Mock Server)

Same as A, no need to do any lightning setup, but in the server .env file, set

LND_MACAROON=""
LND_SOCKET=""

This will run the server in mock mode.

Deploying Smart Contracts

To test the smart contracts

yarn foundry:test

Once you are ready to deploy your smart contracts, there are a few things you need to adjust.

Select the network

By default, yarn deploy will deploy the contract to the local network. You can change the defaultNetwork in packages/hardhat/hardhat.config.ts. You could also simply run yarn deploy --network target_network to deploy to another network.

Check the hardhat.config.ts for the networks that are pre-configured. You can also add other network settings to the hardhat.config.ts file. Here are the Alchemy docs for information on specific networks.

Example: To deploy the contract to the Sepolia network, run the command below:

yarn deploy --network sepolia

Generate a new account or add one to deploy the contract(s) from. Additionally you will need to add your Alchemy API key. Rename .env.example to .env and fill the required keys.

ALCHEMY_API_KEY="",
DEPLOYER_PRIVATE_KEY=""

The deployer account is the account that will deploy your contracts. Additionally, the deployer account will be used to execute any function calls that are part of your deployment script.

You can generate a random account / private key with yarn generate or add the private key of your crypto wallet. yarn generate will create a random account and add the DEPLOYER_PRIVATE_KEY to the .env file. You can check the generated account with yarn account.

Deploy your smart contract(s)

Run the command below to deploy the smart contract to the target network. Make sure to have some funds in your deployer account to pay for the transaction.

cd packages/foundry
yarn deployWithGasPrice --network botanixTestnet

Verify your smart contract

You can verify your smart contract on Etherscan by running:

yarn verify --network network_name

eg: yarn verify --network sepolia

This uses etherscan-verify from hardhat-deploy to verify all the deployed contracts.

You can alternatively use hardhat-verify to verify your contracts, passing network name, contract address and constructor arguments (if any): yarn hardhat-verify --network network_name contract_address "Constructor arg 1"

If the chain you're using is not supported by any of the verifying methods, you can add new supported chains to your chosen method, either etherscan-verify or hardhat-verify.

Make sure your packages/nextjs/scaffold.config.ts file has the values you need.

Running in Production

To run the app in production, you need to build the app and run the server.

Do all the steps in the Deploying your Smart Contracts to a Live Network section.
Do all the steps in the Lightning Setup section.
Pull the latest changes set your .env files and run the following commands:

docker-compose up -d --build

Run a Nginx server to serve the app, refer to the example.nginx.config file in the root of the project. This will require you to have a domain and a SSL certificate.
Set your DNS to point to the server.
Enjoy your app running in production.

Future Work

Server funds rebalancing (cycle funds from the evm chain to the lightning network channel)
Add support to receive payments from the lightning network to the evm chain
Create proper database for the server
Add ability to change LSP
Integrate service fee for the LSP
Preconfirmations from the LSP before user pays on-chain
Indexing payments to provide most recent history
Relay server for unlocking HTLCs

Disabling Github Workflow

We have github workflow setup checkout .github/workflows/lint.yaml which runs types and lint error checks every time code is pushed to main branch or pull request is made to main branch

To disable it, delete .github directory

Contributing

We welcome contributions to the lightning dapp.

Please see CONTRIBUTING.MD for more information and guidelines for contributing to the lightning dapp.

Acknowledgements

Special thanks to:

Scaffold-eth for the base of this project
Voltage for the lightning node service
HTLC Solidity base which I forked and updated https://github.com/chatch/hashed-timelock-contract-ethereum

diyahir/lightning-evm-bridge-dapp