v3.0.0

Author: pkieltyka

.gitignore

@@ -8,9 +8,5 @@ lerna-debug.log*
 
 *.js.map
 build
-cache
 coverage
 coverage.json
-
-artifacts/build-info
-artifacts/**/*.dbg.json

README.md

@@ -1,8 +1,8 @@
-# General Meta Wrapper Contract for ERC20
+General ERC20 -> ERC1155 Token Wrapper Contract
+===============================================
 
-Wrapper contract offering meta-transaction methods to any token compliant with the ERC-20 standard.
-
-As well, it allows any ERC-20 token to function with an ERC-1155 contract.
+Allows any ERC-20 token to be wrapped inside of an ERC-1155 contract, and thereby
+allows an ERC-20 token to function as an ERC-1155 contract.
 
 ## How does it work?
 

hardhat.config.ts

@@ -7,9 +7,6 @@ import 'hardhat-gas-reporter'
 import 'solidity-coverage'
 
 const config: HardhatUserConfig = {
-  paths: {
-    artifacts: './artifacts'
-  },
   solidity: {
     version: '0.7.4',
     settings: {
@@ -23,6 +20,10 @@ const config: HardhatUserConfig = {
       }
     }
   },
+  paths: {
+    root: 'src',
+    tests: '../tests'
+  },
   networks: {
     ganache: {
       url: 'http://127.0.0.1:8545',

package.json

@@ -1,45 +1,46 @@
 {
   "name": "erc20-meta-token",
-  "version": "2.2.0",
-  "description": "General ERC-1155 Transaction Wrapper Contract for ERC20s",
+  "private": true,
+  "workspaces": ["src"],
+  "description": "General ERC-1155 Transaction Wrapper Contract for ERC20 Tokens",
   "repository": "https://github.com/0xsequence/erc20-meta-token",
   "license": "Apache-2.0",
   "scripts": {
     "build": "yarn clean && yarn compile && yarn gen:typings",
-    "clean": "rimraf artifacts && rimraf typings/contracts && rimraf cache",
+    "clean": "rimraf src/artifacts && rimraf src/typings/contracts && rimraf src/cache",
     "compile": "hardhat --max-memory 4096 compile",
-    "gen:typings": "rimraf typings/contracts && typechain --target ethers-v5 --outDir typings/contracts './artifacts/!(build-info)/**/*[^dbg].json'",
+    "gen:typings": "rimraf src/typings/contracts && typechain --target ethers-v5 --outDir src/typings/contracts './src/artifacts/!(build-info)/**/*[^dbg].json'",
     "test": "yarn build && yarn concurrently -k --success first 'yarn start:ganache' 'yarn test:ganache'",
     "test:hardhat": "hardhat test tests/*.spec.ts",
     "test:ganache": "hardhat --network ganache test tests/*.spec.ts",
     "test:gas-report": "REPORT_GAS=true yarn test",
     "test:benchmark": "hardhat --network ganache test tests/*.bench.ts",
     "lint": "yarn lint:ts && yarn lint:sol",
     "lint:fix": "yarn lint:ts:fix && yarn lint:sol:fix",
-    "lint:sol": "solhint './contracts/**/*.sol'",
-    "lint:sol:fix": "solhint './contracts/**/*.sol' --fix",
+    "lint:sol": "solhint './src/contracts/**/*.sol'",
+    "lint:sol:fix": "solhint './src/contracts/**/*.sol' --fix",
     "lint:ts": "eslint -c .eslintrc.js './**/*.ts'",
     "lint:ts:fix": "eslint -c .eslintrc.js --fix './**/*.ts'",
     "format": "prettier --write ./**/*.ts",
     "start:ganache": "ganache-cli --chainId ${npm_package_config_ganacheChainID} --networkId ${npm_package_config_ganacheChainID} --port ${npm_package_config_ganachePort} --gasLimit ${npm_package_config_ganacheGasLimit} --gasPrice ${npm_package_config_ganacheGasPrice} --defaultBalanceEther ${npm_package_config_etherBalance} --deterministic --mnemonic \"${npm_package_config_mnemonic}\" ${npm_package_config_extra}",
     "start:ganache:verbose": "yarn run start:ganache --verbose",
-    "stop:ganache": "ps aux | grep ganache-cli | grep -v grep | awk '{print $2}' | xargs kill -9"
+    "stop:ganache": "ps aux | grep ganache-cli | grep -v grep | awk '{print $2}' | xargs kill -9",
+    "release": "yarn publish src"
   },
   "dependencies": {
-    "multi-token-standard": "2.2.0"
   },
   "devDependencies": {
     "@nomiclabs/hardhat-ethers": "^2.0.2",
     "@nomiclabs/hardhat-truffle5": "^2.0.0",
     "@nomiclabs/hardhat-web3": "^2.0.0",
-    "@typechain/ethers-v5": "^6.0.0",
+    "@typechain/ethers-v5": "^6.0.3",
     "@types/chai": "^4.2.15",
     "@types/chai-as-promised": "^7.1.3",
     "@types/chai-string": "^1.4.2",
     "@types/mocha": "^8.2.0",
     "@types/node": "^14.14.16",
-    "@typescript-eslint/eslint-plugin": "^4.17.0",
-    "@typescript-eslint/parser": "^4.17.0",
+    "@typescript-eslint/eslint-plugin": "^4.18.0",
+    "@typescript-eslint/parser": "^4.18.0",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "chai-bignumber": "^3.0.0",
@@ -67,13 +68,6 @@
     "ERC1155",
     "ethereum"
   ],
-  "files": [
-    "README.md",
-    "LICENSE",
-    "artifacts",
-    "contracts",
-    "typings"
-  ],
   "config": {
     "mnemonic": "test test test test test test test test test test test junk",
     "ganacheChainID": 127001,

src/.gitignore

@@ -0,0 +1,3 @@
+cache
+artifacts/build-info
+artifacts/**/*.dbg.json

src/.npmignore

@@ -0,0 +1,3 @@
+cache
+artifacts/build-info
+artifacts/**/*.dbg.json

src/README.md

@@ -0,0 +1,40 @@
+@0xsequence/erc20-meta-token
+============================
+
+Allows any ERC-20 token to be wrapped inside of an ERC-1155 contract, and thereby
+allows an ERC-20 token to function as an ERC-1155 contract.
+
+For more information see, [github.com/0xsequence/erc-1155](https://github.com/0xsequence/erc20-meta-token)
+
+
+## Getting started
+
+### Install
+
+`npm install @0xsequence/erc20-meta-token` or `yarn add @0xsequence/erc20-meta-token`
+
+### Usage from Solidity
+
+```solidity
+pragma solidity ^0.7.4;
+
+import '@0xsequence/erc20-meta-token/contracts/wrapper/ERC20Wrapper.sol';
+
+contract MyERC20MetaToken is ERC20Wrapper {
+  ...
+}
+```
+
+## NOTES
+
+`@0xsequence/erc20-meta-token` includes the following files in its package distribution:
+
+* `artifacts` -- hardhat output of contract compilation
+* `typings` -- ethers v5 typings for easier interfacing with the contract abis
+
+
+## LICENSE
+
+Copyright (c) 2017-present [Horizon Blockchain Games Inc](https://horizon.io).
+
+Licensed under [Apache-2.0](https://github.com/0xsequence/erc-1155/blob/master/LICENSE)

…ts/interfaces/IERC1155.sol/IERC1155.json …ts/interfaces/IERC1155.sol/IERC1155.jsonartifacts/multi-token-standard/contracts/interfaces/IERC1155.sol/IERC1155.json renamed to src/artifacts/@0xsequence/erc-1155/contracts/interfaces/IERC1155.sol/IERC1155.json artifacts/multi-token-standard/contracts/interfaces/IERC1155.sol/IERC1155.json renamed to src/artifacts/@0xsequence/erc-1155/contracts/interfaces/IERC1155.sol/IERC1155.json

@@ -1,7 +1,7 @@
 {
   "_format": "hh-sol-artifact-1",
   "contractName": "IERC1155",
-  "sourceName": "multi-token-standard/contracts/interfaces/IERC1155.sol",
+  "sourceName": "@0xsequence/erc-1155/contracts/interfaces/IERC1155.sol",
   "abi": [
     {
       "anonymous": false,

…nReceiver.sol/IERC1155TokenReceiver.json …nReceiver.sol/IERC1155TokenReceiver.jsonartifacts/multi-token-standard/contracts/interfaces/IERC1155TokenReceiver.sol/IERC1155TokenReceiver.json renamed to src/artifacts/@0xsequence/erc-1155/contracts/interfaces/IERC1155TokenReceiver.sol/IERC1155TokenReceiver.json artifacts/multi-token-standard/contracts/interfaces/IERC1155TokenReceiver.sol/IERC1155TokenReceiver.json renamed to src/artifacts/@0xsequence/erc-1155/contracts/interfaces/IERC1155TokenReceiver.sol/IERC1155TokenReceiver.json

@@ -1,7 +1,7 @@
 {
   "_format": "hh-sol-artifact-1",
   "contractName": "IERC1155TokenReceiver",
-  "sourceName": "multi-token-standard/contracts/interfaces/IERC1155TokenReceiver.sol",
+  "sourceName": "@0xsequence/erc-1155/contracts/interfaces/IERC1155TokenReceiver.sol",
   "abi": [
     {
       "inputs": [

…s/IERC1271Wallet.sol/IERC1271Wallet.json …s/IERC1271Wallet.sol/IERC1271Wallet.jsonartifacts/multi-token-standard/contracts/interfaces/IERC1271Wallet.sol/IERC1271Wallet.json renamed to src/artifacts/@0xsequence/erc-1155/contracts/interfaces/IERC1271Wallet.sol/IERC1271Wallet.json artifacts/multi-token-standard/contracts/interfaces/IERC1271Wallet.sol/IERC1271Wallet.json renamed to src/artifacts/@0xsequence/erc-1155/contracts/interfaces/IERC1271Wallet.sol/IERC1271Wallet.json

@@ -1,7 +1,7 @@
 {
   "_format": "hh-sol-artifact-1",
   "contractName": "IERC1271Wallet",
-  "sourceName": "multi-token-standard/contracts/interfaces/IERC1271Wallet.sol",
+  "sourceName": "@0xsequence/erc-1155/contracts/interfaces/IERC1271Wallet.sol",
   "abi": [
     {
       "inputs": [