## Version -- 1.5.14

- Implement shared 1155URI tests.
NFTCulture · Oct 23, 2023 · 635412f · 635412f
1 parent 875a483
commit 635412f
Show file tree

Hide file tree

Showing 6 changed files with 104 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,9 @@ As of 12/13/2022, this repo has been renamed from "nftc-open-contracts" to "nftc
 ## Version -- 1.5.next [Not published]
 - TODO
 
+## Version -- 1.5.14
+- Implement shared 1155URI tests.
+
 ## Version -- 1.5.13
 - Implement shared baseURI tests.
 

diff --git a/contracts/mocks/token/ERC1155/MockERC1155ConfigurableURI.sol b/contracts/mocks/token/ERC1155/MockERC1155ConfigurableURI.sol
@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.19;
+
+import '@openzeppelin/contracts/token/ERC1155/ERC1155.sol';
+
+contract MockERC1155ConfigurableURI is ERC1155 {
+    constructor(string memory __URI) ERC1155(__URI) {}
+
+    function mint(uint256 itemId, uint256 quantity) public {
+        _mint(msg.sender, itemId, quantity, '');
+    }
+}
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@nftculture/nftc-contracts",
-    "version": "1.5.13",
+    "version": "1.5.14",
     "description": "NFTCulture Open Source Contracts Project",
     "author": "@NFTCulture",
     "license": "MIT",

diff --git a/src/behaviors/token/URI.ts b/src/behaviors/token/URI.ts
@@ -2,12 +2,12 @@ import { expect } from 'chai';
 
 import { skipIfDefault } from '../../for-tests';
 
-export function shouldDefineBaseURI(contractName: string, expectedURIFn: () => Promise<string | null>) {
+export function shouldDefineBaseURI(contractName: string, expectedBaseURIFn: () => Promise<string | null>) {
     describe(`Base URI for ${contractName}:`, function () {
         beforeEach(async function () {
             expect(this).to.have.property('contractUnderTest'); // Must be set in caller
 
-            this.expectedURI = await expectedURIFn();
+            this.expectedURI = await expectedBaseURIFn();
         });
 
         describe('is defined:', function () {
@@ -51,3 +51,51 @@ export function shouldDefineBaseURI(contractName: string, expectedURIFn: () => P
         });
     });
 }
+
+export function shouldDefine1155URI(contractName: string, expectedURIFn: () => Promise<string | null>) {
+    describe(`ERC1155 URI for ${contractName}:`, function () {
+        beforeEach(async function () {
+            expect(this).to.have.property('contractUnderTest'); // Must be set in caller
+
+            this.expectedURI = await expectedURIFn();
+        });
+
+        describe('is defined:', function () {
+            it('not as zero.', async function () {
+                const erc1155Uri = await this.contractUnderTest.uri(0);
+                const isSetToZero = erc1155Uri === 'https://nftc-media.mypinata.cloud/ipfs/Qm000000/{id}.json'; // Zero
+
+                const defaultConfigurationCheck = !isSetToZero;
+                expect(skipIfDefault(this, defaultConfigurationCheck)).to.equal(true);
+            });
+
+            it('not as pinata public gateway.', async function () {
+                const erc1155Uri = await this.contractUnderTest.uri(0);
+                const isSetToPublicPinata = erc1155Uri === 'https://gateway.pinata.cloud/ipfs/ipfs/Qm000000/{id}.json'; // Pinata Public gateway
+
+                const defaultConfigurationCheck = !isSetToPublicPinata;
+                expect(skipIfDefault(this, defaultConfigurationCheck)).to.equal(true);
+            });
+
+            it('not as default for NFTC tokens.', async function () {
+                const erc1155Uri = await this.contractUnderTest.uri(0);
+                const isSetToDefault =
+                    erc1155Uri ===
+                    'https://nftc-media.mypinata.cloud/ipfs/QmNaNCsufrof7s9xp7whbo8dq1hdYdjmjYfgKvGSFbg23f/{id}.json'; // Dr3amLabs_Reference1155_Metadata_V1cb
+
+                const defaultConfigurationCheck = !isSetToDefault;
+                expect(skipIfDefault(this, defaultConfigurationCheck)).to.equal(true);
+            });
+
+            it('as expected.', async function () {
+                const placeholderValue = 'DELIBERATELY BAD VALUE'; // Used if expectedURI is null.
+
+                const erc1155Uri = await this.contractUnderTest.uri(0);
+                const erc1155UriIsCorrect = erc1155Uri === (this.expectedURI ?? placeholderValue);
+
+                const defaultConfigurationCheck = erc1155UriIsCorrect;
+                expect(skipIfDefault(this, defaultConfigurationCheck)).to.equal(true);
+            });
+        });
+    });
+}
diff --git a/test/typescript/behaviors/token/URI.1155.test.ts b/test/typescript/behaviors/token/URI.1155.test.ts
@@ -0,0 +1,32 @@
+import * as dotenv from 'dotenv';
+import hre from 'hardhat';
+
+import { addHardhatSignersToContext, shouldDefine1155URI } from '../../../../src';
+import { MockERC1155ConfigurableURI, MockERC1155ConfigurableURI__factory } from '../../../../typechain-types';
+
+dotenv.config();
+
+const TESTHARNESS_CONTRACT_NAME = 'MockERC1155ConfigurableURI';
+
+let _testHarnessContractFactory: MockERC1155ConfigurableURI__factory;
+let _testHarnessInstance: MockERC1155ConfigurableURI;
+
+// Some plausibly real ERC1155 URI
+const ERC1155URI = 'https://nftculture.mypinata.com/ipfs/Qm000abcdefghijkl/{id}.json';
+
+// Start test block
+describe(`${TESTHARNESS_CONTRACT_NAME} Unit Tests`, function () {
+    before(async function () {
+        _testHarnessContractFactory = await hre.ethers.getContractFactory(TESTHARNESS_CONTRACT_NAME);
+    });
+
+    beforeEach(async function () {
+        _testHarnessInstance = await _testHarnessContractFactory.deploy(ERC1155URI);
+        await _testHarnessInstance.deployed();
+        this.contractUnderTest = _testHarnessInstance;
+    });
+
+    addHardhatSignersToContext();
+
+    shouldDefine1155URI(TESTHARNESS_CONTRACT_NAME, async () => ERC1155URI);
+});
diff --git a/test/typescript/behaviors/token/URI.test.ts → ...ypescript/behaviors/token/URI.721.test.ts b/test/typescript/behaviors/token/URI.test.ts → ...ypescript/behaviors/token/URI.721.test.ts
@@ -1,8 +1,7 @@
 import * as dotenv from 'dotenv';
 import hre from 'hardhat';
 
-import { addHardhatSignersToContext } from '../../../../src';
-import { shouldDefineBaseURI } from '../../../../src/behaviors/token/URI';
+import { addHardhatSignersToContext, shouldDefineBaseURI } from '../../../../src';
 import { MockERC721SolBase, MockERC721SolBase__factory } from '../../../../typechain-types';
 
 dotenv.config();
@@ -12,24 +11,22 @@ const TESTHARNESS_CONTRACT_NAME = 'MockERC721SolBase';
 let _testHarnessContractFactory: MockERC721SolBase__factory;
 let _testHarnessInstance: MockERC721SolBase;
 
+// Some plausibly real ERC721 baseURI
+const ERC721BaseURI = 'https://nftculture.mypinata.cloud/ipfs/Qm000abcdefghijkl/';
+
 // Start test block
 describe(`${TESTHARNESS_CONTRACT_NAME} Unit Tests`, function () {
     before(async function () {
         _testHarnessContractFactory = await hre.ethers.getContractFactory(TESTHARNESS_CONTRACT_NAME);
     });
 
     beforeEach(async function () {
-        _testHarnessInstance = await _testHarnessContractFactory.deploy(
-            'https://nftculture.mypinata.cloud/ipfs/Qm000abcdefghijkl/'
-        );
+        _testHarnessInstance = await _testHarnessContractFactory.deploy(ERC721BaseURI);
         await _testHarnessInstance.deployed();
         this.contractUnderTest = _testHarnessInstance;
     });
 
     addHardhatSignersToContext();
 
-    shouldDefineBaseURI(
-        TESTHARNESS_CONTRACT_NAME,
-        async () => 'https://nftculture.mypinata.cloud/ipfs/Qm000abcdefghijkl/' // Some plausibly real baseURI
-    );
+    shouldDefineBaseURI(TESTHARNESS_CONTRACT_NAME, async () => ERC721BaseURI);
 });