Created using remix-ide: Realtime Ethereum Contract Compiler and Runtime.

Instructions for loading a file into the Remix IDE by pasting a gist URL, and it contains the contents of a default Remix workspace. This workspace includes configuration files (like `.gitconfig` and `.prettierrc.json`), a `README.txt` explaining the directory structure of `contracts`, `scripts`, and `tests`, and a sample Solidity contract (`1_Storage.sol`). The README details how to deploy contracts using TypeScript scripts and run tests within the Remix environment.

Created May 22, 2026 10:54 - - Save Cloverbrat/4a0318569491c33f3780502d224894a5 to your computer and use it in GitHub Desktop. Created using remix-ide: Realtime Ethereum Contract Compiler and Runtime. Load this file by pasting this gists URL or ID at https://remix.ethereum.org/ version=soljson-v0.8.34+commit.80d5c536.js&optimize=undefined&runs=200&gist= https://remix.ethereum.org/ version=soljson-v0.8.34+commit.80d5c536.js&optimize=undefined&runs=200&gist= This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters https://github.co/hiddenchars | core | | | repositoryformatversion = 0 | | | filemode = false | | | bare = false | | | logallrefupdates = true | | | symlinks = false | | | ignorecase = true | This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters https://github.co/hiddenchars | ref: refs/heads/main | This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters https://github.co/hiddenchars | { | | | "overrides": | | | { | | | "files": " .sol", | | | "options": { | | | "printWidth": 80, | | | "tabWidth": 4, | | | "useTabs": false, | | | "singleQuote": false, | | | "bracketSpacing": false | | | } | | | }, | | | { | | | "files": " .yml", | | | "options": {} | | | }, | | | { | | | "files": " .yaml", | | | "options": {} | | | }, | | | { | | | "files": " .toml", | | | "options": {} | | | }, | | | { | | | "files": " .json", | | | "options": {} | | | }, | | | { | | | "files": " .js", | | | "options": {} | | | }, | | | { | | | "files": " .ts", | | | "options": {} | | | } | | | | | | } | This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters https://github.co/hiddenchars | REMIX DEFAULT WORKSPACE | | | Remix default workspace is present when: | | | i. Remix loads for the very first time | | | ii. A new workspace is created with 'Default' template | | | iii. There are no files existing in the File Explorer | | | This workspace contains 3 directories: | | | 1. 'contracts': Holds three contracts with increasing levels of complexity. | | | 2. 'scripts': Contains four typescript files to deploy a contract. It is explained below. | | | 3. 'tests': Contains one Solidity test file for 'Ballot' contract & one JS test file for 'Storage' contract. | | | SCRIPTS | | | The 'scripts' folder has two typescript files which help to deploy the 'Storage' contract using 'ethers.js' libraries. | | | For the deployment of any other contract, just update the contract name from 'Storage' to the desired contract and provide constructor arguments accordingly | | | in the file deploy with ethers.ts | | | In the 'tests' folder there is a script containing Mocha-Chai unit tests for 'Storage' contract. | | | To run a script, right click on file name in the file explorer and click 'Run'. Remember, Solidity file must already be compiled. | | | Output from script will appear in remix terminal. | | | Please note, require/import is supported in a limited manner for Remix supported modules. | | | For now, modules supported by Remix are ethers, swarmgw, chai, multihashes, remix and hardhat only for hardhat.ethers object/plugin. | | | For unsupported modules, an error like this will be thrown: '<module name module require is not supported by Remix IDE' will be shown. | This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters https://github.co/hiddenchars | // SPDX-License-Identifier: GPL-3.0 | | | pragma solidity =0.8.2 <0.9.0; | | | / | | | @title Storage | | | @dev Store & retrieve value in a variable | | | @custom:dev-run-script ./scripts/deploy with ethers.ts | | | / | | | contract Storage { | | | uint256 number; | | | / | | | @dev Store value in variable | | | @param num value to store | | | / | | | function store uint256 num public { | | | number = num; | | | } | | | / | | | @dev Return value | | | @return value of 'number' | | | / | | | function retrieve public view returns uint256 { | | | return number; | | | } | | | } | This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters https://github.co/hiddenchars | // SPDX-License-Identifier: GPL-3.0 | | | pragma solidity =0.7.0 <0.9.0; | | | import "hardhat/console.sol"; | | | / | | | @title Owner | | | @dev Set & change owner | | | / | | | contract Owner { | | | address private owner; | | | // event for EVM logging | | | event OwnerSet address indexed oldOwner, address indexed newOwner ; | | | // modifier to check if caller is owner | | | modifier isOwner { | | | // If the first argument of 'require' evaluates to 'false', execution terminates and all | | | // changes to the state and to Ether balances are reverted. | | | // This used to consume all gas in old EVM versions, but not anymore. | | | // It is often a good idea to use 'require' to check if functions are called correctly. | | | // As a second argument, you can also provide an explanation about what went wrong. | | | require msg.sender == owner, "Caller is not owner" ; | | | ; | | | } | | | / | | | @dev Set contract deployer as owner | | | / | | | constructor { | | | console.log "Owner contract deployed by:", msg.sender ; | | | owner = msg.sender; // 'msg.sender' is sender of current call, contract deployer for a constructor | | | emit OwnerSet address 0 , owner ; | | | } | | | / | | | @dev Change owner | | | @param newOwner address of new owner | | | / | | | function changeOwner address newOwner public isOwner { | | | require newOwner = address 0 , "New owner should not be the zero address" ; | | | emit OwnerSet owner, newOwner ; | | | owner = newOwner; | | | } | | | / | | | @dev Return owner address | | | @return address of owner | | | / | | | function getOwner external view returns address { | | | return owner; | | | } | | | } | This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters https://github.co/hiddenchars | // SPDX-License-Identifier: GPL-3.0 | | | pragma solidity =0.7.0 <0.9.0; | | | / | | | @title Ballot | | | @dev Implements voting process along with vote delegation | | | / | | | contract Ballot { | | | // This declares a new complex type which will | | | // be used for variables later. | | | // It will represent a single voter. | | | struct Voter { | | | uint weight; // weight is accumulated by delegation | | | bool voted; // if true, that person already voted | | | address delegate; // person delegated to | | | uint vote; // index of the voted proposal | | | } | | | // This is a type for a single proposal. | | | struct Proposal { | | | // If you can limit the length to a certain number of bytes, | | | // always use one of bytes1 to bytes32 because they are much cheaper | | | bytes32 name; // short name up to 32 bytes | | | uint voteCount; // number of accumulated votes | | | } | | | address public chairperson; | | | // This declares a state variable that | | | // stores a 'Voter' struct for each possible address. | | | mapping address = Voter public voters; | | | // A dynamically-sized array of 'Proposal' structs. | | | Proposal public proposals; | | | / | | | @dev Create a new ballot to choose one of 'proposalNames'. | | | @param proposalNames names of proposals | | | / | | | constructor bytes32 memory proposalNames { | | | chairperson = msg.sender; | | | voters chairperson .weight = 1; | | | // For each of the provided proposal names, | | | // create a new proposal object and add it | | | // to the end of the array. | | | for uint i = 0; i < proposalNames.length; i++ { | | | // 'Proposal {...} ' creates a temporary | | | // Proposal object and 'proposals.push ... ' | | | // appends it to the end of 'proposals'. | | | proposals.push Proposal { | | | name: proposalNames i , | | | voteCount: 0 | | | } ; | | | } | | | } | | | / | | | @dev Give 'voter' the right to vote on this ballot. May only be called by 'chairperson'. | | | @param voter address of voter | | | / | | | function giveRightToVote address voter external { | | | // If the first argument of require evaluates | | | // to 'false', execution terminates and all | | | // changes to the state and to Ether balances | | | // are reverted. | | | // This used to consume all gas in old EVM versions, but | | | // not anymore. | | | // It is often a good idea to use 'require' to check if | | | // functions are called correctly. | | | // As a second argument, you can also provide an | | | // explanation about what went wrong. | | | require | | | msg.sender == chairperson, | | | "Only chairperson can give right to vote." | | | ; | | | require | | | voters voter .voted, | | | "The voter already voted." | | | ; | | | require voters voter .weight == 0, "Voter already has the right to vote." ; | | | voters voter .weight = 1; | | | } | | | / | | | @dev Delegate your vote to the voter 'to'. | | | @param to address to which vote is delegated | | | / | | | function delegate address to external { | | | // assigns reference | | | Voter storage sender = voters msg.sender ; | | | require sender.weight = 0, "You have no right to vote" ; | | | require sender.voted, "You already voted." ; | | | require to = msg.sender, "Self-delegation is disallowed." ; | | | // Forward the delegation as long as | | | // 'to' also delegated. | | | // In general, such loops are very dangerous, | | | // because if they run too long, they might | | | // need more gas than is available in a block. | | | // In this case, the delegation will not be executed, | | | // but in other situations, such loops might | | | // cause a contract to get "stuck" completely. | | | while voters to .delegate = address 0 { | | | to = voters to .delegate; | | | // We found a loop in the delegation, not allowed. | | | require to = msg.sender, "Found loop in delegation." ; | | | } | | | Voter storage delegate = voters to ; | | | // Voters cannot delegate to accounts that cannot vote. | | | require delegate .weight = 1 ; | | | // Since 'sender' is a reference, this | | | // modifies 'voters msg.sender '. | | | sender.voted = true; | | | sender.delegate = to; | | | if delegate .voted { | | | // If the delegate already voted, | | | // directly add to the number of votes | | | proposals delegate .vote .voteCount += sender.weight; | | | } else { | | | // If the delegate did not vote yet, | | | // add to her weight. | | | delegate .weight += sender.weight; | | | } | | | } | | | / | | | @dev Give your vote including votes delegated to you to proposal 'proposals proposal .name'. | | | @param proposal index of proposal in the proposals array | | | / | | | function vote uint proposal external { | | | Voter storage sender = voters msg.sender ; | | | require sender.weight = 0, "Has no right to vote" ; | | | require sender.voted, "Already voted." ; | | | sender.voted = true; | | | sender.vote = proposal; | | | // If 'proposal' is out of the range of the array, | | | // this will throw automatically and revert all | | | // changes. | | | proposals proposal .voteCount += sender.weight; | | | } | | | / | | | @dev Computes the winning proposal taking all previous votes into account. | | | @return winningProposal index of winning proposal in the proposals array | | | / | | | function winningProposal public view | | | returns uint winningProposal | | | { | | | uint winningVoteCount = 0; | | | for uint p = 0; p < proposals.length; p++ { | | | if proposals p .voteCount winningVoteCount { | | | winningVoteCount = proposals p .voteCount; | | | winningProposal = p; | | | } | | | } | | | } | | | / | | | @dev Calls winningProposal function to get the index of the winner contained in the proposals array and then | | | @return winnerName the name of the winner | | | / | | | function winnerName external view | | | returns bytes32 winnerName | | | { | | | winnerName = proposals winningProposal .name; | | | } | | | } | This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters https://github.co/hiddenchars | { | | | "mcp": { | | | "version": "1.0.0", | | | "security": { | | | "allowedFileTypes": | | | "sol", | | | "js", | | | "ts", | | | "json", | | | "md", | | | "txt", | | | "toml", | | | "yaml", | | | "yml", | | | "sql", | | | "jsx", | | | "tsx", | | | "abi" | | | , | | | "blockedPaths": | | | ".env", | | | ".git", | | | "node modules", | | | ".ssh", | | | "private", | | | "secret" | | | , | | | "allowedPaths": , | | | "maxExecutionTime": 30000, | | | "excludeTools": , | | | "permissions": { | | | "requirePermissions": true, | | | "defaultPermissions": | | | " " | | | | | | }, | | | "rateLimit": { | | | "enabled": true, | | | "requestsPerMinute": 100, | | | "burstAllowance": 4 | | | }, | | | "fileWritePermissions": { | | | "mode": "ask", | | | "allowedFiles": | | | } | | | }, | | | "validation": { | | | "validateSchemas": true, | | | "validateTypes": true, | | | "validateRanges": true, | | | "validateFormats": true, | | | "strictMode": false, | | | "toolValidation": {}, | | | "fileOperations": { | | | "maxFileSize": 10485760, | | | "allowedExtensions": | | | "sol", | | | "js", | | | "ts", | | | "json", | | | "md", | | | "txt", | | | "toml", | | | "yaml", | | | "yml", | | | "sql", | | | "jsx", | | | "tsx", | | | "abi" | | | , | | | "blockedPatterns": | | | " /node modules/ ", | | | " /.git/ " | | | | | | }, | | | "networkOperations": { | | | "allowedNetworks": | | | "sepolia", | | | "goerli", | | | "localhost", | | | "vm", | | | "mainnet" | | | , | | | "warnOnMainnet": true, | | | "maxGasLimit": 15000000 | | | } | | | }, | | | "resources": { | | | "enableCache": true, | | | "cacheTTL": 300000, | | | "excludeResources": , | | | "allowResources": , | | | "accessPatterns": { | | | "allowedPatterns": , | | | "blockedPatterns": | | | } | | | }, | | | "features": { | | | "compilation": true, | | | "deployment": true, | | | "debugging": true, | | | "analysis": true, | | | "testing": true, | | | "git": true | | | }, | | | "logging": { | | | "level": "info", | | | "console": true | | | } | | | } | | | } | This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters https://github.co/hiddenchars | { | | | "project": "remixDefault", | | | "version": "2.2.0", | | | "IDE": "remix.ethereum.org" | | | } | This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters https://github.co/hiddenchars | // This script can be used to deploy the "Storage" contract using ethers.js library. | | | // Please make sure to compile "./contracts/1 Storage.sol" file before running this script. | | | // And use Right click - "Run" from context menu of the file to run the script. Shortcut: Ctrl+Shift+S | | | import { deploy } from './ethers-lib' | | | async = { | | | try { | | | const result = await deploy 'Storage', | | | console.log address: ${result.address} | | | } catch e { | | | console.log e.message | | | } | | | } | This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters https://github.co/hiddenchars | import { ethers } from 'ethers' | | | / | | | Deploy the given contract | | | @param {string} contractName name of the contract to deploy | | | @param {Array<any } args list of constructor' parameters | | | @param {Number} accountIndex account index from the exposed account | | | @return {Contract} deployed contract | | | / | | | export const deploy = async contractName: string, args: Array<any , accountIndex?: number : Promise<ethers.Contract = { | | | console.log deploying ${contractName} | | | // Note that the script needs the ABI which is generated from the compilation artifact. | | | // Make sure contract is compiled and artifacts are generated | | | const artifactsPath = browser/artifacts/${contractName}.json // Change this for different path | | | const metadata = JSON.parse await remix.call 'fileManager', 'getFile', artifactsPath | | | // 'web3Provider' is a remix global variable object | | | const signer = new ethers.providers.Web3Provider web3Provider .getSigner accountIndex | | | const factory = new ethers.ContractFactory metadata.abi, metadata.data.bytecode.object, signer | | | const contract = await factory.deploy ...args | | | // The contract is NOT deployed yet; we must wait until it is mined | | | await contract.deployed | | | return contract | | | } | This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters https://github.co/hiddenchars | // SPDX-License-Identifier: GPL-3.0 | | | pragma solidity =0.7.0 <0.9.0; | | | import "remix tests.sol"; // this import is automatically injected by Remix. | | | import "hardhat/console.sol"; | | | import "../contracts/3 Ballot.sol"; | | | contract BallotTest { | | | bytes32 proposalNames; | | | Ballot ballotToTest; | | | function beforeAll public { | | | proposalNames.push bytes32 "candidate1" ; | | | ballotToTest = new Ballot proposalNames ; | | | } | | | function checkWinningProposal public { | | | console.log "Running checkWinningProposal" ; | | | ballotToTest.vote 0 ; | | | Assert.equal ballotToTest.winningProposal , uint 0 , "proposal at index 0 should be the winning proposal" ; | | | Assert.equal ballotToTest.winnerName , bytes32 "candidate1" , "candidate1 should be the winner name" ; | | | } | | | function checkWinninProposalWithReturnValue public view returns bool { | | | return ballotToTest.winningProposal == 0; | | | } | | | } | This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters https://github.co/hiddenchars | / eslint-disable no-undef / | | | // Right click on the script name and hit "Run" to execute | | | const { expect } = require "chai" ; | | | const { ethers } = require "hardhat" ; | | | describe "Storage", function { | | | it "test initial value", async function { | | | const Storage = await ethers.getContractFactory "Storage" ; | | | const storage = await Storage.deploy ; | | | await storage.deployed ; | | | console.log "storage deployed at:" + storage.address ; | | | expect await storage.retrieve .toNumber .to.equal 0 ; | | | } ; | | | it "test updating and retrieving updated value", async function { | | | const Storage = await ethers.getContractFactory "Storage" ; | | | const storage = await Storage.deploy ; | | | await storage.deployed ; | | | const storage2 = await ethers.getContractAt "Storage", storage.address ; | | | const setValue = await storage2.store 56 ; | | | await setValue.wait ; | | | expect await storage2.retrieve .toNumber .to.equal 56 ; | | | } ; | | | } ; |