diff --git a/CHANGELOG.md b/CHANGELOG.md index e3189dad14..193373dcd9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,12 @@ +## [6.0.2](https://github.com/aeternity/aepp-sdk-js/compare/6.0.1...6.0.2) (2019-10-31) + + +### Bug Fixes + +* **name claim:** Revert ignoring waitMined from user passed options (#727) + + + ## [6.0.1](https://github.com/aeternity/aepp-sdk-js/compare/6.0.0...6.0.1) (2019-10-29) diff --git a/docs/api/ae.md b/docs/api/ae.md index 691907d43f..b2b92c1faf 100644 --- a/docs/api/ae.md +++ b/docs/api/ae.md @@ -13,7 +13,6 @@ import Ae from '@aeternity/aepp-sdk/es/ae' * _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_ diff --git a/docs/api/ae/aens.md b/docs/api/ae/aens.md index 3e4d65f561..e48608bc66 100644 --- a/docs/api/ae/aens.md +++ b/docs/api/ae/aens.md @@ -14,8 +14,6 @@ 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_ * _async_ * [.update(nameId, target, options)](#exp_module_@aeternity/aepp-sdk/es/ae/aens--update) ⇒ `Object` ⏏ @@ -41,23 +39,6 @@ Aens provides name-system related methods atop | --- | --- | --- | --- | | [options] | `Object` | {} | Initializer object | - - -### 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` | true | Throw error on invalid | - ### .update(nameId, target, options) ⇒ `Object` ⏏ diff --git a/docs/api/ae/oracle.md b/docs/api/ae/oracle.md index 7eed453316..c8e45a528f 100644 --- a/docs/api/ae/oracle.md +++ b/docs/api/ae/oracle.md @@ -16,8 +16,7 @@ import Oracle from '@aeternity/aepp-sdk/es/ae/oracle' * [Oracle([options])](#exp_module_@aeternity/aepp-sdk/es/ae/oracle--Oracle) ⇒ `Object` ⏏ * _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` ⏏ + * [.pollForQueries(oracleId, onQuery, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/oracle--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>` ⏏ @@ -57,34 +56,6 @@ Poll for oracle queries | [options] | `Object` | Options object | | [options.interval] | `Object` | Poll interval(default: 5000) | -### .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) | - -### .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) | - ### .getQueryObject(oracleId, queryId) ⇒ `Promise.<Object>` ⏏ diff --git a/docs/api/chain.md b/docs/api/chain.md index 28ec9f6689..6f7aa6159e 100644 --- a/docs/api/chain.md +++ b/docs/api/chain.md @@ -30,26 +30,12 @@ import Chain from '@aeternity/aepp-sdk/es/chain' * _static_ * [.waitMined(bool)](#module_@aeternity/aepp-sdk/es/chain.waitMined) ⇒ `Stamp` -### Chain([options]) ⇒ `Object` ⏏ -Basic Chain Stamp + -Attempting to create instances from the Stamp without overwriting all -abstract methods using composition will result in an exception. - -**Kind**: Exported function -**Returns**: `Object` - Chain instance -**rtype**: `Stamp` - -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| [options] | `Object` | {} | Initializer object | - - - -#### *chain.sendTransaction(tx, [options]) ⇒ `Object` \| `String`* +### *@aeternity/aepp-sdk/es/chain.sendTransaction(tx, [options]) ⇒ `Object` \| `String`* Submit a signed transaction for mining -**Kind**: instance abstract method of [`Chain`](#exp_module_@aeternity/aepp-sdk/es/chain--Chain) +**Kind**: instance abstract method of [`@aeternity/aepp-sdk/es/chain`](#module_@aeternity/aepp-sdk/es/chain) **Returns**: `Object` \| `String` - Transaction or transaction hash **Category**: async **rtype**: `(tx: String, options?: Object) => tx: Promise[Object]|txHash: Promise[String]` diff --git a/docs/api/contract.md b/docs/api/contract.md index 769294890b..283981ec3c 100644 --- a/docs/api/contract.md +++ b/docs/api/contract.md @@ -19,24 +19,9 @@ import ContractBase from '@aeternity/aepp-sdk/es/contract' * *[.setCompilerUrl(url)](#module_@aeternity/aepp-sdk/es/contract+setCompilerUrl) ⇒ `void`* * *[.getCompilerVersion()](#module_@aeternity/aepp-sdk/es/contract+getCompilerVersion) ⇒ `String`* -### ContractBase([options]) ⇒ `Object` ⏏ -Basic Contract Stamp + -This stamp include api call's related to contract functionality. -Attempting to create instances from the Stamp without overwriting all -abstract methods using composition will result in an exception. - -**Kind**: Exported function -**Returns**: `Object` - Contract instance -**rtype**: `Stamp` - -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| [options] | `Object` | {} | Initializer object | - - - -#### *contractBase.contractGetACI(source, [options]) ⇒ `Object`* +### *@aeternity/aepp-sdk/es/contract.contractGetACI(source, [options]) ⇒ `Object`* Get contract ACI **Kind**: instance abstract method of [`@aeternity/aepp-sdk/es/contract`](#module_@aeternity/aepp-sdk/es/contract) diff --git a/docs/api/contract/ga.md b/docs/api/contract/ga.md index 74fae2afb3..b35a5c0d4f 100644 --- a/docs/api/contract/ga.md +++ b/docs/api/contract/ga.md @@ -13,36 +13,9 @@ import { GeneralizeAccount } from '@aeternity/aepp-sdk' (Using bundle) ``` * [@aeternity/aepp-sdk/es/contract/ga](#module_@aeternity/aepp-sdk/es/contract/ga) - * [exports.GeneralizeAccount([options])](#exp_module_@aeternity/aepp-sdk/es/contract/ga--exports.GeneralizeAccount) ⇒ `Object` ⏏ * [createGeneralizeAccount(authFnName, source, args, options)](#exp_module_@aeternity/aepp-sdk/es/contract/ga--createGeneralizeAccount) ⇒ `Promise.<Readonly.<{result: \*, owner: \*, createdAt: Date, address, rawTx: \*, transaction: \*}>>` ⏏ * [createMetaTx(rawTransaction, authData, authFnName, options)](#exp_module_@aeternity/aepp-sdk/es/contract/ga--createMetaTx) ⇒ `String` ⏏ - - -### exports.GeneralizeAccount([options]) ⇒ `Object` ⏏ -GeneralizeAccount Stamp - -Provide Generalize Account implementation -[@aeternity/aepp-sdk/es/contract/ga](#module_@aeternity/aepp-sdk/es/contract/ga) clients. - -**Kind**: Exported function -**Returns**: `Object` - GeneralizeAccount instance -**rtype**: `Stamp` - -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| [options] | `Object` | {} | Initializer object | - -**Example** -```js -const authContract = `` -await client.createGeneralizeAccount(authFnName, authContract, [...authFnArguments] -// Make spend using GA -const callData = 'cb_...' // encoded call data for auth contract -await client.spend(10000, receiverPub, { authData: { callData } }) -// or -await client.spend(10000, receiverPub, { authData: { source: authContract, args: [...authContractArgs] } }) // sdk will prepare callData itself -``` ### createGeneralizeAccount(authFnName, source, args, options) ⇒ `Promise.<Readonly.<{result: \*, owner: \*, createdAt: Date, address, rawTx: \*, transaction: \*}>>` ⏏ diff --git a/package-lock.json b/package-lock.json index 2af0187fab..94f1d54c08 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@aeternity/aepp-sdk", - "version": "6.0.1", + "version": "6.0.2", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -9943,7 +9943,7 @@ }, "strip-eof": { "version": "1.0.0", - "resolved": "http://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz", + "resolved": "https://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz", "integrity": "sha1-u0P/VZim6wXYm1n80SnJgzE2Br8=", "dev": true }, diff --git a/package.json b/package.json index d4bfc151d3..66ad0d6f3c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@aeternity/aepp-sdk", - "version": "6.0.1", + "version": "6.0.2", "description": "SDK for the æternity blockchain", "main": "dist/aepp-sdk.js", "browser": "dist/aepp-sdk.browser.js",