Migration from v1.2 to v2.0

Breaking Changes
TLDR:
In your project run:
npm i etherlime-lib
Wherever you have require('etherlime') you now need to change to require('etherlime-lib'). You can safely uninstall your project version of etherlime npm uninstall etherlime.
Note: Do reinstall the global CLI version of etherlime: npm uninstall -g etherlime, npm install -g etherlime
Installing v2.0
Installing the CLI:
npm i -g etherlime
This command in v2.0 will install only the etherlime CLI - (command line interface) library. You can use all the CLI commands.
Installing the LIB:
npm i etherlime-lib
This command will install only etherlime LIB . You can use LIB to deploy, instantiate or test smart contracts.
Deploying in v1.2
Deploying in v1.2 is as follows:
Example:
    const etherlime = require('etherlime');
​
    // Path to your etherlime compiled contract json file
    const TestContract = require('../build/TestContract.json'); 
​
    const deploy = async (network, secret) => {
​
        const deployer = new etherlime.EtherlimeGanacheDeployer();
​
        // Add params separated with ,
        const result = await deployer.deploy(TestContract, {});
    }
​
    module.exports = { deploy }
Please note that here etherlime is required as etherlime.
Deploying in v2.0
Deploying in v2.0 is as follows using Etherlime LIB.
Example:
    const etherlime = require('etherlime-lib');
​
    // Path to your etherlime compiled contract json file
    const TestContract = require('../build/TestContract.json'); 
​
    const deploy = async (network, secret) => {
​
        const deployer = new etherlime.EtherlimeGanacheDeployer();
​
        // Add params separated with ,
        const result = await deployer.deploy(TestContract, {});
    }
​
    module.exports = { deploy }
Please note that here etherlime is required as etherlime-lib.
Testing Smart Contracts v1.2
    const etherlime = require('etherlime');
    const Billboard = require('../build/Billboard.json');
​
    describe('Example', () => {
        let owner = accounts[3];
        let deployer;
​
        beforeEach(async () => {
            deployer = new etherlime.EtherlimeGanacheDeployer(owner.secretKey);
        });
​
        it('should set correct owner', async () => {
            const BillboardContract = await deployer.deploy(Billboard, {});
            let _owner = await BillboardContract.owner();
​
            assert.strictEqual(_owner, owner.signer.address,
              'Initial contract owner does not match');
        });
    });
Please note that here etherlime is required as etherlime.
Testing Smart Contracts v2.0
    const etherlime = require('etherlime-lib');
    const Billboard = require('../build/Billboard.json');
​
    describe('Example', () => {
        let owner = accounts[3];
        let deployer;
​
        beforeEach(async () => {
            deployer = new etherlime.EtherlimeGanacheDeployer(owner.secretKey);
        });
​
        it('should set correct owner', async () => {
            const BillboardContract = await deployer.deploy(Billboard, {});
            let _owner = await BillboardContract.owner();
​
            assert.strictEqual(_owner, owner.signer.address,
              'Initial contract owner does not match');
        });
    });
Please note that here etherlime is required as etherlime-lib.
Developer Documentation - Previous
Migration from Truffle to Etherlime
Next - Developer Documentation
License
Last updated 1 year ago