Add support for ERC-721 and ERC-1155 (v3) (#218)
* First draft for erc721 token allowance * Split ui and provide parameters into their own files * Print txtype when not supported * fix compilation for erc721 * Use pluginType * Add debug statement in compound plugin * add debug error msg in plugin error * Add parameter parsing for all methods * Remove debug logs * Add SET_APPROVAL_FOR_ALL; Add correct parsing method on contract init * Add dst_size parameter to copy functions * Add query contract id code * format * Add UIs * update ethapp.asc * Change setExternalPlugin to setPlugin; Add support for ERC721 * clang-format * Fix typo Unconsistent -> Inconsistent * Add support for 721; use extraInfo * Add extraInfo to ethpluginQueryConractUI * Rename extraInfo to item * Add txFromEtherscan to tests * Add nft key and temp padding * Remove comments around HAVE_BYPASS_SIGNATURES * Rename TESTING_KEY to NFT_TESTING_KEY * Add comments regarding value of queryContractUI->item * Fix comment regarding method selector * Rename provideToken to provideInfo; Update plugin doc * fix caps of eth_plugin_prepare_provide_info * fix caps of handle_provide_info * Use verificationFn insead of hardcoded cx_ecdsa_verify * Add comments about nftInfo_t and tokenDefinition_t * Add erc721 test * Remove comment from plugin interface version * Fix network_ticker duplicate * Add setPlugin and provideNFTInfo to doc.asc * Add back setExternalPlugin; implement new setPlugin * Update plugin sdk * Call setPlugin instead of setExternalPlugin * setPlugin work without checking sig * Remove printf of displayed fees * Add working 721 test * Finalize ERC721 and add simple test * Display NFT address on set approval and operator * Support set approval for all for erc721 * Finish UI for set approval for all erc721 * Move copy_parameter and copy_address to eth_plugin_internal; Add tests for erc721 * update plugin sdk * Add erc1155 plugin and 1155 tests placeholder * Add restriction for AWS key and setPlugin * Add NOT_OLD_INTERNAL variant; Add erc_1155_plugin_call * Fixed compilation warnings (function pointer casting) Co-authored-by: pscott <scott.piriou@ledger.fr>
This commit is contained in:
apaillier-ledger
GitHub
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user