BrainPass Nft Contract

README.md

@@ -36,6 +36,72 @@ 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 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 previledges 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 contract as a constructor parameter.
+
+### Adding a Pass Type
+This function allows the contract owner to add a new pass type.
+
+Call the `addPassType` function with the following parameters:
+- `pricePerDay`: The price per day in IQ tokens for the pass.
+- `tokenURI`: The base URI for the pass token metadata.
+- `name`: The name of the pass type.
+- `maxTokens`: The maximum number of tokens that can be minted for this pass type.
+- `discount`: The discount percentage applied to the pass price (optional).
+
+### Minting an NFT Pass
+This function allows users to mint a BrainPass NFT for a specific pass type and duration.
+Call the `mintNFT` function with the following parameters:
+- `passId`: The ID of the pass type to mint.
+- `startTimestamp`: The start timestamp for the pass.
+- `endTimestamp`: The end timestamp for the pass.
+- the duration is calculated by endTimestamp - startTimestamp
+- An address can only mint one passtype.
+- The payment is in IQ Token
+
+### Increasing Pass Time
+This function is ued to increase the duration for which a pass is owned for.
+Call the `increasePassTime` function with the following parameters:
+- `tokenId`: The ID of the NFT whose time should be increased.
+- `newStartTime`: The new start timestamp for the pass.
+- `newEndTime`: The new end timestamp for the pass.
+
+### Get User Pass Details
+This gets the details of the tokenId the user has in the particular passId
+Call the `getUserPassDetails` function with the following parameters:
+- `user`: The address of the user.
+- `passId`: The ID of the pass type.
+
+### Get Pass Types
+Call the `getAllPassType` function to get an array of all pass types.
+
+### Get Pass Type Details
+This gets a single passtype  details
+Call the `getPassType` function with the following parameters:
+- `passId`: The ID of the pass type.
+
+### Withdraw Ether
+Only the contract owner can call the `withdraw` function to withdraw any amount of Ether stored in the contract. 
+
+## Events
+
+The contract emits the following events:
+
+- `BrainPassBought`: Emitted when a user buys a BrainPass NFT.
+- `TimeIncreased`: Emitted when the time of a BrainPass NFT is increased.
+- `NewPassAdded`: Emitted when a new pass type is added.
+
+## PICTORAL EXPLANATION
+![image](https://github.com/EveripediaNetwork/ep-contract/assets/75235148/eee4d631-28d9-4ca4-bc0e-62e5a02998a2)
+

script/BrainPassDeployer.s.sol

@@ -0,0 +1,22 @@
+// 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 {
+    address constant owner = address(0xE161eB85f00eC6471E0de06bA1Cfc136C053fFfe);
+
+    function run() external {
+        vm.startBroadcast();
+
+        console.log("Deploying Brainpass deployer....");
+        BrainPassCollectibles validator = new BrainPassCollectibles(0x5E959c60f86D17fb7D764AB69B654227d464E820);
+        console.log("Brainpass Deployed", address(validator));
+
+        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();