d-bis/app-ethereum
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add support for ERC-721 and ERC-1155 (v3) (#218)

Browse Source 
* 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
2021-11-22 14:39:36 +01:00
committed by GitHub
parent a490532605
commit fcc3dd6d31
94 changed files with 2026 additions and 349 deletions
Download Patch File Download Diff File Expand all files Collapse all files

136
src_plugins/erc1155/erc1155_plugin.c Normal file
View File

@@ -0,0 +1,136 @@
#include "erc1155_plugin.h"
#include "eth_plugin_internal.h"
static const uint8_t ERC1155_APPROVE_FOR_ALL_SELECTOR[SELECTOR_SIZE] = {0xa2, 0x2c, 0xb4, 0x65};
static const uint8_t ERC1155_SAFE_TRANSFER_SELECTOR[SELECTOR_SIZE] = {0xf2, 0x42, 0x43, 0x2a};
static const uint8_t ERC1155_SAFE_BATCH_TRANSFER[SELECTOR_SIZE] = {0xf2, 0x42, 0x43, 0x2a};
const uint8_t *const ERC1155_SELECTORS[NUM_ERC1155_SELECTORS] = {
ERC1155_APPROVE_FOR_ALL_SELECTOR,
ERC1155_SAFE_TRANSFER_SELECTOR,
ERC1155_SAFE_BATCH_TRANSFER,
};
static void handle_init_contract(void *parameters) {
ethPluginInitContract_t *msg = (ethPluginInitContract_t *) parameters;
erc1155_context_t *context = (erc1155_context_t *) msg->pluginContext;
uint8_t i;
for (i = 0; i < NUM_ERC1155_SELECTORS; i++) {
if (memcmp((uint8_t *) PIC(ERC1155_SELECTORS[i]), msg->selector, SELECTOR_SIZE) == 0) {
context->selectorIndex = i;
break;
}
}
// No selector found.
if (i == NUM_ERC1155_SELECTORS) {
PRINTF("Unknown erc1155 selector %.*H\n", SELECTOR_SIZE, msg->selector);
msg->result = ETH_PLUGIN_RESULT_FALLBACK;
return;
}
msg->result = ETH_PLUGIN_RESULT_OK;
switch (context->selectorIndex) {
case SAFE_TRANSFER:
case SAFE_BATCH_TRANSFER:
context->next_param = FROM;
break;
case SET_APPROVAL_FOR_ALL:
context->next_param = OPERATOR;
break;
default:
PRINTF("Unsupported selector index: %d\n", context->selectorIndex);
msg->result = ETH_PLUGIN_RESULT_ERROR;
break;
}
}
static void handle_finalize(void *parameters) {
ethPluginFinalize_t *msg = (ethPluginFinalize_t *) parameters;
erc1155_context_t *context = (erc1155_context_t *) msg->pluginContext;
if (context->selectorIndex != SAFE_BATCH_TRANSFER) {
msg->tokenLookup1 = msg->pluginSharedRO->txContent->destination;
} else {
msg->tokenLookup1 = NULL;
}
msg->tokenLookup2 = NULL;
switch (context->selectorIndex) {
case SAFE_TRANSFER:
msg->numScreens = 4;
break;
case SET_APPROVAL_FOR_ALL:
case SAFE_BATCH_TRANSFER:
msg->numScreens = 3;
break;
default:
msg->result = ETH_PLUGIN_RESULT_ERROR;
return;
}
// Check if some ETH is attached to this tx
if (!allzeroes((void *) &msg->pluginSharedRO->txContent->value,
sizeof(msg->pluginSharedRO->txContent->value))) {
// Those functions are not payable so return an error.
msg->result = ETH_PLUGIN_RESULT_ERROR;
return;
}
msg->uiType = ETH_UI_TYPE_GENERIC;
msg->result = ETH_PLUGIN_RESULT_OK;
}
static void handle_provide_info(void *parameters) {
ethPluginProvideInfo_t *msg = (ethPluginProvideInfo_t *) parameters;
msg->result = ETH_PLUGIN_RESULT_OK;
}
static void handle_query_contract_id(void *parameters) {
ethQueryContractID_t *msg = (ethQueryContractID_t *) parameters;
erc1155_context_t *context = (erc1155_context_t *) msg->pluginContext;
msg->result = ETH_PLUGIN_RESULT_OK;
strlcpy(msg->name, "NFT", msg->nameLength);
switch (context->selectorIndex) {
case SET_APPROVAL_FOR_ALL:
strlcpy(msg->version, "Allowance", msg->versionLength);
break;
case SAFE_TRANSFER:
case SAFE_BATCH_TRANSFER:
strlcpy(msg->version, "Transfer", msg->versionLength);
break;
default:
PRINTF("Unsupported selector %d\n", context->selectorIndex);
msg->result = ETH_PLUGIN_RESULT_ERROR;
break;
}
}
void erc1155_plugin_call(int message, void *parameters) {
switch (message) {
case ETH_PLUGIN_INIT_CONTRACT: {
handle_init_contract(parameters);
} break;
case ETH_PLUGIN_PROVIDE_PARAMETER: {
handle_provide_parameter_1155(parameters);
} break;
case ETH_PLUGIN_FINALIZE: {
handle_finalize(parameters);
} break;
case ETH_PLUGIN_PROVIDE_INFO: {
handle_provide_info(parameters);
} break;
case ETH_PLUGIN_QUERY_CONTRACT_ID: {
handle_query_contract_id(parameters);
} break;
case ETH_PLUGIN_QUERY_CONTRACT_UI: {
handle_query_contract_ui_1155(parameters);
} break;
default:
PRINTF("Unhandled message %d\n", message);
break;
}
}

49
src_plugins/erc1155/erc1155_plugin.h Normal file
View File

@@ -0,0 +1,49 @@
#pragma once
#include <string.h>
#include "eth_plugin_handler.h"
#include "shared_context.h"
#include "ethUtils.h"
#include "utils.h"
// Internal plugin for EIP 1155: https://eips.ethereum.org/EIPS/eip-1155
#define NUM_ERC1155_SELECTORS 3
typedef enum {
SET_APPROVAL_FOR_ALL,
SAFE_TRANSFER,
SAFE_BATCH_TRANSFER,
} erc1155_selector_t;
typedef enum {
FROM,
TO,
TOKEN_IDS_OFFSET,
TOKEN_IDS_LENGTH,
TOKEN_ID,
VALUE_OFFSET,
VALUE_LENGTH,
VALUE,
OPERATOR,
APPROVED,
NONE,
} erc1155_selector_field;
typedef struct erc1155_context_t {
uint8_t address[ADDRESS_LENGTH];
uint8_t tokenId[INT256_LENGTH];
uint8_t value[INT256_LENGTH];
uint32_t valueOffset;
uint32_t tokenIdsOffset;
uint32_t targetOffset;
bool approved;
erc1155_selector_field next_param;
uint8_t selectorIndex;
} erc1155_context_t;
// TODO: Find out why there is a duplicate if we remove 1155 suffix
void handle_provide_parameter_1155(void *parameters);
void handle_query_contract_ui_1155(void *parameters);

106
src_plugins/erc1155/erc1155_provide_parameters.c Normal file
View File

@@ -0,0 +1,106 @@
#include "erc1155_plugin.h"
#include "eth_plugin_internal.h"
static void handle_safe_transfer(ethPluginProvideParameter_t *msg, erc1155_context_t *context) {
switch (context->next_param) {
case FROM:
context->next_param = TO;
break;
case TO:
copy_address(context->address, msg->parameter, sizeof(context->address));
context->next_param = TOKEN_ID;
break;
case TOKEN_ID:
copy_parameter(context->tokenId, msg->parameter, sizeof(context->tokenId));
context->next_param = VALUE;
break;
case VALUE:
copy_parameter(context->value, msg->parameter, sizeof(context->value));
context->next_param = NONE;
break;
default:
// Some extra data might be present so don't error.
break;
}
}
static void handle_batch_transfer(ethPluginProvideParameter_t *msg, erc1155_context_t *context) {
switch (context->next_param) {
case FROM:
context->next_param = TO;
break;
case TO:
copy_address(context->address, msg->parameter, sizeof(context->address));
context->next_param = TOKEN_ID;
break;
case TOKEN_IDS_OFFSET:
context->tokenIdsOffset = U4BE(msg->parameter, PARAMETER_LENGTH - 4);
context->next_param = VALUE_OFFSET;
break;
case VALUE_OFFSET:
context->targetOffset = context->tokenIdsOffset;
context->next_param = TOKEN_ID;
break;
case TOKEN_ID:
copy_parameter(context->tokenId, msg->parameter, sizeof(context->tokenId));
context->targetOffset = context->valueOffset;
context->next_param = VALUE;
break;
case VALUE:
copy_parameter(context->value, msg->parameter, sizeof(context->value));
context->targetOffset = 0;
context->next_param = NONE;
default:
// Some extra data might be present so don't error.
break;
}
}
static void handle_approval_for_all(ethPluginProvideParameter_t *msg, erc1155_context_t *context) {
switch (context->next_param) {
case OPERATOR:
context->next_param = APPROVED;
copy_address(context->address, msg->parameter, sizeof(context->address));
break;
case APPROVED:
context->approved = msg->parameter[PARAMETER_LENGTH - 1];
context->next_param = NONE;
break;
default:
PRINTF("Param %d not supported\n", context->next_param);
msg->result = ETH_PLUGIN_RESULT_ERROR;
break;
}
}
void handle_provide_parameter_1155(void *parameters) {
ethPluginProvideParameter_t *msg = (ethPluginProvideParameter_t *) parameters;
erc1155_context_t *context = (erc1155_context_t *) msg->pluginContext;
PRINTF("erc1155 plugin provide parameter %d %.*H\n",
msg->parameterOffset,
PARAMETER_LENGTH,
msg->parameter);
msg->result = ETH_PLUGIN_RESULT_SUCCESSFUL;
if (context->targetOffset > SELECTOR_SIZE &&
context->targetOffset != msg->parameterOffset - SELECTOR_SIZE) {
return;
}
switch (context->selectorIndex) {
case SAFE_TRANSFER:
handle_safe_transfer(msg, context);
break;
case SAFE_BATCH_TRANSFER:
handle_batch_transfer(msg, context);
break;
case SET_APPROVAL_FOR_ALL:
handle_approval_for_all(msg, context);
break;
default:
PRINTF("Selector index %d not supported\n", context->selectorIndex);
msg->result = ETH_PLUGIN_RESULT_ERROR;
break;
}
}

135
src_plugins/erc1155/erc1155_ui.c Normal file
View File

@@ -0,0 +1,135 @@
#include "erc1155_plugin.h"
static void set_approval_for_all_ui(ethQueryContractUI_t *msg, erc1155_context_t *context) {
switch (msg->screenIndex) {
case 0:
if (context->approved) {
strlcpy(msg->title, "Allow", msg->titleLength);
} else {
strlcpy(msg->title, "Revoke", msg->titleLength);
}
getEthDisplayableAddress(context->address,
msg->msg,
msg->msgLength,
&global_sha3,
chainConfig->chainId);
break;
case 1:
strlcpy(msg->title, "To Manage ALL", msg->titleLength);
if (msg->item1) {
strlcpy(msg->msg, (const char *) &msg->item1->nft.collectionName, msg->msgLength);
} else {
strlcpy(msg->msg, "Not found", msg->msgLength);
}
break;
case 2:
strlcpy(msg->title, "NFT Address", msg->titleLength);
getEthDisplayableAddress(msg->pluginSharedRO->txContent->destination,
msg->msg,
msg->msgLength,
&global_sha3,
chainConfig->chainId);
break;
default:
PRINTF("Unsupported screen index %d\n", msg->screenIndex);
msg->result = ETH_PLUGIN_RESULT_ERROR;
break;
}
}
static void set_transfer_ui(ethQueryContractUI_t *msg, erc1155_context_t *context) {
switch (msg->screenIndex) {
case 0:
// What will be displayed on the screen is:
// | Send |
// | `X` `COLLECTION_NAME` |
// where `X` is `value`
strlcpy(msg->title, "Send", msg->titleLength);
uint256_to_decimal(context->value, sizeof(context->value), msg->msg, msg->msgLength);
strlcat(msg->msg, " ", msg->msgLength);
if (msg->item1) {
strlcat(msg->msg, (const char *) &msg->item1->nft.collectionName, msg->msgLength);
} else {
strlcat(msg->msg, "Items", msg->msgLength);
}
break;
case 1:
strlcpy(msg->title, "To", msg->titleLength);
getEthDisplayableAddress(context->address,
msg->msg,
msg->msgLength,
&global_sha3,
chainConfig->chainId);
break;
case 2:
strlcpy(msg->title, "NFT Address", msg->titleLength);
getEthDisplayableAddress(msg->pluginSharedRO->txContent->destination,
msg->msg,
msg->msgLength,
&global_sha3,
chainConfig->chainId);
break;
case 3:
strlcpy(msg->title, "NFT ID", msg->titleLength);
uint256_to_decimal(context->tokenId,
sizeof(context->tokenId),
msg->msg,
msg->msgLength);
break;
default:
PRINTF("Unsupported screen index %d\n", msg->screenIndex);
msg->result = ETH_PLUGIN_RESULT_ERROR;
break;
}
}
static void set_batch_transfer_ui(ethQueryContractUI_t *msg, erc1155_context_t *context) {
switch (msg->screenIndex) {
case 0:
strlcpy(msg->title, "Send NFTs From", msg->titleLength);
uint256_to_decimal(context->value, sizeof(context->value), msg->msg, msg->msgLength);
strlcat(msg->msg, " Different Collections", msg->msgLength);
break;
case 1:
strlcpy(msg->title, "To", msg->titleLength);
getEthDisplayableAddress(context->address,
msg->msg,
msg->msgLength,
&global_sha3,
chainConfig->chainId);
case 2:
strlcpy(msg->title, "NFT Address", msg->titleLength);
getEthDisplayableAddress(msg->pluginSharedRO->txContent->destination,
msg->msg,
msg->msgLength,
&global_sha3,
chainConfig->chainId);
break;
default:
PRINTF("Unsupported screen index %d\n", msg->screenIndex);
msg->result = ETH_PLUGIN_RESULT_ERROR;
break;
}
}
void handle_query_contract_ui_1155(void *parameters) {
ethQueryContractUI_t *msg = (ethQueryContractUI_t *) parameters;
erc1155_context_t *context = (erc1155_context_t *) msg->pluginContext;
msg->result = ETH_PLUGIN_RESULT_OK;
switch (context->selectorIndex) {
case SET_APPROVAL_FOR_ALL:
set_approval_for_all_ui(msg, context);
break;
case SAFE_TRANSFER:
set_transfer_ui(msg, context);
break;
case SAFE_BATCH_TRANSFER:
set_batch_transfer_ui(msg, context);
break;
default:
msg->result = ETH_PLUGIN_RESULT_ERROR;
PRINTF("Unsupported selector index %d\n", context->selectorIndex);
break;
}
}