Merge pull request #267 from LedgerHQ/develop_1.9.17

Add Non-Fungible Token (ERC 721 & 1155) support

Author: Saltari

CHANGELOG.md

@@ -5,13 +5,40 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.9.17](https://github.com/ledgerhq/app-ethereum/compare/1.9.16...1.9.17) - 2022-01-14
+
+### Added
+
+- Support for Non-Fungible Tokens (ERC-721 & ERC-1155)
+
+## [1.9.16](https://github.com/ledgerhq/app-ethereum/compare/1.9.14...1.9.16) - 2022-01-13
+
+### Added
+
+- Shyft variant
+
+## [1.9.14](https://github.com/ledgerhq/app-ethereum/compare/1.9.13...1.9.14) - 2021-11-30
+
+### Added
+
+- Added Moonriver BIP44 1285
+
+### Fixed
+
+- Fixed stark order signature on LNS 
+
+## [1.9.13](https://github.com/ledgerhq/app-ethereum/compare/1.9.12...1.9.13) - 2021-11-17
+
+### Changed
+
+- Small improvement in app size
+
 ## [1.9.12](https://github.com/ledgerhq/app-ethereum/compare/1.9.11...1.9.12) - 2021-11-12
 
 ### Fixed
 
 - Fixed stark order signature on LNX 
 
-
 ## [1.9.11](https://github.com/ledgerhq/app-ethereum/compare/1.9.10...1.9.11) - 2021-10-12
 
 ### Added

Makefile

@@ -30,7 +30,7 @@ APP_LOAD_PARAMS += --path "1517992542'/1101353413'"
 
 APPVERSION_M=1
 APPVERSION_N=9
-APPVERSION_P=16
+APPVERSION_P=17
 APPVERSION=$(APPVERSION_M).$(APPVERSION_N).$(APPVERSION_P)
 APP_LOAD_FLAGS= --appFlags 0x240 --dep Ethereum:$(APPVERSION)
 
@@ -248,10 +248,10 @@ APP_LOAD_PARAMS += $(APP_LOAD_FLAGS) --path "44'/1'"
 DEFINES += $(DEFINES_LIB)
 
 #prepare hsm generation
-ifeq ($(TARGET_NAME), TARGET_NANOX)
-ICONNAME=icons/nanox_app_$(CHAIN).gif
-else
+ifeq ($(TARGET_NAME),TARGET_NANOS)
 ICONNAME=icons/nanos_app_$(CHAIN).gif
+else
+ICONNAME=icons/nanox_app_$(CHAIN).gif
 endif
 
 ################
@@ -283,19 +283,21 @@ DEFINES   += HAVE_UX_FLOW
 DEFINES   += HAVE_WEBUSB WEBUSB_URL_SIZE_B=0 WEBUSB_URL=""
 
 ifeq ($(TARGET_NAME),TARGET_NANOX)
-DEFINES   += IO_SEPROXYHAL_BUFFER_SIZE_B=300
 DEFINES   += HAVE_BLE BLE_COMMAND_TIMEOUT_MS=2000
 DEFINES   += HAVE_BLE_APDU # basic ledger apdu transport over BLE
+endif
 
+ifeq ($(TARGET_NAME),TARGET_NANOS)
+DEFINES   += IO_SEPROXYHAL_BUFFER_SIZE_B=72
+DEFINES   += HAVE_WALLET_ID_SDK
+else
+DEFINES   += IO_SEPROXYHAL_BUFFER_SIZE_B=300
 DEFINES   += HAVE_GLO096
 DEFINES   += HAVE_BAGL BAGL_WIDTH=128 BAGL_HEIGHT=64
 DEFINES   += HAVE_BAGL_ELLIPSIS # long label truncation feature
 DEFINES   += HAVE_BAGL_FONT_OPEN_SANS_REGULAR_11PX
 DEFINES   += HAVE_BAGL_FONT_OPEN_SANS_EXTRABOLD_11PX
 DEFINES   += HAVE_BAGL_FONT_OPEN_SANS_LIGHT_16PX
-else
-DEFINES   += IO_SEPROXYHAL_BUFFER_SIZE_B=72
-DEFINES   += HAVE_WALLET_ID_SDK
 endif
 
 # Enables direct data signing without having to specify it in the settings. Useful when testing with speculos.
@@ -304,21 +306,31 @@ ifneq ($(ALLOW_DATA),0)
 DEFINES += HAVE_ALLOW_DATA
 endif
 
-# Bypass the signature verification for setExternalPlugin and provideERC20TokenInfo calls
+# Bypass the signature verification for setExternalPlugin, setPlugin, provideERC20TokenInfo and provideNFTInfo calls
 BYPASS_SIGNATURES:=0
 ifneq ($(BYPASS_SIGNATURES),0)
 DEFINES += HAVE_BYPASS_SIGNATURES
 endif
 
+# NFTs
+ifneq ($(TARGET_NAME),TARGET_NANOS)
+DEFINES	+= HAVE_NFT_SUPPORT
+# Enable the NFT testing key
+NFT_TESTING_KEY:=0
+ifneq ($(NFT_TESTING_KEY),0)
+DEFINES += HAVE_NFT_TESTING_KEY
+endif
+endif
+
 
 # Enabling debug PRINTF
 DEBUG:=0
 ifneq ($(DEBUG),0)
 DEFINES += HAVE_STACK_OVERFLOW_CHECK
-ifeq ($(TARGET_NAME),TARGET_NANOX)
-DEFINES   += HAVE_PRINTF PRINTF=mcu_usb_printf
-else
+ifeq ($(TARGET_NAME),TARGET_NANOS)
 DEFINES   += HAVE_PRINTF PRINTF=screen_printf
+else
+DEFINES   += HAVE_PRINTF PRINTF=mcu_usb_printf
 endif
 else
 DEFINES   += PRINTF\(...\)=

README.md

@@ -4,7 +4,7 @@ Ledger Blue is not maintained anymore, but the app can still be compiled for thi
 
 This app follows the specification available in the `doc/` folder.
 
-To compile it and load it on a device, please check out our [developer portal](https://developers.ledger.com/docs/NA/start_here/).
+To compile it and load it on a device, please check out our [developer portal](https://developers.ledger.com/docs/nano-app/introduction/).
 
 # Plugins
 
@@ -20,7 +20,7 @@ First [install yarn](https://classic.yarnpkg.com/en/docs/install/#debian-stable)
 Open `tests/build_local_test_elfs.sh` and add your BOLOS SDKs path to `NANOS_SDK` and `NANOX_SDK`.
 This helper script will build the applications required by the test suite and move them at the right place.
 ```
-cd test
+cd tests
 ./build_local_test_elfs.sh
 ```
 Then you can install the project by simply running:

doc/ethapp.asc

@@ -23,6 +23,9 @@ Application version 1.5.0 - 25th of September 2020
 ## 1.7.6
   - Add SET EXTERNAL PLUGIN
 
+## 1.9.13
+  - Add SET PLUGIN
+
 ## About
 
 This application describes the APDU messages interface to communicate with the Ethereum application. 
@@ -240,6 +243,49 @@ signed by the following secp256k1 public key 0482bbf2f34f367b2e5bc21847b6566f21f
 
 None
 
+### PROVIDE NFT INFORMATION
+
+#### Description
+
+This commands provides a trusted description of an NFT to associate a contract address with a collectionName.
+
+It shall be run immediately before performing a transaction involving a contract calling this contract address to display the proper nft information to the user if necessary, as marked in GET APP CONFIGURATION flags.
+
+The signature is computed on 
+
+type || version || len(collectionName) || collectionName || address || chainId || keyId || algorithmId || len(signature) || signature
+
+#### Coding
+
+'Command'
+
+[width="80%"]
+|==============================================================================================================================
+| *CLA* | *INS*  | *P1*               | *P2*       | *Lc*     | *Le*   
+|   E0  |   14   |  00   |   00       | variable | 00
+|==============================================================================================================================
+
+'Input data'
+
+[width="80%"]
+|==============================================================================================================================
+| *Description*                                                                     | *Length*
+| Type                                                                              | 1
+| Version                                                                           | 1
+| Collection Name Length                                                            | 1
+| Collection Name                                                                   | variable
+| Address                                                                           | 20
+| Chain ID                                                                          | 8
+| KeyID                                                                             | 1
+| Algorithm ID                                                                      | 1
+| Signature Length                                                                  | 1
+| Signature                                                                         | variable
+|==============================================================================================================================
+
+'Output data'
+
+None
+
 
 ### SET EXTERNAL PLUGIN
 
@@ -283,6 +329,56 @@ signed by the following secp256k1 public key 0482bbf2f34f367b2e5bc21847b6566f21f
 
 None
 
+### SET PLUGIN
+
+#### Description
+
+This commands provides the name of a trusted binding of a plugin with a contract address and a supported method selector. This plugin will be called to interpret contract data in the following transaction signing command.
+
+It can be used to set both internal and external plugins.
+
+It shall be run immediately before performing a transaction involving a contract supported by this plugin to display the proper information to the user if necessary.
+
+The function returns an error sw (0x6984) if the plugin requested is not installed on the device, 0x9000 otherwise.
+
+The plugin names `ERC20`, `ERC721` and `ERC1155` are reserved. Additional plugin names might be added to this list in the future.
+
+The signature is computed on
+
+type || version || len(pluginName) || pluginName || address || selector || chainId || keyId || algorithmId || len(signature) || signature
+
+#### Coding
+
+'Command'
+
+[width="80%"]
+|==============================================================================================================================
+| *CLA* | *INS*  | *P1*               | *P2*       | *Lc*     | *Le*
+|   E0  |   16   |  00   |   00       | variable   | 00
+|==============================================================================================================================
+
+'Input data'
+
+[width="80%"]
+|==============================================================================================================================
+| *Description*                                                                     | *Length*
+| Type                                                                              | 1
+| Version                                                                           | 1
+| Plugin Name Length                                                                | 1
+| Plugin Name                                                                       | variable
+| Address                                                                           | 20
+| Selector                                                                          | 4
+| Chain ID                                                                          | 8
+| KeyID                                                                             | 1
+| Algorithm ID                                                                      | 1
+| Signature Length                                                                  | 1
+| Signature                                                                         | variable
+|==============================================================================================================================
+
+'Output data'
+
+None
+
 ### GET APP CONFIGURATION
 
 #### Description

doc/ethapp_plugins.asc

@@ -145,8 +145,8 @@ typedef struct ethPluginFinalize_t {
   ethPluginSharedRO_t *pluginSharedRO;
   uint8_t *pluginContext;
 
-  uint8_t *tokenLookup1; // set by the plugin if a token should be looked up
-  uint8_t *tokenLookup2; 
+  uint8_t *itemLookup1; // set by the plugin if a token or an nft should be looked up
+  uint8_t *itemLookup2; 
 
   uint8_t *amount; // set an uint256 pointer if uiType is UI_AMOUNT_ADDRESS
   uint8_t *address;  // set to the destination address if uiType is UI_AMOUNT_ADDRESS. Set to the user's address if uiType is UI_TYPE_GENERIC
@@ -161,8 +161,8 @@ typedef struct ethPluginFinalize_t {
 
 This message is sent when the data field has been fully parsed. The following specific fields can be filled by the plugin : 
 
-  * tokenLookup1 : the pointer shall be set to a 20 bytes address to look up an ERC 20 token descriptor if needed by the plugin
-  * tokenLookup2 : the pointer shall be set to a 20 bytes address to look up an ERC 20 token descriptor if needed by the plugin  
+  * itemLookup1 : the pointer shall be set to a 20 bytes address to look up an ERC20 token or NFT if needed by the plugin
+  * itemLookup2 : the pointer shall be set to a 20 bytes address to look up an ERC20 token or NFT if needed by the plugin  
   * uiType : set to either ETH_UI_TYPE_AMOUNT_ADDRESS for an amount/address UI or ETH_UI_TYPE_GENERIC for a generic UI
 
 The following specific fields are filled by the plugin when returning an amount/address UI :
@@ -179,32 +179,32 @@ The following return codes are expected, any other will abort the signing proces
   * ETH_PLUGIN_RESULT_OK : if the plugin can be successfully initialized
   * ETH_PLUGIN_RESULT_FALLBACK : if the signing logic should fallback to the generic one
 
-### ETH_PLUGIN_PROVIDE_TOKEN
+### ETH_PLUGIN_PROVIDE_INFO
 
 [source,C]
 ----
 
-typedef struct ethPluginProvideToken_t {
+typedef struct ethPluginProvideInfo_t {
 
   ethPluginSharedRW_t *pluginSharedRW;
   ethPluginSharedRO_t *pluginSharedRO;
   uint8_t *pluginContext;
 
-  tokenDefinition_t *token1; // set by the ETH application, to be saved by the plugin
-  tokenDefinition_t *token2;
+  union extraInfo *item1; // set by the ETH application, to be saved by the plugin
+  union extraInfo *item2;
 
-  uint8_t additionalScreens; // Used by the plugin if it needs to display additional screens based on the information received from the token definitions.
+  uint8_t additionalScreens; // Used by the plugin if it needs to display additional screens based on the information received.
 
   uint8_t result;
 
-} ethPluginProvideToken_t;
+} ethPluginProvideInfo_t;
 
 ----
 
-This message is sent if a token lookup was required by the plugin when parsing a finalize message. The following specific fields are filled when the plugin is called :
+This message is sent if an information lookup was required by the plugin when parsing a finalize message. The following specific fields are filled when the plugin is called :
 
-  * token1 : pointer to a token definition matching tokenLookup1, or NULL if not found 
-  * token2 : pointer to a token definition matching tokenLookup2, or NULL if not found or not requested
+  * item1 : pointer to an union matching itemLookup1, or NULL if not found 
+  * item2 : pointer to an union matching itemLookup2, or NULL if not found
 
 The following return codes are expected, any other will abort the signing process : 
 
@@ -233,7 +233,7 @@ typedef struct ethQueryContractID_t {
 
 ----
 
-This message is sent after the parsing finalization and token lookups if requested if a generic UI is used. The following specific fields are provided when the plugin is called :
+This message is sent after the parsing finalization and information lookups if requested if a generic UI is used. The following specific fields are provided when the plugin is called :
 
   * name : pointer to the name of the plugin, to be filled by the plugin
   * nameLength : maximum name length
@@ -253,6 +253,9 @@ typedef struct ethQueryContractUI_t {
 
   ethPluginSharedRW_t *pluginSharedRW;
   ethPluginSharedRO_t *pluginSharedRO;
+  union extraInfo_t *item1;
+  union extraInfo_t *item2;
+  char network_ticker[MAX_TICKER_LEN]; 
   uint8_t *pluginContext;
   uint8_t screenIndex;
   char *title;
@@ -268,6 +271,10 @@ typedef struct ethQueryContractUI_t {
 
 This message is sent when a plugin screen shall be displayed if a generic UI is used. The following specific fields are provided when the plugin is called : 
 
+
+  * item1 : pointer to token / nft information
+  * item2 : pointer to token / nft information
+  * network_ticker : string that holds the network ticker
   * screenIndex : index of the screen to display, starting from 0
   * title : pointer to the first line of the screen, to be filled by the plugin
   * titleLength : maximum title length

ethereum-plugin-sdk

@@ -15,6 +15,8 @@
 #define INS_GET_ETH2_PUBLIC_KEY             0x0E
 #define INS_SET_ETH2_WITHDRAWAL_INDEX       0x10
 #define INS_SET_EXTERNAL_PLUGIN             0x12
+#define INS_PROVIDE_NFT_INFORMATION         0x14
+#define INS_SET_PLUGIN                      0x16
 #define P1_CONFIRM                          0x01
 #define P1_NON_CONFIRM                      0x00
 #define P2_NO_CHAINCODE                     0x00
@@ -64,6 +66,12 @@ void handleProvideErc20TokenInformation(uint8_t p1,
                                         uint16_t dataLength,
                                         unsigned int *flags,
                                         unsigned int *tx);
+void handleProvideNFTInformation(uint8_t p1,
+                                 uint8_t p2,
+                                 uint8_t *dataBuffer,
+                                 uint16_t dataLength,
+                                 unsigned int *flags,
+                                 unsigned int *tx);
 void handleSign(uint8_t p1,
                 uint8_t p2,
                 uint8_t *dataBuffer,
@@ -96,6 +104,13 @@ void handleSetExternalPlugin(uint8_t p1,
                              unsigned int *flags,
                              unsigned int *tx);
 
+void handleSetPlugin(uint8_t p1,
+                     uint8_t p2,
+                     uint8_t *workBuffer,
+                     uint16_t dataLength,
+                     unsigned int *flags,
+                     unsigned int *tx);
+
 #ifdef HAVE_ETH2
 
 void handleGetEth2PublicKey(uint8_t p1,