BrainPass Nft Contract

README.md

@@ -36,6 +36,109 @@ Deploy and verify a contract
 source .env
 
 # To deploy and verify our contract
-forge script script/WikiNoValidator.s.sol:WikiNoValidator --rpc-url $RPC_URL  --private-key $PRIVATE_KEY --broadcast --verify --etherscan-api-key $ETHERSCAN_KEY -vvvv --gas-price 60 --legacy
+forge script script/BrainPassDeployer.s.sol:BrainPassDeployer --rpc-url $RPC_URL  --private-key $PRIVATE_KEY --broadcast --verify --etherscan-api-key $ETHERSCAN_KEY -vvvv --gas-price 60 --legacy
 
 ```
+
+# Expalaining How BrainPassCollectibles Contract Works
+
+BrainPassCollectibles is a Solidity smart contract that enables the creation and management of BrainPass NFTs. It allows users to buy passes to have some Wiki privileges on IQ Wiki and provides functionalities to mint NFTs, increase pass time, and manage pass types.
+
+## Usage
+
+### Contract Deployment
+Deploy the `BrainPassCollectibles` contract by providing the address of the IQ token and the `baseTokenURI` contract as constructor parameters.
+
+## `pause()`
+Pauses the contract and prevents any further actions. Can only be called by the contract owner.
+
+## `unpause()`
+Unpauses the contract and resumes normal operations. Can only be called by the contract owner.
+
+## `configureMintLimit()`
+Configures the lower and upper limits for minting NFTs.
+- `lowerLimit`: Minimum duration (in days) for a subscription.
+- `upperLimit`: Maximum duration (in days) for a subscription.
+Only the contract owner can call this function.
+
+## `addPassType()`
+Adds a new pass type.
+- `pricePerDay`: Price per day of the new pass type.
+- `name`: Name of the new pass type.
+- `maxTokens`: Total number of tokens in the pass.
+Only the contract owner can call this function and only when the contract is not paused 
+
+## `togglePassTypeStatus()`
+toggles the status of a specific pass type from paused to unpaused.
+- `passId`: ID of the pass type to be deactivated.
+Only the contract owner can call this function and only when the contract is not paused 
+
+## `mintNFT()`
+Mints an NFT of a particular pass type.
+- `passId`: ID of the pass type to mint.
+- `startTimestamp`: Time when the NFT subscription starts.
+- `endTimestamp`: Time when the NFT subscription ends.
+Can call this function  only when the contract is not paused, using  the `whenNotPaused` modifier 
+
+## `increaseEndTime()`
+Increases the EndTime time of an NFT.
+- `tokenId`: ID of the NFT whose time is to be increased.
+- `newEndTime`: New subscription end time for the NFT.
+Only when the contract is not paused can this function be called, using  the `whenNotPaused` modifier
+
+## `withdrawEther()`
+Withdraws any amount of Ether held in the contract. 
+- `receiver`: The address the Ether would be sent to.
+- `amount`: The amount to be sent to the address from the contract.
+Only the contract owner can call this function.
+
+
+## `withdrawIQ()`
+Withdraws any amount of IQ tokens held in the contract. 
+- `receiver`: The address the Ether would be sent to.
+- `amount`: The amount to be sent to the address from the contract.
+Only the contract owner can call this function.
+
+## `setBaseURI`
+sets the BaseUri in the contructor, during deployment of the contract.
+
+## `_baseURI`
+Returns the baseUri of the all tokens
+
+## `getUserPassDetails()`
+Retrieves the details of an NFT owned by a specific user for a given pass type.
+- `user`: Address of the user.
+
+## `getAllPassType()`
+Retrieves the details of all the pass types added to the contract.
+
+## `getPassType()`
+Retrieves the details of a specific pass type.
+- `passId`: ID of the pass type
+
+## Events
+
+The contract emits the following events:
+
+- `BrainPassBought`: Emitted when a user buys a BrainPass NFT.
+- `PassTimeIncreased`: Emitted when the time of a BrainPass NFT is increased.
+- `NewPassAdded`: Emitted when a new pass type is added.
+- `PassTypeStatusToggled`: Emitted when a pass is paused or unpaused.
+
+## PICTORAL EXPLANATION
+![image](https://github.com/EveripediaNetwork/ep-contract/assets/75235148/eee4d631-28d9-4ca4-bc0e-62e5a02998a2)
+
+
+# Expalaining How BrainPassValidiator Contract Works
+BrainPassValidiator is a Solidity smart contract that validates a user to have the ability to post a wiki on IQ Wiki.
+
+
+## Usage
+
+### Contract Deployment
+Deploy the `BrainPassValidiator` contract by providing the address of the BrainPassCollectibles as a constructor parameter.
+
+## `validate()`
+`user`: The user address that is validated
+Checks the validity of an address and returns a boolean values based on the result.
+

remappings.txt

@@ -4,3 +4,4 @@ forge-std/=lib/forge-std/src/
 openzeppelin-contracts/=lib/openzeppelin-contracts/
 prb-test/=lib/prb-test/src/
 solmate/=lib/solmate/src/
+

script/BrainPassDeployer.s.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+import {Script} from "../lib/forge-std/src/Script.sol";
+import {console} from "../lib/forge-std/src/console.sol";
+import {BrainPassCollectibles} from "../src/BrainPass/BrainPass.sol";
+
+contract BrainPassDeployer is Script {
+    function run() external {
+        vm.startBroadcast();
+        console.log("Deploying Brainpass deployer....");
+        BrainPassCollectibles brainPass = new BrainPassCollectibles(
+            0x5E959c60f86D17fb7D764AB69B654227d464E820,
+            "https://api.dev.braindao.org/brainpass/"
+        );
+        console.log("Brainpass Deployed To:", address(brainPass));
+        vm.stopBroadcast();
+    }
+}

script/BrainPassValidator.s.sol

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+import {Script} from "../lib/forge-std/src/Script.sol";
+import {console} from "../lib/forge-std/src/console.sol";
+import {BrainPassValidiator} from "../src/BrainPass/BrainPassValidator.sol";
+
+contract BrainPassValidiatorDeployer is Script {
+    function run() external {
+        vm.startBroadcast();
+        console.log("Deploying Brainpass Valdiator....");
+        BrainPassValidiator brainPassValidator = new BrainPassValidiator(
+            0x6e213cE219d7ef282ACCC7734040D67875828be4
+        );
+        console.log("Brainpass Deployed To", address(brainPassValidator));
+        vm.stopBroadcast();
+    }
+}

script/WikiWhitelistValidator.s.sol

@@ -22,10 +22,8 @@ contract WikiWhitelistValidator is Script {
         validator.whitelistEditor(address(0xF6d9467758C08d05571f1bFa0a03A2286cE1F043));
         validator.whitelistEditor(address(0x2fE6aCD015384E1ee5138eF79fe1a434dA8FA12e));
         validator.whitelistEditor(address(0xb029c0367CCFeEFBc6D00B4cc22fcbFd6A781F5c));
-
         validator.whitelistEditor(address(0x9fEAB70f3c4a944B97b7565BAc4991dF5B7A69ff));
         validator.whitelistEditor(address(0x14B68b85E1037d1C75726b7794e99C20554f9CC3));
-
         validator.setOwner(owner);
 
         vm.stopBroadcast();