368 lines
11 KiB
Python
368 lines
11 KiB
Python
import pytest
|
|
from typing import Optional, Any
|
|
from pathlib import Path
|
|
from typing import Callable
|
|
from ragger.error import ExceptionRAPDU
|
|
from ragger.firmware import Firmware
|
|
from ragger.backend import BackendInterface
|
|
from ragger.navigator import Navigator, NavInsID
|
|
from ledger_app_clients.ethereum.client import EthAppClient, StatusWord
|
|
import ledger_app_clients.ethereum.response_parser as ResponseParser
|
|
from ledger_app_clients.ethereum.utils import get_selector_from_data, recover_transaction
|
|
from web3 import Web3
|
|
import json
|
|
import os
|
|
|
|
|
|
ROOT_SCREENSHOT_PATH = Path(__file__).parent
|
|
ABIS_FOLDER = "%s/abis" % (os.path.dirname(__file__))
|
|
|
|
BIP32_PATH = "m/44'/60'/0'/0/0"
|
|
NONCE = 21
|
|
GAS_PRICE = 13
|
|
GAS_LIMIT = 21000
|
|
FROM = bytes.fromhex("1122334455667788990011223344556677889900")
|
|
TO = bytes.fromhex("0099887766554433221100998877665544332211")
|
|
NFTS = [(1, 3), (5, 2), (7, 4)] # tuples of (token_id, amount)
|
|
DATA = "Some data".encode()
|
|
DEVICE_ADDR: Optional[bytes] = None
|
|
|
|
|
|
class NFTCollection:
|
|
addr: bytes
|
|
name: str
|
|
chain_id: int
|
|
|
|
def __init__(self, addr: bytes, name: str, chain_id: int, contract):
|
|
self.addr = addr
|
|
self.name = name
|
|
self.chain_id = chain_id
|
|
self.contract = contract
|
|
|
|
|
|
class Action:
|
|
fn_name: str
|
|
fn_args: list[Any]
|
|
nav_fn: Callable
|
|
|
|
def __init__(self, fn_name: str, fn_args: list[Any], nav_fn: Callable):
|
|
self.fn_name = fn_name
|
|
self.fn_args = fn_args
|
|
self.nav_fn = nav_fn
|
|
|
|
|
|
def common_nav_nft(is_nano: bool,
|
|
nano_steps: int,
|
|
stax_steps: int,
|
|
reject: bool) -> list[NavInsID]:
|
|
moves = list()
|
|
if is_nano:
|
|
moves += [NavInsID.RIGHT_CLICK] * nano_steps
|
|
if reject:
|
|
moves += [NavInsID.RIGHT_CLICK]
|
|
moves += [NavInsID.BOTH_CLICK]
|
|
else:
|
|
moves += [NavInsID.USE_CASE_REVIEW_TAP] * stax_steps
|
|
if reject:
|
|
moves += [
|
|
NavInsID.USE_CASE_REVIEW_REJECT,
|
|
NavInsID.USE_CASE_CHOICE_CONFIRM
|
|
]
|
|
else:
|
|
moves += [NavInsID.USE_CASE_REVIEW_CONFIRM]
|
|
return moves
|
|
|
|
|
|
def snapshot_test_name(nft_type: str, fn: str, chain_id: int, reject: bool) -> str:
|
|
name = "%s_%s_%s" % (nft_type, fn, str(chain_id))
|
|
if reject:
|
|
name += "-rejected"
|
|
return name
|
|
|
|
|
|
def common_test_nft(fw: Firmware,
|
|
back: BackendInterface,
|
|
nav: Navigator,
|
|
collec: NFTCollection,
|
|
action: Action,
|
|
reject: bool,
|
|
plugin_name: str):
|
|
global DEVICE_ADDR
|
|
app_client = EthAppClient(back)
|
|
|
|
if app_client._client.firmware.name == "nanos":
|
|
pytest.skip("Not supported on LNS")
|
|
|
|
if DEVICE_ADDR is None: # to only have to request it once
|
|
with app_client.get_public_addr(display=False):
|
|
pass
|
|
_, DEVICE_ADDR, _ = ResponseParser.pk_addr(app_client.response().data)
|
|
|
|
data = collec.contract.encodeABI(action.fn_name, action.fn_args)
|
|
with app_client.set_plugin(plugin_name,
|
|
collec.addr,
|
|
get_selector_from_data(data),
|
|
collec.chain_id):
|
|
pass
|
|
with app_client.provide_nft_metadata(collec.name, collec.addr, collec.chain_id):
|
|
pass
|
|
tx_params = {
|
|
"nonce": NONCE,
|
|
"gasPrice": Web3.to_wei(GAS_PRICE, "gwei"),
|
|
"gas": GAS_LIMIT,
|
|
"to": collec.addr,
|
|
"value": 0,
|
|
"chainId": collec.chain_id,
|
|
"data": data,
|
|
}
|
|
with app_client.sign(BIP32_PATH, tx_params):
|
|
nav.navigate_and_compare(ROOT_SCREENSHOT_PATH,
|
|
snapshot_test_name(plugin_name.lower(),
|
|
action.fn_name,
|
|
collec.chain_id,
|
|
reject),
|
|
action.nav_fn(fw.is_nano,
|
|
collec.chain_id,
|
|
reject))
|
|
# verify signature
|
|
vrs = ResponseParser.signature(app_client.response().data)
|
|
addr = recover_transaction(tx_params, vrs)
|
|
assert addr == DEVICE_ADDR
|
|
|
|
|
|
def common_test_nft_reject(test_fn: Callable,
|
|
fw: Firmware,
|
|
back: BackendInterface,
|
|
nav: Navigator,
|
|
collec: NFTCollection,
|
|
action: Action):
|
|
try:
|
|
test_fn(fw, back, nav, collec, action, True)
|
|
except ExceptionRAPDU as e:
|
|
assert e.status == StatusWord.CONDITION_NOT_SATISFIED
|
|
else:
|
|
assert False # An exception should have been raised
|
|
|
|
# ERC-721
|
|
|
|
|
|
ERC721_PLUGIN = "ERC721"
|
|
|
|
with open("%s/erc721.json" % (ABIS_FOLDER)) as file:
|
|
contract_erc721 = Web3().eth.contract(
|
|
abi=json.load(file),
|
|
address=bytes(20)
|
|
)
|
|
|
|
# ui nav functions
|
|
|
|
def nav_erc721_transfer_from(is_nano: bool,
|
|
chain_id: int,
|
|
reject: bool) -> list[NavInsID]:
|
|
nano_steps = 7
|
|
stax_steps = 3
|
|
if chain_id != 1:
|
|
nano_steps += 1
|
|
stax_steps += 1
|
|
return common_nav_nft(is_nano, nano_steps, stax_steps, reject)
|
|
|
|
|
|
def nav_erc721_approve(is_nano: bool,
|
|
chain_id: int,
|
|
reject: bool) -> list[NavInsID]:
|
|
nano_steps = 7
|
|
stax_steps = 3
|
|
if chain_id != 1:
|
|
nano_steps += 1
|
|
stax_steps += 1
|
|
return common_nav_nft(is_nano, nano_steps, stax_steps, reject)
|
|
|
|
|
|
def nav_erc721_set_approval_for_all(is_nano: bool,
|
|
chain_id: int,
|
|
reject: bool) -> list[NavInsID]:
|
|
nano_steps = 6
|
|
if chain_id != 1:
|
|
nano_steps += 1
|
|
return common_nav_nft(is_nano, nano_steps, 3, reject)
|
|
|
|
|
|
collecs_721 = [
|
|
NFTCollection(bytes.fromhex("bc4ca0eda7647a8ab7c2061c2e118a18a936f13d"),
|
|
"Bored Ape Yacht Club",
|
|
1,
|
|
contract_erc721),
|
|
NFTCollection(bytes.fromhex("670fd103b1a08628e9557cd66b87ded841115190"),
|
|
"y00ts",
|
|
137,
|
|
contract_erc721),
|
|
NFTCollection(bytes.fromhex("2909cf13e458a576cdd9aab6bd6617051a92dacf"),
|
|
"goerlirocks",
|
|
5,
|
|
contract_erc721),
|
|
]
|
|
actions_721 = [
|
|
Action("safeTransferFrom",
|
|
[FROM, TO, NFTS[0][0], DATA],
|
|
nav_erc721_transfer_from),
|
|
Action("safeTransferFrom",
|
|
[FROM, TO, NFTS[0][0]],
|
|
nav_erc721_transfer_from),
|
|
Action("transferFrom",
|
|
[FROM, TO, NFTS[0][0]],
|
|
nav_erc721_transfer_from),
|
|
Action("approve",
|
|
[TO, NFTS[0][0]],
|
|
nav_erc721_approve),
|
|
Action("setApprovalForAll",
|
|
[TO, False],
|
|
nav_erc721_set_approval_for_all),
|
|
]
|
|
|
|
|
|
@pytest.fixture(params=collecs_721)
|
|
def collec_721(request) -> NFTCollection:
|
|
return request.param
|
|
|
|
|
|
@pytest.fixture(params=actions_721)
|
|
def action_721(request) -> Action:
|
|
return request.param
|
|
|
|
|
|
def test_erc721(firmware: Firmware,
|
|
backend: BackendInterface,
|
|
navigator: Navigator,
|
|
collec_721: NFTCollection,
|
|
action_721: Action,
|
|
reject: bool = False):
|
|
common_test_nft(firmware,
|
|
backend,
|
|
navigator,
|
|
collec_721,
|
|
action_721,
|
|
reject,
|
|
ERC721_PLUGIN)
|
|
|
|
|
|
def test_erc721_reject(firmware: Firmware,
|
|
backend: BackendInterface,
|
|
navigator: Navigator):
|
|
common_test_nft_reject(test_erc721,
|
|
firmware,
|
|
backend,
|
|
navigator,
|
|
collecs_721[0],
|
|
actions_721[0])
|
|
|
|
|
|
# ERC-1155
|
|
|
|
ERC1155_PLUGIN = "ERC1155"
|
|
|
|
with open("%s/erc1155.json" % (ABIS_FOLDER)) as file:
|
|
contract_erc1155 = Web3().eth.contract(
|
|
abi=json.load(file),
|
|
address=bytes(20)
|
|
)
|
|
|
|
|
|
# ui nav functions
|
|
|
|
def nav_erc1155_safe_transfer_from(is_nano: bool,
|
|
chain_id: int,
|
|
reject: bool) -> list:
|
|
nano_steps = 8
|
|
if chain_id != 1:
|
|
nano_steps += 1
|
|
return common_nav_nft(is_nano, nano_steps, 4, reject)
|
|
|
|
|
|
def nav_erc1155_safe_batch_transfer_from(is_nano: bool,
|
|
chain_id: int,
|
|
reject: bool) -> list:
|
|
nano_steps = 7
|
|
stax_steps = 3
|
|
if chain_id != 1:
|
|
nano_steps += 1
|
|
stax_steps += 1
|
|
return common_nav_nft(is_nano, nano_steps, stax_steps, reject)
|
|
|
|
|
|
def nav_erc1155_set_approval_for_all(is_nano: bool,
|
|
chain_id: int,
|
|
reject: bool) -> list:
|
|
nano_steps = 6
|
|
if chain_id != 1:
|
|
nano_steps += 1
|
|
return common_nav_nft(is_nano, nano_steps, 3, reject)
|
|
|
|
|
|
collecs_1155 = [
|
|
NFTCollection(bytes.fromhex("495f947276749ce646f68ac8c248420045cb7b5e"),
|
|
"OpenSea Shared Storefront",
|
|
1,
|
|
contract_erc1155),
|
|
NFTCollection(bytes.fromhex("2953399124f0cbb46d2cbacd8a89cf0599974963"),
|
|
"OpenSea Collections",
|
|
137,
|
|
contract_erc1155),
|
|
NFTCollection(bytes.fromhex("f4910c763ed4e47a585e2d34baa9a4b611ae448c"),
|
|
"OpenSea Collections",
|
|
5,
|
|
contract_erc1155),
|
|
]
|
|
actions_1155 = [
|
|
Action("safeTransferFrom",
|
|
[FROM, TO, NFTS[0][0], NFTS[0][1], DATA],
|
|
nav_erc1155_safe_transfer_from),
|
|
Action("safeBatchTransferFrom",
|
|
[
|
|
FROM,
|
|
TO,
|
|
list(map(lambda nft: nft[0], NFTS)),
|
|
list(map(lambda nft: nft[1], NFTS)),
|
|
DATA
|
|
],
|
|
nav_erc1155_safe_batch_transfer_from),
|
|
Action("setApprovalForAll",
|
|
[TO, False],
|
|
nav_erc1155_set_approval_for_all),
|
|
]
|
|
|
|
|
|
@pytest.fixture(params=collecs_1155)
|
|
def collec_1155(request) -> bool:
|
|
return request.param
|
|
|
|
|
|
@pytest.fixture(params=actions_1155)
|
|
def action_1155(request) -> Action:
|
|
return request.param
|
|
|
|
|
|
def test_erc1155(firmware: Firmware,
|
|
backend: BackendInterface,
|
|
navigator: Navigator,
|
|
collec_1155: NFTCollection,
|
|
action_1155: Action,
|
|
reject: bool = False):
|
|
common_test_nft(firmware,
|
|
backend,
|
|
navigator,
|
|
collec_1155,
|
|
action_1155,
|
|
reject,
|
|
ERC1155_PLUGIN)
|
|
|
|
|
|
def test_erc1155_reject(firmware: Firmware,
|
|
backend: BackendInterface,
|
|
navigator: Navigator):
|
|
common_test_nft_reject(test_erc1155,
|
|
firmware,
|
|
backend,
|
|
navigator,
|
|
collecs_1155[0],
|
|
actions_1155[0])
|