npmpackage.info

Gathering detailed insights and metrics for @polkadot/apps-config

Other packages similar to @polkadot/apps-config

@subscan/parachains-info

2.2.2

This package contains info of parachain projects used in Subscan parachain module based on @polkadot/apps-config.

@substrate/txwrapper-registry

7.5.3

Polkadot-js type registry creation assistants for txwrapper libraries.

@polkadot/ui-settings

3.11.3

Manages app settings

@polkadot/util-crypto

13.2.3

A collection of useful crypto utilities for @polkadot

Gathering detailed insights and metrics for @polkadot/apps-config

@polkadot/apps-config

Basic Polkadot/Substrate UI for interacting with a Polkadot and Substrate node. This is the main user-facing application, allowing access to all features available on Substrate chains.

0.146.1

1,758

Apache-2.0

TypeScript

1,345,657 4

Installations

npm install @polkadot/apps-config

Pull Requests

Open

26

Total

7,176

Closed

487

Merged

6,663

Issues

Open

238

Total

3,860

Closed

3,622

Releases

112

v0.145.1

Published on 13 Nov 2024

v0.144.1

Published on 25 Sept 2024

v0.143.2

Published on 21 Aug 2024

v0.143.1

Published on 21 Aug 2024

v0.142.1

Published on 18 Jul 2024

v0.141.1

Published on 03 Jul 2024

View all 112 releases

Developer

polkadot-js

Developer Guide

BETA

Module System

ESM

Min. Node Version

>=18

Typescript Support

Yes

Node Version

22.10.0

NPM Version

10.9.0 Statistics

1,758 Stars

13,330 Commits

1,549 Forks

66 Watching

17 Branches

577 Contributors

Updated on 27 Nov 2024

Languages

TypeScript (99.83%)

JavaScript (0.14%)

HTML (0.02%)

Shell (0.01%)

Total Downloads

Cumulative downloads

Total Downloads

1,345,657

Last day

-40.9%

822

Compared to previous day

Last week

-33.2%

10,286

Compared to previous week

Last month

14.5%

63,396

Compared to previous month

Last year

90.8%

566,167

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@acala-network/type-definitions @bifrost-finance/type-definitions @crustio/type-definitions @darwinia/types @darwinia/types-known @digitalnative/type-definitions @docknetwork/node-types @edgeware/node-types @equilab/definitions @fragnova/api-augment @frequency-chain/api-augment @interlay/interbtc-types @kiltprotocol/type-definitions @laminar/type-definitions @logion/node-api @mangata-finance/type-definitions @metaverse-network-sdk/type-definitions @parallel-finance/type-definitions @peaqnetwork/type-definitions @pendulum-chain/type-definitions @phala/typedefs @polkadot/api @polkadot/api-derive @polkadot/networks @polkadot/react-identicon @polkadot/types @polkadot/types-codec @polkadot/util @polkadot/util-crypto @polkadot/wasm-util @polkadot/x-fetch @polkadot/x-ws @polymeshassociation/polymesh-types @snowfork/snowbridge-types @sora-substrate/type-definitions @subsocial/definitions @unique-nft/opal-testnet-types @unique-nft/quartz-mainnet-types @unique-nft/sapphire-mainnet-types @unique-nft/unique-mainnet-types @zeitgeistpm/type-defs @zeroio/type-definitions moonbeam-types-bundle pontem-types-bundle rxjs tslib

Versions

@polkadot/apps

A Portal into the Polkadot and Substrate networks. Provides a view and interaction layer from a browser.

This can be accessed as a hosted application via https://polkadot.js.org/apps/ or you can access the IPFS hosted version via https://polkadot.js.org/apps/ipfs (via hash) or https://dotapps.io (via ipns) to explore any of the supported Polkadot and Substrate chains.

If you run one or more IPFS node(s), pinning the UI (which only gets updated on releases) will make it faster for you and others. You can find details about that below in the IPFS chapter below.

Important If you are a chain developer and would like to add support for your chain to the UI, all the local configuration (API types, settings, logos) can be customized in the apps-config package, complete with instructions of what goes where.

Overview

The repo is split into a number of packages, each representing an application.

Development

Contributions are welcome!

To start off, this repo (along with others in the @polkadot family) uses yarn workspaces to organize the code. As such, after cloning dependencies should be installed via yarn, not via npm, the latter will result in broken dependencies.

To get started -

Clone the repo locally, via git clone https://github.com/polkadot-js/apps <optional local path>
Ensure that you have a recent LTS version of Node.js, for development purposes Node >= 16 is recommended.
Ensure that you have a recent version of Yarn, for development purposes Yarn >= 1.22 is required.
Install the dependencies by running yarn
Ready! Now you can launch the UI (assuming you have a local Polkadot Node running), via yarn run start
Access the UI via http://localhost:3000

Docker

You can run a docker container via -

docker run --rm -it --name polkadot-ui -e WS_URL=ws://someip:9944 -p 80:80 jacogr/polkadot-js-apps:latest

To build a docker container containing local changes -

docker build -t jacogr/polkadot-js-apps -f docker/Dockerfile .

When using these Docker commands, you can access the UI via http://localhost:80 (or just http://localhost)

IPFS

IPFS allows sharing files in a decentralized manner in a similar fashion the polkadot network exchanges blocks. IPFS works best when many nodes seed the same data. Nodes can seed specific data by pinning them.

You can pin with the following command:

curl -s https://polkadot.js.org/apps/ipfs/pin.json | jq -jr .IpfsHash | xargs -0 -I CID ipfs pin add --progress CID

Here is a script you can save as /usr/local/bin/polkadotjs-ipfs-pin.sh:

#!/usr/bin/env bash

IPFS='/usr/local/bin/ipfs'
curl -s https://polkadot.js.org/apps/ipfs/pin.json | jq -jr .IpfsHash | xargs -0 -I CID $IPFS pin add --progress CID

I suggest to run the script once. The output should be similar to (the CID/Hash will very likely be different though):

$ /usr/local/bin/polkadotjs-ipfs-pin.sh
pinned QmNYAbzaE8kRAf68YiN3ZuUxgdwroeav3JhicsHsG5b2oW recursively

Now that you know the CID (hash), you can check whether the data is already pinned or not:

$ ipfs pin ls | grep QmNYAbzaE8kRAf68YiN3ZuUxgdwroeav3JhicsHsG5b2oW
QmNYAbzaE8kRAf68YiN3ZuUxgdwroeav3JhicsHsG5b2oW recursive

Now that we know it works, we can automate that with a cron task. Run crontab -e. If you see only comments, append the following to the file and save:

SHELL=/bin/bash
HOME=/
0 * * * * /usr/local/bin/polkadotjs-ipfs-pin.sh >/dev/null 2>&1

Now our script will run every hours at minute '0' (8:00, 9:00, etc...). To check, we can unpin temporarily:

$ ipfs pin rm QmNYAbzaE8kRAf68YiN3ZuUxgdwroeav3JhicsHsG5b2oW
unpinned QmNYAbzaE8kRAf68YiN3ZuUxgdwroeav3JhicsHsG5b2oW

Now asking for the CID confirms that is it not there.

$ ipfs pin ls QmNYAbzaE8kRAf68YiN3ZuUxgdwroeav3JhicsHsG5b2oW
Error: path 'QmNYAbzaE8kRAf68YiN3ZuUxgdwroeav3JhicsHsG5b2oW' is not pinned

Wait until the your cron task runs and try again:

$ ipfs pin ls QmNYAbzaE8kRAf68YiN3ZuUxgdwroeav3JhicsHsG5b2oW
QmNYAbzaE8kRAf68YiN3ZuUxgdwroeav3JhicsHsG5b2oW recursive

Tada! This is now automatic and you may forget it.

If you are curious and want to know how many people seed the UI on IPFS, here is the magic command (it may take a while to return the answer as ipfs will search for about 1 minute):

ipfs dht findprovs QmTejwB7mJPBHBoqubjzHSgSxfLMcjnZA3LFefqoQc87VJ | wc -l

If you are current about the content of what you just pinned, you may use the following command:

$ ipfs ls QmTejwB7mJPBHBoqubjzHSgSxfLMcjnZA3LFefqoQc87VJ
QmPJGyqVCcXm238noz7TZDByyGa35qqc8g6sfyXF3KDXZ3 38078   favicon.ico
QmdouVsVE9rMVB84Cy1ehVi1LAGW1fKcqqQxSEjgxJrv7H 668     index.html
QmWHcGf1JCFZCYjZsw52vM5RiJVbcNpX1fo2NyoBKBvtuf -       ipfs/
QmT6NwDsJzMyBs6bMq845nMumeJWbixBfNXA9hdAhAMdSG -       locales/
QmcgiZpwvpT1E1dkSS3zr5je89rZRVocNKPebgWhn3JVTC 2178582 main.ce05dfca.js
QmdnEtuhFDyw5Tjr82bFPzyveFrbkYjJAnUvBvzwT18YGG 337     manifest.json
QmW7gDKHbmtD7sRTqsvyo84bDpyYPZR3w1wQo8pme2q5HC -       next/
Qmd8UnRQiBobm4qb6dhiC1HoQ7SvwZrWJenoN3JPEV3iiF 480594  polkadotjs.3af757ad.js
QmUfXPMfNys8Y8dekuankBx7BHiSAjALCpBDKH6F5DdcNm 628284  react.0cecb00d.css
QmSEgXdQbC1ek9Td1mHy3BRvJpfWHm9zQYegTgAUj1QC4g 924156  react.8f083b49.js
QmfGBgFe2aqf83Wv21m9k5DH2ew89CDj4tydoxJWdK6NNL 1552    runtime.3d77e510.js
QmYPa8jcHH7gfopMALr5XTW4i1QM2xgVBe3NeP11y3tErA -       static/
QmeYBC5EgbccC8NEwXC2rvbd93YiHtTM5xYzqCDohXerDf 859984  vendor.8b793a81.js

Desktop App

The main advantage of using Desktop App is that it by default stores encrypted accounts on the filesystem instead of browser's local storage. Local storage is susceptible to attacks using XSS (Cross-Site Scripting). There's no such risk when with files stored on disk.

The desktop app uses the Electron framework. It provides the same features as web app, the only difference being different account storage.

The accounts are stored in the following directories:

Mac: ~/Library/Application Support/polkadot-apps/polkadot-accounts
Linux: ~/.config/polkadot-apps/polkadot-accounts (or $XDG_CONFIG_HOME/polkadot-apps/polkadot-accounts if $XDG_CONFIG_HOME is defined)
Windows: %APPDATA%\polkadot-apps\polkadot-accounts

For more details on the desktop app, head over to Electron package README.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Maintained

Determines if the project is "actively maintained".

10

License

Determines if the project has defined a license.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/chain-endpoints.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/polkadot-js/apps/chain-endpoints.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/chain-endpoints.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/polkadot-js/apps/chain-endpoints.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr-any.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/polkadot-js/apps/pr-any.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr-any.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/polkadot-js/apps/pr-any.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/push-master.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/polkadot-js/apps/push-master.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/push-master.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/polkadot-js/apps/push-master.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/push-master.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/polkadot-js/apps/push-master.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/push-master.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/polkadot-js/apps/push-master.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/push-master.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/polkadot-js/apps/push-master.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/push-master.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/polkadot-js/apps/push-master.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/push-master.yml:78: update your workflow using https://app.stepsecurity.io/secureworkflow/polkadot-js/apps/push-master.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-nightly.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/polkadot-js/apps/test-nightly.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-nightly.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/polkadot-js/apps/test-nightly.yml/master?enable=pin
Warn: containerImage not pinned by hash: docker/Dockerfile:1
Warn: containerImage not pinned by hash: docker/Dockerfile:20: pin your Docker image by updating nginx:stable-alpine to nginx:stable-alpine@sha256:d6f8c6b38edf2b7c6619718ad7a00caa4ed4741d12ce12550333a28d2b52dc89
Warn: downloadThenRun not pinned by hash: docker/Dockerfile:8
Warn: npmCommand not pinned by hash: docker/Dockerfile:12
Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
Info: 4 out of 5 third-party GitHubAction dependencies pinned
Info: 0 out of 2 containerImage dependencies pinned
Info: 0 out of 1 downloadThenRun dependencies pinned
Info: 0 out of 1 npmCommand dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

56 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-hpx4-r86g-5jrg
Warn: Project is vulnerable to: GHSA-prr3-c3m5-p7q2
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-r4pf-3v7r-hh55
Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
Warn: Project is vulnerable to: GHSA-9jxc-qjr9-vjxq
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-h4hr-7fg3-h35w
Warn: Project is vulnerable to: GHSA-gj77-59wh-66hg
Warn: Project is vulnerable to: GHSA-hqhp-5p83-hx96
Warn: Project is vulnerable to: GHSA-3949-f494-cm99
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-x3m3-4wpv-5vgc
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-584q-6j8j-r5pm
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-wpg7-2c88-r8xv
Warn: Project is vulnerable to: GHSA-652h-xwhf-q4h6
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-5r9g-qh6m-jxff
Warn: Project is vulnerable to: GHSA-r6ch-mqf9-qc9w
Warn: Project is vulnerable to: GHSA-wqq4-5wpv-mx2g
Warn: Project is vulnerable to: GHSA-3787-6prv-h9w3
Warn: Project is vulnerable to: GHSA-9qxr-qj54-h672
Warn: Project is vulnerable to: GHSA-m4v8-wqvr-p9f7
Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7

Score

4

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More