https://github.com/polkadot-js/common

Utilities and base libraries for use across polkadot-js for Polkadot and Substrate. Includes base libraries, crypto helpers and cross-environment helpers.
https://github.com/polkadot-js/common

blockchain crypto polkadot polkadot-js substrate utilities

Last synced: 3 days ago
JSON representation

Utilities and base libraries for use across polkadot-js for Polkadot and Substrate. Includes base libraries, crypto helpers and cross-environment helpers.

• Host: GitHub
• URL: https://github.com/polkadot-js/common
• Owner: polkadot-js
• License: apache-2.0
• Created: 2017-11-18T13:20:32.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T19:38:51.000Z (3 months ago)
• Last Synced: 2024-10-29T17:38:11.066Z (2 months ago)
• Topics: blockchain, crypto, polkadot, polkadot-js, substrate, utilities
• Language: TypeScript
• Homepage:
• Size: 46.7 MB
• Stars: 254
• Watchers: 11
• Forks: 144
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• best-of-crypto - GitHub - 4% open · ⏱️ 14.05.2024): (Smart Contract Platforms)

README

        
# @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

This repository 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

## 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 `

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.10.1](https://yarnpkg.com/docs/install) is required.

4. Install the dependencies by running `yarn`

5. Build the everything via `yarn run build`

6. You can also launch the API Docs, via `yarn vuepress dev docs`

7. Access the docs via [http://localhost:8080](http://localhost:8080)

## tutorials

Looking for tutorials to get started? Look at [examples](https://polkadot.js.org/api/examples/keyring/) for guides on how to use the base utilities.