remix-project mirror
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
remix-project/libs/remix-lib
Admin d9fbbe0df1 comment added 3 years ago
..
src comment added 3 years ago
test move execution-context 4 years ago
.eslintrc remix-lib linting done 4 years ago
.npmignore moved libs into libs dir 4 years ago
README.md remix lib readme updated 4 years ago
package.json bump version numbers for libs 3 years ago
tsconfig.json Setup tsconfig.base.json 3 years ago
tsconfig.lib.json astwalker test fix 4 years ago

README.md

Remix Lib

npm version npm npm GitHub contributions welcome

@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:

npm install @remix-project/remix-lib

How to use

@remix-project/remix-lib exports:

{
    EventManager: EventManager,
    helpers: {
      ui: uiHelper,
      compiler: compilerHelper
    },
    vm: {
      Web3Providers: Web3Providers,
      DummyProvider: DummyProvider,
      Web3VMProvider: Web3VmProvider
    },
    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 to our contribution guidelnes here. Reach us on Gitter in case of any queries.

License

MIT © 2018-21 Remix Team