Merge pull request #1165 from aeternity/release/8.0.0-beta.1

Release 8.0.0-beta.1

Author: davidyuk

.env

@@ -1,2 +1,2 @@
-NODE_TAG=v5.5.4
+NODE_TAG=v5.10.1
 COMPILER_TAG=v4.3.2

.github/ISSUE_TEMPLATE/bug_report.md

@@ -24,11 +24,11 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Please tell us about your environment:**
-  
+
   - Node Version: v0.0.0
   - Protocol Version: 1
   - Compiler version: v0.0.0
-  - VM Version: aevm | fate
+  - VM Version: fate | fate2
   - SDK Version: v0.0.0
   - Python version: v3.7.0
 

.gitignore

@@ -4,6 +4,10 @@ node_modules
 .tern-project
 .dir-locals.el
 /dist
+/es
+/docs/api*
+/docs/examples
+__pycache__
 /.envrc
 /yarn-error.log
 .idea
@@ -16,3 +20,5 @@ coverage.*
 .nyc_output/
 /examples/**/package-lock.json
 /examples/**/dist
+.history
+.site

.readthedocs.yml

@@ -0,0 +1,5 @@
+version: 2
+mkdocs:
+  configuration: mkdocs.yml
+conda:
+  environment: docs/conda.yml

.travis.yml

@@ -14,7 +14,7 @@ before_install:
   - if [[ $TRAVIS_EVENT_TYPE == "cron" ]]; then
       export NODE_TAG=master;
       export COMPILER_TAG=latest;
-      export FORCE_COMPATIBILITY=true;
+      export IGNORE_VERSION=true;
     fi
   - if [[ $TRAVIS_BUILD_STAGE_NAME == "Integration tests" ]]; then
       docker-compose up -d;
@@ -30,6 +30,17 @@ jobs:
         - npm run build
         - npm run test:unit
         - npm run report-coverage
+        - pyenv global 3.8
+        - pip3 install -r docs/requirements.txt
+        - mkdocs build
+      deploy:
+        - provider: pages
+          skip_cleanup: true
+          github_token: $GITHUB_TOKEN
+          keep_history: true
+          local_dir: docs
+          on:
+            branch: develop
     - stage: Integration tests
       name: Channel, accounts
       script:

CHANGELOG.md

@@ -5,7 +5,7 @@
 [![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) 
+[![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].
@@ -16,127 +16,9 @@ JavaScript SDK for the revolutionary [æternity] blockchain, targeting the
 
 [develop branch]: https://github.com/aeternity/aepp-sdk-js/tree/develop
 
-## Table of content
-- [Æternity's JavaScript SDK](#%C3%86ternitys-Javascript-SDK)
-  - [Table of content](#Table-of-content)
-  - [Quick Start](#Quick-Start)
-    - [1. Install SDK](#1-Install-SDK)
-      - [A) Simple Usage: with `<script>` tag](#A-Simple-Usage-with-script-tag)
-      - [B) Advanced Usage: with `npm` or similar](#B-Advanced-Usage-with-npm-or-similar)
-    - [2. Create an Account](#2-Create-an-Account)
-      - [A) Using the Command Line](#A-Using-the-Command-Line)
-      - [B) Using the SDK](#B-Using-the-SDK)
-    - [3. Give yourself some _AE_ tokens](#3-Give-yourself-some-AE-tokens)
-    - [4. Import (a chosen Flavor)](#4-Import-a-chosen-Flavor)
-    - [5. Play with Aetenity's blockchain features](#5-Play-with-Aetenitys-blockchain-features)
-  - [More: Guides & Examples](#More-Guides--Examples)
-  - [CLI - Command Line Client](#CLI---Command-Line-Client)
-  - [Contributing](#Contributing)
-  - [Change Log](#Change-Log)
-  - [License](#License)
-
-## Quick Start
-
-### 1. Install SDK
-#### A) Simple Usage: with `<script>` tag
-For those not using any JS bundling/complilation or compilation technique or tools like [_Codepen_](https://codepen.io/pen/) or similar online Editors, please check our [**Import SDK bundle with `<script>` tag**](docs/guides/import-script-tag.md).
-
-If you're using bundling/compilation techniques (eg. `webpack`), please continue reading.
-
-#### B) Advanced Usage: with `npm` or similar
-Add the latest `@aeternity/aepp-sdk` release from npmjs.com to your project using one of these commands
-
-```bash
-# install using npm...or yarn or pnpm
-npm i @aeternity/aepp-sdk
-```
-
-**Note:** To install a _Pre-Release_ (latest `beta` or `alpha` version) using on the latest Node version, you have to install the package appending the `@next` tag reference, or even use the `#` symbol and the Repo URL to install a version coming from a specific branch.
-```bash
-# install the @next version of the SDK
-npm i @aeternity/aepp-sdk@next
-
-# install the #develop version of the SDK
-npm i https://github.com/aeternity/aepp-sdk-js#develop
-```
-
-**Note** : If you experience errors during the installation, you might need to install build tools for your OS.
-
-Windows: Windows Build Tools
-```
-npm install -g windows-build-tools
-```
-Ubuntu / Debian: Build Essential
-```
-sudo apt-get update
-sudo apt-get install build-essential
-```
-Mac:
-Download [Xcode](https://apps.apple.com/de/app/xcode/id497799835?mt=12) from AppStore, then run
-```
-xcode-select --install
-```
-
-### 2. Create an Account
-You can do many more things now, but you'll probably have to start with:
-
-#### A) Using the Command Line
-Create an account using the [💻 CLI](#cli---command-line-client)
-
-#### B) Using the SDK
-
-```javascript
-  import { Crypto } from '@aeternity/aepp-sdk/es'
-  const keypair = Crypto.generateKeyPair()
-  console.log(`Secret key: ${keypair.secretKey}`)
-  console.log(`Public key: ${keypair.publicKey}`)
-```
-
-### 3. Give yourself some _AE_ tokens
-To get yourself some _AEs_ you can use the [🚰 Faucet Aepp](https://faucet.aepps.com/). Just add your publicKey, and you'll immediately get some test tokens.
-
-
-### 4. Import (a chosen Flavor)
-
-Import the right [flavor](docs/README.md#flavors--entry-points). For this example with get the `Universal` flavor, which contains all the features of the SDK:
-
-```js
-// Import Flavor
-import Ae from '@aeternity/aepp-sdk/es/ae/universal' // or other flavor
-```
-
-### 5. Play with Aetenity's blockchain features
-
-```js
-// Use Flavor
-import Ae from '@aeternity/aepp-sdk/es/ae/universal' // or other flavor
-import MemoryAccount from '@aeternity/aepp-sdk/es/account/memory' // or other flavor
-import Node from '@aeternity/aepp-sdk/es/node' // or other flavor
-import { AE_AMOUNT_FORMATS } from '@aeternity/aepp-sdk/es/utils/amount-formatter'
-
-const NODE_URL = 'https://sdk-testnet.aepps.com'
-const COMPILER_URL = 'COMPILER_URL' // required for using Contract
-const ACCOUNT = MemoryAccount({ keypair: { secretKey: 'A_PRIV_KEY', publicKey: 'A_PUB_ADDRESS' } })
-
-(async function () {
-  const nodeInstance = await Node({ url: NODE_URL })
-  const sdkInstance = await Ae({
-     compilerUrl: COMPILER_URL,
-     nodes: [ { name: 'test-net', instance: nodeInstance } ],
-     accounts: [ ACCOUNT ]
-  })
-
-  await sdkInstance.height() // get top block height
-  console.log('Current Block Height:', height)
-  
-  await sdkInstance.spend(1, 'ak_asd23dasdasda...', { denomination: AE_AMOUNT_FORMATS.AE }) // spend one AE
+## Guides & Examples
 
-})()
-```
-
-## More: Guides & Examples
-
-Check out our [Guides](docs/README.md) and [Examples](examples/README.md).
+Check out our [Quick Start guide](docs/guides/quick-start.md), [Documentation](docs/README.md), and [Examples](examples/README.md).
 
 ## CLI - Command Line Client
 

README.md

@@ -27,7 +27,7 @@ const outputDir = `${__dirname}/docs`
 const prefix = /^@aeternity\/aepp-sdk\/es\//
 const templateData = jsdoc2md.getTemplateDataSync({
   configure: '.jsdoc.json',
-  files: 'es/**'
+  files: 'src/**'
 })
 
 function createDirs (path) {

apidoc.js

@@ -1,8 +1,11 @@
 {
-  "presets": ["@babel/preset-env"],
+  "presets": [
+    "@babel/preset-env",
+    "@babel/preset-typescript"
+  ],
   "plugins": [
     "@babel/plugin-proposal-object-rest-spread",
-    "@babel/plugin-transform-runtime",
+    ["@babel/plugin-transform-runtime", { "corejs": 3 }],
     "@babel/plugin-proposal-export-default-from",
     "ramda"
   ]

.babelrc renamed to babel.config.json

@@ -0,0 +1,5 @@
+const config = require('./babel.config.json')
+
+config.presets[0] = ['@babel/preset-env', { modules: false }]
+
+module.exports = config