remix-project/libs/remix-lib/README.md

Remix Lib

@remix-project/remix-lib is a common library to various remix tools. It is used in remix-astwalker, remix-analyzer, remix-debug, remix-simulator, remix-solidity, remix-tests libraries and in Remix IDE codebase.

Installation

@remix-project/remix-lib is an NPM package and can be installed using NPM as:

yarn add @remix-project/remix-lib

How to use

@remix-project/remix-lib exports:

{
    EventManager: EventManager,
    helpers: {
      ui: uiHelper,
      compiler: compilerHelper
    },
    Storage: Storage,
    util: util,
    execution: {
      EventsDecoder: EventsDecoder,
      txExecution: txExecution,
      txHelper: txHelper,
      executionContext: new ExecutionContext(),
      txFormat: txFormat,
      txListener: TxListener,
      txRunner: TxRunner,
      typeConversion: typeConversion
    },
    UniversalDApp: UniversalDApp
}

Contribute

Please feel free to open an issue or a pull request.

In case you want to add some code, do have a look at our contribution guidelines here. Reach us on Gitter in case of any queries.

License

MIT © 2018-21 Remix Team