Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Zondax/ledger-arweave

Arweave app for Ledger Nano S and X
https://github.com/Zondax/ledger-arweave

arweave ledger

Last synced: 2 months ago
JSON representation

Arweave app for Ledger Nano S and X

Lists

README 

        
# Ledger Arweave app



![stability-wip](https://img.shields.io/badge/stability-work_in_progress-lightgrey.svg)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![GithubActions](https://github.com/zondax/ledger-arweave/actions/workflows/main.yml/badge.svg)](https://github.com/Zondax/ledger-arweave/blob/main/.github/workflows/main.yaml)



---



![zondax_light](docs/zondax_light.png#gh-light-mode-only)

![zondax_dark](docs/zondax_dark.png#gh-dark-mode-only)



_Please visit our website at [zondax.ch](https://www.zondax.ch)_



---



This repository contains:



- Ledger Nano S/X BOLOS app

- Specs / Documentation

- C++ unit tests

- Zemu tests



## ATTENTION



Please:



- **Do not use in production**

- **Do not use a Ledger device with funds for development purposes.**

- **Have a separate and marked device that is used ONLY for development and testing**



## Download and install



_Once the app is approved by Ledger, it will be available in their app store (Ledger Live).

You can get builds generated by CircleCI from the release tab. THESE ARE UNVETTED DEVELOPMENT RELEASES_



Download a release from here (https://github.com/Zondax/ledger-icp/releases). You only need `installer_s.sh`



If the file is not executable, run

```sh

chmod +x ./installer_s.sh

```



then run:



```sh

./installer_s.sh load

```



# Development



## Preconditions



- Be sure you checkout submodules too:



    ```

    git submodule update --init --recursive

    ```



- Install Docker CE

    - Instructions can be found here: https://docs.docker.com/install/



- We only officially support Ubuntu. Install the following packages:

   ```

   sudo apt update && apt-get -y install build-essential git wget cmake \

  libssl-dev libgmp-dev autoconf libtool

   ```



- Install `node > v14.0`. We typically recommend using `n` for node version management. (This is used to run emulation tests)



- Install python 3



- Install other dependencies running:



  - `make deps`



- This project requires Ledger firmware 1.6

  - The current repository keeps track of Ledger's SDK but it is possible to override it by changing the git submodule.



_Warning_: Some IDEs may not use the same python interpreter or virtual enviroment as the one you used when running `pip`.

If you see conan is not found, check that you installed the package in the same interpreter as the one that launches `cmake`.



## How to build ?



> We like clion or vscode, however, he we describe reproducible command line steps that can be used anywhere



- Building the app itself



  If you installed all dependencies (as described above), just run:



  ```bash

  make

  ```



## Running tests



- Running C/C++ tests (x64)



  If you installed the what is described above, just run:



  ```bash

  make cpp_test

  ```



- Running device emulation+integration tests!!



   ```bash

    Use Zemu! Explained below!

    ```



## How to test with Zemu?



> What is Zemu?? Great you asked!!

> As part of this project, we are making public a beta version of our internal testing+emulation framework for Ledger apps.

>

> Npm Package here: https://www.npmjs.com/package/@zondax/zemu

>

> Repo here: https://github.com/Zondax/zemu



Let's go! First install everything:

> At this moment, if you change the app you will need to run `make` before running the test again.



```bash

make zemu_install

```



Then you can run JS tests:



```bash

make zemu_test

```



To run a single specific test:



> At the moment, the recommendation is to run from the IDE. Remember to run `make` if you change the app.



## Using a real device



### How to prepare your DEVELOPMENT! device:



> You can normally use an emulated device for development purposed. This is only required if you are working on some integration that requires a physical device.

>

> **Please do not use a Ledger device with funds for development purposes.**

>

> > **Have a separate and marked device that is used ONLY for development and testing**



There are a few additional steps that increase reproducibility and simplify development:



**1 - Ensure your device works in your OS**



- In Linux hosts it might be necessary to adjust udev rules, etc.



  Refer to Ledger documentation: https://support.ledger.com/hc/en-us/articles/115005165269-Fix-connection-issues



**2 - Set a test mnemonic**



Many of our integration tests expect the device to be configured with a known test mnemonic.



- Plug your device while pressing the right button



- Your device will show "Recovery" in the screen



- Double click



- Run `make dev_init`. This will take about 2 minutes. The device will be initialized to:



  ```

  PIN: 5555

  Mnemonic: equip will roof matter pink blind book anxiety banner elbow sun young

  ```



**3 - Add a development certificate**



- Plug your device while pressing the right button



- Your device will show "Recovery" in the screen



- Click both buttons at the same time



- Enter your pin if necessary



- Run `make dev_ca`. The device will receive a development certificate to avoid constant manual confirmations.



## Building the Ledger App



### Loading into your development device



The Makefile will build the firmware in a docker container and leave the binary in the correct directory.



- Build



  ```

  make                # Builds the app

  ```



- Upload to a device



  The following command will upload the application to the ledger:



  _Warning: The application will be deleted before uploading._



  ```

  make load          # Builds and loads the app to the device

  ```



## APDU Specifications



- [APDU Protocol](docs/APDUSPEC.md)