Updated docs

README.md

@@ -122,6 +122,84 @@ export interface ITransferParams<LONG = string | number> extends IBasicParams<LO
   attachment?: string | TTypedData
 }
 ```
+
+If you want to create  the minimum you need to provide is **amount** and **recipient** as defined in Transfer params:
+```js
+
+const { transfer } = require('@waves/waves-transactions')
+const seed = 'some example seed phrase'
+const signedTranserTx = transfer({ 
+  amount: 1,
+  recipient: '3N4mLCaHq2twRKnbUjdvAHyXjoccQE9KDRE',
+  //Timestamp is optional but it was overrided, in case timestamp is not provided it will fallback to Date.now(). You can set any oftional params yourself. go check full docs
+  timestamp: 1536917842558 
+}, seed)
+
+// or using alias
+
+const signedTranserTx = transfer({ 
+  amount: 1,
+  recipient: 'alias:W:aliasForMyAddress'
+}, seed)
+```
+
+Output will be a signed transfer transaction:
+```js
+{
+  id: '8NrUwgKRCMFbUbqXKQAHkGnspmWHEjKUSi5opEC6Havq',
+  type: 4,
+  version: 2,
+  recipient: '3N4mLCaHq2twRKnbUjdvAHyXjoccQE9KDRE',
+  attachment: undefined,
+  feeAssetId: undefined,
+  assetId: undefined,
+  amount: 1,
+  fee: 100000,
+  senderPublicKey: '6nR7CXVV7Zmt9ew11BsNzSvVmuyM5PF6VPbWHW9BHgPq',
+  timestamp: 1536917842558,
+  proofs: [
+    '25kyX6HGjS3rkPTJRj5NVH6LLuZe6SzCzFtoJ8GDkojY9U5oPfVrnwBgrCHXZicfsmLthPUjTrfT9TQL2ciYrPGE'
+  ]
+}
+```
+
+You can also create transaction, but not sign it:
+```javascript
+const unsignedTransferTx = transfer({ 
+  amount: 1,
+  recipient: '3N4mLCaHq2twRKnbUjdvAHyXjoccQE9KDRE',
+  //senderPublicKey is required if you omit seed
+  senderPublicKey: '6nR7CXVV7Zmt9ew11BsNzSvVmuyM5PF6VPbWHW9BHgPq' 
+})
+```
+
+Now you are able to POST it to Waves API or store for future purpose or you can add another signature from other party:
+```js
+const otherPartySeed = 'other party seed phrase'
+const transferSignedWithTwoParties = transfer(signedTranserTx, seed)
+```
+
+So now there are two proofs:
+```js
+{
+  id: '8NrUwgKRCMFbUbqXKQAHkGnspmWHEjKUSi5opEC6Havq',
+  type: 4,
+  version: 2,
+  recipient: '3N4mLCaHq2twRKnbUjdvAHyXjoccQE9KDRE',
+  attachment: undefined,
+  feeAssetId: undefined,
+  assetId: undefined,
+  amount: 1,
+  fee: 100000,
+  senderPublicKey: '6nR7CXVV7Zmt9ew11BsNzSvVmuyM5PF6VPbWHW9BHgPq',
+  timestamp: 1536917842558,
+  proofs: [
+    '25kyX6HGjS3rkPTJRj5NVH6LLuZe6SzCzFtoJ8GDkojY9U5oPfVrnwBgrCHXZicfsmLthPUjTrfT9TQL2ciYrPGE',
+    'CM9emPzpe6Ram7ZxcYax6s7Hkw6698wXCMPSckveFAS2Yh9vqJpy1X9nL7p4RKgU3UEa8c9RGXfUK6mFFq4dL9z'
+  ]
+}
+```
+
 #### Reissue transaction. Type 5
 ```typescript
 export interface IReissueParams<LONG = string | number> extends IBasicParams<LONG> {
@@ -288,111 +366,13 @@ export interface IUpdateAssetInfoParams<LONG = string | number> extends IBasicPa
 }
 ```
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-If you want to create  the minimum you need to provide is **amount** and **recipient** as defined in Transfer params:
-```js
-
-const { transfer } = require('@waves/waves-transactions')
-const seed = 'some example seed phrase'
-const signedTranserTx = transfer({ 
-  amount: 1,
-  recipient: '3N4mLCaHq2twRKnbUjdvAHyXjoccQE9KDRE',
-  //Timestamp is optional but it was overrided, in case timestamp is not provided it will fallback to Date.now(). You can set any oftional params yourself. go check full docs
-  timestamp: 1536917842558 
-}, seed)
-
-// or using alias
-
-const signedTranserTx = transfer({ 
-  amount: 1,
-  recipient: 'alias:W:aliasForMyAddress'
-}, seed)
-```
-
-Output will be a signed transfer transaction:
-```js
-{
-  id: '8NrUwgKRCMFbUbqXKQAHkGnspmWHEjKUSi5opEC6Havq',
-  type: 4,
-  version: 2,
-  recipient: '3N4mLCaHq2twRKnbUjdvAHyXjoccQE9KDRE',
-  attachment: undefined,
-  feeAssetId: undefined,
-  assetId: undefined,
-  amount: 1,
-  fee: 100000,
-  senderPublicKey: '6nR7CXVV7Zmt9ew11BsNzSvVmuyM5PF6VPbWHW9BHgPq',
-  timestamp: 1536917842558,
-  proofs: [
-    '25kyX6HGjS3rkPTJRj5NVH6LLuZe6SzCzFtoJ8GDkojY9U5oPfVrnwBgrCHXZicfsmLthPUjTrfT9TQL2ciYrPGE'
-  ]
-}
-```
-
-You can also create transaction, but not sign it:
-```javascript
-const unsignedTransferTx = transfer({ 
-  amount: 1,
-  recipient: '3N4mLCaHq2twRKnbUjdvAHyXjoccQE9KDRE',
-  //senderPublicKey is required if you omit seed
-  senderPublicKey: '6nR7CXVV7Zmt9ew11BsNzSvVmuyM5PF6VPbWHW9BHgPq' 
-})
-```
-
-Now you are able to POST it to Waves API or store for future purpose or you can add another signature from other party:
-```js
-const otherPartySeed = 'other party seed phrase'
-const transferSignedWithTwoParties = transfer(signedTranserTx, seed)
-```
-
-So now there are two proofs:
-```js
-{
-  id: '8NrUwgKRCMFbUbqXKQAHkGnspmWHEjKUSi5opEC6Havq',
-  type: 4,
-  version: 2,
-  recipient: '3N4mLCaHq2twRKnbUjdvAHyXjoccQE9KDRE',
-  attachment: undefined,
-  feeAssetId: undefined,
-  assetId: undefined,
-  amount: 1,
-  fee: 100000,
-  senderPublicKey: '6nR7CXVV7Zmt9ew11BsNzSvVmuyM5PF6VPbWHW9BHgPq',
-  timestamp: 1536917842558,
-  proofs: [
-    '25kyX6HGjS3rkPTJRj5NVH6LLuZe6SzCzFtoJ8GDkojY9U5oPfVrnwBgrCHXZicfsmLthPUjTrfT9TQL2ciYrPGE',
-    'CM9emPzpe6Ram7ZxcYax6s7Hkw6698wXCMPSckveFAS2Yh9vqJpy1X9nL7p4RKgU3UEa8c9RGXfUK6mFFq4dL9z'
-  ]
-}
+#### CommitToGeneration transaction. Type 19
+```typescript
+export type ICommitToGenerationParams<LONG = string | number> = {
+    generationPeriodStart: number
+    endorserPublicKey?: string
+    commitmentSignature?: string
+} & IBasicParams<LONG>
 ```
 
 ### Orders

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/assets/hierarchy.js

@@ -0,0 +1 @@
+window.hierarchyData = "eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzwMKVNfWAgCbHgqm"

docs/assets/highlight.css

@@ -0,0 +1,106 @@
+:root {
+    --light-hl-0: #0000FF;
+    --dark-hl-0: #569CD6;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #0070C1;
+    --dark-hl-2: #4FC1FF;
+    --light-hl-3: #795E26;
+    --dark-hl-3: #DCDCAA;
+    --light-hl-4: #A31515;
+    --dark-hl-4: #CE9178;
+    --light-hl-5: #001080;
+    --dark-hl-5: #9CDCFE;
+    --light-hl-6: #098658;
+    --dark-hl-6: #B5CEA8;
+    --light-hl-7: #267F99;
+    --dark-hl-7: #4EC9B0;
+    --light-hl-8: #008000;
+    --dark-hl-8: #6A9955;
+    --light-hl-9: #AF00DB;
+    --dark-hl-9: #C586C0;
+    --light-hl-10: #000000;
+    --dark-hl-10: #C8C8C8;
+    --light-hl-11: #0451A5;
+    --dark-hl-11: #9CDCFE;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
+.hl-10 { color: var(--hl-10); }
+.hl-11 { color: var(--hl-11); }
+pre, code { background: var(--code-background); }