@ironblocks/cli

Description

This CLI tool will help you to interact and easily integrate with our ecosystem.

Compatibility

Solidity versions >= 0.8.

Installation

$ npm install @ironblocks/cli -g

Config

Customize default config by adding a .ib.cli.js file at the working directory from which you use the tool.

module.exports = {
    fw: {
        integ: {
            include: [],
            exclude: ['examples', 'more-examples/**/*.sol'],
            overrideDefaults: false
        }
    }
};

options	type	required	description	defaults
fw.integ.include	string[]	false	allow list of solidity contract files and directories to consider when integrating with the firewall	-
fw.integ.exclude	string[]	false	ignore list of solidity contract files and directories to exclude when integrating with the firewall	["**/node_modules/*"]
fw.integ.overrideDefaults	boolean	false	whether to ignore the default firewall integration exclude list	false

Commands

Usage Example

# List available commands
$ ib --help

Firewall Integration

options	type	required	description
-f --file	string	false	path to a solidity file to integrate with the firewall
-d --dir	string	false	path to directory containing solidity files to integrate with the firewall (non recursive)
-r --rec	flag	false	special flag for the "-d" option, indicating whether should visit subdirectories or not
-v --verbose	flag	false	execute the command in "verbose" mode printing additional details along the execution
-i --internal	flag	false	whether to add firewall protection for "internal" functions
-m --modifiers	string	false	set advanced modifiers. options

Advanced Modifiers

• invariantProtected - For applying the subscribed invariant policy.

Usage Example

# Integrating a specific file with the firewall
$ ib fw integ -f /path/to/file.sol

# Integrating all files in a directory
$ ib fw integ -d /path/to/contracts

# Integrating all files in a directory and its subdirectories
$ ib fw integ -d /path/to/contracts -r

# Integrate internal functions as well
$ ib fw integ -d /path/to/contracts -i

# Integrate internal functions and use the "invariantProtected" modifier where possible
$ ib fw integ -d /path/to/contracts -i -m invariantProtected

License

Ironblocks Firewall Contracts are released under the MIT License.