Skip to main content

Setup

caution

Oasis Core Ledger is currently only supported on x86_64 Linux and macOS systems.

Prerequisites

Oasis Core Ledger CLI

There are no special requirements for running the Oasis Core Ledger CLI.

Ledger Signer Plugin

You will need an appropriate version Oasis Node CLI installed your system.

For more details, see the Oasis Node documentation in the general Oasis Docs.

caution

Currently, there are no binary releases of the Oasis Node CLI for macOS systems.

To be able to use the Ledger signer plugin on a macOS system, you will need to build the Oasis Node CLI from source.

Downloading a Binary Release

Go to Oasis Core Ledger's GitHub Releases page and download the latest version.

Building From Source

TODO: Link to Development docs once they exist.

Adding oasis-core-ledger Binary to PATH

To install the oasis-core-ledger binary for the current user, copy/symlink it to ~/.local/bin.

To install the oasis-core-ledger binary for all users of the system, copy it to /usr/local/bin.

Remembering Path to ledger-signer Plugin

For convenience, set the LEDGER_SIGNER_PATH to the location of the ledger-signer binary, e.g.:

LEDGER_SIGNER_PATH="$HOME/oasis_core_ledger_1.0.0_linux_amd64/ledger-signer"

Installing Oasis App on Your Ledger Wallet

The recommended way to install the Oasis app on your Ledger wallet is to install it via Ledger Live's Manager.

info

Currently, you will have enable Developer mode by going to Settings -> Experimental features, to be able to find the Oasis app in Ledger Live's Manager.

caution

To be able to install the current version (version 2.3.2) of the Oasis app, the firmware on your Ledger wallet needs to be up-to-date:

  • At least version 2.1.0 released on Nov 30, 2021 on a Nano S device.
  • At least version 2.0.0 released on Oct 21, 2021 on a Nano X device.

Follow Ledger's instructions for updating the firmware on your Ledger wallet:

info

To find the Oasis app in the Ledger Live app store, go to the App catalog search bar and type in Oasis.

You may see both the Oasis app and the OasisVal app come up in the search results. You need to use the standard Oasis app.

Oasis app in Ledger Live

Once installed, the Oasis app will use the generated mnemonic stored on the Ledger wallet to generate the private & public key pairs for your accounts.