diff --git a/doc/404.html b/doc/404.html index c93dc54..67a9243 100644 --- a/doc/404.html +++ b/doc/404.html @@ -4,9 +4,9 @@ - - 404 – merkle_tree v1.5.0 - + + 404 – merkle_tree v1.6.0 + @@ -19,9 +19,6 @@
- @@ -30,7 +27,7 @@

merkle_tree

- v1.5.0 + v1.6.0

@@ -60,7 +57,8 @@

-
+
+

Page not found

@@ -70,23 +68,24 @@

Page not found

API Reference page to find what you were looking for.

- +
- + diff --git a/doc/MerkleTree.ArgumentError.html b/doc/MerkleTree.ArgumentError.html index 2330843..bde3279 100644 --- a/doc/MerkleTree.ArgumentError.html +++ b/doc/MerkleTree.ArgumentError.html @@ -4,9 +4,9 @@ - - MerkleTree.ArgumentError – merkle_tree v1.5.0 - + + MerkleTree.ArgumentError – merkle_tree v1.6.0 + @@ -19,9 +19,6 @@
- @@ -30,7 +27,7 @@

merkle_tree

- v1.5.0 + v1.6.0

@@ -60,11 +57,12 @@

-
+
+

- merkle_tree v1.5.0 + merkle_tree v1.6.0 MerkleTree.ArgumentError exception @@ -128,7 +126,8 @@

exception(msg) - + +

@@ -141,7 +140,8 @@

message(exception) - + +

@@ -155,23 +155,24 @@

- +

- + diff --git a/doc/MerkleTree.Crypto.html b/doc/MerkleTree.Crypto.html index 6180723..05888b5 100644 --- a/doc/MerkleTree.Crypto.html +++ b/doc/MerkleTree.Crypto.html @@ -4,9 +4,9 @@ - - MerkleTree.Crypto – merkle_tree v1.5.0 - + + MerkleTree.Crypto – merkle_tree v1.6.0 + @@ -19,9 +19,6 @@
- @@ -30,7 +27,7 @@

merkle_tree

- v1.5.0 + v1.6.0

@@ -60,11 +57,12 @@

-
+
+

- merkle_tree v1.5.0 + merkle_tree v1.6.0 MerkleTree.Crypto @@ -167,7 +165,8 @@

hash(data, algorithm) - + +

@@ -189,7 +188,8 @@

Specs

sha256(data) - + +
@@ -212,23 +212,24 @@

Specs

- +
- + diff --git a/doc/MerkleTree.Node.html b/doc/MerkleTree.Node.html index bf9df00..7938b19 100644 --- a/doc/MerkleTree.Node.html +++ b/doc/MerkleTree.Node.html @@ -4,9 +4,9 @@ - - MerkleTree.Node – merkle_tree v1.5.0 - + + MerkleTree.Node – merkle_tree v1.6.0 + @@ -19,9 +19,6 @@
- @@ -30,7 +27,7 @@

merkle_tree

- v1.5.0 + v1.6.0

@@ -60,11 +57,12 @@

-
+
+

- merkle_tree v1.5.0 + merkle_tree v1.6.0 MerkleTree.Node @@ -91,6 +89,12 @@

Types

+
+ hash() +
+ +
+
t()
@@ -118,8 +122,12 @@

Types

-
- 
t :: %MerkleTree.Node{children: [MerkleTree.Node.t], height: non_neg_integer, value: String.t}
+
+ 
hash :: binary | String.t
+ +
+
+ 
t :: %MerkleTree.Node{children: [MerkleTree.Node.t], height: non_neg_integer, value: hash}
@@ -132,23 +140,24 @@

- +

- + diff --git a/doc/MerkleTree.Proof.html b/doc/MerkleTree.Proof.html index ba82197..ce42c4c 100644 --- a/doc/MerkleTree.Proof.html +++ b/doc/MerkleTree.Proof.html @@ -4,9 +4,9 @@ - - MerkleTree.Proof – merkle_tree v1.5.0 - + + MerkleTree.Proof – merkle_tree v1.6.0 + @@ -19,9 +19,6 @@
- @@ -30,7 +27,7 @@

merkle_tree

- v1.5.0 + v1.6.0

@@ -60,11 +57,12 @@

-
+
+

- merkle_tree v1.5.0 + merkle_tree v1.6.0 MerkleTree.Proof @@ -152,7 +150,7 @@

- 
t :: %MerkleTree.Proof{hash_function: MerkleTree.hash_function, hashes: [String.t, ...]}
+ 
t :: %MerkleTree.Proof{hash_function: MerkleTree.hash_function | nil, hashes: [String.t, ...]}
@@ -174,14 +172,15 @@

prove(tree, index) - + +

Specs

- 
prove(MerkleTree.t, non_neg_integer) :: t
+ 
prove(MerkleTree.t | MerkleTree.Node.t, non_neg_integer) :: t
@@ -197,7 +196,8 @@

Specs

proven?(arg, root_hash, hash_function, proof) - + +
@@ -221,23 +221,24 @@

Specs

- +
- + diff --git a/doc/MerkleTree.html b/doc/MerkleTree.html index aecb136..ebba750 100644 --- a/doc/MerkleTree.html +++ b/doc/MerkleTree.html @@ -4,9 +4,9 @@ - - MerkleTree – merkle_tree v1.5.0 - + + MerkleTree – merkle_tree v1.6.0 + @@ -19,9 +19,6 @@
- @@ -30,7 +27,7 @@

merkle_tree

- v1.5.0 + v1.6.0

@@ -60,11 +57,12 @@

-
+
+

- merkle_tree v1.5.0 + merkle_tree v1.6.0 MerkleTree @@ -141,20 +139,28 @@

- build(blocks, hash_function) + build(blocks, hash_function_or_opts \\ [])
-

Builds a new binary merkle tree

+

Builds a root MerkleTree.Node structure of a merkle tree

- new(blocks, hash_function) + fast_root(blocks, opts \\ [])
-

Creates a new merkle tree. -given a blocks and hash function or opts +

Calculates the root of the merkle tree without building the entire tree explicitly,

+
+ +
+
+
+ new(blocks, hash_function_or_opts \\ []) +
+ +

Creates a new merkle tree, given a blocks and hash function or opts. available options:

:hash_function - used hash in mercle tree default :sha256 from :cryto
 :hash_leaves - flag says whether the leaves should be hashed, default true
@@ -222,21 +228,48 @@ 

     
       
     
-    build(blocks, hash_function)
-      
+    build(blocks, hash_function_or_opts \\ [])
+    
+

Specs

- 
build(blocks, hash_function) :: root
+ 
build(blocks, hash_function | Keyword.t) :: root
-

Builds a new binary merkle tree.

+

Builds a root MerkleTree.Node structure of a merkle tree

+

See new/2 for a rundown of options

+ +
+
+
+
+ + + + fast_root(blocks, opts \\ []) + + +
+ +
+

Specs

+
+ + 
fast_root(blocks, Keyword.t) :: MerkleTree.Node.hash
+ +
+
+ +
+

Calculates the root of the merkle tree without building the entire tree explicitly,

+

See new/2 for a rundown of options

@@ -245,22 +278,22 @@

Specs

- new(blocks, hash_function) - + new(blocks, hash_function_or_opts \\ []) + +

Specs

- 
new(blocks, hash_function | [{atom, any}]) :: t
+ 
new(blocks, hash_function | Keyword.t) :: t
-

Creates a new merkle tree. -given a blocks and hash function or opts +

Creates a new merkle tree, given a blocks and hash function or opts. available options:

:hash_function - used hash in mercle tree default :sha256 from :cryto
 :hash_leaves - flag says whether the leaves should be hashed, default true
@@ -281,23 +314,24 @@ 
Specs

       
 
       
-        
+
- + diff --git a/doc/api-reference.html b/doc/api-reference.html index 1190cef..ba0ad54 100644 --- a/doc/api-reference.html +++ b/doc/api-reference.html @@ -4,9 +4,9 @@ - - API Reference – merkle_tree v1.5.0 - + + API Reference – merkle_tree v1.6.0 + @@ -19,9 +19,6 @@
- @@ -30,7 +27,7 @@

merkle_tree

- v1.5.0 + v1.6.0

@@ -60,10 +57,11 @@

-
+
+

- merkle_tree v1.5.0 + merkle_tree v1.6.0 API Reference

@@ -132,23 +130,24 @@

Exceptions

- +
- + diff --git a/doc/dist/app-918614602f.js b/doc/dist/app-21f1a20b9e.js similarity index 75% rename from doc/dist/app-918614602f.js rename to doc/dist/app-21f1a20b9e.js index a10d1ba..a7b29b1 100644 --- a/doc/dist/app-918614602f.js +++ b/doc/dist/app-21f1a20b9e.js @@ -1,6 +1,6 @@ !function(e){function t(r){if(n[r])return n[r].exports;var i=n[r]={exports:{},id:r,loaded:!1};return e[r].call(i.exports,i,i.exports,t),i.loaded=!0,i.exports}var n={};return t.m=e,t.c=n,t.p="",t(0)}(function(e){for(var t in e)if(Object.prototype.hasOwnProperty.call(e,t))switch(typeof e[t]){case"function":break;case"object":e[t]=function(t){var n=t.slice(1),r=e[t[0]];return function(e,t,i){r.apply(this,[e,t,i].concat(n))}}(e[t]);break;default:e[t]=e[e[t]]}return e}([function(e,t,n){"use strict";var r=n(1)["default"],i=n(2),a=r(i),o=n(3),s=r(o),l=n(4),c=n(95),u=n(96);window.$=a["default"],a["default"](function(){s["default"].configure({tabReplace:" ",languages:[]}),u.initialize(),c.initialize(),l.initialize(),s["default"].initHighlighting()})},function(e,t){"use strict";t["default"]=function(e){return e&&e.__esModule?e:{"default":e}},t.__esModule=!0},function(e,t,n){var r,i;!function(t,n){"object"==typeof e&&"object"==typeof e.exports?e.exports=t.document?n(t,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return n(e)}:n(t)}("undefined"!=typeof window?window:this,function(n,a){function o(e){var t="length"in e&&e.length,n=re.type(e);return"function"===n||re.isWindow(e)?!1:1===e.nodeType&&t?!0:"array"===n||0===t||"number"==typeof t&&t>0&&t-1 in e}function s(e,t,n){if(re.isFunction(t))return re.grep(e,function(e,r){return!!t.call(e,r,e)!==n});if(t.nodeType)return re.grep(e,function(e){return e===t!==n});if("string"==typeof t){if(fe.test(t))return re.filter(t,e,n);t=re.filter(t,e)}return re.grep(e,function(e){return V.call(t,e)>=0!==n})}function l(e,t){for(;(e=e[t])&&1!==e.nodeType;);return e}function c(e){var t=ye[e]={};return re.each(e.match(ve)||[],function(e,n){t[n]=!0}),t}function u(){te.removeEventListener("DOMContentLoaded",u,!1),n.removeEventListener("load",u,!1),re.ready()}function f(){Object.defineProperty(this.cache={},0,{get:function(){return{}}}),this.expando=re.expando+f.uid++}function d(e,t,n){var r;if(void 0===n&&1===e.nodeType)if(r="data-"+t.replace(ke,"-$1").toLowerCase(),n=e.getAttribute(r),"string"==typeof n){try{n="true"===n?!0:"false"===n?!1:"null"===n?null:+n+""===n?+n:Ee.test(n)?re.parseJSON(n):n}catch(i){}we.set(e,t,n)}else n=void 0;return n}function p(){return!0}function h(){return!1}function g(){try{return te.activeElement}catch(e){}}function m(e,t){return re.nodeName(e,"table")&&re.nodeName(11!==t.nodeType?t:t.firstChild,"tr")?e.getElementsByTagName("tbody")[0]||e.appendChild(e.ownerDocument.createElement("tbody")):e}function v(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function y(e){var t=Be.exec(e.type);return t?e.type=t[1]:e.removeAttribute("type"),e}function b(e,t){for(var n=0,r=e.length;r>n;n++)_e.set(e[n],"globalEval",!t||_e.get(t[n],"globalEval"))}function x(e,t){var n,r,i,a,o,s,l,c;if(1===t.nodeType){if(_e.hasData(e)&&(a=_e.access(e),o=_e.set(t,a),c=a.events)){delete o.handle,o.events={};for(i in c)for(n=0,r=c[i].length;r>n;n++)re.event.add(t,i,c[i][n])}we.hasData(e)&&(s=we.access(e),l=re.extend({},s),we.set(t,l))}}function _(e,t){var n=e.getElementsByTagName?e.getElementsByTagName(t||"*"):e.querySelectorAll?e.querySelectorAll(t||"*"):[];return void 0===t||t&&re.nodeName(e,t)?re.merge([e],n):n}function w(e,t){var n=t.nodeName.toLowerCase();"input"===n&&Se.test(e.type)?t.checked=e.checked:("input"===n||"textarea"===n)&&(t.defaultValue=e.defaultValue)}function E(e,t){var r,i=re(t.createElement(e)).appendTo(t.body),a=n.getDefaultComputedStyle&&(r=n.getDefaultComputedStyle(i[0]))?r.display:re.css(i[0],"display");return i.detach(),a}function k(e){var t=te,n=We[e];return n||(n=E(e,t),"none"!==n&&n||(ze=(ze||re("