Merge pull request #974 from lukso-network/refactor/lsp7-with-erc725-v8

refactor!: Remove `Core` contracts from LSP7 and LSP8 + use latest `@erc725/smart-contracts` to remove dependency with `OwnableUnset`

.github/workflows/solc_version.yml

@@ -45,6 +45,10 @@ jobs:
             "0.8.21",
             "0.8.22",
             "0.8.23",
+            "0.8.24",
+            "0.8.25",
+            "0.8.26",
+            "0.8.27",
           ]
     steps:
       - uses: actions/checkout@v3

.gitignore

@@ -65,7 +65,6 @@ typings/
 
 # Output of 'npm pack'
 package/
-*.tgz
 
 # Yarn Integrity file
 .yarn-integrity

foundry.toml

@@ -11,6 +11,11 @@ solc_version = "0.8.17"
 runs = 10_000
 max_test_rejects = 200_000
 
+[profile.lsp0]
+src = 'packages/lsp0-contracts/contracts'
+test = 'packages/lsp0-contracts/foundry'
+out = 'packages/lsp0-contracts/contracts/foundry_artifacts'
+
 [profile.lsp2]
 src = 'packages/lsp2-contracts/contracts'
 test = 'packages/lsp2-contracts/foundry'

package.json

@@ -62,6 +62,9 @@
     "test:reentrancy": "hardhat test --no-compile packages/lsp-smart-contracts/tests/Reentrancy/Reentrancy.test.ts",
     "test:reentrancyinit": "hardhat test --no-compile packages/lsp-smart-contracts/tests/Reentrancy/ReentrancyInit.test.ts"
   },
+  "dependencies": {
+    "@erc725/smart-contracts-v8": "npm:@erc725/[email protected]"
+  },
   "devDependencies": {
     "@b00ste/hardhat-dodoc": "^0.3.16",
     "@erc725/erc725.js": "0.23.0",
@@ -88,9 +91,9 @@
     "npm-run-all": "^4.1.5",
     "pluralize": "^8.0.0",
     "prettier": "^2.8.8",
-    "prettier-plugin-solidity": "^1.1.3",
+    "prettier-plugin-solidity": "^1.4.1",
     "rollup-plugin-esbuild": "^5.0.0",
-    "solhint": "^3.6.2",
+    "solhint": "^5.0.3",
     "ts-node": "^10.2.0",
     "turbo": "latest",
     "typechain": "^8.3.2",

packages/lsp-smart-contracts/.solhint.json

@@ -20,6 +20,6 @@
     "reason-string": ["warn", { "maxLength": 120 }],
     "avoid-low-level-calls": "off",
     "no-empty-blocks": ["error", { "ignoreConstructors": true }],
-    "custom-errors": "off"
+    "gas-custom-errors": "off"
   }
 }

packages/lsp-smart-contracts/constants.ts

@@ -17,8 +17,8 @@ export type {
   LSP4DigitalAssetMetadataJSON,
   LSP4DigitalAssetMetadata,
   AttributeMetadata,
-  AssetFile,
-  DigitalAsset,
+  FileAsset,
+  ContractAsset,
 } from '@lukso/lsp4-contracts';
 export type { LSP6PermissionName } from '@lukso/lsp6-contracts';
 

packages/lsp-smart-contracts/package.json

@@ -62,33 +62,33 @@
     "lint": "eslint . --ext .ts,.js",
     "lint:solidity": "solhint 'contracts/**/*.sol' && prettier --check 'contracts/**/*.sol'",
     "package": "hardhat prepare-package",
-    "test": "hardhat test --no-compile tests/**/*.test.ts",
+    "test": "hardhat test --no-compile tests/**/*.test.ts tests/LSP7DigitalAsset/**/*.ts tests/LSP8IdentifiableDigitalAsset/**/*.ts",
     "test:foundry": "FOUNDRY_PROFILE=lsp_smart_contracts forge test --no-match-test Skip -vvv",
     "test:coverage": "hardhat coverage",
     "test:benchmark": "hardhat test --no-compile tests/Benchmark.test.ts"
   },
   "dependencies": {
-    "@lukso/lsp0-contracts": "~0.15.0",
-    "@lukso/lsp1-contracts": "~0.15.0",
-    "@lukso/lsp10-contracts": "~0.15.0",
-    "@lukso/lsp12-contracts": "~0.15.0",
-    "@lukso/lsp14-contracts": "~0.15.0",
-    "@lukso/lsp16-contracts": "~0.15.0",
-    "@lukso/lsp17-contracts": "~0.15.0",
-    "@lukso/lsp17contractextension-contracts": "~0.15.0",
-    "@lukso/lsp1delegate-contracts": "~0.15.0",
-    "@lukso/lsp2-contracts": "~0.15.0",
-    "@lukso/lsp20-contracts": "~0.15.0",
-    "@lukso/lsp23-contracts": "~0.15.0",
-    "@lukso/lsp25-contracts": "~0.15.0",
-    "@lukso/lsp26-contracts": "~0.15.0",
-    "@lukso/lsp3-contracts": "~0.15.0",
-    "@lukso/lsp4-contracts": "~0.15.0",
-    "@lukso/lsp5-contracts": "~0.15.0",
-    "@lukso/lsp6-contracts": "~0.15.0",
-    "@lukso/lsp7-contracts": "~0.15.0",
-    "@lukso/lsp8-contracts": "~0.15.0",
-    "@lukso/lsp9-contracts": "~0.15.0",
-    "@lukso/universalprofile-contracts": "~0.15.0"
+    "@lukso/lsp0-contracts": "*",
+    "@lukso/lsp1-contracts": "*",
+    "@lukso/lsp10-contracts": "*",
+    "@lukso/lsp12-contracts": "*",
+    "@lukso/lsp14-contracts": "*",
+    "@lukso/lsp16-contracts": "*",
+    "@lukso/lsp17-contracts": "*",
+    "@lukso/lsp17contractextension-contracts": "*",
+    "@lukso/lsp1delegate-contracts": "*",
+    "@lukso/lsp2-contracts": "*",
+    "@lukso/lsp20-contracts": "*",
+    "@lukso/lsp23-contracts": "*",
+    "@lukso/lsp25-contracts": "*",
+    "@lukso/lsp26-contracts": "*",
+    "@lukso/lsp3-contracts": "*",
+    "@lukso/lsp4-contracts": "*",
+    "@lukso/lsp5-contracts": "*",
+    "@lukso/lsp6-contracts": "*",
+    "@lukso/lsp7-contracts": "*",
+    "@lukso/lsp8-contracts": "*",
+    "@lukso/lsp9-contracts": "*",
+    "@lukso/universalprofile-contracts": "*"
   }
 }

packages/lsp-smart-contracts/tests/LSP20CallVerification/LSP6/Admin/PermissionChangeOwner.test.ts

@@ -8,7 +8,7 @@ import { ERC725YDataKeys } from '../../../../constants';
 import { OPERATION_TYPES } from '@lukso/lsp0-contracts';
 import { PERMISSIONS } from '@lukso/lsp6-contracts';
 
-import { LSP6KeyManager, LSP6KeyManager__factory } from '../../types';
+import { LSP6KeyManager, LSP6KeyManager__factory } from '../../../../types';
 
 // setup
 import { LSP6TestContext } from '../../../utils/context';

packages/lsp-smart-contracts/tests/LSP20CallVerification/LSP6/Interactions/AllowedAddresses.test.ts

@@ -2,7 +2,7 @@ import { expect } from 'chai';
 import { ethers } from 'hardhat';
 import { SignerWithAddress } from '@nomicfoundation/hardhat-ethers/signers';
 
-import { TargetContract, TargetContract__factory } from '../../types';
+import { TargetContract, TargetContract__factory } from '../../../../types';
 
 // constants
 import { ERC725YDataKeys } from '../../../../constants';

packages/lsp-smart-contracts/tests/LSP20CallVerification/LSP6/Interactions/AllowedFunctions.test.ts

@@ -9,7 +9,7 @@ import {
   LSP7Mintable__factory,
   LSP8Mintable,
   LSP8Mintable__factory,
-} from '../../types';
+} from '../../../../types';
 
 // constants
 import { ERC725YDataKeys, INTERFACE_IDS } from '../../../../constants';

packages/lsp-smart-contracts/tests/LSP20CallVerification/LSP6/Interactions/AllowedStandards.test.ts

@@ -11,7 +11,7 @@ import {
   LSP7Mintable__factory,
   UniversalProfile,
   UniversalProfile__factory,
-} from '../../types';
+} from '../../../../types';
 
 // constants
 import { ERC725YDataKeys, INTERFACE_IDS } from '../../../../constants';

packages/lsp-smart-contracts/tests/LSP20CallVerification/LSP6/Interactions/ERC725XExecuteBatch.test.ts

@@ -15,7 +15,7 @@ import {
   LSP7MintableInit,
   LSP7MintableInit__factory,
   LSP7Mintable__factory,
-} from '../../types';
+} from '../../../../types';
 
 export const shouldBehaveLikeBatchExecute = (
   buildContext: (initialFunding?: bigint) => Promise<LSP6TestContext>,

packages/lsp-smart-contracts/tests/LSP20CallVerification/LSP6/Interactions/OtherScenarios.test.ts

@@ -1,7 +1,7 @@
 import { expect } from 'chai';
 import { SignerWithAddress } from '@nomicfoundation/hardhat-ethers/signers';
 
-import { TargetContract__factory, TargetContract } from '../../types';
+import { TargetContract__factory, TargetContract } from '../../../../types';
 
 // constants
 import { ERC725YDataKeys } from '../../../../constants';

packages/lsp-smart-contracts/tests/LSP20CallVerification/LSP6/Interactions/PermissionCall.test.ts

@@ -9,7 +9,7 @@ import {
   FallbackRevert__factory,
   TargetContract,
   TargetContract__factory,
-} from '../../types';
+} from '../../../../types';
 
 // constants
 import { ERC725YDataKeys } from '../../../../constants';

packages/lsp-smart-contracts/tests/LSP20CallVerification/LSP6/Interactions/PermissionDelegateCall.test.ts

@@ -1,7 +1,7 @@
 import { expect } from 'chai';
 import { SignerWithAddress } from '@nomicfoundation/hardhat-ethers/signers';
 
-import { ERC725YDelegateCall, ERC725YDelegateCall__factory } from '../../types';
+import { ERC725YDelegateCall, ERC725YDelegateCall__factory } from '../../../../types';
 
 // constants
 import { ERC725YDataKeys } from '../../../../constants';

packages/lsp-smart-contracts/tests/LSP20CallVerification/LSP6/Interactions/PermissionDeploy.test.ts

@@ -3,7 +3,7 @@ import { ethers } from 'hardhat';
 import { SignerWithAddress } from '@nomicfoundation/hardhat-ethers/signers';
 import { calculateCreate2 } from 'eth-create2-calculator';
 
-import { TargetContract__factory } from '../../types';
+import { TargetContract__factory } from '../../../../types';
 
 // constants
 import { ERC725YDataKeys } from '../../../../constants';

packages/lsp-smart-contracts/tests/LSP20CallVerification/LSP6/Interactions/PermissionStaticCall.test.ts

@@ -1,7 +1,7 @@
 import { expect } from 'chai';
 import { SignerWithAddress } from '@nomicfoundation/hardhat-ethers/signers';
 
-import { TargetContract, TargetContract__factory } from '../../types';
+import { TargetContract, TargetContract__factory } from '../../../../types';
 
 // constants
 import { ERC725YDataKeys } from '../../../../constants';

packages/lsp-smart-contracts/tests/LSP20CallVerification/LSP6/Interactions/PermissionTransferValue.test.ts

@@ -16,7 +16,7 @@ import {
   UniversalProfile,
   FallbackContract__factory,
   FallbackContract,
-} from '../../types';
+} from '../../../../types';
 
 // constants
 import { ERC725YDataKeys } from '../../../../constants';

packages/lsp-smart-contracts/tests/LSP20CallVerification/LSP6/Interactions/Security.test.ts

@@ -12,7 +12,7 @@ import {
   TargetContract,
   TargetContract__factory,
   UniversalReceiverDelegateDataUpdater__factory,
-} from '../../types';
+} from '../../../../types';
 
 // constants
 import { ERC725YDataKeys, LSP1_TYPE_IDS } from '../../../../constants';

packages/lsp-smart-contracts/tests/LSP20CallVerification/LSP6/SetData/PermissionSetData.test.ts

@@ -3,7 +3,7 @@ import { ethers } from 'hardhat';
 import { SignerWithAddress } from '@nomicfoundation/hardhat-ethers/signers';
 import { encodeData, ERC725JSONSchema } from '@erc725/erc725.js';
 
-import { ExecutorLSP20, ExecutorLSP20__factory } from '../../types';
+import { ExecutorLSP20, ExecutorLSP20__factory } from '../../../../types';
 
 // constants
 import { ERC725YDataKeys } from '../../../../constants';

packages/lsp-smart-contracts/tests/LSP6KeyManager/LSP6ControlledToken.test.ts

@@ -170,7 +170,7 @@ describe('When deploying LSP7 with LSP6 as owner', () => {
 
       await expect(
         context.keyManager.connect(context.mainController).execute(payload),
-      ).to.be.revertedWithCustomError(context.token, 'OwnableCallerNotTheOwner');
+      ).to.be.revertedWith('Ownable: caller is not the owner');
     });
 
     it('should allow the new owner to call setData(..)', async () => {
@@ -212,7 +212,7 @@ describe('When deploying LSP7 with LSP6 as owner', () => {
 
       await expect(
         context.keyManager.connect(context.mainController).execute(transferOwnershipPayload),
-      ).to.be.revertedWithCustomError(context.token, 'OwnableCallerNotTheOwner');
+      ).to.be.revertedWith('Ownable: caller is not the owner');
     });
 
     it('should allow the new owner to call transferOwnership(..)', async () => {
@@ -227,7 +227,7 @@ describe('When deploying LSP7 with LSP6 as owner', () => {
 
       await expect(
         context.keyManager.connect(context.mainController).execute(renounceOwnershipPayload),
-      ).to.be.revertedWithCustomError(context.token, 'OwnableCallerNotTheOwner');
+      ).to.be.revertedWith('Ownable: caller is not the owner');
     });
 
     it('should allow the new owner to call renounceOwnership(..)', async () => {

packages/lsp-smart-contracts/tests/LSP7DigitalAsset/LSP7DigitalAsset.behaviour.ts

@@ -22,6 +22,7 @@ import { ERC725YDataKeys, INTERFACE_IDS, LSP1_TYPE_IDS, SupportedStandards } fro
 
 import { abiCoder } from '../utils/helpers';
 import { AddressZero } from '../LSP17Extensions/helpers/utils';
+import { build } from 'unbuild';
 
 export type LSP7TestAccounts = {
   owner: SignerWithAddress;
@@ -444,8 +445,8 @@ export const shouldBehaveLikeLSP7 = (buildContext: () => Promise<LSP7TestContext
       });
 
       describe('when `operator` param is the zero address', () => {
-        const tokenOwner = context.accounts.owner.address;
         it('should revert', async () => {
+          const tokenOwner = context.accounts.owner.address;
           const subtractedAmount = toBigInt(1);
 
           await expect(
@@ -2127,7 +2128,7 @@ export const shouldBehaveLikeLSP7 = (buildContext: () => Promise<LSP7TestContext
       const newOwner = context.accounts.anyone;
       await expect(
         context.lsp7.connect(newOwner).transferOwnership(newOwner.address),
-      ).to.be.revertedWithCustomError(context.lsp7, 'OwnableCallerNotTheOwner');
+      ).to.be.revertedWith('Ownable: caller is not the owner');
     });
 
     describe('after transferring ownership of the contract', () => {
@@ -2139,21 +2140,21 @@ export const shouldBehaveLikeLSP7 = (buildContext: () => Promise<LSP7TestContext
         const randomAddress = context.accounts.anyone.address;
         await expect(
           context.lsp7.connect(oldOwner).transferOwnership(randomAddress),
-        ).to.be.revertedWithCustomError(context.lsp7, 'OwnableCallerNotTheOwner');
+        ).to.be.revertedWith('Ownable: caller is not the owner');
       });
 
       it('old owner should not be allowed to use `renounceOwnership(..)`', async () => {
-        await expect(
-          context.lsp7.connect(oldOwner).renounceOwnership(),
-        ).to.be.revertedWithCustomError(context.lsp7, 'OwnableCallerNotTheOwner');
+        await expect(context.lsp7.connect(oldOwner).renounceOwnership()).to.be.revertedWith(
+          'Ownable: caller is not the owner',
+        );
       });
 
       it('old owner should not be allowed to use `setData(..)`', async () => {
         const key = ethers.keccak256(ethers.toUtf8Bytes('key'));
         const value = ethers.keccak256(ethers.toUtf8Bytes('value'));
-        await expect(
-          context.lsp7.connect(oldOwner).setData(key, value),
-        ).to.be.revertedWithCustomError(context.lsp7, 'OwnableCallerNotTheOwner');
+        await expect(context.lsp7.connect(oldOwner).setData(key, value)).to.be.revertedWith(
+          'Ownable: caller is not the owner',
+        );
       });
 
       it('new owner should be allowed to use `transferOwnership(..)`', async () => {

packages/lsp-smart-contracts/tests/LSP7DigitalAsset/LSP7Mintable.behaviour.ts

@@ -87,7 +87,7 @@ export const shouldBehaveLikeLSP7Mintable = (
 
       await expect(
         context.lsp7Mintable.connect(nonOwner).mint(nonOwner.address, amountToMint, true, '0x'),
-      ).to.be.revertedWithCustomError(context.lsp7Mintable, 'OwnableCallerNotTheOwner');
+      ).to.be.revertedWith('Ownable: caller is not the owner');
     });
   });
 

packages/lsp-smart-contracts/tests/LSP8IdentifiableDigitalAsset/LSP8IdentifiableDigitalAsset.behaviour.ts

@@ -119,7 +119,7 @@ export const shouldBehaveLikeLSP8 = (
         context.lsp8
           .connect(context.accounts.anyone)
           .setDataForTokenId(tokenId, dataKey, dataValue),
-      ).to.be.revertedWithCustomError(context.lsp8, 'OwnableCallerNotTheOwner');
+      ).to.be.revertedWith('Ownable: caller is not the owner');
     });
 
     it('TokenIdDataChanged emitted when data is set for a specific tokenId', async () => {
@@ -1795,7 +1795,7 @@ export const shouldBehaveLikeLSP8 = (
       const newOwner = context.accounts.anyone;
       await expect(
         context.lsp8.connect(newOwner).transferOwnership(newOwner.address),
-      ).to.be.revertedWithCustomError(context.lsp8, 'OwnableCallerNotTheOwner');
+      ).to.be.revertedWith('Ownable: caller is not the owner');
     });
 
     it('should transfer ownership of the contract', async () => {
@@ -1814,21 +1814,21 @@ export const shouldBehaveLikeLSP8 = (
         const randomAddress = context.accounts.anyone.address;
         await expect(
           context.lsp8.connect(oldOwner).transferOwnership(randomAddress),
-        ).to.be.revertedWithCustomError(context.lsp8, 'OwnableCallerNotTheOwner');
+        ).to.be.revertedWith('Ownable: caller is not the owner');
       });
 
       it('old owner should not be allowed to use `renounceOwnership(..)`', async () => {
-        await expect(
-          context.lsp8.connect(oldOwner).renounceOwnership(),
-        ).to.be.revertedWithCustomError(context.lsp8, 'OwnableCallerNotTheOwner');
+        await expect(context.lsp8.connect(oldOwner).renounceOwnership()).to.be.revertedWith(
+          'Ownable: caller is not the owner',
+        );
       });
 
       it('old owner should not be allowed to use `setData(..)`', async () => {
         const key = ethers.keccak256(ethers.toUtf8Bytes('key'));
         const value = ethers.keccak256(ethers.toUtf8Bytes('value'));
-        await expect(
-          context.lsp8.connect(oldOwner).setData(key, value),
-        ).to.be.revertedWithCustomError(context.lsp8, 'OwnableCallerNotTheOwner');
+        await expect(context.lsp8.connect(oldOwner).setData(key, value)).to.be.revertedWith(
+          'Ownable: caller is not the owner',
+        );
       });
 
       it('new owner should be allowed to use `transferOwnership(..)`', async () => {