Realign 4.0.0 (#478)

* chore(package): Bump version to 2.4.1 * chore(Adjust CHANGELOG): * chore(CAHNGELOG): Fix typo * docs(USAGE): Fix networkId in Wallet example * fix(Http): Remove userAgent from axios * chore(CHANGELOG): Fix typo * docs(*): Regenrate docs * chore(bump version in package): * chore(CHANGELOG): Adjust changelog to conventional changelog style * chore(Docker): Update node version tot 2.3.0 * docs(CHANGELOG): Adjust release * feat(npm): Add script for auto-generating changelog * chore(Node): downgrade to 2.2.0 due to failed channel test * fix(Channel): Fix failing test on 2.3.0 node * chore(package-lock): adjust package-lock * chore(Channel): Revert to 2.2.0 * docs(Docs): Regenerate docs * refactor(node): Add txHash to sendTransaction error * chore(package): bump version to 3.1.0 * chore(Docs): Regeneratee docs and changelog * chore(package): Add packa-lock * chore(changelog): Adjust closes issue * chore(package): Bump version to 3.2.0 * docs(Docs and Changelog): Regenerate docs * docs(CHANGELOG): Adjust changelog * docs(CHANGELOG): Adjust changelog * chore(Jenkions): Force jenkins * fix(NPM): Make audit of npm packages. Remove esm from deps * chore(Release): Bump version in package, generate CHNAGELOG * force Jenkins * force Jenkins * force Jenkins * force Jenkins * fix(AEP exampe): Fix contract in AEPP example * Release/3.3.0 (#417) * Realign/3.2.1 (#412) * chore(package): Bump version to 2.4.1 * chore(Adjust CHANGELOG): * chore(CAHNGELOG): Fix typo * docs(USAGE): Fix networkId in Wallet example * fix(Http): Remove userAgent from axios * chore(CHANGELOG): Fix typo * docs(*): Regenrate docs * chore(bump version in package): * chore(CHANGELOG): Adjust changelog to conventional changelog style * chore(Docker): Update node version tot 2.3.0 * docs(CHANGELOG): Adjust release * feat(npm): Add script for auto-generating changelog * chore(Node): downgrade to 2.2.0 due to failed channel test * fix(Channel): Fix failing test on 2.3.0 node * chore(package-lock): adjust package-lock * chore(Channel): Revert to 2.2.0 * docs(Docs): Regenerate docs * refactor(node): Add txHash to sendTransaction error * chore(package): bump version to 3.1.0 * chore(Docs): Regeneratee docs and changelog * chore(package): Add packa-lock * chore(changelog): Adjust closes issue * chore(package): Bump version to 3.2.0 * docs(Docs and Changelog): Regenerate docs * docs(CHANGELOG): Adjust changelog * docs(CHANGELOG): Adjust changelog * chore(Jenkions): Force jenkins * fix(NPM): Make audit of npm packages. Remove esm from deps * chore(Release): Bump version in package, generate CHNAGELOG * force Jenkins * force Jenkins * force Jenkins * force Jenkins * feat(Consensus): Add function to get consensus version. (#413) * feat(Consensus): Add function to get conmsensus version. Get vm/abi based on node protocol * chore(node): Remove logs * add docs for node getProtocol * disable channel tests * try to fix channel test * try to fix channel test * Make sdk compatible with node from 2.3.0 to 4.0.0 * feat(TxBuilder): INT type must be greater or equal 0 int transaction * feat(State Channels): Make state channels compatible with aeternity v… (#415) * feat(State Channels): Make state channels compatible with aeternity v3.0.0 * Fix lint error * feat(Transaction Builder): Add serializations for transactions introd… (#416) * feat(Transaction Builder): Add serializations for transactions introduced in fortuna release * Fix lint errors * fix(AEP exampe): Fix contract in AEPP example * chore(package): Bump version to 3.3.0 * fix(Node): Use universalUrl istead of ES URL * Enable channel tests * chore(package): Bump version to 3.4.0 * chore(CHANGELOG): Adjust CHANGELOG for 3.4.0 * chore(CHANGELOG/.env): Adjust changlog. Point node version in `.env` to v3.0.0-rc.1 * chore(.env): Remove trailing newlines * docs(Docs): Regenrate docs * fix(Deps): Update axios lib to 0.19.0 * chore(Release): Bump version to 3.4.1. Regenerate CHANGELOG * Adjust changelog * build(deps): Make audit of example app packages. Regenerate lock files * chore(package): Bump version to 4.0.0 Regenerate CHANGELOG * chore(CHANGELOG): Adjust CHANGELOG * chore(build): Regenerate package-lock and pnpm-lock * docs(API): Regenrate * chore(Changelog): Adjust CHANGELOG * chore(docs): Resolve comments * chore(examples): Regenerate lock files * chore(CHANGELOG): Adjust
aeternity · Jun 12, 2019 · b8f4fde · b8f4fde
1 parent 9e17863
commit b8f4fde
Show file tree

Hide file tree

Showing 12 changed files with 5,158 additions and 7,984 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,38 @@
+# [4.0.0](https://github.com/aeternity/aepp-sdk-js/compare/3.4.1...4.0.0) (2019-06-12)
+
+### Bug Fixes
+
+* **Ae:** Fix exception when it used without Contract stamp
+
+### Code Refactoring
+
+* **SCM:** Update compatibility range for node: 3.0.1 - 4 and compiler 3.1.0 - 4 ([#474](https://github.com/aeternity/aepp-sdk-js/issues/474)) ([a1494fd](https://github.com/aeternity/aepp-sdk-js/commit/a1494fd))
+* **Test:** Simplify client creation
+
+### Features
+
+* **Docs** chore(Docs): new docs ([#370](https://github.com/aeternity/aepp-sdk-js/pull/370))
+* **Compiler:** Add `getCompilerVersion` to compiler stamp
+* **ACI:** Make compatible with compiler 3.1.0 ([#457](https://github.com/aeternity/aepp-sdk-js/issues/457)) ([d92f2c7](https://github.com/aeternity/aepp-sdk-js/commit/d92f2c7)), closes [#458](https://github.com/aeternity/aepp-sdk-js/issues/458)
+* **ACI:** Generate JS function proto for each of contract function ([#439](https://github.com/aeternity/aepp-sdk-js/issues/439)) ([2f47b4d](https://github.com/aeternity/aepp-sdk-js/commit/2f47b4d))
+* **Compiler/ACI:** Make ACI compatible with compiler 3.0.0 ([#441](https://github.com/aeternity/aepp-sdk-js/issues/441)) ([2a8eb1a](https://github.com/aeternity/aepp-sdk-js/commit/2a8eb1a))
+* **Node:** Avoid usage of "universal-url" package ([#434](https://github.com/aeternity/aepp-sdk-js/issues/434)) ([a8268d5](https://github.com/aeternity/aepp-sdk-js/commit/a8268d5))
+* **TX:** encode payload as base64 ([#460](https://github.com/aeternity/aepp-sdk-js/issues/460)) ([ad490af](https://github.com/aeternity/aepp-sdk-js/commit/ad490af))
+* **TX_BUILDER:** Fix bug related to contract fee calculation. ([#472](https://github.com/aeternity/aepp-sdk-js/issues/472)) ([7214cfb](https://github.com/aeternity/aepp-sdk-js/commit/7214cfb))
+
+
+### BREAKING CHANGES
+
+* **DOCS** Restructure and rework sdk documentation
+* **SCM:** This change will make the release not compatible with older version of the node and
+compiler
+* **ACI:** Change Contract low lvl API: 
+  - change `contractDecodeData` interface from:
+    - `(type:String, data: String) => Any` to `(source: String, fn: String, callValue: String, callResult:String) => Any`.
+    (`callResult` is `callType` from call result, can be `ok`, `revert`, ...)
+
+
+
 ## [3.4.1](https://github.com/aeternity/aepp-sdk-js/compare/3.4.0...3.4.1) (2019-06-05)
 
 

diff --git a/README.md b/README.md
@@ -65,7 +65,7 @@ import Ae from '@aeternity/aepp-sdk/es/ae/universal' // or other flavor
 ```
 
 ### 3. Create an Account and get some _AEs_
-You can do many more things now, but you'll probably have to start by:
+You can do many more things now, but you'll probably have to start with:
 
 1. Create an account using the [💻 CLI](#cli---command-line-client)
 2. Give yourself some initial _AEs_ using the [🚰 Faucet Aepp](https://faucet.aepps.com/)
@@ -80,7 +80,7 @@ Check out our [Guides](docs/README.md) and [Examples](examples/README.md).
 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:
 
 1. `npm i -g @aeternity/aepp-cli` to globally install the CLI
-2. `aecly --help` to get a list of possible commands
+2. `aecli --help` to get a list of possible commands
 
 _eg._ Create an Account:
 

diff --git a/docs/README.md b/docs/README.md
@@ -23,7 +23,7 @@ Factories_ based on the specific use case:
 * [@aeternity/aepp-sdk/es/ae/oracle](api/ae/oracle.md): for **Oracle**'s focused development
 * [@aeternity/aepp-sdk/es/ae/universal](api/ae/universal.md): for **Universal** development (includes all SDK features)
 
-In order to cater to more specific needs, it is recommended to refer to the
+In order to cater more specific needs, it is recommended to refer to the
 [contributing Docs](contrib/README.md).
 
 ### Testing Networks

diff --git a/docs/api/account/selector.md b/docs/api/account/selector.md
@@ -5,7 +5,7 @@ Accounts Selector module
 
 This is the complement to [@aeternity/aepp-sdk/es/accounts](#module_@aeternity/aepp-sdk/es/accounts).
 
-**Export**: Account  
+**Export**: Selector  
 **Example**  
 ```js
 import Selector from '@aeternity/aepp-sdk/es/account/selector'

diff --git a/docs/api/ae/contract.md b/docs/api/ae/contract.md
@@ -21,7 +21,7 @@ import { Contract } from '@aeternity/aepp-sdk' (Using bundle)
     * _async_
         * [handleCallError(result)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--handleCallError) ⇒ `Promise.&lt;void&gt;` ⏏
         * [contractEncodeCall(source, name, args)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--contractEncodeCall) ⇒ `Promise.&lt;String&gt;` ⏏
-        * [contractDecodeData(type, data)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--contractDecodeData) ⇒ `Promise.&lt;String&gt;` ⏏
+        * [contractDecodeData(source, fn, callValue, callResult, options)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--contractDecodeData) ⇒ `Promise.&lt;String&gt;` ⏏
         * [contractCallStatic(source, address, name, args, options, top, options)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--contractCallStatic) ⇒ `Promise.&lt;Object&gt;` ⏏
         * [contractCall(source, address, name, args, options)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--contractCall) ⇒ `Promise.&lt;Object&gt;` ⏏
         * [contractDeploy(code, source, initState, options)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--contractDeploy) ⇒ `Promise.&lt;Object&gt;` ⏏
@@ -94,7 +94,7 @@ Encode call data for contract call
 
 <a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--contractDecodeData"></a>
 
-### contractDecodeData(type, data) ⇒ `Promise.&lt;String&gt;` ⏏
+### contractDecodeData(source, fn, callValue, callResult, options) ⇒ `Promise.&lt;String&gt;` ⏏
 Decode contract call result data
 
 **Kind**: Exported function  
@@ -103,12 +103,15 @@ Decode contract call result data
 
 | Param | Type | Description |
 | --- | --- | --- |
-| type | `String` | Data type (int, string, list,...) |
-| data | `String` | call result data (cb_iwer89fjsdf2j93fjews_(ssdffsdfsdf...) |
+| source | `String` | source code |
+| fn | `String` | function name |
+| callValue | `String` | result call data |
+| callResult | `String` | result status |
+| options |  |  |
 
 **Example**  
 ```js
-const decodedData = await client.contractDecodeData('string' ,'cb_sf;ls43fsdfsdf...')
+const decodedData = await client.contractDecodeData(SourceCode ,'functionName', 'cb_asdasdasd...', 'ok|revert')lt
 ```
 <a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--contractCallStatic"></a>
 

diff --git a/docs/api/contract.md b/docs/api/contract.md
@@ -16,6 +16,8 @@ import ContractBase from '@aeternity/aepp-sdk/es/contract'
         * *[.contractDecodeCallDataBySourceAPI(source, function, callData)](#module_@aeternity/aepp-sdk/es/contract--ContractBase+contractDecodeCallDataBySourceAPI) ⇒ `String`*
         * *[.contractDecodeCallDataByCodeAPI(code, callData)](#module_@aeternity/aepp-sdk/es/contract--ContractBase+contractDecodeCallDataByCodeAPI) ⇒ `String`*
         * *[.compileContractAPI(code, [options])](#module_@aeternity/aepp-sdk/es/contract--ContractBase+compileContractAPI) ⇒ `Object`*
+        * *[.setCompilerUrl(url)](#module_@aeternity/aepp-sdk/es/contract--ContractBase+setCompilerUrl) ⇒ `void`*
+        * *[.getCompilerVersion()](#module_@aeternity/aepp-sdk/es/contract--ContractBase+getCompilerVersion) ⇒ `String`*
 
 <a id="exp_module_@aeternity/aepp-sdk/es/contract--ContractBase"></a>
 
@@ -111,3 +113,25 @@ Compile contract
 | code | `String` |  | Contract source code |
 | [options] | `Object` | <code>{}</code> | Options |
 
+<a id="module_@aeternity/aepp-sdk/es/contract--ContractBase+setCompilerUrl"></a>
+
+#### *contractBase.setCompilerUrl(url) ⇒ `void`*
+Set compiler url
+
+**Kind**: instance abstract method of [`ContractBase`](#exp_module_@aeternity/aepp-sdk/es/contract--ContractBase)  
+**Category**: async  
+**rtype**: `(url: String) => void`
+
+| Param | Type | Description |
+| --- | --- | --- |
+| url | `String` | Compiler url |
+
+<a id="module_@aeternity/aepp-sdk/es/contract--ContractBase+getCompilerVersion"></a>
+
+#### *contractBase.getCompilerVersion() ⇒ `String`*
+Get Compiler Version
+
+**Kind**: instance abstract method of [`ContractBase`](#exp_module_@aeternity/aepp-sdk/es/contract--ContractBase)  
+**Returns**: `String` - Compiler version  
+**Category**: async  
+**rtype**: `() => String`