* fix: Remove prior docs attempt files * docs: Add Gitbook docs for common repo with examples. See detailed comments * Remove old attempt at docs in docs/ folders * Add Typedoc config typedoc.js * Add .nvmrc for easily switching Node.js version with NVM * Add ESLint config .eslintrc.json and .eslintignore * Fix in tsconfig.json so is keyring not util-keyring * Update package.json with dependencies and script same as in polkadot-js/api * Update root README fixing CI icons, adding guide same as in polkadot-js/api, and fixing link to keyring, not util-keyring * Update root .gitignore with Gitbook build files same as in polkadot-js/api * Add Gitbook docs structure same as in polkadot-js/api * Add Gitbook examples for keyring, trie-db, util-crypto * Add Gitbook outer summary for the menu, Readme, logo and styles same as in polkadot-js/api * Add Gitbook config book.json * docs: Remove db and util-rlp from Gitbook summary menu since RLP not in PoC-3 * docs: Add Typedocs with examples for db MemoryDb and DiskDb * docs: Update db/ Readme with CI icons fixed, and indicating that no methods exposed in Common Docs * docs: Update keyring Readme with CI icons fixed and link to Common Docs * fix: Fix keyring package.json info to refer to common, not client * fix: Updates license in 4x files in keyring/address folder with keyring, not util-keyring * docs: Add Typedocs to Keyring class, pair function, and testKeyring function * docs: Update keyring Readme with CI icons fixed and link to Common Docs * fix: Update package.json moving @polkadot/db from devDependencies to dependencies * fix: Update test to iterate array not object with forEach * fix: Use semicolon instead of comma in tests to fix linting errors. Fix typo * docs: Add Typedoc to Trie class * docs: Add Typedoc to is functions * docs: Update keyring Readme with CI icons fixed and link to Common Docs * fix: Add return type to encodeAux function * docs: Add Typedoc to encode function * fix: Fix formatting of Typedoc example for root * docs: Add Typedoc for genRoot * docs: Add Typedoc for pairsUniq * docs: Add Typedoc for getSharedLength * docs: Add Typedoc for sharedPrefixLength * fix: Fix formatting of Typedoc example for rootOrdered, asNibbles, fromNibbles * fix: Various fixes to util-crypto. See commit detail comments * Update root Readme with class and function info * Fix typos and Typedoc examples * Expose mnemonic by exporting it in an index.ts * Fix naming from naclKeypair to naclKeypairFromRandom * Fix typos * Fix randomAsU8s to be randomAsU8a * Fix spelling of bitLength * fix: Various fixes to util-rlp. See detailed commit comments * Update keyring Readme with CI icons fixed and link to Common Docs mentioning since RLP not in PoC-3 nothing exposed in Common Docs * Add Typedocs * Move Typedocs to different file so they appear in Common Docs * fix: Various fixes to util. See detailed commit comments * Update root Readme to use Yarn and list and explain exposed Common Docs methods * Fix typos and Typedoc examples * fix: Restore tests back using variable they were iterating over before * docs: Move nested part of Summary to individual package Readme. Add Usage to Readmes * fix: Add missing semicolon to existing test * fix: Remove docs/gitbook folder and files since generated by CI * feat: Update Gitignore to ignore CI-generated files like .html and docs/gitbook/ folder * docs: Remove CI-icons from all packages within polkadot-js/common, except its root Readme * fix: Update to incorporate changes from PR #233 and #229 * fix: Ignore build directories in Jest tests using modulePathIgnorePatterns * fix: Remove useless docs/html from .gitignore since there is no html subdirectory * fix: Update util-crypto README with link to mnemonicToSeed instead of toSecret * docs: Update keyring create account example to show result to user * fix: Update dependencies in examples so the examples work again * fix: Update keyring example 02 load accounts not to use addFromAddress * fix: Update .gitignore so it is suitable for both polkadot-js common and api * fix: Adjust .gitignore after testing changes that work with polkadot-js api too * fix: Resolve .gitignore to overcome FileNotFoundError: No README file (or is ignored) * fix: Remove from Git tracking docs/.nojekyll since generated * fix: Add lerna to gitignore to match api repo * Revert to original .gitignore. Does not work without Gitbooks files Git tracked * docs: Hide trie-db Examples since have limited use
47 lines
2.8 KiB
Markdown
47 lines
2.8 KiB
Markdown
[](https://polkadot.js.org)
|
|

|
|
[](https://github.com/Flet/semistandard)
|
|
[](https://travis-ci.org/polkadot-js/common)
|
|
[](https://codeclimate.com/github/polkadot-js/common/maintainability)
|
|
[](https://coveralls.io/github/polkadot-js/common?branch=master)
|
|
[](https://greenkeeper.io/)
|
|
|
|
# @polkadot/common
|
|
|
|
Various useful utility functions that are used across all projects in the [@polkadot](https://polkadot.js.org) namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.
|
|
|
|
## overview
|
|
|
|
It is split up into a number of internal packages, namely utilities -
|
|
|
|
- [keyring](packages/keyring/) Keyring management
|
|
- [util](packages/util/) General utilities
|
|
- [util-crypto](packages/util-crypto/) Crypto and hashing utilities
|
|
- [util-rlp](packages/util-rlp/) RLP encoding & decoding
|
|
|
|
Various useful trie and database interfaces -
|
|
|
|
- [db](packages/db/) Sync memory and disk database interfaces
|
|
- [trie-db](packages/trie-db/) Merkle Patricia Tree implementation adapcted for Polkadot
|
|
- [trie-hash](packages/trie-hash/) Calculate hashes (either ordered or unordered) from a set of inputs
|
|
|
|
## development
|
|
|
|
Contributions are welcome!
|
|
|
|
To start off, this repo (along with others in the [@polkadot](https://github.com/polkadot-js/) family) uses yarn workspaces to organise the code. As such, after cloning, its dependencies _should_ be installed via `yarn`, not via npm; the latter will result in broken dependencies.
|
|
|
|
To get started -
|
|
|
|
1. Clone the repo locally, via `git clone https://github.com/polkadot-js/common <optional local path>`
|
|
2. Ensure that you have a recent version of Node.js, for development purposes [Node 10](https://nodejs.org/en/) is recommended.
|
|
3. Ensure that you have a recent version of Yarn, for development purposes [Yarn >=1.3.2](https://yarnpkg.com/docs/install) is required.
|
|
4. Install the dependencies by running `yarn`
|
|
5. Build the API Docs, via `yarn run build`
|
|
6. Ready! Now you can launch the API Docs, via `yarn gitbook serve`
|
|
7. Access the API Docs via [http://localhost:4000](http://localhost:4000)
|
|
|
|
## tutorials
|
|
|
|
Looking for tutorials to get started? Look at [examples](https://polkadot.js.org/api/examples/keyring/) for guides on how to use the API.
|