Merge pull request #1427 from aeternity/release/v11.0.0

Release v11.0.0

Author: marc0olo

.env

@@ -1,2 +1,2 @@
-NODE_TAG=v6.3.0
+NODE_TAG=v6.4.0
 COMPILER_TAG=v6.1.0

.github/workflows/main.yml

@@ -1,43 +1,39 @@
-name: Test, build, and deploy
+name: Test & build
 on: [push, pull_request]
 jobs:
   main:
     runs-on: ubuntu-latest
     steps:
-      - if: github.ref != 'refs/heads/develop'
-        uses: actions/checkout@v2
-        with:
-          ref: develop
       - uses: actions/checkout@v2
         with:
-          fetch-depth: 100
-      - if: github.ref != 'refs/heads/develop'
-        run: git branch develop origin/develop
-
+          fetch-depth: 0
       - uses: actions/setup-node@v2
         with:
-          node-version: 14.x
+          node-version: 16.x
       - uses: actions/cache@v2
         with:
           path: ~/.npm
           key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
-
       - run: npm ci --ignore-scripts
+      - name: Run Commitlint
+        env:
+          EVENT_TYPE: ${{ github.event_name }}
+          HEAD: ${{ github.event.pull_request.head.sha }}
+          BASE: ${{ github.event.pull_request.base.sha }}
+        run: |
+          if [ "$EVENT_TYPE" = "push" ]; then
+            npx commitlint --from HEAD~${{ github.event.push.commits }} --to HEAD --verbose
+          else
+            npx commitlint --from $BASE --to $HEAD --verbose
+          fi
       - run: npm run lint
       - run: npm run build
       - run: npm run test:unit
-      - run: npm run report-coverage
-        if: always()
-
       - run: docker-compose up -d
       - name: Ensure that node is running
         run: |
           while [[ `curl -s -o /dev/null -w %{http_code} localhost:3013/api` != 200 ]]; do
             sleep 0.2;
           done
-
       - run: npm run test:integration
-      - run: npm run report-coverage
-        if: always()
       - run: docker-compose logs
-        if: always()

.gitignore

@@ -10,7 +10,6 @@ node_modules
 /docs/examples
 /docs/public
 /docs/docco.css
-/docs/CHANGELOG.md
 __pycache__
 /.envrc
 /yarn-error.log

.mocharc.js

@@ -0,0 +1,9 @@
+module.exports = {
+  require: [
+    '@babel/register',
+    'ts-node/register'
+  ],
+  recursive: true,
+  timeout: '40s',
+  exit: true // TODO: fix in state channel tests
+}

README.md

@@ -1,39 +1,40 @@
-# [æternity](https://aeternity.com/)'s JavaScript SDK
+# [æternity](https://aeternity.com)'s JavaScript SDK
 
 [![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/aeternity/aepp-sdk-js.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/aeternity/aepp-sdk-js/context:javascript)
-[![codecov](https://codecov.io/gh/aeternity/aepp-sdk-js/branch/develop/graph/badge.svg)](https://codecov.io/gh/aeternity/aepp-sdk-js)
-[![Build Status](https://travis-ci.com/aeternity/aepp-sdk-js.svg?branch=develop)](http://travis-ci.com/aeternity/aepp-sdk-js?branch=develop)
-[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 [![npm](https://img.shields.io/npm/v/@aeternity/aepp-sdk.svg)](https://www.npmjs.com/package/@aeternity/aepp-sdk)
 [![npm](https://img.shields.io/npm/l/@aeternity/aepp-sdk.svg)](https://www.npmjs.com/package/@aeternity/aepp-sdk)
-[![Greenkeeper badge](https://badges.greenkeeper.io/aeternity/aepp-sdk-js.svg)](https://greenkeeper.io/)
+
 JavaScript SDK for the revolutionary [æternity] blockchain, targeting the
-[æternity node] implementation. Aepp-sdk is [hosted on GitHub].
+[æternity node] implementation. The aepp-sdk is [hosted on GitHub].
 
-[æternity]: https://aeternity.com/
+[æternity]: https://aeternity.com
 [æternity node]: https://github.com/aeternity/aeternity
 [hosted on GitHub]: https://github.com/aeternity/aepp-sdk-js
 
-[develop branch]: https://github.com/aeternity/aepp-sdk-js/tree/develop
-
 ## Guides & Examples
 
 Introduction
 - [Installation](docs/index.md)
 - [Quick Start](docs/quick-start.md)
 
 Usage guides:
-- [æternity naming system](docs/guides/aens.md)
+- [AENS](docs/guides/aens.md) (æternity naming system)
 - [Contracts](docs/guides/contracts.md)
-- [Contract events](docs/guides/contract-events.md)
+- [Contract Events](docs/guides/contract-events.md)
 - [Oracles](docs/guides/oracles.md)
+- [PayingForTx](docs/guides/paying-for-tx.md) (Meta-Transactions)
+- [Batch Transactions](docs/guides//batch-requests.md)
+- [Error Handling](docs/guides/error-handling.md)
 - [Low vs High level API](docs/guides/low-vs-high-usage.md)
+- Wallet Interaction
+    - [Connect an æpp to a wallet](docs/guides/connect-aepp-to-wallet.md)
+    - [How to build a wallet](docs/guides/build-wallet.md)
 
 There are also [examples](examples/README.md) that you can directly use and play with.
 
-## CLI - Command Line Client
+## CLI - Command Line Interface
 
-To quickly test _all_ of æternity's blockchain features from your terminal, you can install and use our **NodeJS [CLI](https://github.com/aeternity/aepp-cli-js)** by running:
+To quickly test _all_ of æternity's blockchain features from your terminal, you can install and use the [CLI](https://github.com/aeternity/aepp-cli-js) by running:
 
 1. `npm i -g @aeternity/aepp-cli` to globally install the CLI
 2. `aecli --help` to get a list of possible commands
@@ -44,7 +45,7 @@ For advanced use, to get a deeper understanding of the SDK or to contribute to i
 
 ## Changelog
 
-We keep our [Changelog](CHANGELOG.md) up to date.
+We keep our [Changelog](docs/CHANGELOG.md) up to date.
 
 ## License
 

apidoc.js

@@ -21,7 +21,6 @@
 const jsdoc2md = require('jsdoc-to-markdown')
 const fs = require('fs')
 const path = require('path')
-const R = require('ramda')
 
 const outputDir = path.join(__dirname, 'docs')
 const prefix = /^@aeternity\/aepp-sdk\/es\//
@@ -32,7 +31,7 @@ const templateData = jsdoc2md.getTemplateDataSync({
 
 function createDirs (path) {
   const paths = path.split(/\//).slice(1, -1)
-    .reduce((acc, e) => acc.concat([`${R.last(acc)}/${e}`]), ['']).slice(1)
+    .reduce((acc, e) => acc.concat([`${acc[acc.length - 1]}/${e}`]), ['']).slice(1)
 
   paths.forEach(dir => {
     try {
@@ -44,12 +43,12 @@ function createDirs (path) {
 }
 
 const modules = templateData
-  .filter(R.propEq('kind', 'module'))
+  .filter(({ kind }) => kind === 'module')
   .map(({ name }) => {
     return { name, out: `api/${name.replace(prefix, '')}` }
   })
 
-R.forEachObjIndexed(({ name, out }) => {
+Object.values(modules).forEach(({ name, out }) => {
   const template = `{{#module name="${name}"}}{{>docs}}{{/module}}`
   console.log(`rendering ${name}`)
   const dest = path.resolve(outputDir, `${out}.md`)
@@ -64,7 +63,7 @@ R.forEachObjIndexed(({ name, out }) => {
   })
   createDirs(dest)
   fs.writeFileSync(dest, output)
-}, modules)
+})
 
 const output = jsdoc2md.renderSync({
   data: modules,

babel.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  presets: [
+    ['@babel/preset-env', {
+      include: [
+        '@babel/plugin-proposal-nullish-coalescing-operator',
+        '@babel/plugin-proposal-logical-assignment-operators'
+      ]
+    }],
+    '@babel/preset-typescript'
+  ],
+  plugins: [
+    ['@babel/plugin-transform-runtime', { corejs: 3 }]
+  ]
+}

babel.config.json

@@ -1,5 +1,15 @@
-const config = require('./babel.config.json')
+const config = require('./babel.config.js')
 
-config.presets[0] = ['@babel/preset-env', { modules: false }]
+config.presets
+  .filter(plugin => Array.isArray(plugin))
+  .find(([name]) => name === '@babel/preset-env')[1].modules = false
+
+config.plugins.push(
+  ['add-import-extension', { extension: 'mjs' }],
+  ['import-globals', {
+    Buffer: { moduleName: 'buffer', exportName: 'Buffer' }
+  }],
+  ['transform-default-named-imports']
+)
 
 module.exports = config

babel.esm.config.js

@@ -4,11 +4,8 @@ services:
     image: aeternity/aeternity:${NODE_TAG}
     hostname: node
     ports: ["3013:3013", "3113:3113", "3014:3014", "3114:3114"]
-    environment:
-      EPOCH_CONFIG: /home/aeternity/aeternity_node.yaml
-    command: bin/aeternity console -noinput -aecore
     volumes:
-      - ./docker/aeternity_node_mean16.yaml:/home/aeternity/aeternity_node.yaml
+      - ./docker/aeternity_node_mean16.yaml:/home/aeternity/node/aeternity.yaml
       - ./docker/accounts_test.json:/home/aeternity/node/data/aecore/.genesis/accounts_test.json
 
   compiler: