Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SteerProtocolSDK

Steer Protocol SDK and Node Operator

Hierarchy

  • SteerProtocolSDK

Index

Constructors

constructor

  • Creates an instance of the Steer Protocol SDK

    Parameters

    • ipfsConfig: Options

      Options Config for IPFS client

    • identityConfig: IdentityManagerConfig

      Identity manager that provides the current identity of the user of the protocol

    • networkConfig: NetworkConfig

      Network config for ethers

    • registryConfig: RegistryConfig

      Network config for Steer Protocol, the global registry address is provided through this config.

    • userInterfaceConfig: UserInterfaceConfig = ...

      Network config for Steer Protocol, the global registry address is provided through this config.

    Returns SteerProtocolSDK

Properties

connectionManager

connectionManager: ConnectionManager

connectionStatistics

connectionStatistics: ConnectionStatistics

events

identityManager

identityManager: IdentityManager

ipfs

ipfs: IPFS

ipfsConfig

ipfsConfig: Options

logger

logger: Logger

networkConfig

networkConfig: NetworkConfig

orbit

orbit: Orbit

registry

registry: Registry

registryConfig

registryConfig: RegistryConfig

Optional userInterface

userInterface: UserInterface

userInterfaceConfig

userInterfaceConfig: UserInterfaceConfig

wallet

wallet: Wallet

Methods

Private handleForcedExit

  • handleForcedExit(): void
  • Provides a process.on hook for SIGINT which will ask the IPFS and Orbit instance to close their connections

    Returns void

initialize

  • initialize(): Promise<void>
  • Initialize performs all async required setup steps. This includes required library instances as well as the initial connection to the registry address. The node IPFS, orbit, identity, and peer connections are performed within this call. Once a proper connection to the network is established, initialize will resolve it's promise.

    Returns Promise<void>

start

  • start(): Promise<void>

stop

  • stop(exit?: boolean): Promise<void>
  • Shutdown sequence for the node

    Parameters

    • exit: boolean = true

    Returns Promise<void>

Generated using TypeDoc