yann300
3 years ago
committed by
GitHub
commit
305265060c
@ -1,3 +1,2 @@ |
||||
export { default as remixDefault } from './remixDefault' |
||||
export { default as erc20 } from './erc20' |
||||
export { default as blank } from './blank' |
||||
|
||||
@ -1,406 +0,0 @@ |
||||
'use strict' |
||||
|
||||
const storage = `// SPDX-License-Identifier: GPL-3.0
|
||||
|
||||
pragma solidity >=0.7.0 <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; |
||||
} |
||||
}` |
||||
|
||||
const owner = `// 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 { |
||||
emit OwnerSet(owner, newOwner); |
||||
owner = newOwner; |
||||
} |
||||
|
||||
/** |
||||
* @dev Return owner address
|
||||
* @return address of owner |
||||
*/ |
||||
function getOwner() external view returns (address) { |
||||
return owner; |
||||
} |
||||
}` |
||||
|
||||
const ballot = `// 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 { |
||||
|
||||
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
|
||||
} |
||||
|
||||
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; |
||||
|
||||
mapping(address => Voter) public voters; |
||||
|
||||
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 (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) public { |
||||
require( |
||||
msg.sender == chairperson, |
||||
"Only chairperson can give right to vote." |
||||
); |
||||
require( |
||||
!voters[voter].voted, |
||||
"The voter already voted." |
||||
); |
||||
require(voters[voter].weight == 0); |
||||
voters[voter].weight = 1; |
||||
} |
||||
|
||||
/** |
||||
* @dev Delegate your vote to the voter 'to'. |
||||
* @param to address to which vote is delegated |
||||
*/ |
||||
function delegate(address to) public { |
||||
Voter storage sender = voters[msg.sender]; |
||||
require(!sender.voted, "You already voted."); |
||||
require(to != msg.sender, "Self-delegation is disallowed."); |
||||
|
||||
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."); |
||||
} |
||||
sender.voted = true; |
||||
sender.delegate = to; |
||||
Voter storage delegate_ = voters[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) public { |
||||
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() public view |
||||
returns (bytes32 winnerName_) |
||||
{ |
||||
winnerName_ = proposals[winningProposal()].name; |
||||
} |
||||
} |
||||
` |
||||
|
||||
const ballotTest = `// 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; |
||||
} |
||||
} |
||||
` |
||||
|
||||
/* eslint-disable no-useless-escape */ |
||||
const deployWithWeb3 = ` |
||||
// This script can be used to deploy the "Storage" contract using Web3 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 './web3.ts' |
||||
|
||||
(async () => { |
||||
try { |
||||
const result = await deploy('Storage', []) |
||||
console.log(\`address: \${result.address\}\`)
|
||||
} catch (e) { |
||||
console.log(e.message) |
||||
} |
||||
})()` |
||||
|
||||
const deployWithEthers = ` |
||||
// 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.ts' |
||||
|
||||
(async () => { |
||||
try { |
||||
const result = await deploy('Storage', []) |
||||
console.log(\`address: \${result.address\}\`)
|
||||
} catch (e) { |
||||
console.log(e.message) |
||||
} |
||||
})()` |
||||
|
||||
const libWeb3 = ` |
||||
export const deploy = async (contractName: string, arguments: Array<any>, from?: string, gas?: number) => { |
||||
|
||||
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/contracts/artifacts/\${contractName\}.json\` // Change this for different path
|
||||
|
||||
const metadata = JSON.parse(await remix.call('fileManager', 'getFile', artifactsPath)) |
||||
|
||||
const accounts = await web3.eth.getAccounts() |
||||
|
||||
let contract = new web3.eth.Contract(metadata.abi) |
||||
|
||||
contract = contract.deploy({ |
||||
data: metadata.data.bytecode.object, |
||||
arguments |
||||
}) |
||||
|
||||
const newContractInstance = await contract.send({ |
||||
from: from || accounts[0], |
||||
gas: gas || 1500000 |
||||
}) |
||||
return newContractInstance.options
|
||||
}: Promise<any>` |
||||
|
||||
const libEthers = ` |
||||
export const deploy = async (contractName: string, arguments: Array<any>, from?: string) => {
|
||||
|
||||
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/contracts/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() |
||||
|
||||
let factory = new ethers.ContractFactory(metadata.abi, metadata.data.bytecode.object, signer); |
||||
|
||||
let contract |
||||
if (from) { |
||||
contract = await factory.connect(from).deploy(...arguments); |
||||
} else { |
||||
contract = await factory.deploy(...arguments); |
||||
}
|
||||
|
||||
// The contract is NOT deployed yet; we must wait until it is mined
|
||||
await contract.deployed() |
||||
return contract |
||||
}: Promise<any>` |
||||
/* eslint-enable no-useless-escape */ |
||||
|
||||
const storageTestJs = `// 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); |
||||
}); |
||||
});` |
||||
|
||||
const readme = `REMIX DEFAULT WORKSPACE
|
||||
|
||||
Remix default workspace is present when: |
||||
i. Remix loads for the very first time
|
||||
ii. A new workspace is created |
||||
iii. There are no files existing in the File Explorer |
||||
|
||||
This workspace contains 3 directories: |
||||
|
||||
1. 'contracts': Holds three contracts with different complexity level, denoted with number prefix in file name. |
||||
2. 'scripts': Holds two scripts 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 contains two example async/await scripts for deploying the 'Storage' contract. |
||||
For the deployment of any other contract, 'contractName' and 'constructorArgs' should be updated (along with other code if required).
|
||||
|
||||
Also, there is a script containing some unit tests for Storage contract inside tests directory. |
||||
|
||||
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' statement is supported in a limited manner for Remix supported modules.
|
||||
For now, modules supported by Remix are ethers, web3, swarmgw, chai, 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.' |
||||
` |
||||
|
||||
export default { |
||||
storage: { name: 'contracts/1_Storage.sol', content: storage }, |
||||
owner: { name: 'contracts/2_Owner.sol', content: owner }, |
||||
ballot: { name: 'contracts/3_Ballot.sol', content: ballot }, |
||||
storageTestJs: { name: 'tests/storage.test.js', content: storageTestJs }, |
||||
ballot_test: { name: 'tests/Ballot_test.sol', content: ballotTest }, |
||||
deployWithWeb3: { name: 'scripts/deploy_with_web3.ts', content: deployWithWeb3 }, |
||||
deployWithEthers: { name: 'scripts/deploy_with_ethers.ts', content: deployWithEthers }, |
||||
web3: { name: 'scripts/web3.ts', content: libWeb3 }, |
||||
ethers: { name: 'scripts/ethers.ts', content: libEthers }, |
||||
readme: { name: 'README.txt', content: readme } |
||||
} |
||||
@ -0,0 +1,12 @@ |
||||
{ |
||||
"extends": "../../.eslintrc", |
||||
"rules": { |
||||
}, |
||||
"env": { |
||||
"browser": true, |
||||
"amd": true, |
||||
"node": true, |
||||
"es6": true |
||||
}, |
||||
"ignorePatterns": ["!**/*"] |
||||
} |
||||
@ -0,0 +1,20 @@ |
||||
## remix-ws-templates |
||||
[](https://www.npmjs.com/package/@remix-project/remix-ws-templates) |
||||
|
||||
|
||||
`@remix-project/remix-ws-templates` is used to create a workspace using different templates on Remix IDE. |
||||
|
||||
### Installation |
||||
|
||||
`@remix-project/remix-ws-templates` is an NPM package and can be installed using NPM as: |
||||
|
||||
`npm install @remix-project/remix-ws-templates` |
||||
|
||||
### Contribute |
||||
|
||||
Please feel free to open an issue or a pull request. |
||||
|
||||
In case you want to add some code, do have a look to our contribution guidelnes [here](https://github.com/ethereum/remix-project/blob/master/CONTRIBUTING.md). Reach us on [Gitter](https://gitter.im/ethereum/remix) in case of any queries. |
||||
|
||||
### License |
||||
MIT © 2022 Remix Team |
||||
@ -0,0 +1,23 @@ |
||||
{ |
||||
"name": "@remix-project/remix-ws-templates", |
||||
"version": "1.0.0", |
||||
"description": "Create a Remix IDE workspace using different templates", |
||||
"main": "src/index.js", |
||||
"types": "src/index.d.ts", |
||||
"scripts": { |
||||
"test": "echo \"Error: no test specified\" && exit 1" |
||||
}, |
||||
"publishConfig": { |
||||
"access": "public" |
||||
}, |
||||
"repository": { |
||||
"type": "git", |
||||
"url": "git+https://github.com/ethereum/remix-project.git" |
||||
}, |
||||
"author": "Aniket-Engg", |
||||
"license": "MIT", |
||||
"bugs": { |
||||
"url": "https://github.com/ethereum/remix-project/issues" |
||||
}, |
||||
"homepage": "https://github.com/ethereum/remix-project/tree/master/libs/remix-ws-templates#readme" |
||||
} |
||||
@ -0,0 +1,3 @@ |
||||
export { default as remixDefault } from './templates/remixDefault' |
||||
export { default as erc20 } from './templates/erc20' |
||||
export { default as blank } from './templates/blank' |
||||
@ -0,0 +1 @@ |
||||
export default async () => { return {}} |
||||
@ -0,0 +1,15 @@ |
||||
// SPDX-License-Identifier: GPL-3.0 |
||||
|
||||
pragma solidity >=0.7.0 <0.9.0; |
||||
|
||||
/** |
||||
* @title SampleERC20 |
||||
* @dev Create a sample ERC20 standard token |
||||
*/ |
||||
|
||||
import "@openzeppelin/contracts/token/ERC20/ERC20.sol"; |
||||
|
||||
contract SampleERC20 is ERC20 { |
||||
|
||||
constructor(string memory tokenName, string memory tokenSymbol) ERC20(tokenName, tokenSymbol) {} |
||||
} |
||||
@ -0,0 +1,16 @@ |
||||
export default async () => { |
||||
return { |
||||
// @ts-ignore
|
||||
'contracts/SampleERC20.sol': (await import('raw-loader!./contracts/SampleERC20.sol')).default, |
||||
// @ts-ignore
|
||||
'scripts/deploy_with_ethers.ts': (await import('!!raw-loader!./scripts/deploy_with_ethers.ts')).default, |
||||
// @ts-ignore
|
||||
'scripts/deploy_with_web3.ts': (await import('!!raw-loader!./scripts/deploy_with_web3.ts')).default, |
||||
// @ts-ignore
|
||||
'scripts/ethers.ts': (await import('!!raw-loader!./scripts/ethers.ts')).default, |
||||
// @ts-ignore
|
||||
'scripts/web3.ts': (await import('!!raw-loader!./scripts/web3.ts')).default, |
||||
// @ts-ignore
|
||||
'tests/SampleERC20_test.sol': (await import('raw-loader!./tests/SampleERC20_test.sol')).default |
||||
} |
||||
} |
||||
@ -0,0 +1,10 @@ |
||||
import { deploy } from './ethers' |
||||
|
||||
(async () => { |
||||
try { |
||||
const result = await deploy('SampleERC20', ['testToken', 'TST']) |
||||
console.log(`address: ${result.address}`) |
||||
} catch (e) { |
||||
console.log(e.message) |
||||
} |
||||
})() |
||||
@ -0,0 +1,10 @@ |
||||
import { deploy } from './web3' |
||||
|
||||
(async () => { |
||||
try { |
||||
const result = await deploy('SampleERC20', ['testToken', 'TST']) |
||||
console.log(`address: ${result.address}`) |
||||
} catch (e) { |
||||
console.log(e.message) |
||||
} |
||||
})() |
||||
@ -0,0 +1,27 @@ |
||||
|
||||
|
||||
|
||||
export const deploy = async (contractName: string, args: Array<any>, from?: string): Promise<any> => {
|
||||
|
||||
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/contracts/artifacts/${contractName}.json` |
||||
|
||||
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() |
||||
|
||||
const factory = new ethers.ContractFactory(metadata.abi, metadata.data.bytecode.object, signer); |
||||
|
||||
let contract |
||||
if (from) { |
||||
contract = await factory.connect(from).deploy(...args); |
||||
} else { |
||||
contract = await factory.deploy(...args); |
||||
}
|
||||
|
||||
// The contract is NOT deployed yet; we must wait until it is mined
|
||||
await contract.deployed() |
||||
return contract |
||||
} |
||||
@ -0,0 +1,24 @@ |
||||
export const deploy = async (contractName: string, args: Array<any>, from?: string, gas?: number): Promise<any> => { |
||||
|
||||
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/contracts/artifacts/${contractName}.json` |
||||
|
||||
const metadata = JSON.parse(await remix.call('fileManager', 'getFile', artifactsPath)) |
||||
|
||||
const accounts = await web3.eth.getAccounts() |
||||
|
||||
let contract = new web3.eth.Contract(metadata.abi) |
||||
|
||||
contract = contract.deploy({ |
||||
data: metadata.data.bytecode.object, |
||||
arguments: args |
||||
}) |
||||
|
||||
const newContractInstance = await contract.send({ |
||||
from: from || accounts[0], |
||||
gas: gas || 1500000 |
||||
}) |
||||
return newContractInstance.options
|
||||
} |
||||
@ -0,0 +1,18 @@ |
||||
// SPDX-License-Identifier: GPL-3.0 |
||||
|
||||
pragma solidity >=0.7.0 <0.9.0; |
||||
import "remix_tests.sol"; |
||||
import "../contracts/SampleERC20.sol"; |
||||
|
||||
contract SampleERC20Test { |
||||
|
||||
SampleERC20 s; |
||||
function beforeAll () public { |
||||
s = new SampleERC20("TestToken", "TST"); |
||||
} |
||||
|
||||
function testTokenNameAndSymbol () public { |
||||
Assert.equal(s.name(), "TestToken", "token name did not match"); |
||||
Assert.equal(s.symbol(), "TST", "token symbol did not match"); |
||||
} |
||||
} |
||||
@ -0,0 +1,26 @@ |
||||
REMIX DEFAULT WORKSPACE |
||||
|
||||
Remix default workspace is present when: |
||||
i. Remix loads for the very first time |
||||
ii. A new workspace is created |
||||
iii. There are no files existing in the File Explorer |
||||
|
||||
This workspace contains 3 directories: |
||||
|
||||
1. 'contracts': Holds three contracts with different complexity level, denoted with number prefix in file name. |
||||
2. 'scripts': Holds two scripts 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 contains two example async/await scripts for deploying the 'Storage' contract. |
||||
For the deployment of any other contract, 'contractName' and 'constructorArgs' should be updated (along with other code if required). |
||||
|
||||
Also, there is a script containing some unit tests for Storage contract inside tests directory. |
||||
|
||||
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' statement is supported in a limited manner for Remix supported modules. |
||||
For now, modules supported by Remix are ethers, web3, swarmgw, chai, 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.' |
||||
@ -0,0 +1,29 @@ |
||||
// SPDX-License-Identifier: GPL-3.0 |
||||
|
||||
pragma solidity >=0.7.0 <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; |
||||
} |
||||
} |
||||
@ -0,0 +1,54 @@ |
||||
// 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 { |
||||
emit OwnerSet(owner, newOwner); |
||||
owner = newOwner; |
||||
} |
||||
|
||||
/** |
||||
* @dev Return owner address |
||||
* @return address of owner |
||||
*/ |
||||
function getOwner() external view returns (address) { |
||||
return owner; |
||||
} |
||||
} |
||||
@ -0,0 +1,138 @@ |
||||
// 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 { |
||||
|
||||
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 |
||||
} |
||||
|
||||
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; |
||||
|
||||
mapping(address => Voter) public voters; |
||||
|
||||
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 (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) public { |
||||
require( |
||||
msg.sender == chairperson, |
||||
"Only chairperson can give right to vote." |
||||
); |
||||
require( |
||||
!voters[voter].voted, |
||||
"The voter already voted." |
||||
); |
||||
require(voters[voter].weight == 0); |
||||
voters[voter].weight = 1; |
||||
} |
||||
|
||||
/** |
||||
* @dev Delegate your vote to the voter 'to'. |
||||
* @param to address to which vote is delegated |
||||
*/ |
||||
function delegate(address to) public { |
||||
Voter storage sender = voters[msg.sender]; |
||||
require(!sender.voted, "You already voted."); |
||||
require(to != msg.sender, "Self-delegation is disallowed."); |
||||
|
||||
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."); |
||||
} |
||||
sender.voted = true; |
||||
sender.delegate = to; |
||||
Voter storage delegate_ = voters[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) public { |
||||
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() public view |
||||
returns (bytes32 winnerName_) |
||||
{ |
||||
winnerName_ = proposals[winningProposal()].name; |
||||
} |
||||
} |
||||
@ -0,0 +1,24 @@ |
||||
export default async () => { |
||||
return { |
||||
// @ts-ignore
|
||||
'contracts/1_Storage.sol': (await import('raw-loader!./contracts/1_Storage.sol')).default, |
||||
// @ts-ignore
|
||||
'contracts/2_Owner.sol': (await import('raw-loader!./contracts/2_Owner.sol')).default, |
||||
// @ts-ignore
|
||||
'contracts/3_Ballot.sol': (await import('raw-loader!./contracts/3_Ballot.sol')).default, |
||||
// @ts-ignore
|
||||
'scripts/deploy_with_ethers.ts': (await import('!!raw-loader!./scripts/deploy_with_ethers.ts')).default, |
||||
// @ts-ignore
|
||||
'scripts/deploy_with_web3.ts': (await import('!!raw-loader!./scripts/deploy_with_web3.ts')).default, |
||||
// @ts-ignore
|
||||
'scripts/ethers.ts': (await import('!!raw-loader!./scripts/ethers.ts')).default, |
||||
// @ts-ignore
|
||||
'scripts/web3.ts': (await import('!!raw-loader!./scripts/web3.ts')).default, |
||||
// @ts-ignore
|
||||
'tests/Ballot_test.sol': (await import('raw-loader!./tests/Ballot_test.sol')).default, |
||||
// @ts-ignore
|
||||
'tests/storage.test.js': (await import('!!raw-loader!./tests/storage.test.js')).default, |
||||
// @ts-ignore
|
||||
'README.txt': (await import('raw-loader!./README.txt')).default, |
||||
} |
||||
} |
||||
@ -0,0 +1,14 @@ |
||||
// 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' |
||||
|
||||
(async () => { |
||||
try { |
||||
const result = await deploy('Storage', []) |
||||
console.log(`address: ${result.address}`) |
||||
} catch (e) { |
||||
console.log(e.message) |
||||
} |
||||
})() |
||||
@ -0,0 +1,14 @@ |
||||
// This script can be used to deploy the "Storage" contract using Web3 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 './web3' |
||||
|
||||
(async () => { |
||||
try { |
||||
const result = await deploy('Storage', []) |
||||
console.log(`address: ${result.address}`) |
||||
} catch (e) { |
||||
console.log(e.message) |
||||
} |
||||
})() |
||||
@ -0,0 +1,24 @@ |
||||
export const deploy = async (contractName: string, args: Array<any>, from?: string): Promise<any> => {
|
||||
|
||||
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/contracts/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() |
||||
|
||||
const factory = new ethers.ContractFactory(metadata.abi, metadata.data.bytecode.object, signer); |
||||
|
||||
let contract |
||||
if (from) { |
||||
contract = await factory.connect(from).deploy(...args); |
||||
} else { |
||||
contract = await factory.deploy(...args); |
||||
}
|
||||
|
||||
// The contract is NOT deployed yet; we must wait until it is mined
|
||||
await contract.deployed() |
||||
return contract |
||||
} |
||||
@ -0,0 +1,24 @@ |
||||
export const deploy = async (contractName: string, args: Array<any>, from?: string, gas?: number): Promise<any> => { |
||||
|
||||
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/contracts/artifacts/${contractName}.json` // Change this for different path
|
||||
|
||||
const metadata = JSON.parse(await remix.call('fileManager', 'getFile', artifactsPath)) |
||||
|
||||
const accounts = await web3.eth.getAccounts() |
||||
|
||||
let contract = new web3.eth.Contract(metadata.abi) |
||||
|
||||
contract = contract.deploy({ |
||||
data: metadata.data.bytecode.object, |
||||
arguments: args |
||||
}) |
||||
|
||||
const newContractInstance = await contract.send({ |
||||
from: from || accounts[0], |
||||
gas: gas || 1500000 |
||||
}) |
||||
return newContractInstance.options
|
||||
} |
||||
@ -0,0 +1,28 @@ |
||||
// 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; |
||||
} |
||||
} |
||||
@ -0,0 +1,22 @@ |
||||
// 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); |
||||
}); |
||||
}); |
||||
@ -0,0 +1,7 @@ |
||||
{ |
||||
"extends": "../../tsconfig.base.json", |
||||
"compilerOptions": { |
||||
"types": ["node"], |
||||
}, |
||||
"include": ["**/*.ts"] |
||||
} |
||||
@ -0,0 +1,14 @@ |
||||
{ |
||||
"extends": "./tsconfig.json", |
||||
"compilerOptions": { |
||||
"module": "commonjs", |
||||
"declaration": true, |
||||
"rootDir": "./src", |
||||
"types": ["node"] |
||||
}, |
||||
"exclude": [ |
||||
"**/*.spec.ts", |
||||
"tests/" |
||||
], |
||||
"include": ["**/index.ts"] |
||||
} |
||||
@ -0,0 +1,4 @@ |
||||
declare const remix:any |
||||
declare const ethers:any |
||||
declare const web3:any |
||||
declare const web3Provider:any |
||||
Loading…
Reference in new issue