diff --git a/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP/LSP1UniversalReceiverDelegateUP.sol b/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP/LSP1UniversalReceiverDelegateUP.sol index 0952733ed..a60e0f4a8 100644 --- a/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP/LSP1UniversalReceiverDelegateUP.sol +++ b/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP/LSP1UniversalReceiverDelegateUP.sol @@ -19,7 +19,7 @@ import { ERC165Checker } from "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol"; import {LSP5Utils} from "lsp5/contracts/LSP5Utils.sol"; -import {LSP10Utils} from "../../LSP10ReceivedVaults/LSP10Utils.sol"; +import {LSP10Utils} from "lsp10/contracts/LSP10Utils.sol"; // constants import {_INTERFACEID_LSP1_DELEGATE} from "../LSP1Constants.sol"; diff --git a/package-lock.json b/package-lock.json index d77d324d2..0b684be5a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -17,6 +17,7 @@ "@erc725/smart-contracts": "^7.0.0", "@openzeppelin/contracts": "^4.9.2", "@openzeppelin/contracts-upgradeable": "^4.9.2", + "lsp10": "*", "lsp2": "*", "lsp5": "*", "solidity-bytes-utils": "0.8.0" @@ -13284,6 +13285,10 @@ "yallist": "^3.0.2" } }, + "node_modules/lsp10": { + "resolved": "packages/LSP10ReceivedVaults", + "link": true + }, "node_modules/lsp2": { "resolved": "packages/LSP2ERC725YJSONSchema", "link": true @@ -23515,6 +23520,54 @@ "ethers": "^5.7.0" } }, + "packages/LSP10ReceivedVaults": { + "version": "0.12.1", + "license": "Apache-2.0", + "dependencies": { + "@erc725/smart-contracts": "^6.0.0" + }, + "devDependencies": { + "@nomicfoundation/hardhat-toolbox": "^2.0.2", + "@typechain/ethers-v5": "^10.2.0", + "dotenv": "^16.0.3", + "eslint-config-custom": "*", + "ethers": "^5.7.2", + "hardhat": "^2.13.0", + "hardhat-contract-sizer": "^2.8.0", + "hardhat-deploy": "^0.11.25", + "hardhat-gas-reporter": "^1.0.9", + "hardhat-packager": "^1.4.2", + "lsp2": "*", + "solhint": "^3.3.6", + "ts-node": "^10.2.0", + "tsconfig": "*", + "typechain": "^8.0.0", + "typescript": "^4.9.5" + } + }, + "packages/LSP10ReceivedVaults/node_modules/@erc725/smart-contracts": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/@erc725/smart-contracts/-/smart-contracts-6.0.0.tgz", + "integrity": "sha512-6okutGGL9xbg/MSgAof2FU1UcSNE/z3p9TORlROVGaM3gi1A6FQQ7fDqtBYkPtvHureX8yS9gP7xPt3PRbP43Q==", + "dependencies": { + "@openzeppelin/contracts": "^4.9.3", + "@openzeppelin/contracts-upgradeable": "^4.9.3", + "solidity-bytes-utils": "0.8.0" + } + }, + "packages/LSP10ReceivedVaults/node_modules/typescript": { + "version": "4.9.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz", + "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, "packages/LSP2ERC725YJSONSchema": { "name": "lsp2", "version": "0.12.1", @@ -33618,6 +33671,46 @@ "yallist": "^3.0.2" } }, + "lsp10": { + "version": "file:packages/LSP10ReceivedVaults", + "requires": { + "@erc725/smart-contracts": "^6.0.0", + "@nomicfoundation/hardhat-toolbox": "^2.0.2", + "@typechain/ethers-v5": "^10.2.0", + "dotenv": "^16.0.3", + "eslint-config-custom": "*", + "ethers": "^5.7.2", + "hardhat": "^2.13.0", + "hardhat-contract-sizer": "^2.8.0", + "hardhat-deploy": "^0.11.25", + "hardhat-gas-reporter": "^1.0.9", + "hardhat-packager": "^1.4.2", + "lsp2": "*", + "solhint": "^3.3.6", + "ts-node": "^10.2.0", + "tsconfig": "*", + "typechain": "^8.0.0", + "typescript": "^4.9.5" + }, + "dependencies": { + "@erc725/smart-contracts": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/@erc725/smart-contracts/-/smart-contracts-6.0.0.tgz", + "integrity": "sha512-6okutGGL9xbg/MSgAof2FU1UcSNE/z3p9TORlROVGaM3gi1A6FQQ7fDqtBYkPtvHureX8yS9gP7xPt3PRbP43Q==", + "requires": { + "@openzeppelin/contracts": "^4.9.3", + "@openzeppelin/contracts-upgradeable": "^4.9.3", + "solidity-bytes-utils": "0.8.0" + } + }, + "typescript": { + "version": "4.9.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz", + "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==", + "dev": true + } + } + }, "lsp2": { "version": "file:packages/LSP2ERC725YJSONSchema", "requires": { diff --git a/package.json b/package.json index 17e8b5fac..0d38ec04a 100644 --- a/package.json +++ b/package.json @@ -114,7 +114,8 @@ "@openzeppelin/contracts-upgradeable": "^4.9.2", "solidity-bytes-utils": "0.8.0", "lsp2": "*", - "lsp5": "*" + "lsp5": "*", + "lsp10": "*" }, "devDependencies": { "@b00ste/hardhat-dodoc": "^0.3.15", diff --git a/packages/LSP10ReceivedVaults/.eslintrc.js b/packages/LSP10ReceivedVaults/.eslintrc.js new file mode 100644 index 000000000..03ee7431b --- /dev/null +++ b/packages/LSP10ReceivedVaults/.eslintrc.js @@ -0,0 +1,4 @@ +module.exports = { + root: true, + extends: ['custom'], +}; diff --git a/packages/LSP10ReceivedVaults/.solhint.json b/packages/LSP10ReceivedVaults/.solhint.json new file mode 100644 index 000000000..26e01c48a --- /dev/null +++ b/packages/LSP10ReceivedVaults/.solhint.json @@ -0,0 +1,25 @@ +{ + "extends": "solhint:recommended", + "rules": { + "avoid-sha3": "error", + "avoid-suicide": "error", + "avoid-throw": "error", + "avoid-tx-origin": "error", + "check-send-result": "error", + "compiler-version": ["error", "^0.8.0"], + "func-visibility": ["error", { "ignoreConstructors": true }], + "not-rely-on-block-hash": "error", + "not-rely-on-time": "error", + "reentrancy": "error", + "constructor-syntax": "error", + "private-vars-leading-underscore": ["error", { "strict": false }], + "imports-on-top": "error", + "visibility-modifier-order": "error", + "no-unused-import": "error", + "no-global-import": "error", + "reason-string": ["warn", { "maxLength": 120 }], + "avoid-low-level-calls": "off", + "no-empty-blocks": ["error", { "ignoreConstructors": true }], + "custom-errors": "off" + } +} diff --git a/packages/LSP10ReceivedVaults/README.md b/packages/LSP10ReceivedVaults/README.md new file mode 100755 index 000000000..69b3ff4ff --- /dev/null +++ b/packages/LSP10ReceivedVaults/README.md @@ -0,0 +1,5 @@ +# LSP Template + +This project can be used as a skeleton to build a package for a LSP implementation in Solidity (LUKSO Standard Proposal) + +It is based on Hardhat. diff --git a/contracts/LSP10ReceivedVaults/LSP10Constants.sol b/packages/LSP10ReceivedVaults/contracts/LSP10Constants.sol similarity index 100% rename from contracts/LSP10ReceivedVaults/LSP10Constants.sol rename to packages/LSP10ReceivedVaults/contracts/LSP10Constants.sol diff --git a/contracts/LSP10ReceivedVaults/LSP10Utils.sol b/packages/LSP10ReceivedVaults/contracts/LSP10Utils.sol similarity index 97% rename from contracts/LSP10ReceivedVaults/LSP10Utils.sol rename to packages/LSP10ReceivedVaults/contracts/LSP10Utils.sol index 5191c8360..c824fd889 100644 --- a/contracts/LSP10ReceivedVaults/LSP10Utils.sol +++ b/packages/LSP10ReceivedVaults/contracts/LSP10Utils.sol @@ -10,11 +10,14 @@ import { import {LSP2Utils} from "lsp2/contracts/LSP2Utils.sol"; // constants -import {_INTERFACEID_LSP9} from "../LSP9Vault/LSP9Constants.sol"; + +// TODO: add LSP9 as a dependency to this package and import the constant from it +bytes4 constant _INTERFACEID_LSP9 = 0x28af17e6; + import { _LSP10_VAULTS_MAP_KEY_PREFIX, _LSP10_VAULTS_ARRAY_KEY -} from "../LSP10ReceivedVaults/LSP10Constants.sol"; +} from "./LSP10Constants.sol"; /** * @title LSP10 Utility library. diff --git a/packages/LSP10ReceivedVaults/hardhat.config.ts b/packages/LSP10ReceivedVaults/hardhat.config.ts new file mode 100755 index 000000000..d818a205d --- /dev/null +++ b/packages/LSP10ReceivedVaults/hardhat.config.ts @@ -0,0 +1,128 @@ +import { HardhatUserConfig } from 'hardhat/config'; +import { NetworkUserConfig } from 'hardhat/types'; +import { config as dotenvConfig } from 'dotenv'; +import { resolve } from 'path'; + +/** + * this package includes: + * - @nomiclabs/hardhat-ethers + * - @nomicfoundation/hardhat-chai-matchers + * - @nomicfoundation/hardhat-network-helpers + * - @nomiclabs/hardhat-etherscan + * - hardhat-gas-reporter (is this true? Why do we have it as a separate dependency?) + * - @typechain/hardhat + * - solidity-coverage + */ +import '@nomicfoundation/hardhat-toolbox'; + +// additional hardhat plugins +import 'hardhat-packager'; +import 'hardhat-contract-sizer'; +import 'hardhat-deploy'; + +// custom built hardhat plugins and scripts +// can be imported here (e.g: docs generation, gas benchmark, etc...) + +dotenvConfig({ path: resolve(__dirname, './.env') }); + +function getTestnetChainConfig(): NetworkUserConfig { + const config: NetworkUserConfig = { + live: true, + url: 'https://rpc.testnet.lukso.network', + chainId: 4201, + }; + + if (process.env.CONTRACT_VERIFICATION_TESTNET_PK !== undefined) { + config['accounts'] = [process.env.CONTRACT_VERIFICATION_TESTNET_PK]; + } + + return config; +} + +const config: HardhatUserConfig = { + defaultNetwork: 'hardhat', + networks: { + hardhat: { + live: false, + saveDeployments: false, + allowBlocksWithSameTimestamp: true, + }, + luksoTestnet: getTestnetChainConfig(), + }, + namedAccounts: { + owner: 0, + }, + // uncomment if the contracts from this LSP package must be deployed at deterministic + // // addresses across multiple chains + // deterministicDeployment: { + // luksoTestnet: { + // // Nick Factory. See https://github.com/Arachnid/deterministic-deployment-proxy + // factory: '0x4e59b44847b379578588920ca78fbf26c0b4956c', + // deployer: '0x3fab184622dc19b6109349b94811493bf2a45362', + // funding: '0x0000000000000000000000000000000000000000000000000000000000000000', + // signedTx: + // '0xf8a58085174876e800830186a08080b853604580600e600039806000f350fe7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe03601600081602082378035828234f58015156039578182fd5b8082525050506014600cf31ba02222222222222222222222222222222222222222222222222222222222222222a02222222222222222222222222222222222222222222222222222222222222222', + // }, + // }, + etherscan: { + apiKey: 'no-api-key-needed', + customChains: [ + { + network: 'luksoTestnet', + chainId: 4201, + urls: { + apiURL: 'https://api.explorer.execution.testnet.lukso.network/api', + browserURL: 'https://explorer.execution.testnet.lukso.network/', + }, + }, + ], + }, + gasReporter: { + enabled: true, + currency: 'USD', + gasPrice: 21, + excludeContracts: ['Helpers/'], + src: './contracts', + showMethodSig: true, + }, + solidity: { + version: '0.8.17', + settings: { + optimizer: { + enabled: true, + /** + * Optimize for how many times you intend to run the code. + * Lower values will optimize more for initial deployment cost, higher + * values will optimize more for high-frequency usage. + * @see https://docs.soliditylang.org/en/v0.8.6/internals/optimizer.html#opcode-based-optimizer-module + */ + runs: 1000, + }, + outputSelection: { + '*': { + '*': ['storageLayout'], + }, + }, + }, + }, + packager: { + // What contracts to keep the artifacts and the bindings for. + contracts: [], + // Whether to include the TypeChain factories or not. + // If this is enabled, you need to run the TypeChain files through the TypeScript compiler before shipping to the registry. + includeFactories: true, + }, + paths: { + artifacts: 'artifacts', + tests: 'tests', + }, + typechain: { + outDir: 'types', + target: 'ethers-v5', + }, + mocha: { + timeout: 10000000, + }, +}; + +export default config; diff --git a/packages/LSP10ReceivedVaults/package.json b/packages/LSP10ReceivedVaults/package.json new file mode 100644 index 000000000..1ed76a692 --- /dev/null +++ b/packages/LSP10ReceivedVaults/package.json @@ -0,0 +1,45 @@ +{ + "name": "lsp10", + "version": "0.12.1", + "description": "Package for the LSP10 Received Vaults standard", + "license": "Apache-2.0", + "author": "", + "keywords": [ + "LUKSO", + "LSP", + "Blockchain", + "Standards", + "Smart Contracts", + "Ethereum", + "EVM", + "Solidity" + ], + "scripts": { + "build": "hardhat compile --show-stack-traces", + "clean": "hardhat clean", + "format": "prettier --write .", + "lint": "eslint . --ext .ts,.js", + "lint:solidity": "solhint 'contracts/**/*.sol' && prettier --check 'contracts/**/*.sol'" + }, + "dependencies": { + "@erc725/smart-contracts": "^6.0.0" + }, + "devDependencies": { + "@nomicfoundation/hardhat-toolbox": "^2.0.2", + "@typechain/ethers-v5": "^10.2.0", + "dotenv": "^16.0.3", + "eslint-config-custom": "*", + "ethers": "^5.7.2", + "hardhat": "^2.13.0", + "hardhat-contract-sizer": "^2.8.0", + "hardhat-deploy": "^0.11.25", + "hardhat-gas-reporter": "^1.0.9", + "hardhat-packager": "^1.4.2", + "lsp2": "*", + "solhint": "^3.3.6", + "ts-node": "^10.2.0", + "tsconfig": "*", + "typechain": "^8.0.0", + "typescript": "^4.9.5" + } +} diff --git a/packages/LSP10ReceivedVaults/tsconfig.json b/packages/LSP10ReceivedVaults/tsconfig.json new file mode 100755 index 000000000..b7a34e03f --- /dev/null +++ b/packages/LSP10ReceivedVaults/tsconfig.json @@ -0,0 +1,4 @@ +{ + "extends": "tsconfig/contracts.json", + "include": ["**/*.ts"] +} diff --git a/packages/LSP5ReceivedAssets/.eslintrc.js b/packages/LSP5ReceivedAssets/.eslintrc.js index e69de29bb..03ee7431b 100644 --- a/packages/LSP5ReceivedAssets/.eslintrc.js +++ b/packages/LSP5ReceivedAssets/.eslintrc.js @@ -0,0 +1,4 @@ +module.exports = { + root: true, + extends: ['custom'], +}; diff --git a/packages/LSP5ReceivedAssets/.solhint.json b/packages/LSP5ReceivedAssets/.solhint.json index e69de29bb..26e01c48a 100644 --- a/packages/LSP5ReceivedAssets/.solhint.json +++ b/packages/LSP5ReceivedAssets/.solhint.json @@ -0,0 +1,25 @@ +{ + "extends": "solhint:recommended", + "rules": { + "avoid-sha3": "error", + "avoid-suicide": "error", + "avoid-throw": "error", + "avoid-tx-origin": "error", + "check-send-result": "error", + "compiler-version": ["error", "^0.8.0"], + "func-visibility": ["error", { "ignoreConstructors": true }], + "not-rely-on-block-hash": "error", + "not-rely-on-time": "error", + "reentrancy": "error", + "constructor-syntax": "error", + "private-vars-leading-underscore": ["error", { "strict": false }], + "imports-on-top": "error", + "visibility-modifier-order": "error", + "no-unused-import": "error", + "no-global-import": "error", + "reason-string": ["warn", { "maxLength": 120 }], + "avoid-low-level-calls": "off", + "no-empty-blocks": ["error", { "ignoreConstructors": true }], + "custom-errors": "off" + } +} diff --git a/packages/LSP5ReceivedAssets/hardhat.config.ts b/packages/LSP5ReceivedAssets/hardhat.config.ts index d818a205d..c3ab19f2a 100644 --- a/packages/LSP5ReceivedAssets/hardhat.config.ts +++ b/packages/LSP5ReceivedAssets/hardhat.config.ts @@ -126,3 +126,132 @@ const config: HardhatUserConfig = { }; export default config; + +import { HardhatUserConfig } from 'hardhat/config'; +import { NetworkUserConfig } from 'hardhat/types'; +import { config as dotenvConfig } from 'dotenv'; +import { resolve } from 'path'; + +/** + * this package includes: + * - @nomiclabs/hardhat-ethers + * - @nomicfoundation/hardhat-chai-matchers + * - @nomicfoundation/hardhat-network-helpers + * - @nomiclabs/hardhat-etherscan + * - hardhat-gas-reporter (is this true? Why do we have it as a separate dependency?) + * - @typechain/hardhat + * - solidity-coverage + */ +import '@nomicfoundation/hardhat-toolbox'; + +// additional hardhat plugins +import 'hardhat-packager'; +import 'hardhat-contract-sizer'; +import 'hardhat-deploy'; + +// custom built hardhat plugins and scripts +// can be imported here (e.g: docs generation, gas benchmark, etc...) + +dotenvConfig({ path: resolve(__dirname, './.env') }); + +function getTestnetChainConfig(): NetworkUserConfig { + const config: NetworkUserConfig = { + live: true, + url: 'https://rpc.testnet.lukso.network', + chainId: 4201, + }; + + if (process.env.CONTRACT_VERIFICATION_TESTNET_PK !== undefined) { + config['accounts'] = [process.env.CONTRACT_VERIFICATION_TESTNET_PK]; + } + + return config; +} + +const config: HardhatUserConfig = { + defaultNetwork: 'hardhat', + networks: { + hardhat: { + live: false, + saveDeployments: false, + allowBlocksWithSameTimestamp: true, + }, + luksoTestnet: getTestnetChainConfig(), + }, + namedAccounts: { + owner: 0, + }, + // uncomment if the contracts from this LSP package must be deployed at deterministic + // // addresses across multiple chains + // deterministicDeployment: { + // luksoTestnet: { + // // Nick Factory. See https://github.com/Arachnid/deterministic-deployment-proxy + // factory: '0x4e59b44847b379578588920ca78fbf26c0b4956c', + // deployer: '0x3fab184622dc19b6109349b94811493bf2a45362', + // funding: '0x0000000000000000000000000000000000000000000000000000000000000000', + // signedTx: + // '0xf8a58085174876e800830186a08080b853604580600e600039806000f350fe7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe03601600081602082378035828234f58015156039578182fd5b8082525050506014600cf31ba02222222222222222222222222222222222222222222222222222222222222222a02222222222222222222222222222222222222222222222222222222222222222', + // }, + // }, + etherscan: { + apiKey: 'no-api-key-needed', + customChains: [ + { + network: 'luksoTestnet', + chainId: 4201, + urls: { + apiURL: 'https://api.explorer.execution.testnet.lukso.network/api', + browserURL: 'https://explorer.execution.testnet.lukso.network/', + }, + }, + ], + }, + gasReporter: { + enabled: true, + currency: 'USD', + gasPrice: 21, + excludeContracts: ['Helpers/'], + src: './contracts', + showMethodSig: true, + }, + solidity: { + version: '0.8.17', + settings: { + optimizer: { + enabled: true, + /** + * Optimize for how many times you intend to run the code. + * Lower values will optimize more for initial deployment cost, higher + * values will optimize more for high-frequency usage. + * @see https://docs.soliditylang.org/en/v0.8.6/internals/optimizer.html#opcode-based-optimizer-module + */ + runs: 1000, + }, + outputSelection: { + '*': { + '*': ['storageLayout'], + }, + }, + }, + }, + packager: { + // What contracts to keep the artifacts and the bindings for. + contracts: [], + // Whether to include the TypeChain factories or not. + // If this is enabled, you need to run the TypeChain files through the TypeScript compiler before shipping to the registry. + includeFactories: true, + }, + paths: { + artifacts: 'artifacts', + tests: 'tests', + }, + typechain: { + outDir: 'types', + target: 'ethers-v5', + }, + mocha: { + timeout: 10000000, + }, +}; + +export default config; diff --git a/packages/LSP5ReceivedAssets/tsconfig.json b/packages/LSP5ReceivedAssets/tsconfig.json index b7a34e03f..782a36f35 100644 --- a/packages/LSP5ReceivedAssets/tsconfig.json +++ b/packages/LSP5ReceivedAssets/tsconfig.json @@ -2,3 +2,8 @@ "extends": "tsconfig/contracts.json", "include": ["**/*.ts"] } + +{ + "extends": "tsconfig/contracts.json", + "include": ["**/*.ts"] +} diff --git a/template/.gitmodules b/template/.gitmodules deleted file mode 100644 index 3dce69ce0..000000000 --- a/template/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "lib/forge-std"] - path = ../../lib/forge-std - url = https://github.com/foundry-rs/forge-std.git diff --git a/template/foundry.toml b/template/foundry.toml deleted file mode 100644 index aac84236b..000000000 --- a/template/foundry.toml +++ /dev/null @@ -1,10 +0,0 @@ -[profile.default] -src = 'contracts' -out = 'out' -libs = ['node_modules','lib'] -cache_path = 'forge-cache' -test = 'foundry' -solc_version = "0.8.17" -[fuzz] -runs = 10_000 -max_test_rejects = 200_000 diff --git a/template/remappings.txt b/template/remappings.txt deleted file mode 100644 index ca89288f2..000000000 --- a/template/remappings.txt +++ /dev/null @@ -1,9 +0,0 @@ -@erc725/smart-contracts/=node_modules/@erc725/smart-contracts/ -@openzeppelin/contracts/=node_modules/@openzeppelin/contracts/ -@openzeppelin/contracts-upgradeable/=node_modules/@openzeppelin/contracts-upgradeable/ -eth-gas-reporter/=node_modules/eth-gas-reporter/ -forge-std/=lib/forge-std/src/ -hardhat-deploy/=node_modules/hardhat-deploy/ -hardhat/=node_modules/hardhat/ -solidity-bytes-utils/=node_modules/solidity-bytes-utils/ -ds-test/=lib/forge-std/lib/ds-test/src/