diff --git a/README.md b/README.md index c82e7a4..be33471 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,13 @@ Ethereum wallet application framework for Nano S and Nano X. Ledger Blue is not maintained anymore, but the app can still be compiled for this target using the branch `blue-final-release`. -This app follows the specification available in the `doc/` folder +This app follows the specification available in the `doc/` folder. -To compile it and load it on a device, have a look here: https://ledger.readthedocs.io/en/latest/userspace/getting_started.html +To compile it and load it on a device, please check out our [developer portal](https://developers.ledger.com/docs/NA/start_here/). + +# Plugins + +This app support external plugins. More info in [doc/ethapp_plugin.asc](https://github.com/LedgerHQ/app-ethereum/blob/master/doc/ethapp_plugins.asc). If you wish to have a look at an existing plugin, feel free to check out the [ParaSwap plugin](https://github.com/LedgerHQ/app-plugin-paraswap). # Testing @@ -55,5 +59,4 @@ Then copy the binary to the `tests/elfs` folder (in this case, compiled with SDK cp bin/app.elf tests/elfs/ethereum_nanos.elf ``` -Repeat the operation for a binary compiled with nanoX SDK and change for `ethereum_nanox.elf`. - +Repeat the operation for a binary compiled with nanoX SDK and change for `ethereum_nanox.elf`. \ No newline at end of file diff --git a/doc/ethapp_plugins.asc b/doc/ethapp_plugins.asc index 0c320d6..b112639 100644 --- a/doc/ethapp_plugins.asc +++ b/doc/ethapp_plugins.asc @@ -10,6 +10,8 @@ Specification version 1.0 - 24th of September 2020 This specification describes the plugin interface used to display a specific UI on device for Ethereum smart contracts. +Feel free to checkout the ParaSwap plugin to see an actual implementation. Link: https://github.com/LedgerHQ/app-ethereum/blob/named-external-plugins/doc/ethapp_plugins.asc . + ## Flow overview When signing an Ethereum transaction containing data, the Ethereum application looks for a plugin using .either a selector list or the contract address. @@ -279,7 +281,7 @@ The following return codes are expected, any other will abort the signing proces When setting a pointer from the plugin space, make sure to use an address that will be accessible from the Ethereum application (typically in the plugin RAM context, *not* on the plugin stack) -Do not use data types that need to be aligned (such as uint32_t) in the plugin context +Do not use data types that need to be aligned (such as uint32_t) in the plugin context. ## TODOs