Options
All
  • Public
  • Public/Protected
  • All
Menu
example
const { HttpProvider, Messenger } = require('@harmony-js/network');
const { ChainType, ChainID } = require('@harmony-js/utils');

// create a custom messenger
const customMessenger = new Messenger(
  new HttpProvider('http://localhost:9500'),
  ChainType.Harmony, // if you are connected to Harmony's blockchain
  ChainID.HmyLocal, // check if the chainId is correct
)

Hierarchy

  • HarmonyCore
    • Messenger

Index

Constructors

constructor

Properties

JsonRpc

JsonRpc: JsonRpc

Network_ID

Network_ID: string = "Default"

chainId

chainId: ChainID

chainPrefix

chainPrefix: string

chainType

chainType: ChainType

Optional config

config: object

Optional defaultShardID

defaultShardID: number

getChainId

getChainId: ChainID

provider

shardProviders

shardProviders: Map<number, ShardingProvider>

Accessors

currentShard

  • get currentShard(): number

shardCount

  • get shardCount(): number

Methods

getCurrentShardID

  • getCurrentShardID(): any

getShardProvider

providerCheck

  • providerCheck(): void

send

  • send(method: RPCMethod | string, params?: string | any[] | undefined, rpcPrefix?: string, shardID?: number): Promise<any>
  • Parameters

    • method: RPCMethod | string

      RPC method

    • Optional params: string | any[] | undefined

      RPC method params

    • Optional rpcPrefix: string
    • Default value shardID: number = this.currentShard

    Returns Promise<any>

    RPC result

setChainId

  • setChainId(chainId: ChainID): void
  • Parameters

    • chainId: ChainID

    Returns void

setChainType

  • setChainType(chainType: ChainType): void
  • Parameters

    • chainType: ChainType

    Returns void

setDefaultShardID

  • setDefaultShardID(shardID: number): void

setNetworkID

  • setNetworkID(id: string): void

setProvider

setRPCPrefix

  • setRPCPrefix(method: RPCMethod | string, prefix: string): string

setShardingProviders

  • setShardingProviders(): Promise<void>

subscribe

  • subscribe(method: RPCMethod | string, params?: string | any[] | undefined, returnType?: SubscribeReturns, rpcPrefix?: string, shardID?: number): Promise<any>
  • Parameters

    • method: RPCMethod | string
    • Optional params: string | any[] | undefined
    • Default value returnType: SubscribeReturns = SubscribeReturns.all
    • Default value rpcPrefix: string = this.chainPrefix
    • Default value shardID: number = this.currentShard

    Returns Promise<any>

unsubscribe

  • unsubscribe(method: RPCMethod | string, params?: string | any[] | undefined, rpcPrefix?: string, shardID?: number): Promise<any>

Generated using TypeDoc