Files
common/packages/trie-hash/docs/README.md
T
Jaco Greeff 78e01a0e16 Combine util, types & trie into common (#150)
* Pull in trie repo

* Bring in types repo
2018-06-26 21:26:51 +02:00

49 lines
1.1 KiB
Markdown

# Available interfaces
Utility methods to create [Ethereum Trie hashes](https://github.com/ethereum/wiki/wiki/Patricia-Tree)
# Available methods
## trieRoot
Creates a trie hash from the supplied pairs.
```js
trieRoot (pairs: Trie$Pairs): Uint8Array
```
From an `Array<{k: Uint8Array, v: Uint8Array}>` input, calculate the triehash and return the result as a `Uint8Array`.
```js
import { u8aFromString } from '@polkadot/util';
import { trieRoot } from '@polkadot/trie-hash';
trieRoot([{
k: u8aFromString('A'),
v: u8aFromString('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
}]) // => 0xd23786fb4a010da3ce639d66d5e904a11dbc02746d1ce25029e53290cabf28ab
```
## trieRootOrdered
Creates a trie hash from the supplied values.
```js
trieRootOrdered (values: Array<Uint8Array>): Uint8Array
```
From an `Array<Uint8Array>` input, calculate the ordered triehash and return the result as a `Uint8Array`.
```js
import { u8aFromString } from '@polkadot/util';
import { trieRootOrdered } from '@polkadot/trie-hash';
trieRootOrdered([
u8aFromString('doe'),
u8aFromString('reindeer')
]) // => 0xe766d5d51b89dc39d981b41bda63248d7abce4f0225eefd023792a540bcffee3
```