Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @ceramicnetwork/ipfs-topology

Ceramic topology

Bootstrap IPFS topology for Ceramic network

Getting started

Installation

$ npm install @ceramicnetwork/ipfs-topology

Usage

import {IpfsTopology} from "@ceramicnetwork/ipfs-topology";

const topology = new IpfsTopology(ipfs, networkName)
// Sets up topology right away, and set it periodically
await topology.start()

Contributing

We are happy to accept small and large contributions. Make sure to check out the Ceramic specifications for details of how the protocol works.

License

Apache-2.0 or MIT

Index

References

DEFAULT_PEER_DISCOVERY_PERIOD

Re-exports DEFAULT_PEER_DISCOVERY_PERIOD

IpfsApi

Re-exports IpfsApi

IpfsTopology

Re-exports IpfsTopology

Type aliases

IpfsApi

IpfsApi: typeof IpfsApi

Variables

Const DEFAULT_PEER_DISCOVERY_PERIOD

DEFAULT_PEER_DISCOVERY_PERIOD: number = 1000 * 60 * 60

Functions

fetchJson

  • fetchJson(url: string): Promise<any>

Object literals

Const BASE_BOOTSTRAP_LIST

BASE_BOOTSTRAP_LIST: object

dev-unstable

dev-unstable: string[] = ["/dns4/ipfs-dev.3boxlabs.com/tcp/4012/wss/p2p/Qmc4BVsZbVkuvax6SKgwq5BrcKjzBdwx5dW45cWfLVHabx","/dns4/ipfs-dev.ceramic.network/tcp/4012/wss/p2p/QmStNqcAjwh6s2sxUWr2ZXT3MhRZmqpJ9Dj6fp3gPdHr6E","/dns4/ipfs-dev-internal.3boxlabs.com/tcp/4012/wss/p2p/QmYkpxusRem2iup8ZAfVGYv7iq1ks1yyq2XxQh3z2a8xXq","/dns4/ipfs-dev-cas.3boxlabs.com/tcp/4012/wss/p2p/QmPHLQoWhK4CMPPgxGQxjNYEp1fMB8NPpoLaaR2VDMNbcr",]

testnet-clay

testnet-clay: string[] = ["/dns4/ipfs-clay.3boxlabs.com/tcp/4012/wss/p2p/QmWiY3CbNawZjWnHXx3p3DXsg21pZYTj4CRY1iwMkhP8r3","/dns4/ipfs-clay.ceramic.network/tcp/4012/wss/p2p/QmSqeKpCYW89XrHHxtEQEWXmznp6o336jzwvdodbrGeLTk","/dns4/ipfs-clay-internal.3boxlabs.com/tcp/4012/wss/p2p/QmQotCKxiMWt935TyCBFTN23jaivxwrZ3uD58wNxeg5npi","/dns4/ipfs-clay-cas.3boxlabs.com/tcp/4012/wss/p2p/QmbeBTzSccH8xYottaYeyVX8QsKyox1ExfRx7T1iBqRyCd",]

Const PEER_FILE_URLS

PEER_FILE_URLS: object

dev-unstable

dev-unstable: string = "https://raw.githubusercontent.com/ceramicnetwork/peerlist/main/dev-unstable.json"

testnet-clay

testnet-clay: string = "https://raw.githubusercontent.com/ceramicnetwork/peerlist/main/testnet-clay.json"