README.md

Remix Libraries

Remix libraries are part of the Remix Project and provide tools that help smart contract development, compilation, testing & deployment. These tools also work as a core of native plugins of Remix IDE.

Remix IDE is an open source web and desktop application. It fosters a fast development cycle and has a rich set of plugins with intuitive GUIs. Remix is used for the entire journey of contract development as well as being a playground for learning and teaching Ethereum.

The Remix IDE repository is specifically available here, and an online version is available at https://remix.ethereum.org.

To start with Remix IDE, check out official documentation.

Here is the brief description of Remix libraries.

• remix-analyzer: Perform static analysis on Solidity smart contracts to check security vulnerabilities and bad development practices
• remix-astwalker: Parse solidity AST (Abstract Syntax Tree)
• remix-debug: Debug Ethereum transactions. It provides several controls that allow stepping over the trace and seeing the current state of a selected step.
• remix-simulator: Web3 wrapper for different kind of providers
• remix-solidity: Load a Solidity compiler from provided URL and compile the contract using loaded compiler and return the compilation details
• remix-lib: Common place for libraries being used across multiple modules
• remix-tests: Unit test Solidity smart contracts. It works as a plugin & as CLI both
• remix-url-resolver: Provide helpers for resolving the content from external URL ( including github, swarm, ipfs etc.).
• remixd: Allow accessing local filesystem from Remix IDE by running a daemon

Each library is an NPM package and has basic documentation about its usage in its own README.

Contributing

Everyone is very welcome to contribute on Remix Project. Suggestions, issues, queries and feedbacks are our pleasure. Please reach us on Gitter in case of any query.

For more information on the contributing in code, see our contribution guidelines.