embark-nim-compiler/README.md

embark-nim-compiler

Plugin for Embark to compile Nim contracts

Installation

In your embark dapp directory:

npm install embark-nim-compiler --save or yarn add embark-nim-compiler

then add embark-nim-compiler to the plugins section in embark.json:

{
  "plugins": {
    "embark-nim-compiler": {
      "setupBlockchainOptions": true,
      "useTestnet": false,
      "libHeraPath": "path/to/libHera.so"
    }
  }
}

• setupBlockchainOptions: boolean that when set to true, will change the blockchain config for you. If you set this to false, you need to set the blockchain config yourself so that it supports eWasm
• libHeraPath: string path to the file libHera.so that is used to have Geth use Hera as a VM. Not needed if setupBlockchainOptions is false

Requirements

• Embark 5.0.0 or higher
• A valid eWasm ready node. See https://github.com/ewasm/testnet for more details
• Docker

Troubleshooting

If you get an error related to docker or the image jacqueswww/nimclang, you might need to pull it first manually using:

docker pull jacqueswww/nimclang