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

  • any
    • Messenger

Index

Constructors

constructor

  • Parameters

    • provider: HttpProvider | WSProvider
    • Default value chainType: ChainType = defaultConfig.Default.Chain_Type
    • Default value chainId: ChainID = defaultConfig.Default.Chain_ID
    • Default value config: object = defaultConfig

    Returns Messenger

Properties

JsonRpc

JsonRpc: JsonRpc

Network_ID

Network_ID: string = "Default"

Optional config

config: object

Optional defaultShardID

defaultShardID: number

provider

shardProviders

shardProviders: Map<number, ShardingProvider>

Accessors

currentShard

  • get currentShard(): number
  • example
    customMessenger.currentShard

    Returns number

shardCount

  • get shardCount(): number
  • example
    customMessenger.shardCount

    Returns number

Methods

getCurrentShardID

  • getCurrentShardID(): any
  • example
    hmy.messenger.getCurrentShardID()

    Returns any

getShardProvider

  • example
    hmy.messenger.getShardProvider()

    Parameters

    • shardID: number

    Returns HttpProvider | WSProvider

providerCheck

  • providerCheck(): void
  • function

    providerCheck

    memberof

    Messenger

    description

    provider checker

    Returns void

    provider validator

send

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

    send

    memberof

    Messenger.prototype

    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

setDefaultShardID

  • setDefaultShardID(shardID: number): void
  • Parameters

    • shardID: number

    Returns void

setNetworkID

  • setNetworkID(id: string): void
  • function

    setNetworkID

    description

    set network id

    memberof

    Messenger

    Parameters

    • id: string

      network id string

    Returns void

setProvider

  • function

    setProvider

    memberof

    Messenger

    description

    provider setter

    Parameters

    Returns void

setRPCPrefix

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

    • method: RPCMethod | string
    • prefix: string

    Returns string

setShardingProviders

  • setShardingProviders(): Promise<void>
  • Returns 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>
  • Parameters

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

    Returns Promise<any>

Generated using TypeDoc