Nocturne Ejector CLI

Since Nocturne is shutting down, all off-chain infrastructure run by Nocturne Labs, including the frontend, will eventually be turned off. However, the contract still lives on-chain, so you can still withdraw your funds by interacting with it directly. This CLI is a tool that automates this, withdrawing all funds from the protocol (leaving no dust whatsoever) to a burner wallet of your chosing.

Before starting, please read this README in full.

Prerequisites

This CLI only works on Mac and Linux. If you're running Windows, use WSL to run Linux.

Before using this repo, you must have the following installed:

• Node.Js version 18. This can be installed from the official website here.
• git. If you don't already have it installed, you can find instructions for installing it here

And you must have access to the following:

• A fresh Ethereum account, the withdrawal account. This is account you will withdraw your funds to, so it needs to have the following:
  • enough ETH to pay for gas to complete the withdrawal. The exact amount will depend on gas prices and how many deposits there are to withdraw
  • the ability to export the private key. If you're using a hardware wallet, we reccomend to withdraw funds into a "burner" hot wallet and then transfer the funds back to your hardware wallet.
• The Ethereum account you used to sign the key generation message when creating your Nocturne account. For more information about what this is, see our docs.
• An RPC node. You can find publicly-accessible nodes here, though we reccomend setting up a free alchemy account because we make a lot of calls to the node when syncing.

Note that the process will involve exporting your private key and passing it into the CLI's via an environment variable. To stay safe, we strongly reccomend you use a "burner" wallet to withdraw.

Usage

Setup

1. open a terminal and clone the repo by running git clone https://github.com/nocturne-xyz/nocturne-ejector-cli.git
2. move into the repo by running cd nocturne-ejector-cli.
3. run git submodule init
4. run git submodule update --remote
5. run corepack enable
6. run yarn install
7. run npm i -g
8. In the root directory of the repo, locate the file called .env.example. Within it there will be three empty variables: NOCTURNE_SPENDING_KEY, RPC_URL, and WITHDRAWAL_ACCOUNT_PRIVATE_KEY.
9. Make a copy of it, and name it .env. This is how you will tell which private keys the CLI should use.

Filling the .env file

To get NOCTURNE_SPENDING_KEY, run nocturne-ejector-cli export-spend-key. This will locally host a UI (only on your machine) that you can use to export your Nocturne Spending Key. Then do the following:

1. Open your browser and go to http://localhost:3000 to open the UI
2. Connect to MetaMask from the acconut you originally used to set up your Nocturne account
3. Sign the key generation message to re-derive your spend key.
4. You should now see your spending key as a hex string. Copy it into the NOCTURNE_SPENDING_KEY field inside your .env file.
5. Press Ctrl-C in your terminal to stop the frontend once you're done.

To get WITHDRAWAL_ACCOUNT_PRIVATE_KEY, export the private key for the EOA you're using to withdraw and paste it into the WITHDRAWAL_ACCOUNT_PRIVATE_KEY field inside your .env file.

To get RPC_URL, find the URL of the RPC node you prepared in the prerequisites and paste it into the RPC_URL field inside your .env file.

Withdrawing funds

Once you've filled your .env file, all you need to do is nocturne-ejector-cli withdraw. It will:

1. sync your balances
2. prepare a single transaction that withdraws all of your funds from nocturne to the withdrawal EOA in a single transaction.
3. ask for confirmation, and submits the TX if confirmation is given.

Tip: if sync is failing, it's likely due to the CLI overloading your RPC node. Try running with a longer delay between RPC calls. You can set this by running the withdraw command with --rpc-sync-throttle DELAY_MS, where DELAY_MS is the desired delay in milliseconds. By default it's 1000ms. For example, nocturne-ejector-cli withdraw --rpc-sync-throttle 2000.

Example

Here's an worked example that puts it all together, making it clear what each key is for:

1. Suppose I created my Nocturne account by signing the keygen message with Ethereum account 0xaaa. I then deposited some funds into that Nocturne account. I want to withdraw, and I can't access the frontend.
2. I create a separate burner wallet I'm going to withdraw my funds to - its address is 0xbbb. Since this is a hot wallet, I can export my private key, which is 0xccc.
3. I clone the repo and set it up according to the setup instructions above
4. I set WITHDRAWAL_ACCOUNT_PRIVATE_KEY-0xccc in .env
5. I run nocturne-ejector-cli export-spend-key to start the UI, open it at http://localhost:3000, and follow the instructions to export my Nocturne Spending Key, which is 0xddd
6. I set NOCTURNE_SPENDING_KEY=0xddd in .env
7. I set RPC_URL to the URL of my RPC node in .env
8. I run nocturne-ejector-cli withdraw, wait for it to sync, then type yes when is asks for confirmation.
9. I wait for the transaction to land, and see the funds in my burner wallet