Class PeerkitNode

constructor

• new PeerkitNode(
      keyPair: IKeyPair,
      transport: ITransport,
      agentStore: IAgentStore,
      agentByNodeId: Map<string, string>,
      nodeByAgentId: Map<string, string>,
      renewalTimer: Timeout,
  ): PeerkitNode

  Parameters

  • keyPair: IKeyPair
  • transport: ITransport
  • agentStore: IAgentStore
  • agentByNodeId: Map<string, string>
  • nodeByAgentId: Map<string, string>
  • renewalTimer: Timeout

  Returns PeerkitNode

ReadonlyagentStore

ReadonlykeyPair

Readonlytransport

ownAgentId

• get ownAgentId(): string

  The local node's stable agent identity.

  Returns string

createStream

• createStream(agentId: string, protocol: string): Promise<IStream>

  Open an outgoing stream to a connected agent on the given protocol.

  Throws if the agent is not connected.

  Parameters

  • agentId: string
  • protocol: string

  Returns Promise<IStream>

disconnect

• disconnect(fromAgent: string): Promise<void>

  Parameters

  • fromAgent: string

  Returns Promise<void>

getConnectedAgents

• getConnectedAgents(): string[]

  Return the AgentIds of all currently connected peers.

  Returns string[]

isConnected

• isConnected(toAgent: string): boolean

  Parameters

  • toAgent: string

  Returns boolean

isDirectConnection

• isDirectConnection(toAgent: string): boolean

  Parameters

  • toAgent: string

  Returns boolean

register

• register(module: INodeModule): Promise<void>

  Attach a module to this node.

  Calls module.init(this) to wire it up, then module.start() if defined. Multiple modules can be registered.

  Parameters

  • module: INodeModule

  Returns Promise<void>

registerStreamHandler

• registerStreamHandler(
      protocol: string,
      handler: (fromAgent: string, stream: IStream) => void,
  ): void

  Register a handler for incoming streams on the given protocol.

  Called once per incoming stream, after the access check has passed.

  Parameters

  • protocol: string
  • handler: (fromAgent: string, stream: IStream) => void

  Returns void

send

• send(toAgent: string, message: Uint8Array): Promise<void>

  Parameters

  • toAgent: string
  • message: Uint8Array

  Returns Promise<void>

sendAgents

• sendAgents(toAgent: string, agents: Uint8Array): Promise<void>

  Parameters

  • toAgent: string
  • agents: Uint8Array

  Returns Promise<void>

shutDown

• shutDown(): Promise<void>

  Returns Promise<void>