ipfs-interop
Version:
Interoperability Tests for IPFS
74 lines • 2.95 kB
TypeScript
/**
* @param {string[]} addrs
* @param {Factory} factory
* @param {Controller} [relay]
*/
export function createProc(addrs: string[], factory: Factory, relay?: import("ipfsd-ctl").Controller<"go"> | undefined): Promise<import("ipfsd-ctl").Controller<import("ipfsd-ctl").ControllerType>>;
/**
* @param {string[]} addrs
* @param {Factory} factory
* @param {Controller} [relay]
*/
export function createJs(addrs: string[], factory: Factory, relay?: import("ipfsd-ctl").Controller<"go"> | undefined): Promise<import("ipfsd-ctl").Controller<import("ipfsd-ctl").ControllerType>>;
/**
* creates "private" go-ipfs node which is uses static relay if specified
*
* @param {string[]} addrs
* @param {Factory} factory
* @param {Controller} [relay]
*/
export function createGo(addrs: string[], factory: Factory, relay?: import("ipfsd-ctl").Controller<"go"> | undefined): Promise<import("ipfsd-ctl").Controller<import("ipfsd-ctl").ControllerType>>;
/**
* creates "publicly diallable" go-ipfs running a relay service
*
* @param {string[]} addrs
* @param {Factory} factory
*/
export function createGoRelay(addrs: string[], factory: Factory): Promise<import("ipfsd-ctl").Controller<import("ipfsd-ctl").ControllerType>>;
/**
* @param {Factory} factory
*/
export function clean(factory: Factory): Promise<void>;
/**
* @param {Controller} nodeA
* @param {Controller} nodeB
*/
export function send(nodeA: Controller, nodeB: Controller): Promise<void>;
/**
* @param {Controller["api"]} api
*/
export function getWsAddr(api: Controller["api"]): Promise<import("@multiformats/multiaddr").Multiaddr>;
/**
* @param {Controller["api"]} api
*/
export function getWsStarAddr(api: Controller["api"]): Promise<import("@multiformats/multiaddr").Multiaddr>;
/**
* @param {Controller["api"]} api
*/
export function getWrtcStarAddr(api: Controller["api"]): Promise<import("@multiformats/multiaddr").Multiaddr>;
/**
* @param {Controller["api"]} api
*/
export function getTcpAddr(api: Controller["api"]): Promise<import("@multiformats/multiaddr").Multiaddr>;
/**
* @param {Controller} nodeA
* @param {Controller} nodeB
* @param {Controller} relay
* @param {number} timeout
*/
export function connect(nodeA: Controller, nodeB: Controller, relay: Controller, timeout?: number): Promise<void>;
/**
* @param {number} timeout
* @returns
*/
export function connWithTimeout(timeout: number): (nodeA: Controller, nodeB: Controller, relay: Controller) => Promise<void>;
/**
* @typedef {import('ipfsd-ctl').Controller} Controller
* @typedef {import('ipfsd-ctl').Factory} Factory
* @typedef {import('@libp2p/interface-transport').MultiaddrFilter} MultiaddrFilter
*/
export const randomWsAddr: "/ip4/127.0.0.1/tcp/0/ws";
export type Controller = import('ipfsd-ctl').Controller;
export type Factory = import('ipfsd-ctl').Factory;
export type MultiaddrFilter = import('@libp2p/interface-transport').MultiaddrFilter;
//# sourceMappingURL=circuit.d.ts.map