Skip to content

Commit

Permalink
Merge pull request #70 from obsidiansystems/develop
Browse files Browse the repository at this point in the history
Update Master for 0.5.4
  • Loading branch information
ApolloUnicorn authored Jul 8, 2021
2 parents ae86a7f + 1a11988 commit c6a053a
Show file tree
Hide file tree
Showing 12 changed files with 134 additions and 100 deletions.
1 change: 0 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
* Support signing of a hash with Ethereum BIP32 paths.
* Other miscellaneous bug fixes.


## 0.3.1

* Support P chain import and export.
Expand Down
49 changes: 25 additions & 24 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,72 @@
# Overview
# 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](https://nixos.org/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](https://github.com/obsidiansystems/ledgerjs/tree/avax).

# Installation on the Nano S #
## Installation on the Nano S

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

```
$ ./nix/install.sh -t s
```shell
./nix/install.sh -t s
```

and accept the prompts on your ledger device.

# Development #
## Development

## Developing on the Ledger Nano S ##
### Developing on the Ledger Nano S

### Incremental Build ###
#### Incremental Build

``` sh
$ nix-shell -A wallet.s --run 'make all'
```shell
nix-shell -A wallet.s --run 'make all'
```

### Load ###
#### Load

``` sh
$ nix-shell -A wallet.s --run 'make load'
```shell
nix-shell -A wallet.s --run 'make load'
```

## Developing on the Ledger Nano X ##
### Developing on the Ledger Nano X

### Incremental Build ###
#### Incremental Build

``` sh
$ nix-shell -A wallet.x --run 'make all'
```shell
nix-shell -A wallet.x --run 'make all'
```

### Load ###
#### Load

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

# Testing #

## Testing

## Automated Testing ##
### Automated Testing

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

``` sh
$ nix-shell -A wallet.s --run 'make test'
```shell
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

```
```text
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

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

Expand Down
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -170,3 +170,6 @@ test-no-nix: tests/node_packages tests/*.js tests/package.json bin/app.elf

tests/node_packages: tests/package.json
(cd tests; yarn install --frozen-lockfile)

listvariants:
@echo VARIANTS COIN AVAX
Loading

0 comments on commit c6a053a

Please sign in to comment.