The node explorer provides views into a node’s vault and transaction data using Corda’s RPC framework.
Corda Node Explorer is a desktop application designed to provide users with easy access to examine transactions, run flows, and view node and network properties in a few simple clicks. It supports connections to both local and remote Corda nodes.
Key Features:
Vault and Transaction Data Views: Offers insights into a node’s vault and transaction data using Corda’s RPC framework.
Multi-Platform Support: Available for Windows, macOS, and Linux.
User-Friendly Connection Setup: Connects to nodes by providing hostname, RPC port, username, and password. Default credentials (user1/test) are available if needed.
Docker Deployment Support: Can be run using Docker containers, simplifying deployment and access.
Audience & Benefit:
Ideal for developers, administrators, and anyone working with Corda nodes who need to efficiently manage, troubleshoot, or monitor their Corda applications. It provides a user-friendly interface that enables users to interact with Corda nodes without needing in-depth knowledge of RPC frameworks or command-line tools. The application can be installed via winget, ensuring seamless integration into your development environment.
README
Node Explorer
Stand alone desktop app for Win/Osx/Linux that allows connecting to a local or remote Corda node. Examine transactions, run flows and view node and network properties in a few simple clicks.
Downloading the Node Explorer Binaries
If you're looking to download the node explorer and get started using it; download the latest packaged release on this repo's releases page.
There are install packages for Linux, OSX and Windows.
To login to your Corda node, you will need to provide the:
Hostname (domain, IP, or localhost)
Rpc Port
Username
Password
Notes: You can find the Rpc port in your node config under rpcSettings->address or as displayed in a CraSH shell instance. If you have not explicitly set a username/password project defaults are user1 and test.
Full instructions for using the Node-Explorer application at the documentation
Setting up for Node Explorer for Development
Note: This repository uses sub-modules. If cloning use git clone --recursive to automatically initialize and update the submodules.
Installation:
Requirements: NodeJS and Npm package manager.
git clone --recursive
cd node-explorer (or target directory)
npm install
Note this project uses the node-server submodule available at https://github.com/corda/node-server this must be initialised either by passing the --recursive option when running git clone OR executing the following commands.
git submodule init
git submodule update*
*this command must also be run after any pull request which includes updates to the submodule. An alternative is to do pull requests with the following option:
git pull --recurse-submodules
Other submodule commands:
Fetch and merge the latest node-server submodule code
git submodule update --remote
Doing work on the submodule i.e. changing files in ./server
Note: You must have a compiled server jar in the directory root
cd ./server && ./gradlew bootJar, move compiled jar in ./server/build/libs to the root.
Then run: npm run electron-pack
Deploy or Run Node Explorer with Docker
You can build docker images using the provided DockerFile(s). You will need to build two images, one for the Node Explorer front end ./DockerFile and another for the backend Node Server ./server/DockerFile (the Node Server DockerFile utilizes layers so you will need to extract the jar - see A Better Dockerfile)
If you DO NOT want to build your own images you can simply run Node Explorer using the docker-compose.yml and with contributed images. Follow the steps below: