documentation and api changes to remove seed generation

thedewpoint · Jan 28, 2018 · d1733de · d1733de
1 parent 714f837
commit d1733de
Show file tree

Hide file tree

Showing 19 changed files with 68 additions and 119 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 
 
 
+
 # Iota-basic
 [![Build Status](https://travis-ci.org/thedewpoint/iotauth.svg?branch=master)](https://travis-ci.org/thedewpoint/iota-basic.svg?branch=master)
 [![Coverage Status](https://coveralls.io/repos/github/thedewpoint/iota-basic/badge.svg?branch=master&service=github)](https://coveralls.io/github/thedewpoint/iota-basic?branch=master)
@@ -16,6 +17,8 @@ There are many pieces to learn in order to successfully interact with the API, a
 Only Node version 8.x.x is supported at this time due to FFI not working on node version 9.
 related issue: https://github.com/node-ffi/node-ffi/issues/438
 
+NOTE: As of version 2.0 seed generation has been moved as a directive from the foundation for no 3rd party seed generators. 
+
 Using npm:
 ```shell
 $ npm i --save iota-basic
@@ -39,8 +42,6 @@ iota.sendTransaction("RECEIVEADDRESS9999",1).then((success)=>{
 //with await async
 const success = await iota.sendTransaction("RECEIVEADDRESS9999",1);
 
-//generating a secure seed using crypto library in node and window.crypto in browser
-const seed = await iota.generateSeed();
 
 //getting accountdata for your seed
 const accountData = await iota.getAccountData();
@@ -68,9 +69,7 @@ const receiveAddress = await iota.getReceiveAddress();
 * ["impl/CurlHash"](modules/_impl_curlhash_.md)
 * ["impl/CurlHashWebGl"](modules/_impl_curlhashwebgl_.md)
 * ["impl/IotaBasic"](modules/_impl_iotabasic_.md)
-* ["impl/SeedGeneratorFactory"](modules/_impl_seedgeneratorfactory_.md)
-* ["impl/SeedGeneratorNode"](modules/_impl_seedgeneratornode_.md)
-* ["impl/SeedGeneratorWeb"](modules/_impl_seedgeneratorweb_.md)
+
 
 
 

diff --git a/classes/_impl_curlfactory_.curlfactory.md b/classes/_impl_curlfactory_.curlfactory.md
@@ -28,7 +28,7 @@ Factory for returning an implementation of ICurlHash depending on whether the pr
 
 
 
-*Defined in [impl/CurlFactory.ts:12](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/CurlFactory.ts#L12)*
+*Defined in [impl/CurlFactory.ts:12](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/CurlFactory.ts#L12)*
 
 
 
@@ -53,7 +53,7 @@ ___
 
 
 
-*Defined in [impl/CurlFactory.ts:24](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/CurlFactory.ts#L24)*
+*Defined in [impl/CurlFactory.ts:24](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/CurlFactory.ts#L24)*
 
 
 

diff --git a/classes/_impl_curlhash_.curlhash.md b/classes/_impl_curlhash_.curlhash.md
@@ -34,7 +34,7 @@ CurlHash leverages the CCurl binary and ccurl.interface.js to do pow this implem
 
 *Implementation of [ICurlHash](../interfaces/_api_curlhash_.icurlhash.md).[init](../interfaces/_api_curlhash_.icurlhash.md#init)*
 
-*Defined in [impl/CurlHash.ts:17](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/CurlHash.ts#L17)*
+*Defined in [impl/CurlHash.ts:17](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/CurlHash.ts#L17)*
 
 
 
@@ -67,7 +67,7 @@ ___
 
 
 
-*Defined in [impl/CurlHash.ts:25](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/CurlHash.ts#L25)*
+*Defined in [impl/CurlHash.ts:25](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/CurlHash.ts#L25)*
 
 
 

diff --git a/classes/_impl_curlhashwebgl_.curlhashwebgl.md b/classes/_impl_curlhashwebgl_.curlhashwebgl.md
@@ -33,7 +33,7 @@ CurlHashWebGl leverages the webgl2 library in browser through the curl.lib.js de
 
 
 
-*Defined in [impl/CurlHashWebGl.ts:23](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/CurlHashWebGl.ts#L23)*
+*Defined in [impl/CurlHashWebGl.ts:24](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/CurlHashWebGl.ts#L24)*
 
 
 
@@ -65,7 +65,7 @@ ___
 
 *Implementation of [ICurlHash](../interfaces/_api_curlhash_.icurlhash.md).[init](../interfaces/_api_curlhash_.icurlhash.md#init)*
 
-*Defined in [impl/CurlHashWebGl.ts:18](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/CurlHashWebGl.ts#L18)*
+*Defined in [impl/CurlHashWebGl.ts:18](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/CurlHashWebGl.ts#L18)*
 
 
 

diff --git a/classes/_impl_iotabasic_.iota.md b/classes/_impl_iotabasic_.iota.md
@@ -28,7 +28,6 @@ implementation of the IIotaBasic interface
 
 ### Methods
 
-* [generateSeed](_impl_iotabasic_.iota.md#generateseed)
 * [getAccountData](_impl_iotabasic_.iota.md#getaccountdata)
 * [getBalance](_impl_iotabasic_.iota.md#getbalance)
 * [getChecksum](_impl_iotabasic_.iota.md#getchecksum)
@@ -45,7 +44,7 @@ implementation of the IIotaBasic interface
 ### ⊕ **new Iota**(seed: *`string`*, node?: *`string`*, testClient?: *`any`*, pow?: *`boolean`*): [Iota](_impl_iotabasic_.iota.md)
 
 
-*Defined in [impl/IotaBasic.ts:22](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/IotaBasic.ts#L22)*
+*Defined in [impl/IotaBasic.ts:22](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/IotaBasic.ts#L22)*
 
 
 
@@ -79,7 +78,7 @@ init function takes the iotaclient and overrides attachToTangle
 
 **●  ccurlProvider**:  *[ICurlHash](../interfaces/_api_curlhash_.icurlhash.md)* 
 
-*Defined in [impl/IotaBasic.ts:18](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/IotaBasic.ts#L18)*
+*Defined in [impl/IotaBasic.ts:18](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/IotaBasic.ts#L18)*
 
 
 
@@ -93,7 +92,7 @@ ___
 
 **●  iota**:  *`any`* 
 
-*Defined in [impl/IotaBasic.ts:22](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/IotaBasic.ts#L22)*
+*Defined in [impl/IotaBasic.ts:22](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/IotaBasic.ts#L22)*
 
 
 
@@ -107,7 +106,7 @@ ___
 
 **●  seed**:  *`string`* 
 
-*Defined in [impl/IotaBasic.ts:21](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/IotaBasic.ts#L21)*
+*Defined in [impl/IotaBasic.ts:21](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/IotaBasic.ts#L21)*
 
 
 
@@ -121,7 +120,7 @@ ___
 
 **●  seedGenerator**:  *[ISeedGenerator](../interfaces/_api_seedgenerator_.iseedgenerator.md)* 
 
-*Defined in [impl/IotaBasic.ts:19](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/IotaBasic.ts#L19)*
+*Defined in [impl/IotaBasic.ts:19](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/IotaBasic.ts#L19)*
 
 
 
@@ -131,33 +130,6 @@ ___
 
 
 ## Methods
-<a id="generateseed"></a>
-
-###  generateSeed
-
-► **generateSeed**(): `Promise`.<`string`>
-
-
-
-*Implementation of [IIotaBasic](../interfaces/_api_iotabasic_.iiotabasic.md).[generateSeed](../interfaces/_api_iotabasic_.iiotabasic.md#generateseed)*
-
-*Defined in [impl/IotaBasic.ts:69](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/IotaBasic.ts#L69)*
-
-
-
-Generate a secure seed using an implementation of SeedGenerator
-
-
-
-
-**Returns:** `Promise`.<`string`>
-
-
-
-
-
-___
-
 <a id="getaccountdata"></a>
 
 ###  getAccountData
@@ -168,7 +140,7 @@ ___
 
 *Implementation of [IIotaBasic](../interfaces/_api_iotabasic_.iiotabasic.md).[getAccountData](../interfaces/_api_iotabasic_.iiotabasic.md#getaccountdata)*
 
-*Defined in [impl/IotaBasic.ts:121](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/IotaBasic.ts#L121)*
+*Defined in [impl/IotaBasic.ts:121](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/IotaBasic.ts#L121)*
 
 
 
@@ -195,7 +167,7 @@ ___
 
 *Implementation of [IIotaBasic](../interfaces/_api_iotabasic_.iiotabasic.md).[getBalance](../interfaces/_api_iotabasic_.iiotabasic.md#getbalance)*
 
-*Defined in [impl/IotaBasic.ts:107](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/IotaBasic.ts#L107)*
+*Defined in [impl/IotaBasic.ts:107](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/IotaBasic.ts#L107)*
 
 
 
@@ -222,7 +194,7 @@ ___
 
 *Implementation of [IIotaBasic](../interfaces/_api_iotabasic_.iiotabasic.md).[getChecksum](../interfaces/_api_iotabasic_.iiotabasic.md#getchecksum)*
 
-*Defined in [impl/IotaBasic.ts:139](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/IotaBasic.ts#L139)*
+*Defined in [impl/IotaBasic.ts:139](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/IotaBasic.ts#L139)*
 
 
 
@@ -249,7 +221,7 @@ ___
 
 *Implementation of [IIotaBasic](../interfaces/_api_iotabasic_.iiotabasic.md).[getReceiveAddress](../interfaces/_api_iotabasic_.iiotabasic.md#getreceiveaddress)*
 
-*Defined in [impl/IotaBasic.ts:50](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/IotaBasic.ts#L50)*
+*Defined in [impl/IotaBasic.ts:50](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/IotaBasic.ts#L50)*
 
 
 
@@ -276,7 +248,7 @@ ___
 
 *Implementation of [IIotaBasic](../interfaces/_api_iotabasic_.iiotabasic.md).[sendTransaction](../interfaces/_api_iotabasic_.iiotabasic.md#sendtransaction)*
 
-*Defined in [impl/IotaBasic.ts:78](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/IotaBasic.ts#L78)*
+*Defined in [impl/IotaBasic.ts:78](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/IotaBasic.ts#L78)*
 
 
 

diff --git a/classes/_impl_seedgeneratorfactory_.seedgeneratorfactory.md b/classes/_impl_seedgeneratorfactory_.seedgeneratorfactory.md
@@ -28,7 +28,7 @@ Factory for returning an implementation of ISeedGenerator depending on whether t
 
 
 
-*Defined in [impl/SeedGeneratorFactory.ts:11](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/SeedGeneratorFactory.ts#L11)*
+*Defined in [impl/SeedGeneratorFactory.ts:11](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/SeedGeneratorFactory.ts#L11)*
 
 
 
@@ -53,7 +53,7 @@ ___
 
 
 
-*Defined in [impl/SeedGeneratorFactory.ts:24](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/SeedGeneratorFactory.ts#L24)*
+*Defined in [impl/SeedGeneratorFactory.ts:24](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/SeedGeneratorFactory.ts#L24)*
 
 
 

diff --git a/classes/_impl_seedgeneratornode_.seedgeneratornode.md b/classes/_impl_seedgeneratornode_.seedgeneratornode.md
@@ -35,7 +35,7 @@ Seed generator using the node crypto library which uses system entropy to genera
 
 *Implementation of [ISeedGenerator](../interfaces/_api_seedgenerator_.iseedgenerator.md).[generateSeed](../interfaces/_api_seedgenerator_.iseedgenerator.md#generateseed)*
 
-*Defined in [impl/SeedGeneratorNode.ts:15](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/SeedGeneratorNode.ts#L15)*
+*Defined in [impl/SeedGeneratorNode.ts:15](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/SeedGeneratorNode.ts#L15)*
 
 
 
@@ -60,7 +60,7 @@ ___
 
 
 
-*Defined in [impl/SeedGeneratorNode.ts:22](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/SeedGeneratorNode.ts#L22)*
+*Defined in [impl/SeedGeneratorNode.ts:22](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/SeedGeneratorNode.ts#L22)*
 
 
 

diff --git a/classes/_impl_seedgeneratorweb_.seedgeneratorweb.md b/classes/_impl_seedgeneratorweb_.seedgeneratorweb.md
@@ -34,7 +34,7 @@ Seed generator using window.crypto library to securely generate a seed logic sha
 
 *Implementation of [ISeedGenerator](../interfaces/_api_seedgenerator_.iseedgenerator.md).[generateSeed](../interfaces/_api_seedgenerator_.iseedgenerator.md#generateseed)*
 
-*Defined in [impl/SeedGeneratorWeb.ts:15](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/impl/SeedGeneratorWeb.ts#L15)*
+*Defined in [impl/SeedGeneratorWeb.ts:15](https://github.com/thedewpoint/iota-basic/blob/714f837/src/impl/SeedGeneratorWeb.ts#L15)*
 
 
 

diff --git a/interfaces/_api_accountdata_.iaccountdata.md b/interfaces/_api_accountdata_.iaccountdata.md
@@ -15,7 +15,7 @@ Represents AccountData object returned by iota.lib.js getAccountData.
 
 **●  addresses**:  *`string`[]⎮`null`* 
 
-*Defined in [api/AccountData.ts:6](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/api/AccountData.ts#L6)*
+*Defined in [api/AccountData.ts:6](https://github.com/thedewpoint/iota-basic/blob/714f837/src/api/AccountData.ts#L6)*
 
 
 
@@ -29,7 +29,7 @@ ___
 
 **●  balance**:  *`number`* 
 
-*Defined in [api/AccountData.ts:9](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/api/AccountData.ts#L9)*
+*Defined in [api/AccountData.ts:9](https://github.com/thedewpoint/iota-basic/blob/714f837/src/api/AccountData.ts#L9)*
 
 
 
@@ -43,7 +43,7 @@ ___
 
 **●  inputs**:  *[IInput](_api_accountdata_.iinput.md)[]⎮`null`* 
 
-*Defined in [api/AccountData.ts:8](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/api/AccountData.ts#L8)*
+*Defined in [api/AccountData.ts:8](https://github.com/thedewpoint/iota-basic/blob/714f837/src/api/AccountData.ts#L8)*
 
 
 
@@ -57,7 +57,7 @@ ___
 
 **●  latestAddress**:  *`string`* 
 
-*Defined in [api/AccountData.ts:5](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/api/AccountData.ts#L5)*
+*Defined in [api/AccountData.ts:5](https://github.com/thedewpoint/iota-basic/blob/714f837/src/api/AccountData.ts#L5)*
 
 
 
@@ -71,7 +71,7 @@ ___
 
 **●  transfers**:  *[ITransfer](_api_accountdata_.itransfer.md)[]⎮`null`* 
 
-*Defined in [api/AccountData.ts:7](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/api/AccountData.ts#L7)*
+*Defined in [api/AccountData.ts:7](https://github.com/thedewpoint/iota-basic/blob/714f837/src/api/AccountData.ts#L7)*
 
 
 

diff --git a/interfaces/_api_accountdata_.iinput.md b/interfaces/_api_accountdata_.iinput.md
@@ -15,7 +15,7 @@ Represents Input object returned by iota.lib.js getInputs.
 
 **●  address**:  *`string`* 
 
-*Defined in [api/AccountData.ts:45](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/api/AccountData.ts#L45)*
+*Defined in [api/AccountData.ts:45](https://github.com/thedewpoint/iota-basic/blob/714f837/src/api/AccountData.ts#L45)*
 
 
 
@@ -29,7 +29,7 @@ ___
 
 **●  balance**:  *`number`* 
 
-*Defined in [api/AccountData.ts:46](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/api/AccountData.ts#L46)*
+*Defined in [api/AccountData.ts:46](https://github.com/thedewpoint/iota-basic/blob/714f837/src/api/AccountData.ts#L46)*
 
 
 
@@ -43,7 +43,7 @@ ___
 
 **●  keyIndex**:  *`number`* 
 
-*Defined in [api/AccountData.ts:47](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/api/AccountData.ts#L47)*
+*Defined in [api/AccountData.ts:47](https://github.com/thedewpoint/iota-basic/blob/714f837/src/api/AccountData.ts#L47)*
 
 
 
@@ -57,7 +57,7 @@ ___
 
 **●  security**:  *`number`* 
 
-*Defined in [api/AccountData.ts:48](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/api/AccountData.ts#L48)*
+*Defined in [api/AccountData.ts:48](https://github.com/thedewpoint/iota-basic/blob/714f837/src/api/AccountData.ts#L48)*
 
 
 

diff --git a/interfaces/_api_accountdata_.iinputs.md b/interfaces/_api_accountdata_.iinputs.md
@@ -15,7 +15,7 @@ Represents Inputs wrapper object returned by iota.lib.js getInputs.
 
 **●  inputs**:  *[IInput](_api_accountdata_.iinput.md)[]⎮`null`* 
 
-*Defined in [api/AccountData.ts:37](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/api/AccountData.ts#L37)*
+*Defined in [api/AccountData.ts:37](https://github.com/thedewpoint/iota-basic/blob/714f837/src/api/AccountData.ts#L37)*
 
 
 
@@ -29,7 +29,7 @@ ___
 
 **●  totalBalance**:  *`number`* 
 
-*Defined in [api/AccountData.ts:38](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/api/AccountData.ts#L38)*
+*Defined in [api/AccountData.ts:38](https://github.com/thedewpoint/iota-basic/blob/714f837/src/api/AccountData.ts#L38)*
 
 
 

diff --git a/interfaces/_api_accountdata_.itransaction.md b/interfaces/_api_accountdata_.itransaction.md
@@ -15,7 +15,7 @@ Represents transaction object passed to attachToTangle.
 
 **●  address**:  *`string`* 
 
-*Defined in [api/AccountData.ts:54](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/api/AccountData.ts#L54)*
+*Defined in [api/AccountData.ts:54](https://github.com/thedewpoint/iota-basic/blob/714f837/src/api/AccountData.ts#L54)*
 
 
 
@@ -29,7 +29,7 @@ ___
 
 **●  message**:  *`string`* 
 
-*Defined in [api/AccountData.ts:56](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/api/AccountData.ts#L56)*
+*Defined in [api/AccountData.ts:56](https://github.com/thedewpoint/iota-basic/blob/714f837/src/api/AccountData.ts#L56)*
 
 
 
@@ -43,7 +43,7 @@ ___
 
 **●  value**:  *`number`* 
 
-*Defined in [api/AccountData.ts:55](https://github.com/thedewpoint/iota-basic/blob/243d8a8/src/api/AccountData.ts#L55)*
+*Defined in [api/AccountData.ts:55](https://github.com/thedewpoint/iota-basic/blob/714f837/src/api/AccountData.ts#L55)*