Skip to main content

@taqueria/plugin-smartpy

The SmartPy plugin provides a task to compile SmartPy smart contracts to Michelson

Requirements

The SmartPy plugin requires:

  • SmartPy v0.8.4 or later to be installed locally
  • Node.js v16.3 or later

SmartPy is available here

Installation

To install the SmartPy plugin on a Taqueria project, navigate to the project folder and run:

taq install @taqueria/plugin-smartpy

Usage

The SmartPy plugin's taq compile task can be run with or without arguments. The basic syntax for the command is:

taq compile <file-name>

Running the compile task with no options will result in any source SmartPy smart contracts in the contracts folder being compiled to Michelson files in the artifacts folder. If you speficy an optional filename, only SmartPy contracts matching the specified filename in the contracts folder will be compiled

note

The compile task can be implemented by more than one compiler plugin installed on a project (SmartPy, SmartPY). If this is the case, you must use the --plugin flag to specify a particular compiler

Plugin Architecture

This plugin is developed for Taqueria built using TypeScript for NodeJS using the Taqueria Node SDK

The plugin provides a compile task used for compiling SmartPy smart contracts to Michelson

attributevalue
task'compile'
command'compile [sourceFile]
aliases['c', 'compile-smartpy']