Giter Club home page Giter Club logo

filnetdiag's Introduction

Filecoin Network Diagnosis tool

filnetdiag is a tool for performing network connectivity checks. It can perform several checks:

  • check-bootstrappers: verifies and records whether bootstrapper nodes are reachable.
  • check-miners: verifies and records whether miners are connectable. For each miner, it attempts to resolve multiaddrs from the DHT and from their miner actor. It subsequently tries to connect to them by establishing a libp2p connection.
  • check-block-publishers: verifies and records whether nodes publishing blocks in blocks gossipsub topic are connectable. It subscribes to the topic, and for each message, it attempts to locate the author's peer ID in the DHT. If found, it attempts to establish a libp2p connection.

There are 60k+ miners registered in the Filecoin network, but around 1400 of them are actively mining (as of 19th Feburary 2021). To speed up the check-miners check, this repo ships with a cache of all miners, in descending order of their quality-adjusted power. By default, the check-miners check runs against the 100 top miners, but you can adjust this passing in a different value to the --top flag.

To regenerate the cache, use the gen-miner-cache subcommand.

Finally, there is a WIP analyze to process reports and print a summary.

Run it

Assuming you have the Go toolchain installed:

$ git clone https://github.com/raulk/filnetdiag
$ go build .
$ ./filnetdiag --help

External IP

This tool records your external IP in the report, to aid analysis. It records four observations, as reported by:

JSON-RPC API endpoints

This tool uses the JSON-RPC endpoints hosted by the Glif team (thanks!). Overriding at runtime is currently not implemented. To use a different API endpoint (e.g. a local Filecoin node), change te Endpoint const before compiling.

Author/maintainer

@raulk.

License

Dual-licensed: MIT, Apache Software License v2, by way of the Permissive License Stack.

filnetdiag's People

Contributors

raulk avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.