aeproject icon indicating copy to clipboard operation
aeproject copied to clipboard

Testing framework for Sophia Smart Contract development.

AEproject

npm version

AEproject is an æternity framework which helps with setting up a project to develop and test Sophia Smart Contracts. It provides commands to spin up a local environment as well as utilities for compiling and testing Sophia Smart Contracts. The initial scaffold provides an example contract & corresponding tests.

Install

npm install -g @aeternity/aeproject

Documentation

  • Quick Start
  • Project Initialization
  • Local Environment
  • Unit Testing
  • AEproject Library
  • Migration from 3.x.x to 4.x.x
  • Upcoming Version Support

Release Process

  1. merge the release please PR
    • as @aeternity/aeproject has a dependency on itself as library, the CI run before publishing to npm after merging might fail
  2. build locally and publish
    • checkout latest origin/main including the merged release please PR, ensure no local changes
    • publish to npm using npm publish (does automatically clean-build, may require login if not already)