# @canvas-js/network-explorer

> For development, the network explorer connects to `postgres://test@localhost/network-explorer`. To set up a development database, use:

Latest version **0.16.1** (published 2025-07-30) · 0 weekly downloads

## Install

```sh
npm install @canvas-js/network-explorer
pnpm add @canvas-js/network-explorer
yarn add @canvas-js/network-explorer
bun add @canvas-js/network-explorer
```

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; low quality score; large bundle; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.16.1 |
| Published | 2025-07-30 |
| First published | 2024-12-12 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 31 |
| Unpacked size | 30.6 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | joelg, raykyri, rjwebb |

## Links

- npm: https://www.npmjs.com/package/@canvas-js/network-explorer
- npm.io page: https://npm.io/package/@canvas-js/network-explorer

## Dependencies (31)

- [d3](https://npm.io/package/d3.md) ^7.9.0
- [swr](https://npm.io/package/swr.md) ^2.3.0
- [siwe](https://npm.io/package/siwe.md) ^3.0.0
- [uuid](https://npm.io/package/uuid.md) ^11.1.0
- [vite](https://npm.io/package/vite.md) ^6.3.2
- [react](https://npm.io/package/react.md) ^18.3.1
- [ethers](https://npm.io/package/ethers.md) ^6.13.5
- [date-fns](https://npm.io/package/date-fns.md) ^3.6.0
- [immutable](https://npm.io/package/immutable.md) ^5.1.1
- [react-dom](https://npm.io/package/react-dom.md) ^18.3.1
- [codemirror](https://npm.io/package/codemirror.md) ^6.0.1
- [react-icons](https://npm.io/package/react-icons.md) ^5.4.0
- [esbuild-wasm](https://npm.io/package/esbuild-wasm.md) ^0.25.1
- [@noble/hashes](https://npm.io/package/@noble/hashes.md) ^1.8.0
- [@ipld/dag-cbor](https://npm.io/package/@ipld/dag-cbor.md) ^9.2.4
- [@ipld/dag-json](https://npm.io/package/@ipld/dag-json.md) ^10.2.5
- [@canvas-js/core](https://npm.io/package/@canvas-js/core.md) 0.16.1
- [@codemirror/view](https://npm.io/package/@codemirror/view.md) ^6.36.4
- [@radix-ui/themes](https://npm.io/package/@radix-ui/themes.md) ^3.2.1
- [react-router-dom](https://npm.io/package/react-router-dom.md) ^6.20.1
- [vite-plugin-wasm](https://npm.io/package/vite-plugin-wasm.md) ^3.3.0
- [@codemirror/state](https://npm.io/package/@codemirror/state.md) ^6.5.2
- [@canvas-js/modeldb](https://npm.io/package/@canvas-js/modeldb.md) 0.16.1
- [@codemirror/commands](https://npm.io/package/@codemirror/commands.md) ^6.8.0
- [@codemirror/language](https://npm.io/package/@codemirror/language.md) ^6.11.0
- [@vitejs/plugin-react](https://npm.io/package/@vitejs/plugin-react.md) ^4.4.0
- [@canvas-js/interfaces](https://npm.io/package/@canvas-js/interfaces.md) 0.16.1
- [@radix-ui/react-label](https://npm.io/package/@radix-ui/react-label.md) ^2.1.4
- [@tanstack/react-table](https://npm.io/package/@tanstack/react-table.md) ^8.20.6
- [@codemirror/theme-one-dark](https://npm.io/package/@codemirror/theme-one-dark.md) ^6.1.2
- [@codemirror/lang-javascript](https://npm.io/package/@codemirror/lang-javascript.md) ^6.2.3

## Recent versions

- 0.16.1 (latest) — 2025-07-30
- 0.16.0-next.9 (next) — 2025-07-13
- 0.16.0 — 2025-07-08
- 0.16.0-next.8 — 2025-06-26
- 0.16.0-next.7 — 2025-06-25
- 0.16.0-next.6 — 2025-06-25
- 0.16.0-next.5 — 2025-06-18
- 0.16.0-next.4 — 2025-06-18
- 0.16.0-next.3 — 2025-06-13
- 0.16.0-next.2 — 2025-06-13
- 0.16.0-next.1 — 2025-06-13
- 0.16.0-next.0 — 2025-06-13
- 0.15.2-next.0 — 2025-06-11
- 0.15.1 — 2025-06-05
- 0.15.0 — 2025-05-22
- … 29 more at https://npm.io/package/@canvas-js/network-explorer/versions

## README

# Network Explorer

## Setup

For development, the network explorer connects to `postgres://test@localhost/network-explorer`.
To set up a development database, use:

```
createuser test
createdb network-explorer -O test
```

Then run these commands in separate terminals.

```
npm run dev
```

```
npm run dev:server
```

## Deploying the server on Railway

Create a Railway space, and add the `canvasxyz/canvas` Github repo as a service.
Also create a Postgres database.

For the main service:

- Configure the build command to `npm run build && npm run build --workspace=@canvas-js/network-explorer`.
- Configure the start command to `npm start:server --workspace=@canvas-js/network-explorer`.
- Add DATABASE_URL, PORT, LIBP2P_PORT, LIBP2P_PRIVATE_KEY, BOOTSTRAP_LIST as environment variables.
- To use the network explorer, add two custom domains:
  - One should be connected to port 3333, for the network explorer API.
  - One should be connected to port 3334, for the libp2p service.

If you want other services to connect to the network explorer, look up the Peer ID by running `railway logs`,
  and then provide the other services with a multiaddr of the form:

```
/dns4/common-explorer-libp2p.mydomain.org/tcp/443/wss/p2p/12D3...
```

---
_Source: https://npm.io/package/@canvas-js/network-explorer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._