Merge pull request #1249 from aeternity/release/v9.0.0

Author: mradkov

.github/workflows/docs-develop.yml

@@ -0,0 +1,23 @@
+name: Publish develop docs
+on:
+  push:
+    branches: ['develop']
+      
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip3
+          key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
+      - run: pip3 install -r docs/requirements.txt
+      - run: git config --global user.email "[email protected]"
+      - run: git config --global user.name "GitHub Action"
+      - run: mike deploy --push develop

.github/workflows/docs-release.yml

@@ -0,0 +1,24 @@
+name: Publish release docs
+on:
+  release:
+    types: [released]
+      
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip3
+          key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
+      - run: pip3 install -r docs/requirements.txt
+      - run: git config --global user.email "[email protected]"
+      - run: git config --global user.name "GitHub Action"
+      - run: echo "RELEASE_VERSION=${GITHUB_REF:10}" >> $GITHUB_ENV
+      - run: mike deploy --push --update-aliases $RELEASE_VERSION latest

.github/workflows/main.yml

@@ -27,16 +27,6 @@ jobs:
       - run: npm run build
       - run: npm run test:unit
 
-      - uses: actions/setup-python@v2
-        with:
-          python-version: 3.8
-      - uses: actions/cache@v2
-        with:
-          path: ~/.cache/pip3
-          key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
-      - run: pip3 install -r docs/requirements.txt
-      - run: mkdocs build
-
       - run: docker-compose up -d
       - name: Ensure that node is running
         run: |
@@ -50,10 +40,4 @@ jobs:
       - run: npm run report-coverage
         if: always()
       - run: docker-compose logs
-        if: always()
-
-      - uses: peaceiris/actions-gh-pages@v3
-        if: github.ref == 'refs/heads/master'
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs
+        if: always()

.gitignore

@@ -5,8 +5,12 @@ node_modules
 .dir-locals.el
 /dist
 /es
-/docs/api*
+/docs/api.md
+/docs/api/*
 /docs/examples
+/docs/public
+/docs/docco.css
+/docs/CHANGELOG.md
 __pycache__
 /.envrc
 /yarn-error.log
@@ -22,3 +26,4 @@ coverage.*
 /examples/**/dist
 .history
 .site
+site

CHANGELOG.md

@@ -2,6 +2,45 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [9.0.0](https://github.com/aeternity/aepp-sdk-js/compare/v8.2.1...v9.0.0) (2021-09-27)
+
+### ⚠ BREAKING CHANGES
+
+* refactor aens & oracle delegation signature methods to accept parameters as objects
+* merge aens signature delegation methods into a single implementation
+* change t
+* drop `waitMined` static method
+* drop `assertedType`, use `decode` instead
+* **validator:** recursive validator, simplify schema
+* simplify buildTxHash helper
+* enable verification in deep props instead of extra variable
+
+### Features
+
+* `payForTransaction` method ([fbf204d](https://github.com/aeternity/aepp-sdk-js/commit/fbf204dd2ba333551327adce579b9f9d9edc601b))
+
+
+### Bug Fixes
+
+* **AENS:** name length minimum bid fee ([db6ca4c](https://github.com/aeternity/aepp-sdk-js/commit/db6ca4c3d89eedf7fa326bd6d0484ea0d94de19e))
+* **delegate-signature:** stop using the default account in the contex for signing ([29d760e](https://github.com/aeternity/aepp-sdk-js/commit/29d760ef04591cd9a745a508ff4dfbb8859c347a))
+* **deposit-trap:** enforce zero value for `deposit` during contract deploy ([cfb5f22](https://github.com/aeternity/aepp-sdk-js/commit/cfb5f2263316f0f70290cb174c1d334cf49c6db3))
+* **mustAccountStamp:** process accounts only if supplied ([10ec2c3](https://github.com/aeternity/aepp-sdk-js/commit/10ec2c37f6f35516023cace435bdde6294786ed7))
+* **payingFor:** don't check is GA if innerTx ([0ee9db4](https://github.com/aeternity/aepp-sdk-js/commit/0ee9db4b7e1cbab5b874bee56b5bf8814610b913))
+* **payingFor:** don't sent to blockchain if innerTx ([523e9bb](https://github.com/aeternity/aepp-sdk-js/commit/523e9bbd62a506efd8a9d50317bcf3980052948e))
+* swagger https issue ([3a876bb](https://github.com/aeternity/aepp-sdk-js/commit/3a876bbb80300cbf91891daa642f6daee61c1427))
+* **tx serialisation:** accept unpackTx output produced by deserialisator ([ff0b3f5](https://github.com/aeternity/aepp-sdk-js/commit/ff0b3f551f7cf0684ac9c8e528d94eae9c31f226))
+* **validator:** recursive validator, simplify schema ([95a2a23](https://github.com/aeternity/aepp-sdk-js/commit/95a2a232f3fd8b875b223e352445b045a7217dad))
+
+
+* change t ([831e4dd](https://github.com/aeternity/aepp-sdk-js/commit/831e4dde12a78583d1a567fdc5a9ef86518d5fe6))
+* drop `assertedType`, use `decode` instead ([00d563f](https://github.com/aeternity/aepp-sdk-js/commit/00d563feca871e2c9474df667696946d1c8d12c7))
+* drop `waitMined` static method ([2f299de](https://github.com/aeternity/aepp-sdk-js/commit/2f299de2c985ce2619db10e4a264f7e6d1b7279c))
+* enable verification in deep props instead of extra variable ([989b36f](https://github.com/aeternity/aepp-sdk-js/commit/989b36f28e9649fd74b384f2a16bf8fd64bac85c))
+* merge aens signature delegation methods into a single implementation ([456fe00](https://github.com/aeternity/aepp-sdk-js/commit/456fe00cb8b8eba09ea53800e8713550d0f329cc))
+* merge oracle delegation signature methods ([88b7bf3](https://github.com/aeternity/aepp-sdk-js/commit/88b7bf3aa55b3740c9a64fb4049abcc0fdd3b277))
+* simplify buildTxHash helper ([9e1fde7](https://github.com/aeternity/aepp-sdk-js/commit/9e1fde7693986359a9ac0ff80829dbc058882f7b))
+
 ### [8.2.1](https://github.com/aeternity/aepp-sdk-js/compare/v8.2.0...v8.2.1) (2021-06-21)
 
 
@@ -439,13 +478,13 @@ This stamp give more flexibility on transaction serialization/deserialization pr
 
 ### Docs
 
-* **Guide** [Add 7.0.0 migration guide](https://github.com/aeternity/aepp-sdk-js/blob/develop/docs/guides/migration/migration-7.0.0.md)
+* **Guide** [Add 7.0.0 migration guide](https://github.com/aeternity/aepp-sdk-js/blob/develop/docs/guides/migration/7.0.0.md)
 * **Guide:** Add [Oracle](https://github.com/aeternity/aepp-sdk-js/blob/develop/docs/guides/oracle-usage.md), [AENS](https://github.com/aeternity/aepp-sdk-js/blob/develop/docs/guides/aens-usage.md) and [Contract](https://github.com/aeternity/aepp-sdk-js/blob/develop/docs/guides/contract-aci-usage.md) guides
 
 
 ### BREAKING CHANGES
 
-Please check out [7.0.0 migration guide](https://github.com/aeternity/aepp-sdk-js/blob/develop/docs/guides/migration/migration-7.0.0.md)
+Please check out [7.0.0 migration guide](https://github.com/aeternity/aepp-sdk-js/blob/develop/docs/guides/migration/7.0.0.md)
 
 This release include all changes from [7.0.0-next.1](https://github.com/aeternity/aepp-sdk-js/releases/tag/7.0.0-next.1), [7.0.0-next.2](https://github.com/aeternity/aepp-sdk-js/releases/tag/7.0.0-next.2), [7.0.0-next.3](https://github.com/aeternity/aepp-sdk-js/releases/tag/7.0.0-next.3)
 

README.md

@@ -1,4 +1,4 @@
-# [Æ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)
@@ -18,31 +18,38 @@ JavaScript SDK for the revolutionary [æternity] blockchain, targeting the
 
 ## Guides & Examples
 
-Check out our [Quick Start guide](docs/guides/quick-start.md), [Documentation](docs/README.md), and [Examples](examples/README.md).
+Introduction
+- [Installation](docs/index.md)
+- [Quick Start](docs/quick-start.md)
+
+Usage guides:
+- [æternity naming system](docs/guides/aens.md)
+- [Contracts](docs/guides/contracts.md)
+- [Contract events](docs/guides/contract-events.md)
+- [Oracles](docs/guides/oracles.md)
+- [Low vs High level API](docs/guides/low-vs-high-usage.md)
+
+There are also [examples](examples/README.md) that you can directly use and play with.
 
 ## CLI - Command Line Client
 
-To quickly test _all_ of Aeternity'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 our **NodeJS [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
 
-_eg._ Create an Account:
-
-`aecli account create testWhateverAccountName`
-
 ## Contributing
 
 For advanced use, to get a deeper understanding of the SDK or to contribute to its development, it is advised to read the [Contributing Guidelines](docs/contrib/README.md) section.
 
-## Change Log
+## Changelog
 
 We keep our [Changelog](CHANGELOG.md) up to date.
 
 ## License
 
 ISC License (ISC)
-Copyright © 2018 aeternity developers
+Copyright © 2018 æternity developers
 
 Permission to use, copy, modify, and/or distribute this software for any purpose
 with or without fee is hereby granted, provided that the above copyright notice

docs/README.md

@@ -0,0 +1,7 @@
+# API Reference
+
+We currently don't provide the API reference in this documentation anymore as it confused many people more than it helped them. The main reason for that is that the SDK is making heavy use of [Stamps](https://stampit.js.org/essentials/what-is-a-stamp) and there is just no proper way to document this in e.g. JSDoc right now.
+
+However, there is a plan to get rid of Stamps and introduce TypeScript. Once the foundation is laid and it makes sense to publish the API reference this will be done. Until then you are better off taking a look into the [sourcecode](https://github.com/aeternity/aepp-sdk-js/tree/master/src) directly in case you face any uncertainties how to use functions!
+
+If you want to help with the transition to TypeScript let us know! :-)

docs/api-reference.md

@@ -1,4 +1,4 @@
-# Contributing Info
+# Development
 
 ## Principles
 
@@ -22,10 +22,10 @@ It uses the following Javascript technologies and principles:
 - Convention over configuration
 - "Easy things should be easy, and hard things should be possible." [source] -- [Larry Wall]
 - Support for
-  - module access, enabling tree-shaking
-  - direct use in node scripts through bundling
-  - direct use in browser `<script>` tags through bundling
-  - bundling through webpack
+    - module access, enabling tree-shaking
+    - direct use in node scripts through bundling
+    - direct use in browser `<script>` tags through bundling
+    - bundling through webpack
 
 [Node's Swagger file]: https://github.com/aeternity/aeternity/blob/master/config/swagger.yaml
 [stampit]: http://stampit.js.org/
@@ -46,7 +46,7 @@ It uses the following Javascript technologies and principles:
 
 ## Requirements
 
-aepp-sdk is transpiled to EcmaScript 5 through [WebPack](https://webpack.js.org/), using [Babel](https://babeljs.io/) and is expected to work in any sufficiently new version of [Node.js](https://nodejs.org/en/) (`>= 8.11`) or modern web browser.
+aepp-sdk is transpiled to EcmaScript 5 through [WebPack](https://webpack.js.org/), using [Babel](https://babeljs.io/) and is expected to work in any sufficiently new version of [Node.js](https://nodejs.org/en/) (`>= v12.17`) or modern web browser.
 
 ## Contributing
 
@@ -56,11 +56,11 @@ aepp-sdk is transpiled to EcmaScript 5 through [WebPack](https://webpack.js.org/
 
 ## Documenting
 
-Apart from documenting features and code, there is also documentation automatically generated using [**jsdoc**](http://usejsdoc.org/) for documenting JS files (later transformed in to `.md` files (to have them readable in platforms like GitHub) and [**docco**](http://ashkenas.com/docco/) for documenting examples and code partials.
+Apart from documenting features and code, there is also documentation automatically generated using [**jsdoc**](http://usejsdoc.org/) for documenting JS files (later transformed in to `.md` files (to have them readable in platforms like GitHub) and [a script](https://github.com/aeternity/aepp-sdk-js/blob/master/tooling/docs/examples-to-md.js) for documenting examples and code partials.
 
 ```bash
-#generate documentation with docco + jsdoc (and markdownify jsdoc)
-npm run docs:docco && npm run docs:api
+#generate examples and api documentation
+npm run docs:examples && npm run docs:api
 ```
 
 ## Building
@@ -80,7 +80,7 @@ To test, launch the `test` command. This will run [mocha](https://mochajs.org/)'
 pnpm run test
 ```
 
-This repository also includes a docker-compose file, to allow you to **run your own aeternity node locally**. If you want to do so, **from the root of the project**:
+This repository also includes a docker-compose file, to allow you to **run your own æternity node locally**. If you want to do so, **from the root of the project**:
 
 1. Create a _**docker-compose.override.yml**_ file with this content:
 ```yaml
@@ -94,7 +94,7 @@ services:
       - 3001:3001
 ```
 2. Run `docker-compose up node`
-3. Congrats! you're now running your own aeternity node locally.
+3. Congrats! you're now running your own æternity node locally.
 
 
 ## Composing new Flavors
@@ -135,8 +135,3 @@ In order to add a local development version of aepp-sdk to a project, `npm link`
 ## Releasing
 
 [How to release a new version](releases.md)
-
-
-## Guides
-
-If you're interested in getting sample code/guide, you can check out the [Guides](../README.md)

docs/contrib/README.md

@@ -46,18 +46,19 @@ On the release branch, remove the `next` portion of the `version`
 string in `package.json`.
 
 Execute `npm run release` to automatically
- - update [change log file]
+
  - bump version number in package.json and package-lock.json (according to
    [Semantic Versioning])
- - output changes to CHANGELOG.md
+ - output changes to [CHANGELOG.md]
  - commit package-lock.json and package.json and CHANGELOG.md
 
 Next, `git diff` the release, branch a `release/vX.X.X` (where `vX.X.X` is your
 latest release) against `master` and validate that all changes are covered in
-the changelog. You can find more instructions on how to maintain a CHANGELOG:
-[here](http://keepachangelog.com).
+the changelog. You can find more instructions on how to maintain a CHANGELOG here:
+
+- [https://keepachangelog.com](https://keepachangelog.com)
 
-[change log file]: ../CHANGELOG.md
+[CHANGELOG.md]: ../CHANGELOG.md
 [Semantic Versioning]: https://semver.org
 
 ## PR against `master`