@learncard/ethereum-plugin 1.1.24 → 1.1.26

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C,OAAO,EAAE,cAAc,EAAE,cAAc,EAAa,MAAM,SAAS,CAAC;AASpE,cAAc,SAAS,CAAC;AAIxB;;GAEG;AACH,eAAO,MAAM,iBAAiB,kBACX,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,UAC3B,cAAc,KACvB,cAoKF,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C,OAAO,EAAE,cAAc,EAAE,cAAc,EAAa,MAAM,SAAS,CAAC;AAWpE,cAAc,SAAS,CAAC;AAMxB;;GAEG;AACH,eAAO,MAAM,iBAAiB,kBACX,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,UAC3B,cAAc,KACvB,cA+JF,CAAC"}

package/package.json

@@ -1,57 +1,59 @@
 {
-  "name": "@learncard/ethereum-plugin",
-  "version": "1.1.24",
-  "description": "",
-  "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/ethereum-plugin.esm.js",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/ethereum-plugin.esm.js"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "author": "Learning Economy Foundation (www.learningeconomy.io)",
-  "license": "MIT",
-  "homepage": "https://github.com/learningeconomy/LearnCard/tree/main/packages/plugins/ethereum/README.md",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/learningeconomy/LearnCard"
-  },
-  "bugs": {
-    "url": "https://github.com/learningeconomy/LearnCard/issues"
-  },
-  "devDependencies": {
-    "@types/jest": "^29.2.2",
-    "@types/node": "^17.0.31",
-    "aqu": "0.4.3",
-    "esbuild": "^0.27.1",
-    "esbuild-jest": "^0.5.0",
-    "esbuild-plugin-copy": "^1.3.0",
-    "jest": "^29.3.0",
-    "shx": "^0.3.4",
-    "ts-jest": "^29.0.3"
-  },
-  "types": "./dist/index.d.ts",
-  "dependencies": {
-    "@uniswap/default-token-list": "^4.1.0",
-    "ethers": "^5.6.9",
-    "@learncard/core": "9.4.23"
-  },
-  "sideEffects": false,
-  "scripts": {
-    "build": "node ./scripts/build.mjs && shx cp ./scripts/mixedEntypoint.js ./dist/index.cjs && tsc --p tsconfig.json && shx cp ./dist/index.d.ts ./dist/index.d.cts",
-    "test": "jest --passWithNoTests",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --silent --ci --coverage --coverageReporters=\"text\" --coverageReporters=\"text-summary\""
-  }
-}
+    "name": "@learncard/ethereum-plugin",
+    "version": "1.1.26",
+    "description": "",
+    "type": "module",
+    "main": "./dist/index.cjs",
+    "module": "./dist/ethereum-plugin.esm.js",
+    "exports": {
+        ".": {
+            "development": "./src/index.ts",
+            "import": {
+                "types": "./dist/index.d.ts",
+                "default": "./dist/ethereum-plugin.esm.js"
+            },
+            "require": {
+                "types": "./dist/index.d.cts",
+                "default": "./dist/index.cjs"
+            }
+        }
+    },
+    "files": [
+        "dist",
+        "src"
+    ],
+    "scripts": {
+        "build": "node ./scripts/build.mjs && shx cp ./scripts/mixedEntypoint.js ./dist/index.cjs && tsc --p tsconfig.json && shx cp ./dist/index.d.ts ./dist/index.d.cts",
+        "test": "jest --passWithNoTests",
+        "test:watch": "jest --watch",
+        "test:coverage": "jest --silent --ci --coverage --coverageReporters=\"text\" --coverageReporters=\"text-summary\""
+    },
+    "author": "Learning Economy Foundation (www.learningeconomy.io)",
+    "license": "MIT",
+    "homepage": "https://github.com/learningeconomy/LearnCard/tree/main/packages/plugins/ethereum/README.md",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/learningeconomy/LearnCard"
+    },
+    "bugs": {
+        "url": "https://github.com/learningeconomy/LearnCard/issues"
+    },
+    "devDependencies": {
+        "@types/jest": "^29.2.2",
+        "@types/node": "^17.0.31",
+        "aqu": "0.4.3",
+        "esbuild": "^0.27.1",
+        "esbuild-jest": "^0.5.0",
+        "esbuild-plugin-copy": "^1.3.0",
+        "jest": "^29.3.0",
+        "shx": "^0.3.4",
+        "ts-jest": "^29.0.3"
+    },
+    "types": "./dist/index.d.ts",
+    "dependencies": {
+        "@learncard/core": "workspace:*",
+        "@uniswap/default-token-list": "^4.1.0",
+        "ethers": "^5.6.9"
+    },
+    "sideEffects": false
+}

package/src/erc20.abi.json

@@ -0,0 +1,222 @@
+[
+    {
+        "constant": true,
+        "inputs": [],
+        "name": "name",
+        "outputs": [
+            {
+                "name": "",
+                "type": "string"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "constant": false,
+        "inputs": [
+            {
+                "name": "_spender",
+                "type": "address"
+            },
+            {
+                "name": "_value",
+                "type": "uint256"
+            }
+        ],
+        "name": "approve",
+        "outputs": [
+            {
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "constant": true,
+        "inputs": [],
+        "name": "totalSupply",
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "constant": false,
+        "inputs": [
+            {
+                "name": "_from",
+                "type": "address"
+            },
+            {
+                "name": "_to",
+                "type": "address"
+            },
+            {
+                "name": "_value",
+                "type": "uint256"
+            }
+        ],
+        "name": "transferFrom",
+        "outputs": [
+            {
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "constant": true,
+        "inputs": [],
+        "name": "decimals",
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint8"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "constant": true,
+        "inputs": [
+            {
+                "name": "_owner",
+                "type": "address"
+            }
+        ],
+        "name": "balanceOf",
+        "outputs": [
+            {
+                "name": "balance",
+                "type": "uint256"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "constant": true,
+        "inputs": [],
+        "name": "symbol",
+        "outputs": [
+            {
+                "name": "",
+                "type": "string"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "constant": false,
+        "inputs": [
+            {
+                "name": "_to",
+                "type": "address"
+            },
+            {
+                "name": "_value",
+                "type": "uint256"
+            }
+        ],
+        "name": "transfer",
+        "outputs": [
+            {
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "constant": true,
+        "inputs": [
+            {
+                "name": "_owner",
+                "type": "address"
+            },
+            {
+                "name": "_spender",
+                "type": "address"
+            }
+        ],
+        "name": "allowance",
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ],
+        "payable": false,
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "payable": true,
+        "stateMutability": "payable",
+        "type": "fallback"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": true,
+                "name": "owner",
+                "type": "address"
+            },
+            {
+                "indexed": true,
+                "name": "spender",
+                "type": "address"
+            },
+            {
+                "indexed": false,
+                "name": "value",
+                "type": "uint256"
+            }
+        ],
+        "name": "Approval",
+        "type": "event"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": true,
+                "name": "from",
+                "type": "address"
+            },
+            {
+                "indexed": true,
+                "name": "to",
+                "type": "address"
+            },
+            {
+                "indexed": false,
+                "name": "value",
+                "type": "uint256"
+            }
+        ],
+        "name": "Transfer",
+        "type": "event"
+    }
+]

package/src/hardcodedTokens.ts

@@ -0,0 +1,26 @@
+export const hardcodedTokens = [
+    {
+        name: 'USDCoin',
+        address: '0x07865c6e87b9f70255377e024ace6630c1eaa37f',
+        symbol: 'USDC',
+        decimals: 6,
+        chainId: 5,
+        logoURI:
+            'https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/ethereum/assets/0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48/logo.png',
+        extensions: {
+            bridgeInfo: {
+                '10': {
+                    tokenAddress: '0x7F5c764cBc14f9669B88837ca1490cCa17c31607',
+                },
+                '137': {
+                    tokenAddress: '0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174',
+                },
+                '42161': {
+                    tokenAddress: '0xFF970A61A04b1cA14834A43f5dE4533eBDDB5CC8',
+                },
+            },
+        },
+    },
+];
+
+export default hardcodedTokens;

package/src/helpers.ts

@@ -0,0 +1,63 @@
+import { ethers } from 'ethers';
+
+import { Token, TokenList } from './types';
+
+export const isAddress = (maybeAddress: string) => {
+    return maybeAddress.startsWith('0x') && maybeAddress.length === 42;
+};
+
+/* From Ethereum-compatible numbers to human-readable numbers  */
+export const formatUnits = async (
+    units: ethers.BigNumberish,
+    symbolOrAddress: string,
+    tokenList: TokenList,
+    chainId: number
+) => {
+    const token = await getTokenFromSymbolOrAddress(symbolOrAddress, tokenList, chainId);
+
+    return ethers.utils.formatUnits(units, token?.decimals);
+};
+
+/* From human-readable numbers to Ethereum-compatible numbers */
+export const parseUnits = async (
+    units: string,
+    symbolOrAddress: string,
+    tokenList: TokenList,
+    chainId: number
+) => {
+    const token = await getTokenFromSymbolOrAddress(symbolOrAddress, tokenList, chainId);
+
+    return ethers.utils.parseUnits(units, token?.decimals);
+};
+
+export const getTokenFromSymbolOrAddress = async (
+    symbolOrAddress: string,
+    tokenList: TokenList,
+    chainId: number
+): Promise<Token | undefined> => {
+    let token;
+    if (isAddress(symbolOrAddress)) {
+        token = await getTokenFromAddress(symbolOrAddress, tokenList, chainId);
+    } else {
+        token = await getTokenFromSymbol(symbolOrAddress, tokenList, chainId);
+    }
+    return token;
+};
+
+const getTokenFromAddress = async (address: string, tokenList: TokenList, chainId: number) => {
+    const token = tokenList.find(token => token.chainId === chainId && token.address === address);
+
+    return token;
+};
+
+const getTokenFromSymbol = async (symbol: string, tokenList: TokenList, chainId: number) => {
+    const token = tokenList.find(
+        token => token.chainId === chainId && token.symbol.toUpperCase() === symbol.toUpperCase()
+    );
+
+    return token;
+};
+
+export const getChainIdFromProvider = async (provider: ethers.providers.Provider) => {
+    return (await provider.getNetwork()).chainId;
+};

package/src/index.ts

@@ -0,0 +1,188 @@
+import { Buffer } from 'buffer';
+
+import { LearnCard } from '@learncard/core';
+import { ethers } from 'ethers';
+
+import { EthereumConfig, EthereumPlugin, TokenList } from './types';
+import {
+    formatUnits,
+    parseUnits,
+    getTokenFromSymbolOrAddress,
+    getChainIdFromProvider,
+} from './helpers';
+import ERC20ABI from './erc20.abi.json';
+import uniswapDefaultTokenList from '@uniswap/default-token-list/build/uniswap-default.tokenlist.json';
+import hardcodedTokens from './hardcodedTokens';
+
+export * from './types';
+
+const defaultTokenList = (uniswapDefaultTokenList as { tokens: TokenList }).tokens.concat(
+    hardcodedTokens
+);
+
+/**
+ * @group Plugins
+ */
+export const getEthereumPlugin = (
+    initLearnCard: LearnCard<any, 'id'>,
+    config: EthereumConfig
+): EthereumPlugin => {
+    let { infuraProjectId, network = 'mainnet' } = config;
+
+    // Ethers wallet
+    const secpKeypair = initLearnCard.id.keypair('secp256k1');
+
+    if (!secpKeypair) {
+        throw new Error('LearnCard must support secp256k1 JWK in order to add Ethereum Plugin');
+    }
+
+    const privateKey = Buffer.from(secpKeypair.d, 'base64').toString('hex');
+    let ethersWallet = new ethers.Wallet(privateKey);
+    const publicKey: string = ethersWallet.address;
+
+    // Provider
+    const getProvider = () => {
+        let provider: ethers.providers.Provider;
+        if (infuraProjectId) {
+            provider = new ethers.providers.InfuraProvider(network, infuraProjectId);
+        } else {
+            provider = ethers.getDefaultProvider(network);
+        }
+
+        ethersWallet = ethersWallet.connect(provider);
+        return provider;
+    };
+    let provider: ethers.providers.Provider;
+
+    const defaultTokenListForNetwork = defaultTokenList;
+
+    const getTokenAddress = async (tokenSymbolOrAddress: string) => {
+        if (!provider) provider = getProvider();
+
+        return (
+            await getTokenFromSymbolOrAddress(
+                tokenSymbolOrAddress,
+                defaultTokenListForNetwork,
+                await getChainIdFromProvider(provider)
+            )
+        )?.address;
+    };
+
+    const getErc20TokenBalance = async (
+        tokenContractAddress: string,
+        walletPublicAddress = publicKey
+    ) => {
+        if (!provider) provider = getProvider();
+
+        const contract = new ethers.Contract(tokenContractAddress, ERC20ABI, provider);
+
+        const balance = await contract.balanceOf(walletPublicAddress);
+        const formattedBalance = formatUnits(
+            balance,
+            tokenContractAddress,
+            defaultTokenList,
+            await getChainIdFromProvider(provider)
+        );
+
+        return formattedBalance;
+    };
+
+    // Core Methods
+    const getBalance = async (walletAddress = publicKey, tokenSymbolOrAddress = 'ETH') => {
+        if (!provider) provider = getProvider();
+
+        if (!tokenSymbolOrAddress || tokenSymbolOrAddress === 'ETH') {
+            // check ETH by default
+            const balance = await provider.getBalance(walletAddress);
+            const formattedBalance = ethers.utils.formatEther(balance);
+
+            return formattedBalance;
+        }
+
+        const tokenAddress = await getTokenAddress(tokenSymbolOrAddress);
+
+        if (!tokenAddress) {
+            throw new Error(`Unable to determine token address for \"${tokenSymbolOrAddress}\"`);
+        }
+
+        const balance = await getErc20TokenBalance(tokenAddress, walletAddress);
+
+        return balance;
+    };
+
+    return {
+        name: 'Ethereum',
+        displayName: 'Ethereum',
+        description: 'Provides access to currency',
+        methods: {
+            getEthereumAddress: () => publicKey,
+
+            getBalance: async (_learnCard, symbolOrAddress = 'ETH') =>
+                getBalance(publicKey, symbolOrAddress),
+            getBalanceForAddress: async (_learnCard, walletAddress, symbolOrAddress) =>
+                getBalance(walletAddress, symbolOrAddress),
+
+            transferTokens: async (_learnCard, tokenSymbolOrAddress, amount, toAddress) => {
+                if (!provider) provider = getProvider();
+
+                if (tokenSymbolOrAddress === 'ETH') {
+                    const transaction = {
+                        to: toAddress,
+
+                        // Convert ETH to wei
+                        value: ethers.utils.parseEther(amount.toString()),
+                    };
+
+                    return (await ethersWallet.sendTransaction(transaction)).hash;
+                }
+
+                const tokenAddress = await getTokenAddress(tokenSymbolOrAddress);
+                if (!tokenAddress) {
+                    throw new Error(
+                        `Unable to determine token address for \"${tokenSymbolOrAddress}\"`
+                    );
+                }
+
+                const tokenContract = new ethers.Contract(tokenAddress, ERC20ABI, ethersWallet);
+
+                return (
+                    await tokenContract.transfer(
+                        toAddress,
+                        await parseUnits(
+                            amount.toString(),
+                            tokenContract.address,
+                            defaultTokenList,
+                            await getChainIdFromProvider(provider)
+                        )
+                    )
+                ).hash;
+            },
+
+            getGasPrice: async () => {
+                if (!provider) provider = getProvider();
+
+                return ethers.utils.formatUnits(await provider.getGasPrice());
+            },
+
+            /* Configuration-type methods */
+            getCurrentNetwork: () => {
+                return network;
+            },
+            changeNetwork: (_learnCard, _network: ethers.providers.Networkish) => {
+                const oldNetwork = network;
+                try {
+                    network = _network;
+                    provider = getProvider();
+                } catch (e) {
+                    network = oldNetwork;
+                    provider = getProvider();
+                    throw e;
+                }
+            },
+            addInfuraProjectId: (_learnCard, infuraProjectIdToAdd) => {
+                infuraProjectId = infuraProjectIdToAdd;
+                provider = getProvider();
+            },
+        },
+    };
+};

package/src/types.ts

@@ -0,0 +1,41 @@
+import { providers } from 'ethers';
+import { Plugin } from '@learncard/core';
+
+/** @group Ethereum Plugin */
+export type EthereumPluginMethods = {
+    getEthereumAddress: () => string; // TODO is there a way for this to just be a property?
+    getBalance: (symbolOrAddress?: string) => Promise<string>;
+    getBalanceForAddress: (walletAddress: string, symbolOrAddress?: string) => Promise<string>;
+    transferTokens: (
+        tokenSymbolOrAddress: string,
+        amount: number,
+        toAddress: string
+    ) => Promise<string>;
+    getGasPrice: () => Promise<string>;
+    getCurrentNetwork: () => providers.Networkish;
+    changeNetwork: (network: providers.Networkish) => void;
+    addInfuraProjectId: (infuraProjectIdToAdd: string) => void;
+};
+
+/** @group Ethereum Plugin */
+export type EthereumConfig = {
+    infuraProjectId?: string;
+    network?: providers.Networkish;
+};
+
+/** @group Ethereum Plugin */
+export type Token = {
+    chainId: number;
+    address: string;
+    name: string;
+    symbol: string;
+    decimals: number;
+    logoURI: string;
+    extensions: any;
+};
+
+/** @group Ethereum Plugin */
+export type TokenList = Token[];
+
+/** @group Ethereum Plugin */
+export type EthereumPlugin = Plugin<'Ethereum', any, EthereumPluginMethods, 'id'>;