Realign 5.0.0

CHANGELOG.md

@@ -1,3 +1,40 @@
+# [5.0.0](https://github.com/aeternity/aepp-sdk-js/compare/4.7.0...5.0.0) (2019-10-04)
+
+
+### Bug Fixes
+
+* **rpc:** fix resolution rpc ops ([#669](https://github.com/aeternity/aepp-sdk-js/issues/669)) ([abd7c56](https://github.com/aeternity/aepp-sdk-js/commit/abd7c56))
+
+
+### Code Refactoring
+
+* **ACI:** rework Sophia Option type representation ([#691](https://github.com/aeternity/aepp-sdk-js/issues/691)) ([0dbb2fe](https://github.com/aeternity/aepp-sdk-js/commit/0dbb2fe))
+
+
+### Features
+
+* **AENS:** Add ability to spend by name ([#682](https://github.com/aeternity/aepp-sdk-js/issues/682)) ([0d43804](https://github.com/aeternity/aepp-sdk-js/commit/0d43804))
+* **AENS:** Add ability to claim contract, oracle, SC ([#671](https://github.com/aeternity/aepp-sdk-js/issues/671)) ([49fd0fd](https://github.com/aeternity/aepp-sdk-js/commit/49fd0fd))
+* **GA:** enbale GA ([#692](https://github.com/aeternity/aepp-sdk-js/issues/692)) ([eded912](https://github.com/aeternity/aepp-sdk-js/commit/eded912))
+* **Lima:** Lima compatibility ([#683](https://github.com/aeternity/aepp-sdk-js/issues/683)) ([a88042e](https://github.com/aeternity/aepp-sdk-js/commit/a88042e)), closes [#632](https://github.com/aeternity/aepp-sdk-js/issues/632) [#653](https://github.com/aeternity/aepp-sdk-js/issues/653) [#658](https://github.com/aeternity/aepp-sdk-js/issues/658) [#660](https://github.com/aeternity/aepp-sdk-js/issues/660) [#680](https://github.com/aeternity/aepp-sdk-js/issues/680) [#693](https://github.com/aeternity/aepp-sdk-js/issues/693) [#687](https://github.com/aeternity/aepp-sdk-js/issues/687)
+    - AENS auction support
+    - compiler 4.0.0 support
+    - node 5.0.0 support
+    - SDK use `FATE` for contract by default
+* **AE**: Add pointers verification for spend by name   
+
+### BREAKING CHANGES
+
+* **aci:** Change Sophia option type representation in ACI
+```js
+// from
+await contract.methods.optionFn(Promise.resolve(1) || Promise.reject())
+// to
+await contract.methods.optionFn(1 || undefined)
+```
+
+
+
 # [5.0.0-next.1](https://github.com/aeternity/aepp-sdk-js/compare/4.6.0...4.7.0-next.1) (2019-09-10)
 
 

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'

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'

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**: Selector  
 **Example**  
 ```js
 import Selector from '@aeternity/aepp-sdk/es/account/selector'

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'

docs/api/ae.md

@@ -3,19 +3,21 @@
 ## @aeternity/aepp-sdk/es/ae
 Ae module
 
-**Export**: Ae  
 **Example**  
 ```js
 import Ae from '@aeternity/aepp-sdk/es/ae'
 ```
 
 * [@aeternity/aepp-sdk/es/ae](#module_@aeternity/aepp-sdk/es/ae)
     * [Ae([options])](#exp_module_@aeternity/aepp-sdk/es/ae--Ae) ⇒ `Object` ⏏
-        * [.destroyInstance()](#module_@aeternity/aepp-sdk/es/ae--Ae+destroyInstance) ⇒ `void`
-        * _async_
-            * [.send(tx, [options])](#module_@aeternity/aepp-sdk/es/ae--Ae+send) ⇒ `String` \| `String`
-            * [.spend(amount, recipientId, options)](#module_@aeternity/aepp-sdk/es/ae--Ae+spend) ⇒ `String` \| `String`
-            * [.transferFunds(percentage, recipientId, options)](#module_@aeternity/aepp-sdk/es/ae--Ae+transferFunds) ⇒ `String` \| `String`
+        * _instance_
+            * [.destroyInstance()](#module_@aeternity/aepp-sdk/es/ae--Ae+destroyInstance) ⇒ `void`
+            * _async_
+                * [.send(tx, [options])](#module_@aeternity/aepp-sdk/es/ae--Ae+send) ⇒ `String` \| `String`
+                * [.spend(amount, recipientId, options)](#module_@aeternity/aepp-sdk/es/ae--Ae+spend) ⇒ `String` \| `String`
+                * [.transferFunds(percentage, recipientId, options)](#module_@aeternity/aepp-sdk/es/ae--Ae+transferFunds) ⇒ `String` \| `String`
+        * _inner_
+            * [~resolveRecipientName(nameOrAddress, verify)](#module_@aeternity/aepp-sdk/es/ae--Ae..resolveRecipientName) ⇒ `String`
 
 <a id="exp_module_@aeternity/aepp-sdk/es/ae--Ae"></a>
 
@@ -76,7 +78,7 @@ Send tokens to another account
 | Param | Type | Description |
 | --- | --- | --- |
 | amount | `Number` \| `String` | Amount to spend |
-| recipientId | `String` | Address of recipient account |
+| recipientId | `String` | Address or Name of recipient account |
 | options | `Object` | Options |
 
 <a id="module_@aeternity/aepp-sdk/es/ae--Ae+transferFunds"></a>
@@ -95,3 +97,16 @@ Send a percentage of funds to another account
 | recipientId | `String` | Address of recipient account |
 | options | `Object` | Options |
 
+<a id="module_@aeternity/aepp-sdk/es/ae--Ae..resolveRecipientName"></a>
+
+#### Ae~resolveRecipientName(nameOrAddress, verify) ⇒ `String`
+Resolve AENS name and return name hash
+
+**Kind**: inner method of [`Ae`](#exp_module_@aeternity/aepp-sdk/es/ae--Ae)  
+**Returns**: `String` - Address or AENS name hash  
+
+| Param | Type |
+| --- | --- |
+| nameOrAddress | `String` | 
+| verify |  | 
+

docs/api/ae/aens.md

@@ -7,14 +7,15 @@ 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'
 ```
 
 * [@aeternity/aepp-sdk/es/ae/aens](#module_@aeternity/aepp-sdk/es/ae/aens)
     * [Aens([options])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--Aens) ⇒ `Object` ⏏
+    * _global_
+        * [exports.isNameValid(name, [throwError])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--exports.isNameValid) ⇒ ⏏
     * _instance_
         * [.update(nameId, target, options)](#exp_module_@aeternity/aepp-sdk/es/ae/aens--update) ⇒ `Object` ⏏
         * [.query(name)](#exp_module_@aeternity/aepp-sdk/es/ae/aens--query) ⇒ `Promise.<Object>` ⏏
@@ -40,6 +41,23 @@ Aens provides name-system related methods atop
 | --- | --- | --- | --- |
 | [options] | `Object` | <code>{}</code> | Initializer object |
 
+<a id="exp_module_@aeternity/aepp-sdk/es/ae/aens--exports.isNameValid"></a>
+
+### exports.isNameValid(name, [throwError]) ⇒ ⏏
+Is name valid
+
+**Kind**: global method of [`@aeternity/aepp-sdk/es/ae/aens`](#module_@aeternity/aepp-sdk/es/ae/aens)  
+**Returns**: Boolean  
+**Throws**:
+
+- Error
+
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| name | `string` |  |  |
+| [throwError] | `boolean` | <code>true</code> | Throw error on invalid |
+
 <a id="exp_module_@aeternity/aepp-sdk/es/ae/aens--update"></a>
 
 ### .update(nameId, target, options) ⇒ `Object` ⏏

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'

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)
@@ -93,6 +92,7 @@ Encode call data for contract call
 | args | `Array` |  | Argument's for call |
 | [options] | `Object` | <code>{}</code> | Options |
 | [options.filesystem] | `Object` | <code>{}</code> | Contract external namespaces map |
+| [options.backend] | `Object` | <code>&#x27;fate&#x27;</code> | Compiler backend |
 
 <a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--contractDecodeData"></a>
 
@@ -215,6 +215,7 @@ Compile contract source code
 | source | `String` |  | Contract sourece code |
 | [options] | `Object` | <code>{}</code> | Transaction options (fee, ttl, gas, amount, deposit) |
 | [options.filesystem] | `Object` | <code>{}</code> | Contract external namespaces map* @return {Promise<Object>} Result object |
+| [options.backend] | `Object` | <code>&#x27;aevm&#x27;</code> | Contract backend version (aevm|fate) |
 
 **Example**  
 ```js

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'
@@ -18,6 +17,7 @@ import Oracle from '@aeternity/aepp-sdk/es/ae/oracle'
     * _instance_
         * _async_
             * [.getOracleObject(oracleId)](#exp_module_@aeternity/aepp-sdk/es/ae/oracle--getOracleObject) ⇒ `Promise.<Object>` ⏏
+            * [.exports.pollForQueries(oracleId, onQuery, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/oracle--exports.pollForQueries) ⇒ `function` ⏏
             * [.getQueryObject(oracleId, queryId)](#exp_module_@aeternity/aepp-sdk/es/ae/oracle--getQueryObject) ⇒ `Promise.<Object>` ⏏
             * [.exports.pollForQueryResponse(oracleId, queryId, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/oracle--exports.pollForQueryResponse) ⇒ `Promise.<Object>` ⏏
             * [.registerOracle(queryFormat, responseFormat, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/oracle--registerOracle) ⇒ `Promise.<Object>` ⏏
@@ -54,6 +54,22 @@ Constructor for Oracle Object (helper object for using Oracle)
 | --- | --- | --- |
 | oracleId | `String` | Oracle public key |
 
+<a id="exp_module_@aeternity/aepp-sdk/es/ae/oracle--exports.pollForQueries"></a>
+
+### .exports.pollForQueries(oracleId, onQuery, [options]) ⇒ `function` ⏏
+Poll for oracle queries
+
+**Kind**: instance method of [`@aeternity/aepp-sdk/es/ae/oracle`](#module_@aeternity/aepp-sdk/es/ae/oracle)  
+**Returns**: `function` - stopPolling - Stop polling function  
+**Category**: async  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| oracleId | `String` | Oracle public key |
+| onQuery | `function` | OnQuery callback |
+| [options] | `Object` | Options object |
+| [options.interval] | `Object` | Poll interval(default: 5000) |
+
 <a id="exp_module_@aeternity/aepp-sdk/es/ae/oracle--getQueryObject"></a>
 
 ### .getQueryObject(oracleId, queryId) ⇒ `Promise.&lt;Object&gt;` ⏏

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'

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'

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'

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'

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'

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'

docs/api/contract/ga.md

@@ -23,7 +23,7 @@ import { GeneralizeAccount } from '@aeternity/aepp-sdk' (Using bundle)
 GeneralizeAccount Stamp
 
 Provide Generalize Account implementation
-[module:@aeternity/aepp-sdk/es/contract.ga](module:@aeternity/aepp-sdk/es/contract.ga) clients.
+[@aeternity/aepp-sdk/es/contract/ga](#module_@aeternity/aepp-sdk/es/contract/ga) clients.
 
 **Kind**: Exported function  
 **Returns**: `Object` - GeneralizeAccount instance  

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'

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'

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'

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'

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'

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'

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'

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'

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'

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'