Merge pull request #437 from aeternity/release/3.4.0

Release/3.4.0
aeternity · May 22, 2019 · 58e013b · 58e013b
2 parents d957cc9 + 36a076b
commit 58e013b
Show file tree

Hide file tree

Showing 39 changed files with 161 additions and 107 deletions.
diff --git a/.env b/.env
@@ -1,3 +1,2 @@
-TAG=master
+TAG=v3.0.0-rc.1
 COMPILER_TAG=v2.1.0
-
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,22 @@
+# [3.4.0](https://github.com/aeternity/aepp-sdk-js/compare/2.4.0...3.4.0) (2019-05-22)
+
+
+### Bug Fixes
+
+* **State Channels:** Remove automatic pinging to fix browser compatibility ([#432](https://github.com/aeternity/aepp-sdk-js/issues/432)) ([0700f3a](https://github.com/aeternity/aepp-sdk-js/commit/0700f3a))
+
+
+### Features
+
+* **Transaction Builder:** Improve min fee calculation(Reduce the fee) ([#424](https://github.com/aeternity/aepp-sdk-js/pull/424))
+* **AXIOS:** Add ability to intercept error from axios ([#431](https://github.com/aeternity/aepp-sdk-js/pull/431))
+  > Added additional param to sdk initialization `axiosConfig`
+
+  > Example: `Universal({ axiosConfig: { config: { // axios config object }, errorHandler: (err) => throw err }})`
+* **Transaction Builder:** Implement vm/abi validation for contract/oracle tx based on consensus protocol version. Add custom verification based on transaction type ([#425](https://github.com/aeternity/aepp-sdk-js/pull/425)) ([#426](https://github.com/aeternity/aepp-sdk-js/pull/426))
+
+
+
 # [3.3.0](https://github.com/aeternity/aepp-sdk-js/compare/2.4.0...3.3.0) (2019-05-17)
 
 

diff --git a/README.md b/README.md
@@ -13,7 +13,6 @@ aepp-sdk is [hosted on GitHub].
 ![Concept Drawing of aepp-sdk][concept]
 
 [concept]: concept.png "Concept Drawing of aepp-sdk"
-
 [æternity]: https://aeternity.com/
 [æternity node]: https://github.com/aeternity/aeternity
 [hosted on GitHub]: https://github.com/aeternity/aepp-sdk-js

diff --git a/docs/api/account.md b/docs/api/account.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/account
 Account module
 
-**Export**: Account  
 **Example**  
 ```js
 import Account from '@aeternity/aepp-sdk/es/account'

diff --git a/docs/api/account/memory.md b/docs/api/account/memory.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/account/memory
 Memory Account module
 
-**Export**: MemoryAccount  
 **Example**  
 ```js
 import MemoryAccount from '@aeternity/aepp-sdk/es/account/memory'

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

diff --git a/docs/api/accounts.md b/docs/api/accounts.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/accounts
 Accounts module
 
-**Export**: Accounts  
 **Example**  
 ```js
 import Accounts from '@aeternity/aepp-sdk/es/accounts'

diff --git a/docs/api/ae.md b/docs/api/ae.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/ae
 Ae module
 
-**Export**: Ae  
 **Example**  
 ```js
 import Ae from '@aeternity/aepp-sdk/es/ae'

diff --git a/docs/api/ae/aens.md b/docs/api/ae/aens.md
@@ -7,7 +7,6 @@ The high-level description of the naming system is
 https://github.com/aeternity/protocol/blob/master/AENS.md in the protocol
 repository.
 
-**Export**: Aens  
 **Example**  
 ```js
 import Aens from '@aeternity/aepp-sdk/es/ae/aens'

diff --git a/docs/api/ae/aepp.md b/docs/api/ae/aepp.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/ae/aepp
 Aepp module
 
-**Export**: Aepp  
 **Example**  
 ```js
 import Ae from '@aeternity/aepp-sdk/es/ae/aepp'

diff --git a/docs/api/ae/contract.md b/docs/api/ae/contract.md
@@ -6,7 +6,6 @@ Contract module - routines to interact with the æternity contract
 High level documentation of the contracts are available at
 https://github.com/aeternity/protocol/tree/master/contracts and
 
-**Export**: Contract  
 **Example**  
 ```js
 import Contract from '@aeternity/aepp-sdk/es/ae/contract' (Using tree-shaking)

diff --git a/docs/api/ae/oracle.md b/docs/api/ae/oracle.md
@@ -7,7 +7,6 @@ The high-level description of the oracle system is
 https://github.com/aeternity/protocol/blob/master/ORACLE.md in the protocol
 repository.
 
-**Export**: Oracle  
 **Example**  
 ```js
 import Oracle from '@aeternity/aepp-sdk/es/ae/oracle'

diff --git a/docs/api/ae/universal.md b/docs/api/ae/universal.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/ae/universal
 Universal module
 
-**Export**: Universal  
 **Example**  
 ```js
 import Ae from '@aeternity/aepp-sdk/es/ae/universal'

diff --git a/docs/api/ae/wallet.md b/docs/api/ae/wallet.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/ae/wallet
 Wallet module
 
-**Export**: Wallet  
 **Example**  
 ```js
 import Wallet from '@aeternity/aepp-sdk/es/ae/wallet'

diff --git a/docs/api/chain.md b/docs/api/chain.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/chain
 Chain module
 
-**Export**: Chain  
 **Example**  
 ```js
 import Chain from '@aeternity/aepp-sdk/es/chain'

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

diff --git a/docs/api/channel/index.md b/docs/api/channel/index.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/channel/index
 Channel module
 
-**Export**: Channel  
 **Example**  
 ```js
 import Channel from '@aeternity/aepp-sdk/es/channel/index'

diff --git a/docs/api/contract.md b/docs/api/contract.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/contract
 Contract Base module
 
-**Export**: Contract  
 **Example**  
 ```js
 import ContractBase from '@aeternity/aepp-sdk/es/contract'

diff --git a/docs/api/contract/aci.md b/docs/api/contract/aci.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/contract/aci
 ContractACI module
 
-**Export**: ContractACI  
 **Example**  
 ```js
 import ContractACI from '@aeternity/aepp-sdk/es/contract/aci'

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

diff --git a/docs/api/node.md b/docs/api/node.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/node
 Node module
 
-**Export**: Node  
 **Example**  
 ```js
 import Node from '@aeternity/aepp-sdk/es/node'
@@ -12,8 +11,9 @@ import Node from '@aeternity/aepp-sdk/es/node'
 * [@aeternity/aepp-sdk/es/node](#module_@aeternity/aepp-sdk/es/node)
     * [Node([options])](#exp_module_@aeternity/aepp-sdk/es/node--Node) ⇒ `Object` ⏏
         * [~loader(options)](#module_@aeternity/aepp-sdk/es/node--Node..loader) ⇒ `function`
+        * [~getConsensusProtocolVersion(protocols, height)](#module_@aeternity/aepp-sdk/es/node--Node..getConsensusProtocolVersion) ⇒ `Number`
         * _async_
-            * [~remoteSwag(url)](#module_@aeternity/aepp-sdk/es/node--Node..remoteSwag) ⇒ `Object`
+            * [~remoteSwag(url, axiosConfig)](#module_@aeternity/aepp-sdk/es/node--Node..remoteSwag) ⇒ `Object`
 
 <a id="exp_module_@aeternity/aepp-sdk/es/node--Node"></a>
 
@@ -29,6 +29,7 @@ import Node from '@aeternity/aepp-sdk/es/node'
 | [options] | `Object` | <code>{}</code> | Options |
 | options.url | `String` |  | Base URL for Node |
 | options.internalUrl | `String` |  | Base URL for internal requests |
+| options.axiosConfig | `String` |  | Object with axios configuration. Example { config: {}, errorHandler: (err) => throw err } |
 
 **Example**  
 ```js
@@ -49,9 +50,22 @@ Node specific loader for `urlFor`
 | options.url | `String` | Base URL for Node |
 | options.internalUrl | `String` | Base URL for internal requests |
 
+<a id="module_@aeternity/aepp-sdk/es/node--Node..getConsensusProtocolVersion"></a>
+
+#### Node~getConsensusProtocolVersion(protocols, height) ⇒ `Number`
+get consensus protocol version
+
+**Kind**: inner method of [`Node`](#exp_module_@aeternity/aepp-sdk/es/node--Node)  
+**Returns**: `Number` - version Protocol version  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| protocols | `Array` | Array of protocols |
+| height | `Number` | Height |
+
 <a id="module_@aeternity/aepp-sdk/es/node--Node..remoteSwag"></a>
 
-#### Node~remoteSwag(url) ⇒ `Object`
+#### Node~remoteSwag(url, axiosConfig) ⇒ `Object`
 Obtain Swagger configuration from Node node
 
 **Kind**: inner method of [`Node`](#exp_module_@aeternity/aepp-sdk/es/node--Node)  
@@ -62,4 +76,5 @@ Obtain Swagger configuration from Node node
 | Param | Type | Description |
 | --- | --- | --- |
 | url | `String` | Node base URL |
+| axiosConfig | `Object` | Axios configuration object |
 
diff --git a/docs/api/oracle.md b/docs/api/oracle.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/oracle
 Oracle Base module
 
-**Export**: Contract  
 **Example**  
 ```js
 import ContractBase from '@aeternity/aepp-sdk/es/oracle'

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

diff --git a/docs/api/rpc/client.md b/docs/api/rpc/client.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/rpc/client
 RPC client module
 
-**Export**: RpcClient  
 **Example**  
 ```js
 import RpcClient from '@aeternity/aepp-sdk/es/rpc/client'

diff --git a/docs/api/tx.md b/docs/api/tx.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/tx
 Tx module
 
-**Export**: Tx  
 **Example**  
 ```js
 import Tx from '@aeternity/aepp-sdk/es/tx'

diff --git a/docs/api/tx/builder.md b/docs/api/tx/builder.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/tx/builder
 JavaScript-based Transaction builder
 
-**Export**: TxBuilder  
 **Example**  
 ```js
 import Transaction from '@aeternity/aepp-sdk/es/tx/builder'

diff --git a/docs/api/tx/builder/helpers.md b/docs/api/tx/builder/helpers.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/tx/builder/helpers
 JavaScript-based Transaction builder helper function's
 
-**Export**: TxBuilderHelper  
 **Example**  
 ```js
 import TxBuilderHelper from '@aeternity/aepp-sdk/es/tx/builder/helpers'

diff --git a/docs/api/tx/builder/schema.md b/docs/api/tx/builder/schema.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/tx/builder/schema
 Transaction Schema for TxBuilder
 
-**Export**: TxSchema  
 **Example**  
 ```js
 import TxSchema from '@aeternity/aepp-sdk/es/tx/builder/schema'

diff --git a/docs/api/tx/tx.md b/docs/api/tx/tx.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/tx/tx
 Transaction module
 
-**Export**: Transaction  
 **Example**  
 ```js
 import Transaction from '@aeternity/aepp-sdk/es/tx/tx'

diff --git a/docs/api/tx/validator.md b/docs/api/tx/validator.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/tx/validator
 Transaction validator
 
-**Export**: TransactionValidator  
 **Example**  
 ```js
 import TransactionValidator from '@aeternity/aepp-sdk/es/tx/validator'

diff --git a/docs/api/utils/swagger.md b/docs/api/utils/swagger.md
@@ -3,7 +3,6 @@
 ## @aeternity/aepp-sdk/es/utils/swagger
 Swagger module
 
-**Export**: Swagger  
 **Example**  
 ```js
 import Swagger from '@aeternity/aepp-sdk/es/utils/swagger'
@@ -44,6 +43,7 @@ Swagger Stamp
 | --- | --- | --- |
 | options | `Object` | Initializer object |
 | options.swag | `Object` | Swagger definition |
+| options.axiosConfig | `Object` | Object with axios configuration. Example { config: {}, errorHandler: (err) => throw err } |
 
 **Example**  
 ```js

diff --git a/es/channel/internal.js b/es/channel/internal.js
@@ -21,9 +21,6 @@ import * as R from 'ramda'
 import { pascalToSnake } from '../utils/string'
 import { awaitingConnection } from './handlers'
 
-const PING_TIMEOUT_MS = 10000
-const PONG_TIMEOUT_MS = 5000
-
 const options = new WeakMap()
 const status = new WeakMap()
 const state = new WeakMap()
@@ -37,8 +34,6 @@ const actionQueueLocked = new WeakMap()
 const sequence = new WeakMap()
 const channelId = new WeakMap()
 const rpcCallbacks = new WeakMap()
-const pingTimeoutId = new WeakMap()
-const pongTimeoutId = new WeakMap()
 
 function channelURL (url, params) {
   const paramString = R.join('&', R.values(R.mapObjIndexed((value, key) =>
@@ -159,21 +154,10 @@ function call (channel, method, params) {
   })
 }
 
-function ping (channel) {
-  const ws = websockets.get(channel)
-  if (ws.readyState === ws.OPEN) {
-    ws._connection.ping()
-    clearTimeout(pongTimeoutId.get(channel))
-    pongTimeoutId.set(channel, setTimeout(() => ws._connection.drop(), PONG_TIMEOUT_MS))
-  }
-}
-
 function disconnect (channel) {
   const ws = websockets.get(channel)
   if (ws.readyState === ws.OPEN) {
     ws._connection.close()
-    clearTimeout(pongTimeoutId.get(channel))
-    clearTimeout(pingTimeoutId.get(channel))
   }
 }
 
@@ -213,12 +197,6 @@ async function initialize (channel, channelOptions) {
     onclose: () => changeStatus(channel, 'disconnected'),
     onmessage: ({ data }) => onMessage(channel, data)
   })
-  ws._connection.on('pong', () => {
-    clearTimeout(pongTimeoutId.get(channel))
-    clearTimeout(pingTimeoutId.get(channel))
-    pingTimeoutId.set(channel, setTimeout(() => ping(channel), PING_TIMEOUT_MS))
-  })
-  pingTimeoutId.set(channel, setTimeout(() => ping(channel), PING_TIMEOUT_MS))
   websockets.set(channel, ws)
 }