zicky v1.2.1

Zicky

Zicky helps you to track errors on your TDD session over smart contracts developed with Solidity, enhancing the way to find errors and avoiding most of the time, the back and forth with remix tool.

Requirements for compile

• We use this to compile Smart contracts developed under Solc 0.8.9

Some Examples

compileContract - Useful for tests and Deploy

Suppose you have your contract, like Lottery.sol under "contracts" folder then to use it you can do something like this, and reuse it for several contracts:

const {compileContract} = require("zicky");

const compileLottery = () => {
    return compileContract('Lottery.sol', "contracts")
}

module.exports = {
    compileLottery
}

If your sol file has several contracts, you should specify which of them you need from there

If you have a sol file "severalContracts.sol":

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

contract contractOne {
    address public manager;
    constructor (){
        manager = msg.sender;
    }
}

contract contractTwo {
    address public manager;
    constructor (){
        manager = msg.sender;
    }
}

contract contractThree {
    address public manager;
    constructor (){
        manager = msg.sender;
    }
}

And you only need for contractThree, you should:

const {compileContract} = require("zicky");

const compileContractThree = () => {
    return compileContract('severalContracts.sol', "contracts", "contractThree")
}

module.exports = {
    compileContractThree
}

Then in your tests or your compiler, you can use it there too: Under tests:

describe ('Lottery Contract tests', () => {
    let accounts, lottery, contractDeployer, contractCompiled,account;
    beforeEach(async () => {
        // 
        contractCompiled = compileLottery();
       //
       // IMPORTANT: In this point if something is wrong with your contract, 
       // an error raise and you can fix it, without going to Remix to do that! 
       //
       // deployContract and other tests setup.
    })
    ... Your tests! 

If something fail with your contract, the errors will be detected earlier before running any test. You'll see something like this:

-- Your contract has errors! Please read this carefully --
Error: undefinedTypeError: "msg.value" and "callvalue()" can only be used in payable public functions. Make the function "payable" or use an internal function to avoid this error.
  --> Lottery.sol:15:17:
   |
15 |         require(msg.value > .01 ether);
   |                 ^^^^^^^^^



    at getContract (node_modules/zicky/src/compiler.js:44:15)
    at process (node_modules/zicky/src/compiler.js:52:12)
    at compileContract (node_modules/zicky/zicky.js:9:22)
    at Context.<anonymous> (test/Lottery.test.js:41:28)

getAbiForContract

For your This function helps you to get the ABI part of your contract. Web Apps will need the interface which will work together with your Contract and the deployed part into ethereum network

For more examples you can test this example project with a smart contract lottery-solidity:

compileAndPrintContract

Given a contract with one or more contracts insides, zicky will create under <your project>/buildContract folder all contracts as <contractName>.json

Requirements for deploy

With zicky you get easily the contract deployed ready to work with your test

const {getDeployManager} = require("zicky");

describe ('Lottery Contract tests', () => {
    let accounts, lottery, contractDeployer, contractDeployed,  account;
    beforeEach(async () => {
        // 
        contractCompiled = compileLottery();
        contractDeployer = await getDeployManager(contractCompiled)
        // choose one account, you have 10!
        
        account = contractDeployer.accounts[0]
        
        // Account is Mandatory
        // if contract has parameters in constructor you should add an array
        // if you want to add money , please add the third param
        
        contractDeployed = await contractDeployer.deployContract(account)
        
        // now you can go against your contract in your tests!
        // If you need to interact with network like getting balance.
        const web3 = contractDeployer.getNetwork()
    })
    ... Your tests! 

Please take a look this tests to learn about it

Thanks; I'll tell you a secret; My dream's life is driving a Harley!. If you like this code , help me with something, so I can save money for that! You can help me here! Cafecito. Have a Nice Day!!