Aeproject can already be used for testing and setup with the upcoming node versions.

Automatic update

Use aeproject init --next to initialize a new project that has the necessary adjustments to use the latest versions.

Use aeproject init --update --next to update an existing project with the adjustments to use the latest versions.

Manual update

• change occurrences of utils.getSdk() to use utils.getSdk({ ignoreVersion: true }) if needed or use the same option for manually initialized sdk Node and CompilerHttp

• update docker-compose.yml to use the latest node and compiler tags or specify it manually in running with aeproject env --nodeVersion latest --compilerVersion latest

The command is responsible for setting up a healthy local environment. The env command helps developers run a local node and a local compiler in dev-mode using docker. To spawn a fully functional environment it can take a couple of minutes depending on your system.

If using Windows, WSL 2 needs to be used for AEproject to work normally, see https://docs.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers

You can stop both the node and the compiler by running

There are optional parameters --nodeVersion and --compilerVersion. To specify a specific version of node or compiler, or both

This also applies to the commands aeproject node and aeproject compiler.

To see whether you have running instances of the nodes along with a compiler you could run the following command

Requirements

In order to have AEproject working you must have installed the following:

Note: on windows WSL 2 must be used

Install

Init a project

This will create the project scaffold with an example contract including tests as well as a sample deployment script inside the specified folder. If no folder is specified the artifacts will be initialized in the current directory.

Further explained in .

Running a local environment

This will run a local æternity network in dev-mode (node, compiler and nginx-proxy).

To stop an already spawned local environment use aeproject env --stop

Further explained in .

Testing

This will run the tests located in ./test folder. Further explained in .

Help

Run this command to give you all possible commands of aeproject with help and info

Version

Running this command will give you the current installed aeproject version

AEproject v5.0.0 underwent some breaking changes.

Install the latest AEproject version

Various Changes

• dropped commonjs support, newly created projects will be created as esm projects, old cjs projects will not continue to work with newer aeproject versions, to keep using old cjs projects,

Installed automatically with each project initialized with aeproject init, otherwise can be installed using npm i @aeternity/aeproject.

Available imports include helper definitions and utils using:

Utils

Read the contract source from given path, just a wrapper for fs.readFileSync using utf-8 encoding.

Changes

AEproject v4.0.0 underwent some bigger changes, is now available as official package of the æternity organization on NPM and is compatible to the recently published node .

Install the new AEproject version

Optionally a folder can be specified for the project to be initialized in, otherwise the current directory is used.

Creates a new project structure with a few folders in which the developer can create contracts and tests, as well as installing needed dependencies.

Update existing project

For upgrade from old AEproject versions check out and .

Updates the project structure and needed artifacts to the latest version, as well as installing needed dependencies.

Run unit tests

The test command helps developers run their unit tests for æternity projects. The command executes the tests scripts that are located in the test folder of your æternity project.

Implement unit tests

In the test/exampleTest.js file you can find an example for unit testing using AEproject.

1. Dependencies

Javascript testing framework used with for assertions, documented at https://www.chaijs.com/api/assert/

Helper and utilities for AEproject use, e.g. prefunded wallets, network definition and utility functions for SDK initialization and snapshotting.

Read for a more detailed explanation about the usage of these imports.

2. SDK and Snapshotting Setup

Provide your initializations in mocha which need to be done once before all tests:

Initialize the default SDK instance with provided utils:

Get the filesystem definition for (custom) includes of the given contract:

Read the contract source from the filesystem:

Initialize the contract instance:

Deploy the contract:

Create a snapshot of the chain state once before all tests. This allows you to rollback to a clean state after each test if needed:

Rollback to the previously created snapshot after each test for a clean state in the following tests:

3. Example Test

Use mocha for test setup and chai for assert. Then implement contract usage using the aeternity sdk as explained in the guide at https://github.com/aeternity/aepp-sdk-js/blob/develop/docs/guides/contracts.md#5-call-contract-entrypoints