uforia README

Welcome

Features

Compiles Solidity files to TypeScript.

Use CTRL + SHIFT + P -> Uforia - Start to launch the compiler filewatcher.

Use CTRL + SHIFT + P -> Uforia - Stop to stop the compiler filewatcher.

Typescript

Compiler options

Please add the following compiler options to your root tsconfig.json. This will resolve the import of Uforeum.

{
  "compilerOptions": {
    ...
    "baseUrl": "./",
    "paths": {
      "*": ["typings/*", "*"]
    },
    ...
  }
}

Web3.js

To install web3.js library you have two options:

run npm install web3 or add the following to your package.json and run npm install

{
  ...
  "dependencies": {
    "web3": "github:ethereum/web3.js"
  }
  ...
}

Requirements

You have to have an active internet connection, as the compiler is hosted in Azure.

Known Issues

It's alpha. :)

1. It only works on root level. If your .sol file is nested, you will need to adjust the ./Uforeum path in the generated .sol.ts file.