Merge pull request #305 from aeternity/release/2.4.0

Release 2.4.0

Author: nduchak

.env

@@ -1 +1 @@
-TAG=v2.0.0
+TAG=v2.2.0

CHANGELOG.md

@@ -2,6 +2,70 @@
 All notable changes to this project will be documented in this file. This change
 log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).
 
+## [2.4.0]
+### Added
+- Install and configure `commitizen`
+- Add `formatAddress` function to `Crypto`
+- Add Contract Compiler API stamp to `es/contract` (now using instead contract node API)
+- Add basic `http` client stamp (`es/utils/http`)
+- ACI stamp (New Contract interface base on contract ACI schema)
+Usage:
+```
+const contractIns = await client.getContractInstance(contractSourceCode)
+console.log(contract)
+ {
+   interface: String, // Contract interface source code
+   aci: String, // Contract interface json schema
+   source: String, // Contract source code
+   compiled: String, // Compiled contract code
+   deployInfo: { address: contractAddress } // Object with deploy transaction,
+   // Function
+   compile: () => this, // Compile contract,
+   deploy: (init = [], options = { skipArgsConvert: false }) => this, // Deploy contract (compile before if needed)
+   call: (fn, params = [], options = { skipArgsConvert: false, skipTransformDecoded: false, callStatic: false } => CallRersult: Object // Call contract function
+ }
+```
+
+### Changed
+- Extend  `Account.address()` with `accountFormatter` now you can do
+```
+export const ADDRESS_FORMAT = {
+  sophia: 1, // return address like `0xHEX_ADDRESS`
+  api: 2, // return address like `ak_9LJ8ne9tks78hTD2Tp571f7w2MJmzQMRsiZxKCkMA2d2Sbrc4`
+}
+
+//
+
+export { ADDRESS_FORMAT } from 'es/account'
+await account.address(format: ADDRESS_FORMAT) // default ADDRESS_FORMAT.api
+```
+- decode node error coming from contract `call` and `callStatic`
+- Throw native error instead of object in chain `chain.sendTransaction`
+- fix arguments parsing in `Crypto.sing`
+- Add `{ compilerUrl }` to `Universal, Contract, Wallet` stamp initialization
+- Add ability to get `account/balance` on specific block `hash/height`
+- Fix `name hash` function arguments parsing in `Crypto`
+- Improve channel rpc usage
+- Improve channel tests and error handling
+- Improve state channel params handling
+
+ ### Removed
+- `ContractNodeAPI` stamp
+
+ ### Breaking Changes
+- Contract stamp API
+```
+1) Use Compiler instead of node API for encode/decode call-data and compile.
+2) Change Contract interface:
+ - contractCallStatic (address, abi = 'sophia-address', name, { top, args = '()', call, options = {} } = {}) -> (source, address, name, args = [], { top, options = {} } = {}))
+ - contractCall (code, abi, address, name, { args = '()', options = {}, call } = {}) -> (source, address, name, args = [], options = {})
+ - contractDeploy (code, abi, { initState = '()', options = {} } = {}) -> (code, source, initState = [], options = {})
+ - contractEncodeCall (code, abi, name, args, call) -> (source, name, args) // 'source' is -> Contract source code or ACI interface source
+```
+
+ ### Notes and known Issues
+- none
+
 ## [2.3.2]
 ### Added
 - none
@@ -564,3 +628,4 @@ log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).
 [2.3.0]: https://github.com/aeternity/aepp-sdk-js/compare/2.3.0-next...2.3.0
 [2.3.1]: https://github.com/aeternity/aepp-sdk-js/compare/2.3.0...2.3.1
 [2.3.2]: https://github.com/aeternity/aepp-sdk-js/compare/2.3.1...2.3.2
+[2.4.0.]: https://github.com/aeternity/aepp-sdk-js/compare/2.3.2...2.4.0

README.md

@@ -1,5 +1,6 @@
 # aepp-sdk
 
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 [![Build Status](https://ci.aepps.com/buildStatus/icon?job=aepp-sdk-js/develop)](https://ci.aepps.com/job/aepp-sdk-js/job/develop/)
 [![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)

docs/api.md

@@ -13,8 +13,9 @@
   * [@aeternity/aepp-sdk/es/chain](api/chain.md)
   * [@aeternity/aepp-sdk/es/chain/node](api/chain/node.md)
   * [@aeternity/aepp-sdk/es/channel/index](api/channel/index.md)
+  * [@aeternity/aepp-sdk/es/contract/aci](api/contract/aci.md)
+  * [@aeternity/aepp-sdk/es/contract/compiler](api/contract/compiler.md)
   * [@aeternity/aepp-sdk/es/contract](api/contract.md)
-  * [@aeternity/aepp-sdk/es/contract/node](api/contract/node.md)
   * [@aeternity/aepp-sdk/es/node](api/node.md)
   * [@aeternity/aepp-sdk/es/oracle](api/oracle.md)
   * [@aeternity/aepp-sdk/es/oracle/node](api/oracle/node.md)

docs/api/ae/contract.md

@@ -19,12 +19,13 @@ import { Contract } from '@aeternity/aepp-sdk' (Using bundle)
 * [@aeternity/aepp-sdk/es/ae/contract](#module_@aeternity/aepp-sdk/es/ae/contract)
     * [Contract([options])](#exp_module_@aeternity/aepp-sdk/es/ae/contract--Contract) ⇒ `Object` ⏏
     * _async_
-        * [encodeCall(code, abi, name, args, call)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--encodeCall) ⇒ `Promise.<Object>` ⏏
-        * [callStatic(address, abi, name, options, top, args, call, options)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--callStatic) ⇒ `Promise.<Object>` ⏏
+        * [handleCallError(result)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--handleCallError) ⇒ `Promise.<void>` ⏏
+        * [encodeCall(source, name, args)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--encodeCall) ⇒ `Promise.<String>` ⏏
         * [decode(type, data)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--decode) ⇒ `Promise.<String>` ⏏
-        * [call(code, abi, address, name, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/contract--call) ⇒ `Promise.<Object>` ⏏
-        * [deploy(code, abi, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/contract--deploy) ⇒ `Promise.<Object>` ⏏
-        * [compile(code, options)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--compile) ⇒ `Promise.<Object>` ⏏
+        * [callStatic(source, address, name, args, options, top, options)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--callStatic) ⇒ `Promise.<Object>` ⏏
+        * [call(source, address, name, args, options)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--call) ⇒ `Promise.<Object>` ⏏
+        * [deploy(code, source, initState, options)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--deploy) ⇒ `Promise.<Object>` ⏏
+        * [compile(source, options)](#exp_module_@aeternity/aepp-sdk/es/ae/contract--compile) ⇒ `Promise.<Object>` ⏏
 
 <a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--Contract"></a>
 
@@ -42,41 +43,35 @@ Provide contract implementation
 | --- | --- | --- | --- |
 | [options] | `Object` | <code>{}</code> | Initializer object |
 
-<a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--encodeCall"></a>
+<a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--handleCallError"></a>
 
-### encodeCall(code, abi, name, args, call) ⇒ `Promise.&lt;Object&gt;` ⏏
-Encode call data for contract call
+### handleCallError(result) ⇒ `Promise.&lt;void&gt;` ⏏
+Handle contract call error
 
 **Kind**: Exported function  
 **Category**: async  
+**Throws**:
+
+- Error Decoded error
+
 
 | Param | Type | Description |
 | --- | --- | --- |
-| code | `String` | Contract source code or Contract address |
-| abi | `String` | ABI('sophia', 'sophia-address') |
-| name | `String` | Name of function to call |
-| args | `String` | Argument's for call ('()') |
-| call | `String` | Code of `call` contract(Pseudo code with __call => {name}({args}) function) |
+| result | `Object` | call result object |
 
-<a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--callStatic"></a>
+<a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--encodeCall"></a>
 
-### callStatic(address, abi, name, options, top, args, call, options) ⇒ `Promise.&lt;Object&gt;` ⏏
-Static contract call(using dry-run)
+### encodeCall(source, name, args) ⇒ `Promise.&lt;String&gt;` ⏏
+Encode call data for contract call
 
 **Kind**: Exported function  
-**Returns**: `Promise.&lt;Object&gt;` - Result object  
 **Category**: async  
 
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| address | `String` |  | Contract address |
-| abi | `String` | <code>sophia-address</code> | ABI('sophia', 'sophia-address') |
-| name | `String` |  | Name of function to call |
-| options | `Object` |  | [options={}]  Options |
-| top | `String` |  | [options.top] Block hash ob which you want to call contract |
-| args | `String` |  | [options.args] Argument's for call function |
-| call | `String` |  | [options.call] Code of `call` contract(Pseudo code with __call => {name}({args}) function) |
-| options | `String` |  | [options.options]  Transaction options (fee, ttl, gas, amount, deposit) |
+| Param | Type | Description |
+| --- | --- | --- |
+| source | `String` | Contract source code |
+| name | `String` | Name of function to call |
+| args | `Array` | Argument's for call |
 
 <a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--decode"></a>
 
@@ -92,46 +87,61 @@ Decode contract call result data
 | type | `String` | Data type (int, string, list,...) |
 | data | `String` | call result data (cb_iwer89fjsdf2j93fjews_(ssdffsdfsdf...) |
 
+<a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--callStatic"></a>
+
+### callStatic(source, address, name, args, options, top, options) ⇒ `Promise.&lt;Object&gt;` ⏏
+Static contract call(using dry-run)
+
+**Kind**: Exported function  
+**Returns**: `Promise.&lt;Object&gt;` - Result object  
+**Category**: async  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| source | `String` | Contract source code |
+| address | `String` | Contract address |
+| name | `String` | Name of function to call |
+| args | `Array` | Argument's for call function |
+| options | `Object` | [options={}]  Options |
+| top | `String` | [options.top] Block hash on which you want to call contract |
+| options | `String` | [options.options]  Transaction options (fee, ttl, gas, amount, deposit) |
+
 <a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--call"></a>
 
-### call(code, abi, address, name, [options]) ⇒ `Promise.&lt;Object&gt;` ⏏
+### call(source, address, name, args, options) ⇒ `Promise.&lt;Object&gt;` ⏏
 Call contract function
 
 **Kind**: Exported function  
 **Returns**: `Promise.&lt;Object&gt;` - Result object  
 **Category**: async  
 
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| code | `String` |  | Contract source code |
-| abi | `String` |  | ABI('sophia', 'sophia-address') |
-| address | `String` |  | Contract address |
-| name | `String` |  | Name of function to call |
-| [options] | `Object` | <code>{}</code> | options Options |
-| [options.args] | `String` |  | args Argument's for call function |
-| [options.call] | `String` |  | call Code of `call` contract(Pseudo code with __call => {name}({args}) function) |
-| [options.options] | `String` |  | options Transaction options (fee, ttl, gas, amount, deposit) |
+| Param | Type | Description |
+| --- | --- | --- |
+| source | `String` | Contract source code |
+| address | `String` | Contract address |
+| name | `String` | Name of function to call |
+| args | `Array` | Argument's for call function |
+| options | `Object` | Transaction options (fee, ttl, gas, amount, deposit) |
 
 <a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--deploy"></a>
 
-### deploy(code, abi, [options]) ⇒ `Promise.&lt;Object&gt;` ⏏
+### deploy(code, source, initState, options) ⇒ `Promise.&lt;Object&gt;` ⏏
 Deploy contract to the node
 
 **Kind**: Exported function  
 **Returns**: `Promise.&lt;Object&gt;` - Result object  
 **Category**: async  
 
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| code | `String` |  | Contract source code |
-| abi | `String` |  | ABI('sophia', 'sophia-address') |
-| [options] | `Object` | <code>{}</code> | options Options |
-| [options.initState] | `String` |  | initState Argument's for contract init function |
-| [options.options] | `String` |  | options Transaction options (fee, ttl, gas, amount, deposit) |
+| Param | Type | Description |
+| --- | --- | --- |
+| code | `String` | Compiled contract |
+| source | `String` | Contract source code |
+| initState | `Array` | Arguments of contract constructor(init) function |
+| options | `Object` | Transaction options (fee, ttl, gas, amount, deposit) |
 
 <a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--compile"></a>
 
-### compile(code, options) ⇒ `Promise.&lt;Object&gt;` ⏏
+### compile(source, options) ⇒ `Promise.&lt;Object&gt;` ⏏
 Compile contract source code
 
 **Kind**: Exported function  
@@ -140,6 +150,6 @@ Compile contract source code
 
 | Param | Type | Description |
 | --- | --- | --- |
-| code | `String` | Contract code |
+| source | `String` | Contract sourece code |
 | options | `Object` | Transaction options (fee, ttl, gas, amount, deposit) |
 

docs/api/chain.md

@@ -26,6 +26,7 @@ import Chain from '@aeternity/aepp-sdk/es/chain'
                 * *[.getMicroBlockTransactions()](#module_@aeternity/aepp-sdk/es/chain--Chain+getMicroBlockTransactions) ⇒ `Array.<Object>`*
                 * *[.getKeyBlock()](#module_@aeternity/aepp-sdk/es/chain--Chain+getKeyBlock) ⇒ `Object`*
                 * *[.getMicroBlockHeader()](#module_@aeternity/aepp-sdk/es/chain--Chain+getMicroBlockHeader) ⇒ `Object`*
+                * *[.getAccount(address, [options])](#module_@aeternity/aepp-sdk/es/chain--Chain+getAccount) ⇒ `Object`*
                 * *[.txDryRun(txs, accounts, hashOrHeight)](#module_@aeternity/aepp-sdk/es/chain--Chain+txDryRun) ⇒ `Object`*
         * _static_
             * [.waitMined(bool)](#module_@aeternity/aepp-sdk/es/chain--Chain.waitMined) ⇒ `Stamp`
@@ -208,6 +209,23 @@ Get micro block header
 **Returns**: `Object` - Micro block header  
 **Category**: async  
 **rtype**: `(hash) => header: Object`
+<a id="module_@aeternity/aepp-sdk/es/chain--Chain+getAccount"></a>
+
+#### *chain.getAccount(address, [options]) ⇒ `Object`*
+Get account by account public key
+
+**Kind**: instance abstract method of [`Chain`](#exp_module_@aeternity/aepp-sdk/es/chain--Chain)  
+**Returns**: `Object` - Account  
+**Category**: async  
+**rtype**: `(address, { hash, height }) => account: Object`
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| address | `String` |  | Account public key |
+| [options] | `Object` | <code>{}</code> | Options |
+| [options.height] | `Number` |  | Get account on specific block by block height |
+| [options.hash] | `String` |  | Get account on specific block by block hash |
+
 <a id="module_@aeternity/aepp-sdk/es/chain--Chain+txDryRun"></a>
 
 #### *chain.txDryRun(txs, accounts, hashOrHeight) ⇒ `Object`*