@arkecosystem/peers

A simple TypeScript peer discovery client for the ARK Blockchain.

Usage no npm install needed!

<script type="module">
  import arkecosystemPeers from 'https://cdn.skypack.dev/@arkecosystem/peers';
</script>

README

@arkecosystem/peers

Latest Version Node Engine Build Status Codecov License: MIT

Lead Maintainer: Brian Faust

Installation

yarn add @arkecosystem/peers

Usage

Peers via GitHub

import { PeerDiscovery } from "@arkecosystem/peers";

peerDiscovery = await PeerDiscovery.new({
    networkOrHost: "devnet"
})

peers = peerDiscovery
    .withVersion(">=2.4.0-next.0")
    .withLatency(300)
    .sortBy("latency")
    .findPeersWithPlugin("core-api");

Peers via Relay

import { PeerDiscovery } from "@arkecosystem/peers";

peerDiscovery = await PeerDiscovery.new({
    networkOrHost: "http://dexplorer.ark.io/api/peers",
})

peers = peerDiscovery
    .withVersion(">=2.4.0-next.0")
    .withLatency(300)
    .sortBy("latency")
    .findPeersWithPlugin("core-api");

Testing

yarn test

Security

If you discover a security vulnerability within this package, please send an e-mail to security@ark.io. All security vulnerabilities will be promptly addressed.

Credits

This project exists thanks to all the people who contribute.

License

MIT © ARK Ecosystem