Morpho Ledger Plugin

Nano S, S Plus and X plugin for Morpho Labs.

This plugin supports aave-v2 and compound morpho dapps on Ethereum mainnet.

Plugins:

Plugins are lightweight applications that go hand-in-hand with the Ethereum Application on Nano S, SP and X devices.

They allow users to safely interact with smart contracts by parsing the transaction data and displaying its content in a human readable way.

It is STRONGLY recommended to follow the plugin guide in order to better understand the flow and the context for plugins.

Formating:

The C source code is expected to be formatted with clang-format 11.0.0 or higher.

Environment Setup:

Get Docker and Docker-compose.

In a terminal window:

mkdir plugin_dev

cd plugin_dev

git clone https://github.com/LedgerHQ/app-ethereum

git clone https://github.com/LedgerHQ/plugin-tools

git clone https://github.com/gpiriou/morpho-ledger-plugin/

app-ethereum must be on the develop branch.

Build the apps

Launch Docker.

In the same terminal:

cd plugin-tools

./start.sh

cd ../morpho-ledger-plugin/tests/

./build_locals_test.sh all

If needed, replace all with the appropriate flags to specifically build the plugin for S, SP or X and the ethereum app.

Find more info about PRINTF and debugging here.

Running the tests:

Testing with ZEMU:

cd <path>/morpho-ledger-plugin/tests.

yarn test to run all tests

OR

yarn test -t "<name-of-test>" to run a singular test.

The singular test names can be found in the ./tests/src/<test-folder>/*.test.js files.

Note: Sometimes, batched tests may fail. It is recommended to launch a singular test for the failed one to make sure the error does not come from the ZEMU tester.

Find more information about the Zondax ZEMU tester.

Testing on browser:

It is possible to send APDU's to a browser hosted Nano S emulator using speculos via Docker.

Install ledgerblue:

pip3 install ledgerblue

Add these aliases.

speculos='docker run --rm -it -v <path>/plugin_dev/morpho-ledger-plugin/tests/elfs:/speculos/apps -p 5000:5000 --publish 41000:41000 speculos --display headless --vnc-port 41000 --apdu-port 41000 apps/ethereum_nanos.elf -l Morpho:apps/morpho_nanos.elf'

ledgerspec='cat <path>/plugin_dev/-ledger-plugin/tests/apdu/"$1".apdu | LEDGER_PROXY_ADDRESS=127.0.0.1 LEDGER_PROXY_PORT=41000 python3 -m ledgerblue.runScript --apdu'

In a new terminal window enter:

speculos

Open a browser page and enter localhost:5000 in the url field. The browser page should be emulating a Nano S.

In another terminal window type:

ledgerspec borrow_wbtc

The emulating page should display a Morpho - Compound borrow transaction.

More information on the speculos doc page.

Testing by sideloading:

It is also possible to sideload the plugin into a Nano S by using ledgerblue.

This must be executed on Debian (version 10 "Buster" or later) and Ubuntu (version 18.04 or later).

pip3 install ledgerblue

Clone the apropriate repositories.

Set the path for BOLOS_SDK to <path>/nanos-secure-sdk.

Plug and unlock the device and enter in the terminal:

cd <path>/app-ethereum

make load BYPASS_SIGNATURES=1 BOLOS_SDK=$NANOS_SDK CHAIN=ethereum to load the ethereum app to the device.

Follow the steps displayed on the ledger.

Once installed you should be able to open the ethereum app and land on the "Application is ready" screen.

cd ../morpho-ledger-plugin/

make load BOLOS_SDK=$NANOS_SDK to load the plugin.

Send APDU's to the ledger with this alias:

ledger='cat <path>/plugin_dev/morpho-ledger-plugin/tests/apdu/"$1".apdu | sudo -E python3 -m ledgerblue.runScript --targetId 0x310004 --apdu'

Open the plugin.

ledger borrow_wbtc to send the APDU's contained in the file to the ledger.

Plugin modifications:

Basic modifications:

The plugin has 3 basic components for modifications:

Number of screens.
Screen function calls.
String defines.
Supported tokens

1. Number of screens:

There are two variables that can set the screen number.

In ./src/handle_finalize.c the msg->numScreens variable defines how many screens will be displayed.

In ./src/handle_provide_token.c the msg->additionalScreens variable can increase the previously set screen number.

2. Screen function calls:

There are two functions where the screen strings are set.

ID screen:

The first screen is the ID screen, set in ./src/handle_query_contract_id.c.

Note: It is not included in the amount of screens of msg->screenIndex.

UI screens:

These screens are set in ./src/handle_query_contract_ui.c.

Edit the switch(msg->screenIndex) cases of handle_<name-of-action>_ui() functions if needed.

Defines:

TITLE_<NAME_OF_ACTION>_SCREEN_#_UI (top)
MSG_<NAME_OF_ACTION>_SCREEN_#_UI (bottom)

Edit these in ./src/text.h to modify the strings displayed to the user.

Supported tokens

To add supported tokens, add them to the tokens_list array and increase NUM_TOKENS_SUPPORTED accordingly in tokens.h.

*Note: The address is the collateral token's but the ticker and decimal are for the original and corresponding token.

Advanced modifications:

Follow this guide to further modify the plugin.

Deployment

Visit this page to make sure the plugin meets the standards and you have completed all the steps necessary for deployment.

morpho-org / morpho-ledger-plugin Goto Github PK