Skip to main content

Salt Recovery Tool

The Salt Recovery Tool shows that Salt is a truly self-custodial platform:

  • You are in control of your key shards and key material.
  • Salt never holds this information.
  • Salt can never lock or freeze your funds.

The tooling is made up of several parts.

Desktop recovery app​

The desktop app is the simplest recovery option. Download it from GitHub. It is available for:

  • Windows
  • Linux
  • Mac

The Salt Recovery Tool is fully open source. See instructions in the GitHub repo for how to:

  • compile the desktop app from source
  • run it as a Node.js desktop application
  • run it as a portable binary application

What the app does​

The tool has a user interface. It asks you to enter the relevant key material, then re-derives your Salt accounts, including child account private keys.

You can import these private keys into any wallet you like. We recommend MetaMask, but other wallets will work too. You will see that you hold the full private key to your Salt account, and that you can move funds.

Use a test organisation​

warning

Unless you are in a real disaster recovery scenario, only use the desktop recovery app on an organisation and accounts you have created specifically to test this feature. If due diligence recovery tests must be performed on production accounts, use the Salt Recovery Tool Command Line Interface.

Once a private key has been fully formed on an online computer, it should not be used in production to hold real digital assets.

You can be assured that the MPC accounts holding your real assets work in exactly the same way. You created those organisations in exactly the same way as the test organisation we recommend you create to try the recovery app.

Command Line Interface​

The Salt Recovery Tool also includes a command line interface (CLI) as an alternative to the desktop app. Instructions for using it are on GitHub.

The CLI is the lower-level tooling that the desktop recovery app is built on. Because it can be used programmatically, it is very useful for recovering a large number of accounts.

Salt Recovery Scripts​

The CLI is used by the Salt Recovery Scripts.

tip

The Salt Recovery Scripts are safe to use on production MPC accounts to test disaster recovery access to your digital assets.

Used correctly, as described in the scripts' README, they let you:

  • Safely create a transaction from a production MPC account
  • Broadcast that transaction on Etherscan
  • Be sure that your production MPC account, holding real digital assets, can be fully recovered

Key material is only ever entered into a completely offline server, so the account's key material stays safe. As long as the script instructions are followed, the account can continue to be used in production.

note

The scripts must be run by an owner of the organisation.

They are written to be as easy as possible to run, so deep technical knowledge is not required, however some basic terminal skills are useful.