Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/polkadot-js/client
An alternative Polkadot Runtime Environment implementation acting as a full-node (excluding block production for validators) for syncing with Substrate-based chains.
https://github.com/polkadot-js/client
p2p rpc runtime wasm
Last synced: 3 days ago
JSON representation
An alternative Polkadot Runtime Environment implementation acting as a full-node (excluding block production for validators) for syncing with Substrate-based chains.
- Host: GitHub
- URL: https://github.com/polkadot-js/client
- Owner: polkadot-js
- License: apache-2.0
- Created: 2017-11-27T19:42:15.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-05-23T12:42:35.000Z (over 4 years ago)
- Last Synced: 2024-12-10T19:19:57.101Z (12 days ago)
- Topics: p2p, rpc, runtime, wasm
- Language: TypeScript
- Homepage:
- Size: 31.8 MB
- Stars: 83
- Watchers: 11
- Forks: 12
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-substrate - client, WIP and POC JavaScript version of a simplified Polkadot network client
README
[](https://polkadot.js.org)
[](https://www.npmjs.com/package/@polkadot/client)
[](https://www.npmjs.com/package/@polkadot/client)
[](https://codeclimate.com/github/polkadot-js/client/maintainability)
[](https://coveralls.io/github/polkadot-js/client?branch=master)
# @polkadot/client
A JavaScript version of a Polkadot/Substrate network client. It allows operation in full and light nodes fullfilling all functions of chain operation, however does not include the ability to author blocks (i.e. run as a validator on the network).
## Current status
This is the current status of the client -
- It can sync and operate on Polkadot POC-3 networks, and has been tested against Alexander (Polkadot), Dried Danta (Substrate) as well as Edgeware networks.
- It currently does not include much (if any) of the RPC interfaces - so it is not (currently) able to support eg. the apps UI connecting to it
- It does not (currently) do any state and trie pruning, so the resulting backing database growth is not controlled
- As of 0.19.1 the backing database has been swapped to LmDB, this interface is much faster than the previous implementation, however uses more disk space (follow-up from the previous point). Investigations are still ongoing as to the best fit for the backend DB engine.
## Development overview
It is split up into a number of internal packages -
- [client](packages/client/) The main JavaScript client
- [client-chains](packages/client-chains/) Chain definitions
- [client-db](packages/client-db/) Database interface
- [client-p2p](packages/client-p2p/) Peer-to-peer server
- [client-rpc](packages/client-rpc/) RPC server
- [client-runtime](packages/client-runtime/) Basic Wasm runtime wrapper
- [client-telemetry](packages/client-telemetry/) Substrate telemetry interface
- [client-types](packages/client-types/) Specific codec types for client interfaces
- [client-wasm](packages/client-wasm/) Wasm interface wrapper
## Local development node
Start the node with `yarn run start `, e.g. `yarn run start --chain dried-danta`. You can use `--help` to get a list of the available options.
## Running via docker
A docker image is built from the supplied `Dockerfile`, which includes the latest version as supported and deployed to the registry. To run via docker, the following commands can be used. (Split into lines for readability) -
```
docker run -d \
--name dd \
-p 60666:60666 \
-v ~/db:/data \
jacogr/polkadot-js-client:latest \
--chain alexander \
--db-path /data \
--db-type file \
--telemetry-name "some-cool-name-here"
```
Some additional expansion to the above -
- docker `-d` runs the container as a daemon (skip as required)
- docker `--name` specifies the name of the container in `docker container ls`
- docker `-p` maps the p2p port externally (ensure the firewall is open on this)
- docker `-v` uses the local host path `~/db` as the data path, mapping it to the container itself.
- For `--chain` either `alexander` or `dried-danta` are built-in options.
- `--db-type` can be either `file` (default, experimental) or `lmdb` (experimental, more memory intensive).
- Images are deployed to [dockerhub](https://cloud.docker.com/u/jacogr/repository/docker/jacogr/polkadot-js-client), and we try to keep them current.
You can build your own container via the `./docker.sh` script included which will use the latest available repo version to base an image on.
## Contributing
- Bootstrap the dependencies, `yarn`
- Make any changes in the relevant package, on master merges new versions will be published automatically