@ledgerhq/coin-evm 0.3.0 → 0.4.0-next.0

package/src/abis/erc721.abi.json

@@ -0,0 +1,346 @@
+[
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "approved",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "uint256",
+        "name": "tokenId",
+        "type": "uint256"
+      }
+    ],
+    "name": "Approval",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "operator",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "bool",
+        "name": "approved",
+        "type": "bool"
+      }
+    ],
+    "name": "ApprovalForAll",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "uint256",
+        "name": "tokenId",
+        "type": "uint256"
+      }
+    ],
+    "name": "Transfer",
+    "type": "event"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "tokenId",
+        "type": "uint256"
+      }
+    ],
+    "name": "approve",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "totalSupply",
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      }
+    ],
+    "name": "balanceOf",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "balance",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "uint256",
+        "name": "tokenId",
+        "type": "uint256"
+      }
+    ],
+    "name": "getApproved",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "operator",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "operator",
+        "type": "address"
+      }
+    ],
+    "name": "isApprovedForAll",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "name",
+    "outputs": [
+      {
+        "internalType": "string",
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "uint256",
+        "name": "tokenId",
+        "type": "uint256"
+      }
+    ],
+    "name": "ownerOf",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "tokenId",
+        "type": "uint256"
+      }
+    ],
+    "name": "safeTransferFrom",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "tokenId",
+        "type": "uint256"
+      },
+      {
+        "internalType": "bytes",
+        "name": "data",
+        "type": "bytes"
+      }
+    ],
+    "name": "safeTransferFrom",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "operator",
+        "type": "address"
+      },
+      {
+        "internalType": "bool",
+        "name": "_approved",
+        "type": "bool"
+      }
+    ],
+    "name": "setApprovalForAll",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "bytes4",
+        "name": "interfaceId",
+        "type": "bytes4"
+      }
+    ],
+    "name": "supportsInterface",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "symbol",
+    "outputs": [
+      {
+        "internalType": "string",
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "uint256",
+        "name": "tokenId",
+        "type": "uint256"
+      }
+    ],
+    "name": "tokenURI",
+    "outputs": [
+      {
+        "internalType": "string",
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "tokenId",
+        "type": "uint256"
+      }
+    ],
+    "name": "transferFrom",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  }
+]

package/src/adapters.ts

@@ -1,17 +1,23 @@
 import eip55 from "eip55";
 import { ethers } from "ethers";
 import BigNumber from "bignumber.js";
-import { TokenCurrency } from "@ledgerhq/types-cryptoassets";
+import {
+  encodeERC1155OperationId,
+  encodeERC721OperationId,
+} from "@ledgerhq/coin-framework/nft/nftOperationId";
 import { Operation, OperationType } from "@ledgerhq/types-live";
+import { encodeNftId } from "@ledgerhq/coin-framework/nft/nftId";
 import { findTokenByAddressInCurrency } from "@ledgerhq/cryptoassets";
 import { decodeAccountId, encodeTokenAccountId } from "@ledgerhq/coin-framework/account/index";
-import { encodeOperationId } from "@ledgerhq/coin-framework/operation";
+import { encodeOperationId, encodeSubOperationId } from "@ledgerhq/coin-framework/operation";
 import {
   Transaction as EvmTransaction,
   EvmTransactionEIP1559,
   EvmTransactionLegacy,
   EtherscanOperation,
   EtherscanERC20Event,
+  EtherscanERC721Event,
+  EtherscanERC1155Event,
 } from "./types";
 
 /**
@@ -46,93 +52,200 @@ export const transactionToEthersTransaction = (tx: EvmTransaction): ethers.Trans
 
 /**
  * Adapter to convert an Etherscan-like operation into a Ledger Live Operation
+ * It can return more than one operation in case of self-send
  */
-export const etherscanOperationToOperation = (
+export const etherscanOperationToOperations = (
   accountId: string,
   tx: EtherscanOperation,
-): Operation => {
+): Operation[] => {
   const { xpubOrAddress: address } = decodeAccountId(accountId);
   const checksummedAddress = eip55.encode(address);
   const from = eip55.encode(tx.from);
   const to = tx.to ? eip55.encode(tx.to) : "";
   const value = new BigNumber(tx.value);
   const fee = new BigNumber(tx.gasUsed).times(new BigNumber(tx.gasPrice));
+  const hasFailed = tx.isError === "1";
+  const types: OperationType[] = [];
+
+  if (to === checksummedAddress) {
+    types.push("IN");
+  }
+  if (from === checksummedAddress) {
+    types.push(tx.methodId === "0x" ? "OUT" : "FEES");
+  }
+  if (!types.length) {
+    types.push("NONE");
+  }
 
-  const type = ((): OperationType => {
-    if (to === checksummedAddress) {
-      return "IN";
-    }
-    if (from === checksummedAddress) {
-      return value.eq(0) ? "FEES" : "OUT";
-    }
-
-    return "NONE";
-  })();
-
-  return {
-    id: encodeOperationId(accountId, tx.hash, type),
-    hash: tx.hash,
-    type: type,
-    value: type === "OUT" || type === "FEES" ? value.plus(fee) : value,
-    fee,
-    senders: [from],
-    recipients: [to],
-    blockHeight: parseInt(tx.blockNumber, 10),
-    blockHash: tx.blockHash,
-    transactionSequenceNumber: parseInt(tx.nonce, 10),
-    accountId: accountId,
-    date: new Date(parseInt(tx.timeStamp, 10) * 1000),
-    extra: {},
-  };
+  return types.map(
+    type =>
+      ({
+        id: encodeOperationId(accountId, tx.hash, type),
+        hash: tx.hash,
+        type: type,
+        value: type === "OUT" || type === "FEES" ? value.plus(fee) : hasFailed ? fee : value,
+        fee,
+        senders: [from],
+        recipients: [to],
+        blockHeight: parseInt(tx.blockNumber, 10),
+        blockHash: tx.blockHash,
+        transactionSequenceNumber: parseInt(tx.nonce, 10),
+        accountId: accountId,
+        date: new Date(parseInt(tx.timeStamp, 10) * 1000),
+        subOperations: [],
+        nftOperations: [],
+        hasFailed,
+        extra: {},
+      } as Operation),
+  );
 };
 
 /**
  * Adapter to convert an ERC20 transaction received
  * on etherscan-like APIs into an Operation
+ * It can return more than one operation
+ * in case of self-send or airdrop
  */
-export const etherscanERC20EventToOperation = (
+export const etherscanERC20EventToOperations = (
   accountId: string,
   event: EtherscanERC20Event,
-): { tokenCurrency: TokenCurrency; operation: Operation } | null => {
+  index = 0,
+): Operation[] => {
   const { currencyId, xpubOrAddress: address } = decodeAccountId(accountId);
   const tokenCurrency = findTokenByAddressInCurrency(event.contractAddress, currencyId);
-  if (!tokenCurrency) return null;
+  if (!tokenCurrency) return [];
 
   const tokenAccountId = encodeTokenAccountId(accountId, tokenCurrency);
   const from = eip55.encode(event.from);
   const to = event.to ? eip55.encode(event.to) : "";
   const value = new BigNumber(event.value);
   const fee = new BigNumber(event.gasUsed).times(new BigNumber(event.gasPrice));
+  const types: OperationType[] = [];
+
+  if (event.contractAddress && to === eip55.encode(address)) {
+    types.push("IN");
+  }
+  if (event.contractAddress && from === eip55.encode(address)) {
+    types.push("OUT");
+  }
+
+  return types.map(
+    type =>
+      ({
+        id: encodeSubOperationId(tokenAccountId, event.hash, type, index),
+        hash: event.hash,
+        type: type,
+        value,
+        fee,
+        senders: [from],
+        recipients: [to],
+        contract: tokenCurrency.contractAddress,
+        blockHeight: parseInt(event.blockNumber, 10),
+        blockHash: event.blockHash,
+        transactionSequenceNumber: parseInt(event.nonce, 10),
+        accountId: tokenAccountId,
+        date: new Date(parseInt(event.timeStamp, 10) * 1000),
+        extra: {},
+      } as Operation),
+  );
+};
+
+/**
+ * Adapter to convert an ERC721 transaction received
+ * on etherscan-like APIs into an Operation
+ * It can return more than one operation
+ * in case of self-send or airdrop
+ */
+export const etherscanERC721EventToOperations = (
+  accountId: string,
+  event: EtherscanERC721Event,
+  index = 0,
+): Operation[] => {
+  const { xpubOrAddress: address, currencyId } = decodeAccountId(accountId);
+
+  const from = eip55.encode(event.from);
+  const to = event.to ? eip55.encode(event.to) : "";
+  const value = new BigNumber(1); // value is representing the number of NFT transfered. ERC721 are always sending 1 NFT per transaction
+  const fee = new BigNumber(event.gasUsed).times(new BigNumber(event.gasPrice));
+  const contract = eip55.encode(event.contractAddress);
+  const nftId = encodeNftId(accountId, contract, event.tokenID, currencyId);
+  const types: OperationType[] = [];
+
+  if (event.contractAddress && to === eip55.encode(address)) {
+    types.push("NFT_IN");
+  }
+  if (event.contractAddress && from === eip55.encode(address)) {
+    types.push("NFT_OUT");
+  }
+
+  return types.map(
+    type =>
+      ({
+        id: encodeERC721OperationId(nftId, event.hash, type, index),
+        hash: event.hash,
+        type: type,
+        fee,
+        senders: [from],
+        recipients: [to],
+        blockHeight: parseInt(event.blockNumber, 10),
+        blockHash: event.blockHash,
+        transactionSequenceNumber: parseInt(event.nonce, 10),
+        accountId,
+        standard: "ERC721",
+        contract,
+        tokenId: event.tokenID,
+        value,
+        date: new Date(parseInt(event.timeStamp, 10) * 1000),
+        extra: {},
+      } as Operation),
+  );
+};
+
+/**
+ * Adapter to convert an ERC1155 transaction received
+ * on etherscan-like APIs into an Operation
+ */
+export const etherscanERC1155EventToOperations = (
+  accountId: string,
+  event: EtherscanERC1155Event,
+  index = 0,
+): Operation[] => {
+  const { xpubOrAddress: address, currencyId } = decodeAccountId(accountId);
+
+  const from = eip55.encode(event.from);
+  const to = event.to ? eip55.encode(event.to) : "";
+  const value = new BigNumber(event.tokenValue); // value is representing the number of NFT transfered.
+  const fee = new BigNumber(event.gasUsed).times(new BigNumber(event.gasPrice));
+  const contract = eip55.encode(event.contractAddress);
+  const nftId = encodeNftId(accountId, contract, event.tokenID, currencyId);
+  const types: OperationType[] = [];
+
+  if (event.contractAddress && to === eip55.encode(address)) {
+    types.push("NFT_IN");
+  }
+  if (event.contractAddress && from === eip55.encode(address)) {
+    types.push("NFT_OUT");
+  }
 
-  const type = ((): OperationType => {
-    if (event.contractAddress && to === eip55.encode(address)) {
-      return "IN";
-    }
-
-    if (event.contractAddress && from === eip55.encode(address)) {
-      return "OUT";
-    }
-
-    return "NONE";
-  })();
-
-  return {
-    tokenCurrency,
-    operation: {
-      id: encodeOperationId(tokenAccountId, event.hash, type),
-      hash: event.hash,
-      type: type,
-      value,
-      fee,
-      senders: [from],
-      recipients: [to],
-      contract: tokenCurrency.contractAddress,
-      blockHeight: parseInt(event.blockNumber, 10),
-      blockHash: event.blockHash,
-      transactionSequenceNumber: parseInt(event.nonce, 10),
-      accountId: tokenAccountId,
-      date: new Date(parseInt(event.timeStamp, 10) * 1000),
-      extra: {},
-    },
-  };
+  return types.map(
+    type =>
+      ({
+        id: encodeERC1155OperationId(nftId, event.hash, type, index),
+        hash: event.hash,
+        type: type,
+        fee,
+        senders: [from],
+        recipients: [to],
+        blockHeight: parseInt(event.blockNumber, 10),
+        blockHash: event.blockHash,
+        transactionSequenceNumber: parseInt(event.nonce, 10),
+        accountId,
+        standard: "ERC1155",
+        contract,
+        tokenId: event.tokenID,
+        value,
+        date: new Date(parseInt(event.timeStamp, 10) * 1000),
+        extra: {},
+      } as Operation),
+  );
 };