ln-vortex / ln-vortex

Lightning and Taproot enabled collaborative transactions

---

Vortex is a tool to allow users to open lightning channels in a collaborative transaction when using lnd and Core Lightning

Compatibility

Vortex is compatible with lnd version v0.15.4-beta and up & core lightning version v0.10.2.

Building from source

Scala/Java

You can choose to install the Scala toolchain with sdkman or coursier.

Sdkman

You can install sdkman here

Next you can install java and sbt with

sdk install java # not always needed
sdk install sbt

Coursier

If you don't like curl, you can use OS specific package managers to install coursier here

ln-vortex requires java9+ for development environments. If you do not have java9+ installed, you will not be able to build ln-vortex. You will run into this error if you are on java8 or lower

If you follow the coursier route, you can switch to a java11 version by running

cs java --jvm adopt:11 --setup

macOS install

brew install scala
brew install sbt

Running the client

Running the client can simply be done by running

sbt rpcServer/run

ln-vortex's Issues

Reconcile round does not work

Currently it creates 4 new rounds so the peers will receive the first round and not be able to autheticate for the resuling round the coorindator has

Flesh out docs

• quick start
• privacy principles
  • guarantees we give
  • taproot
• config
  • lnd options
  • adding coordinators

Automate release binaries

Process transactions outside of vortex

If a user makes a transaction outside of vortex they'll likely lose their saved anon set and isChange of that utxo.

Create sample-vortex.conf

Includ pending channels in channel list

Allow client to support multiple coorindators

Should probably just make something like VortexClientManager that has multiple clients in it and initiate and closes them in aggregate

Non-networking client server tests still are receiving network messages

Experienced this in RemixTest

Make datadir and port confurable

Currently it is only really possible to run 1 vortexd on a machine, need to make these configurable

Use minimum utxos for round

Currently we just use all the utxos the user selects, we should use the minimum of these

Mark channels anon sets

In list channels we could set the anon set

Still overpaying on fees

Allow for on-chain coordinator and LN coordinator

Add special logic for toxic change

At the very least we should allow the user to provide a custom address. Would be ideal to have it go to a separate account

Add telegram and Twitter integrations for coordinator

A telegram bot to get accounting info, maybe a public facing one with current round params

A Twitter bot that tweets every completed round.

Create tests around round reconciliation

When queueCoins fails, allow for retries

When queueing coins, if any error is returned (ex: "error": "Request failed: Unknown address type"), then the status of the round is getting updated to ReceivedNonce. This issue is relatively recent because I was able to retry queueing coins before.

The way around this issue now is to cancelcoins, although no coins are actually queued.

Add eclair support

Reliant on ACINQ/eclair#1565

Amboss Magma integration

Could add the ability to sell a magma channel through vortex.

User would create an offer of the round amount, then once it is purchased they would queue up a channel open.

Could add in things like making sure the magma fee is higher the coordinator fee so the user always makes money. Or for remixes they can advertise a lower fee because there is no fee to open the channel

https://docs.amboss.space/api/magma/

Add recconect logic if coordinator is disconnected

Create cli command to view status of queued coins

Update CLN to v0.12.0

"/<unresolved>" in peerAddrOpt

Might not be a real issue, but when queueing coins with a peer address and then calling getstatus, peerAddrOpt is formatted like:

"peerAddrOpt": "xyz.onion/<unresolved>:port"

Add code coverage checks

Use DBIO actions to improve safety and speed

Lnd fails to label vortex transcations

It gives an error saying the transaction is already labeled

Decompose change outputs that are larger than the target amount

Will need to rework the protocol

Use websockets instead of Raw TCP socket

https://doc.akka.io/docs/akka-http/current/server-side/websocket-support.html

https://doc.akka.io/docs/akka-http/current/client-side/websocket-support.html

Move input & output fee calculations to core

Currently they exist in the coordinator and it isn't the best place for it

Fix downloadLnd

Need to update to download the arm64 version for mac

Add content to homepage of website

Ideas:

• open a channel, privately
• supports lnd, cln, Bitcoin core
• Taproot enabled 🥕

Star on github
Add license to footer

If a client is disconnected, de-queue them

Add tests around banning utxos

Label coinjoin transcation in LND after it is broadcast

See if we can package vortexd and gui together

Create cli command for canceling queued coins

Rewrite protocol documentation

Fix multiple log bindings

Fix cli command for coordinator

Create website

Can use something like docusarus

Update docker-compose.yml file

Need to add the now deployed image of the gui. Also need to update the vortexd image and fix all the old env variables.

Rotate coordinator key

It is technically insecure to reuse the key infinitely when doing blind signing. We just need to rotate the public key every round to be safe

Add better support for running multiple coordinators

Right now the only way to accomplish this would be separate datadir for each of them. Would be better to do something akin to the wallet Name in bitcoin-s

Make ban durations configurable

Have round announcement websocket send update fee rates

Would be an improvement to have the round annoucement websocket to send updated fee rates to peers every so often so they can have a better estimation and time approaches

Run failing on mac: no main class detected

After following the setup process on mac, sbt gui/run is failing:

[error] java.lang.RuntimeException: No main class detected.
[error] 	at scala.sys.package$.error(package.scala:30)

However, sbt gui/compile succeeds.

Should mainClass be defined in the build file to resolve this?

Add coordinator api docs

Should add documentation around the coordinator endpoints

https://github.com/swagger-akka-http/swagger-akka-http

Change default port for different networks

It's annoying when a regtest or testnet instance overlaps with a mainnet instance. Creating default ports for the different networks would solve this

Set anon set for channel close address

We can set the eventual anon set of the address we get from closing a resulting channel

Add I2P as tor alternative

Tor is becoming increasingly unreliable, I2P seems like a good alternative. Transient addresses should be used by peers for privacy between rounds and for alice & bob distinction