isabella232 / filecoin-network-inspector

An inspector dashboard for filecoin

Filecoin Network Inspector Sample Application

Status

This repository is in a frozen state. It is not being maintained or kept in sync with the tools and libraries it builds on. Even though work on this repository has been shelved, anyone interested in updating or maintaining this project should express their interest on one Filecoin community conversation mediums: https://github.com/filecoin-project/community#join-the-community.

---

• Overview
• App Architecture Overview
• How to run
• License

Overview

This tutorial shows how to build a Filecoin network inspector using lotus via a fork of Textile’s lotus-devnet, the Lotus JS API client, and go-ipfs.

The Filecoin network inspector interacts with several aspects of the Filecoin network that are exposed through Lotus’ JS API. The sample app in this tutorial will include:

• A simple chain explorer, showing information about Filecoin blocks.
• A miner explorer, showing information about all the active miners in the Filecoin network (in this example, this shows the miners in the local devnet).
• A marketplace, where you can add your files on the connected Filecoin network and see how storage and retrieval deals occur under the hood.
• A deals page, where you can see all your previous deals and their details.

Chain

Miners

Market

Deals

App Architecture Overview

A high-level overview of our application architecture:

• Docker script to run a lotus node (Filecoin client) and local-devnet to mock interactions on a live network, like testnet or mainnet.
• Active go-ipfs daemon (IPFS client) to generate data CIDs and import to store on Filecoin.
• React dashboard shows different features of the Filecoin network inspector. The dashboard uses various JavaScript libraries to interact with the lotus node and the go-ipfs node.

How to run

Follow this tutorial on Filecoin docs to get started.

License

This is dual-licensed under Apache 2.0 and MIT terms:

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)