Skip to content

Latest commit

 

History

History
74 lines (47 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

74 lines (47 loc) · 1.86 KB

Contributing

Overview

This repository contains the Avalanche BOLOS application for the Ledger Nano S and Ledger Nano X and tools for testing the application. While this app is currently under development, we do not recommend using it.

This application has been developed against our fork of Avalanche.js. Most instructions assume you have the Nix Package Manager, which you can install on any Linux distribution or MacOS. Application and wallet developers who would like to support Ledger can do so with LedgerJS.

Installation on the Nano S

To install from the source directory, ensure that you have nix installed, run

./nix/install.sh -t s

and accept the prompts on your ledger device.

Development

Developing on the Ledger Nano S

Incremental Build

nix-shell -A wallet.s --run 'make all'

Load

nix-shell -A wallet.s --run 'make load'

Developing on the Ledger Nano X

Incremental Build

nix-shell -A wallet.x --run 'make all'

Load

Ledger Nano X does not currently have a way to load unsigned apps. Testing need to be done through Ledger Live.

Testing

Automated Testing

You can run automated tests through speculos via the ./test.sh script. Just run this:

nix-shell -A wallet.s --run 'make test'

Running the same test suite on a live ledger currently requires that the ledger be configured with the recovery phrase

glory promote mansion idle axis finger extra february uncover one trip resource
lawn turtle enact monster seven myth punch hobby comfort wild raise skin

and then you can (with the ledger connected) run

nix-shell -A wallet.s --run 'make; ./test.sh -h'

The test suite currently does not test any rejections, so just accept every prompt that happens.