docs: update compatibility, tests

aeternity · Nov 25, 2024 · abb6e6d · abb6e6d
1 parent 24f94e1
commit abb6e6d
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 13 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -14,8 +14,8 @@ jobs:
         # for lts node also test first known compatible and latest known good compiler and node versions
         include:
           - node-version: 22
-            node-tag: v6.8.0 # v6.3.0 to v6.7.0 use a different config format
-            compiler-tag: v7.4.0
+            node-tag: v7.2.0 # @aeternity/aepp-sdk@14 only supports node v7.1.0 and above, the devmode bundle in v7.1.0 is buggy, thus using v7.2.0 as lowest usable version
+            compiler-tag: v8.0.0 # @aeternity/aepp-sdk@14 only supports compiler v8.0.0 and above
             aux-ci-run: true
           - node-version: 22
             node-tag: latest

diff --git a/docs/cli/env.md b/docs/cli/env.md
@@ -36,13 +36,8 @@ aeproject env --info
 
 **Compatibility**:
 
-- aeproject until `v4.8.3` is only compatible with node versions `NODE_TAG <= v6.11.0` due to some changes in the devmode plugin
-- aeproject uses the `-bundle` node docker images including dev mode, which are only published from `NODE_TAG >= v6.3.0`
-- the default `aeternity.yaml` config file that ships with aeproject supports `NODE_TAG >= v6.8.0`
-- the latest `@aeternity/aepp-sdk@13` is only compatible using `NODE_TAG >= v6.0.0` and `COMPILER_TAG >= v7.5.0`
-- the sdk from `@aeternity/aepp-sdk@13 >= v13.3.2` is compatible with `NODE_TAG >= v7.0.0-rc1` and `COMPILER_TAG >= v8.0.0-rc1`
-- ARM64/Apple Silicon is supported from images `NODE_TAG >= v6.8.1` and `COMPILER_TAG >= v7.3.0`
-- due to a bug, `NODE_TAG = v7.1.0` is not compatible with aeproject
+- the sdk from `@aeternity/aepp-sdk@14 >= v14.0.0` is compatible with `NODE_TAG >= v7.1.0` and `COMPILER_TAG >= v8.0.0`
+- due to a bug in the devmode plugin, `NODE_TAG = v7.1.0` is not compatible with aeproject
 
 ## Disclaimer
 

diff --git a/docs/cli/test.md b/docs/cli/test.md
@@ -17,15 +17,16 @@ In the `test/exampleTest.js` file you can find an example for unit testing using
 Javascript testing framework used with [mocha](https://mochajs.org/) for assertions, documented at https://www.chaijs.com/api/assert/
 
 ```js
-const { assert } = require("chai");
+import { assert } from "chai";
+import { before, describe, afterEach, it } from "mocha";
 ```
 
 Helper and utilities for AEproject use, e.g. prefunded wallets, network definition and utility functions for SDK initialization and snapshotting.
 
 ```js
-const { utils } = require("@aeternity/aeproject");
+import { utils } from "@aeternity/aeproject";
 import * as AeppSdk from "@aeternity/aepp-sdk";
-const { Contract, getFileSystem } = require("@aeternity/aepp-sdk");
+import { Contract, getFileSystem } from "@aeternity/aepp-sdk";
 ```
 
 Read [AEproject Library](../lib.md) for a more detailed explanation about the usage of these imports.

diff --git a/docs/migration-from-4.x.x-to-5.x.x.md b/docs/migration-from-4.x.x-to-5.x.x.md
@@ -14,7 +14,7 @@ npm install -g @aeternity/aeproject
 - `node@16` is no longer supported, please update to v18 or higher
 - updated to `@aeternity/aepp-sdk@14` to the latest version, see the [migration guide](https://github.com/aeternity/aepp-sdk-js/blob/v14.0.0/docs/guides/migration/14.md) for additional reference.
   - the aeproject provided `utils.getSdk({})` has to be adjusted to pass a reference to the sdk used `utils.getSdk(AeppSdk, {})` where AeppSdk can be imported using `import * as AeppSdk from "@aeternity/aepp-sdk";`
-
+  - `@aeternity/aepp-sdk@14` requires aeternity node version `>= 7.1.0`
 ## Removed from libs
 
 Following utils have been removed and cannot be used anymore: