@tzconnect/ligojs

Ligo.js

A JavaScript/TypeScript wrapper for Ligo

WARNING: This project is in active development and things might change or break at a short notice.

Prerequisite

• For Windows or Mac please install DOCKER before installing this.
• For Windows enable support for Linux containers

Install

npm i @tzconnect/ligojs

or

yarn add @tzconnect/ligojs

Available Scripts

• build to build the package in dist folder.
• test to run the tests
• lint to run the linter
• size-limit to see the size of the package
• analyze to show the deps and source size in browser
• prepare npm prepare hook that executes build
• postinstall npm post install hook to setup necessary env for Ligo to work.

How postinstall works

Checks if the platform is one of 3: win32, darwin or linux.

• If linux then installs the linux binary.
• If win32 or darwin then pulls the latest ligo docker image.

Available Methods

• compile-contract => compileContract
• compile-storage => compileStorage
• compile-parameter => compileParameter
• compile-expression => compileExpression
• dry-run => dryRun
• evaluate-expr
• evaluate-call
• measure-contract