DAPI-Client 2

Classes

DAPIAddress

ListDAPIAddressProvider

SimplifiedMasternodeListDAPIAddressProvider

DAPIClientError

SimplifiedMasternodeListProvider

Typedefs

createDAPIAddressProviderFromOptions ⇒ DAPIAddressProvider | ListDAPIAddressProvider | SimplifiedMasternodeListDAPIAddressProvider | null

RawDAPIAddress : object

Interfaces

DAPIAddressProvider

DAPIAddressProvider

Kind: global interface

• DAPIAddressProvider
  • .getLiveAddress() ⇒ Promise.<DAPIAddress>
  • .hasLiveAddresses() ⇒ boolean

dapiAddressProvider.getLiveAddress() ⇒ Promise.<DAPIAddress>

Kind: instance method of DAPIAddressProvider

dapiAddressProvider.hasLiveAddresses() ⇒ boolean

Kind: instance method of DAPIAddressProvider

DAPIAddress

Kind: global class

• DAPIAddress
  • new DAPIAddress(address)
  • .getHost() ⇒ string
  • .setHost(host) ⇒ DAPIAddress
  • .getHttpPort() ⇒ number
  • .setHttpPort(port) ⇒ DAPIAddress
  • .getGrpcPort() ⇒ number
  • .setGrpcPort(port) ⇒ DAPIAddress
  • .getProRegTxHash() ⇒ string
  • .getBanStartTime() ⇒ number
  • .getBanCount() ⇒ number
  • .markAsBanned() ⇒ DAPIAddress
  • .markAsLive() ⇒ DAPIAddress
  • .isBanned() ⇒ boolean
  • .toJSON() ⇒ RawDAPIAddress

new DAPIAddress(address)

Param	Type
address	RawDAPIAddress | DAPIAddress | string

dapiAddress.getHost() ⇒ string

Get host

Kind: instance method of DAPIAddress

dapiAddress.setHost(host) ⇒ DAPIAddress

Set host

Kind: instance method of DAPIAddress

Param	Type
host	string

dapiAddress.getHttpPort() ⇒ number

Get HTTP port

Kind: instance method of DAPIAddress

dapiAddress.setHttpPort(port) ⇒ DAPIAddress

Set HTTP port

Kind: instance method of DAPIAddress

Param	Type
port	number

dapiAddress.getGrpcPort() ⇒ number

Get gRPC port

Kind: instance method of DAPIAddress

dapiAddress.setGrpcPort(port) ⇒ DAPIAddress

Set gRPC port

Kind: instance method of DAPIAddress

Param	Type
port	number

dapiAddress.getProRegTxHash() ⇒ string

Get ProRegTx hash

Kind: instance method of DAPIAddress

dapiAddress.getBanStartTime() ⇒ number

Kind: instance method of DAPIAddress

dapiAddress.getBanCount() ⇒ number

Kind: instance method of DAPIAddress

dapiAddress.markAsBanned() ⇒ DAPIAddress

Mark address as banned

Kind: instance method of DAPIAddress

dapiAddress.markAsLive() ⇒ DAPIAddress

Mark address as live

Kind: instance method of DAPIAddress

dapiAddress.isBanned() ⇒ boolean

Kind: instance method of DAPIAddress

dapiAddress.toJSON() ⇒ RawDAPIAddress

Return DAPIAddress as plain object

Kind: instance method of DAPIAddress

ListDAPIAddressProvider

Kind: global class

• ListDAPIAddressProvider
  • new ListDAPIAddressProvider(addresses, [options])
  • .getLiveAddress() ⇒ Promise.<(DAPIAddress|undefined)>
  • .getAllAddresses() ⇒ Array.<DAPIAddress>
  • .setAddresses(addresses) ⇒ ListDAPIAddressProvider
  • .hasLiveAddresses() ⇒ Promise.<boolean>
  • .getLiveAddresses() ⇒ Array.<DAPIAddress>

new ListDAPIAddressProvider(addresses, [options])

Param	Type
addresses	Array.<DAPIAddress>
[options]	DAPIClientOptions

listDAPIAddressProvider.getLiveAddress() ⇒ Promise.<(DAPIAddress|undefined)>

Get random address

Kind: instance method of ListDAPIAddressProvider

listDAPIAddressProvider.getAllAddresses() ⇒ Array.<DAPIAddress>

Get all addresses

Kind: instance method of ListDAPIAddressProvider

listDAPIAddressProvider.setAddresses(addresses) ⇒ ListDAPIAddressProvider

Set addresses

Kind: instance method of ListDAPIAddressProvider

Param	Type
addresses	Array.<DAPIAddress>

listDAPIAddressProvider.hasLiveAddresses() ⇒ Promise.<boolean>

Check if we have live addresses left

Kind: instance method of ListDAPIAddressProvider
Returns: Promise.<boolean> - - True if there are live address left

listDAPIAddressProvider.getLiveAddresses() ⇒ Array.<DAPIAddress>

Get live addresses

Kind: instance method of ListDAPIAddressProvider

SimplifiedMasternodeListDAPIAddressProvider

Kind: global class

• SimplifiedMasternodeListDAPIAddressProvider
  • new SimplifiedMasternodeListDAPIAddressProvider(smlProvider, listDAPIAddressProvider, addressWhiteList)
  • .getLiveAddress() ⇒ Promise.<DAPIAddress>
  • .hasLiveAddresses() ⇒ Promise.<boolean>

new SimplifiedMasternodeListDAPIAddressProvider(smlProvider, listDAPIAddressProvider, addressWhiteList)

Param	Type
smlProvider	SimplifiedMasternodeListProvider
listDAPIAddressProvider	ListDAPIAddressProvider
addressWhiteList	Array.<DAPIAddress>

simplifiedMasternodeListDAPIAddressProvider.getLiveAddress() ⇒ Promise.<DAPIAddress>

Get random live DAPI address from SML

Kind: instance method of SimplifiedMasternodeListDAPIAddressProvider

simplifiedMasternodeListDAPIAddressProvider.hasLiveAddresses() ⇒ Promise.<boolean>

Check if we have live addresses left

Kind: instance method of SimplifiedMasternodeListDAPIAddressProvider

DAPIClientError

Kind: global class

new DAPIClientError(message)

Param	Type
message	string

SimplifiedMasternodeListProvider

Kind: global class

• SimplifiedMasternodeListProvider
  • new SimplifiedMasternodeListProvider(jsonRpcTransport, [options])
  • .getSimplifiedMNList() ⇒ Promise.<SimplifiedMNList>

new SimplifiedMasternodeListProvider(jsonRpcTransport, [options])

Param	Type	Default	Description
jsonRpcTransport	JsonRpcTransport		JsonRpcTransport instance
[options]	object		Options
[options.updateInterval]	number	60000
[options.network]	string

simplifiedMasternodeListProvider.getSimplifiedMNList() ⇒ Promise.<SimplifiedMNList>

Returns simplified masternode list

Kind: instance method of SimplifiedMasternodeListProvider

createDAPIAddressProviderFromOptions ⇒ DAPIAddressProvider | ListDAPIAddressProvider | SimplifiedMasternodeListDAPIAddressProvider | null

Kind: global typedef

Param	Type
options	DAPIClientOptions

RawDAPIAddress : object

Kind: global typedef
Properties

Name	Type	Default
host	string
[httpPort]	number	3000
[grpcPort]	number	3010
[proRegTxHash]	string

Classes

DAPIAddress

ListDAPIAddressProvider

SimplifiedMasternodeListDAPIAddressProvider

DAPIClientError

SimplifiedMasternodeListProvider

Typedefs

createDAPIAddressProviderFromOptions ⇒ DAPIAddressProvider | ListDAPIAddressProvider | SimplifiedMasternodeListDAPIAddressProvider | null

RawDAPIAddress : object

Interfaces

DAPIAddressProvider

DAPIAddressProvider

Kind: global interface

• DAPIAddressProvider
  • .getLiveAddress() ⇒ Promise.<DAPIAddress>
  • .hasLiveAddresses() ⇒ boolean

dapiAddressProvider.getLiveAddress() ⇒ Promise.<DAPIAddress>

Kind: instance method of DAPIAddressProvider

dapiAddressProvider.hasLiveAddresses() ⇒ boolean

Kind: instance method of DAPIAddressProvider

DAPIAddress

Kind: global class

• DAPIAddress
  • new DAPIAddress(address)
  • .getHost() ⇒ string
  • .setHost(host) ⇒ DAPIAddress
  • .getHttpPort() ⇒ number
  • .setHttpPort(port) ⇒ DAPIAddress
  • .getGrpcPort() ⇒ number
  • .setGrpcPort(port) ⇒ DAPIAddress
  • .getProRegTxHash() ⇒ string
  • .getBanStartTime() ⇒ number
  • .getBanCount() ⇒ number
  • .markAsBanned() ⇒ DAPIAddress
  • .markAsLive() ⇒ DAPIAddress
  • .isBanned() ⇒ boolean
  • .toJSON() ⇒ RawDAPIAddress

new DAPIAddress(address)

Param	Type
address	RawDAPIAddress | DAPIAddress | string

dapiAddress.getHost() ⇒ string

Get host

Kind: instance method of DAPIAddress

dapiAddress.setHost(host) ⇒ DAPIAddress

Set host

Kind: instance method of DAPIAddress

Param	Type
host	string

dapiAddress.getHttpPort() ⇒ number

Get HTTP port

Kind: instance method of DAPIAddress

dapiAddress.setHttpPort(port) ⇒ DAPIAddress

Set HTTP port

Kind: instance method of DAPIAddress

Param	Type
port	number

dapiAddress.getGrpcPort() ⇒ number

Get gRPC port

Kind: instance method of DAPIAddress

dapiAddress.setGrpcPort(port) ⇒ DAPIAddress

Set gRPC port

Kind: instance method of DAPIAddress

Param	Type
port	number

dapiAddress.getProRegTxHash() ⇒ string

Get ProRegTx hash

Kind: instance method of DAPIAddress

dapiAddress.getBanStartTime() ⇒ number

Kind: instance method of DAPIAddress

dapiAddress.getBanCount() ⇒ number

Kind: instance method of DAPIAddress

dapiAddress.markAsBanned() ⇒ DAPIAddress

Mark address as banned

Kind: instance method of DAPIAddress

dapiAddress.markAsLive() ⇒ DAPIAddress

Mark address as live

Kind: instance method of DAPIAddress

dapiAddress.isBanned() ⇒ boolean

Kind: instance method of DAPIAddress

dapiAddress.toJSON() ⇒ RawDAPIAddress

Return DAPIAddress as plain object

Kind: instance method of DAPIAddress

ListDAPIAddressProvider

Kind: global class

• ListDAPIAddressProvider
  • new ListDAPIAddressProvider(addresses, [options])
  • .getLiveAddress() ⇒ Promise.<(DAPIAddress|undefined)>
  • .getAllAddresses() ⇒ Array.<DAPIAddress>
  • .setAddresses(addresses) ⇒ ListDAPIAddressProvider
  • .hasLiveAddresses() ⇒ Promise.<boolean>
  • .getLiveAddresses() ⇒ Array.<DAPIAddress>

new ListDAPIAddressProvider(addresses, [options])

Param	Type
addresses	Array.<DAPIAddress>
[options]	DAPIClientOptions

listDAPIAddressProvider.getLiveAddress() ⇒ Promise.<(DAPIAddress|undefined)>

Get random address

Kind: instance method of ListDAPIAddressProvider

listDAPIAddressProvider.getAllAddresses() ⇒ Array.<DAPIAddress>

Get all addresses

Kind: instance method of ListDAPIAddressProvider

listDAPIAddressProvider.setAddresses(addresses) ⇒ ListDAPIAddressProvider

Set addresses

Kind: instance method of ListDAPIAddressProvider

Param	Type
addresses	Array.<DAPIAddress>

listDAPIAddressProvider.hasLiveAddresses() ⇒ Promise.<boolean>

Check if we have live addresses left

Kind: instance method of ListDAPIAddressProvider
Returns: Promise.<boolean> - - True if there are live address left

listDAPIAddressProvider.getLiveAddresses() ⇒ Array.<DAPIAddress>

Get live addresses

Kind: instance method of ListDAPIAddressProvider

SimplifiedMasternodeListDAPIAddressProvider

Kind: global class

• SimplifiedMasternodeListDAPIAddressProvider
  • new SimplifiedMasternodeListDAPIAddressProvider(smlProvider, listDAPIAddressProvider, addressWhiteList)
  • .getLiveAddress() ⇒ Promise.<DAPIAddress>
  • .hasLiveAddresses() ⇒ Promise.<boolean>

new SimplifiedMasternodeListDAPIAddressProvider(smlProvider, listDAPIAddressProvider, addressWhiteList)

Param	Type
smlProvider	SimplifiedMasternodeListProvider
listDAPIAddressProvider	ListDAPIAddressProvider
addressWhiteList	Array.<DAPIAddress>

simplifiedMasternodeListDAPIAddressProvider.getLiveAddress() ⇒ Promise.<DAPIAddress>

Get random live DAPI address from SML

Kind: instance method of SimplifiedMasternodeListDAPIAddressProvider

simplifiedMasternodeListDAPIAddressProvider.hasLiveAddresses() ⇒ Promise.<boolean>

Check if we have live addresses left

Kind: instance method of SimplifiedMasternodeListDAPIAddressProvider

DAPIClientError

Kind: global class

new DAPIClientError(message)

Param	Type
message	string

SimplifiedMasternodeListProvider

Kind: global class

• SimplifiedMasternodeListProvider
  • new SimplifiedMasternodeListProvider(jsonRpcTransport, [options])
  • .getSimplifiedMNList() ⇒ Promise.<SimplifiedMNList>

new SimplifiedMasternodeListProvider(jsonRpcTransport, [options])

Param	Type	Default	Description
jsonRpcTransport	JsonRpcTransport		JsonRpcTransport instance
[options]	object		Options
[options.updateInterval]	number	60000
[options.network]	string

simplifiedMasternodeListProvider.getSimplifiedMNList() ⇒ Promise.<SimplifiedMNList>

Returns simplified masternode list

Kind: instance method of SimplifiedMasternodeListProvider

createDAPIAddressProviderFromOptions ⇒ DAPIAddressProvider | ListDAPIAddressProvider | SimplifiedMasternodeListDAPIAddressProvider | null

Kind: global typedef

Param	Type
options	DAPIClientOptions

RawDAPIAddress : object

Kind: global typedef
Properties

Name	Type	Default
host	string
[httpPort]	number	3000
[grpcPort]	number	3010
[proRegTxHash]	string

Classes

DAPIAddress

ListDAPIAddressProvider

SimplifiedMasternodeListDAPIAddressProvider

DAPIClientError

SimplifiedMasternodeListProvider

Typedefs

createDAPIAddressProviderFromOptions ⇒ DAPIAddressProvider | ListDAPIAddressProvider | SimplifiedMasternodeListDAPIAddressProvider | null

RawDAPIAddress : object

Interfaces

DAPIAddressProvider

DAPIAddressProvider

Kind: global interface

• DAPIAddressProvider
  • .getLiveAddress() ⇒ Promise.<DAPIAddress>
  • .hasLiveAddresses() ⇒ boolean

---

dapiAddressProvider.getLiveAddress() ⇒ Promise.<DAPIAddress>

Kind: instance method of DAPIAddressProvider

---

dapiAddressProvider.hasLiveAddresses() ⇒ boolean

Kind: instance method of DAPIAddressProvider

---

DAPIAddress

Kind: global class

• DAPIAddress
  • new DAPIAddress(address)
  • .getHost() ⇒ string
  • .setHost(host) ⇒ DAPIAddress
  • .getHttpPort() ⇒ number
  • .setHttpPort(port) ⇒ DAPIAddress
  • .getGrpcPort() ⇒ number
  • .setGrpcPort(port) ⇒ DAPIAddress
  • .getProRegTxHash() ⇒ string
  • .getBanStartTime() ⇒ number
  • .getBanCount() ⇒ number
  • .markAsBanned() ⇒ DAPIAddress
  • .markAsLive() ⇒ DAPIAddress
  • .isBanned() ⇒ boolean
  • .toJSON() ⇒ RawDAPIAddress

---

new DAPIAddress(address)

Param	Type
address	RawDAPIAddress | DAPIAddress | string

---

dapiAddress.getHost() ⇒ string

Get host

Kind: instance method of DAPIAddress

---

dapiAddress.setHost(host) ⇒ DAPIAddress

Set host

Kind: instance method of DAPIAddress

Param	Type
host	string

---

dapiAddress.getHttpPort() ⇒ number

Get HTTP port

Kind: instance method of DAPIAddress

---

dapiAddress.setHttpPort(port) ⇒ DAPIAddress

Set HTTP port

Kind: instance method of DAPIAddress

Param	Type
port	number

---

dapiAddress.getGrpcPort() ⇒ number

Get gRPC port

Kind: instance method of DAPIAddress

---

dapiAddress.setGrpcPort(port) ⇒ DAPIAddress

Set gRPC port

Kind: instance method of DAPIAddress

Param	Type
port	number

---

dapiAddress.getProRegTxHash() ⇒ string

Get ProRegTx hash

Kind: instance method of DAPIAddress

---

dapiAddress.getBanStartTime() ⇒ number

Kind: instance method of DAPIAddress

---

dapiAddress.getBanCount() ⇒ number

Kind: instance method of DAPIAddress

---

dapiAddress.markAsBanned() ⇒ DAPIAddress

Mark address as banned

Kind: instance method of DAPIAddress

---

dapiAddress.markAsLive() ⇒ DAPIAddress

Mark address as live

Kind: instance method of DAPIAddress

---

dapiAddress.isBanned() ⇒ boolean

Kind: instance method of DAPIAddress

---

dapiAddress.toJSON() ⇒ RawDAPIAddress

Return DAPIAddress as plain object

Kind: instance method of DAPIAddress

---

ListDAPIAddressProvider

Kind: global class

• ListDAPIAddressProvider
  • new ListDAPIAddressProvider(addresses, [options])
  • .getLiveAddress() ⇒ Promise.<(DAPIAddress|undefined)>
  • .getAllAddresses() ⇒ Array.<DAPIAddress>
  • .setAddresses(addresses) ⇒ ListDAPIAddressProvider
  • .hasLiveAddresses() ⇒ Promise.<boolean>
  • .getLiveAddresses() ⇒ Array.<DAPIAddress>

---

new ListDAPIAddressProvider(addresses, [options])

Param	Type
addresses	Array.<DAPIAddress>
[options]	DAPIClientOptions

---

listDAPIAddressProvider.getLiveAddress() ⇒ Promise.<(DAPIAddress|undefined)>

Get random address

Kind: instance method of ListDAPIAddressProvider

---

listDAPIAddressProvider.getAllAddresses() ⇒ Array.<DAPIAddress>

Get all addresses

Kind: instance method of ListDAPIAddressProvider

---

listDAPIAddressProvider.setAddresses(addresses) ⇒ ListDAPIAddressProvider

Set addresses

Kind: instance method of ListDAPIAddressProvider

Param	Type
addresses	Array.<DAPIAddress>

---

listDAPIAddressProvider.hasLiveAddresses() ⇒ Promise.<boolean>

Check if we have live addresses left

Kind: instance method of ListDAPIAddressProvider
Returns: Promise.<boolean> - - True if there are live address left

---

listDAPIAddressProvider.getLiveAddresses() ⇒ Array.<DAPIAddress>

Get live addresses

Kind: instance method of ListDAPIAddressProvider

---

SimplifiedMasternodeListDAPIAddressProvider

Kind: global class

• SimplifiedMasternodeListDAPIAddressProvider
  • new SimplifiedMasternodeListDAPIAddressProvider(smlProvider, listDAPIAddressProvider, addressWhiteList)
  • .getLiveAddress() ⇒ Promise.<DAPIAddress>
  • .hasLiveAddresses() ⇒ Promise.<boolean>

---

new SimplifiedMasternodeListDAPIAddressProvider(smlProvider, listDAPIAddressProvider, addressWhiteList)

Param	Type
smlProvider	SimplifiedMasternodeListProvider
listDAPIAddressProvider	ListDAPIAddressProvider
addressWhiteList	Array.<DAPIAddress>

---

simplifiedMasternodeListDAPIAddressProvider.getLiveAddress() ⇒ Promise.<DAPIAddress>

Get random live DAPI address from SML

Kind: instance method of SimplifiedMasternodeListDAPIAddressProvider

---

simplifiedMasternodeListDAPIAddressProvider.hasLiveAddresses() ⇒ Promise.<boolean>

Check if we have live addresses left

Kind: instance method of SimplifiedMasternodeListDAPIAddressProvider

---

DAPIClientError

Kind: global class

---

new DAPIClientError(message)

Param	Type
message	string

---

SimplifiedMasternodeListProvider

Kind: global class

• SimplifiedMasternodeListProvider
  • new SimplifiedMasternodeListProvider(jsonRpcTransport, [options])
  • .getSimplifiedMNList() ⇒ Promise.<SimplifiedMNList>

---

new SimplifiedMasternodeListProvider(jsonRpcTransport, [options])

Param	Type	Default	Description
jsonRpcTransport	JsonRpcTransport		JsonRpcTransport instance
[options]	object		Options
[options.updateInterval]	number	60000
[options.network]	string

---

simplifiedMasternodeListProvider.getSimplifiedMNList() ⇒ Promise.<SimplifiedMNList>

Returns simplified masternode list

Kind: instance method of SimplifiedMasternodeListProvider

---

createDAPIAddressProviderFromOptions ⇒ DAPIAddressProvider | ListDAPIAddressProvider | SimplifiedMasternodeListDAPIAddressProvider | null

Kind: global typedef

Param	Type
options	DAPIClientOptions

---

RawDAPIAddress : object

Kind: global typedef
Properties

Name	Type	Default
host	string
[httpPort]	number	3000
[grpcPort]	number	3010
[proRegTxHash]	string

---

Classes

DAPIAddress

ListDAPIAddressProvider

SimplifiedMasternodeListDAPIAddressProvider

DAPIClientError

SimplifiedMasternodeListProvider

Typedefs

createDAPIAddressProviderFromOptions ⇒ DAPIAddressProvider | ListDAPIAddressProvider | SimplifiedMasternodeListDAPIAddressProvider | null

RawDAPIAddress : object

Interfaces

DAPIAddressProvider

DAPIAddressProvider

Kind: global interface

• DAPIAddressProvider
  • .getLiveAddress() ⇒ Promise.<DAPIAddress>
  • .hasLiveAddresses() ⇒ boolean

---

dapiAddressProvider.getLiveAddress() ⇒ Promise.<DAPIAddress>

Kind: instance method of DAPIAddressProvider

---

dapiAddressProvider.hasLiveAddresses() ⇒ boolean

Kind: instance method of DAPIAddressProvider

---

DAPIAddress

Kind: global class

• DAPIAddress
  • new DAPIAddress(address)
  • .getHost() ⇒ string
  • .setHost(host) ⇒ DAPIAddress
  • .getHttpPort() ⇒ number
  • .setHttpPort(port) ⇒ DAPIAddress
  • .getGrpcPort() ⇒ number
  • .setGrpcPort(port) ⇒ DAPIAddress
  • .getProRegTxHash() ⇒ string
  • .getBanStartTime() ⇒ number
  • .getBanCount() ⇒ number
  • .markAsBanned() ⇒ DAPIAddress
  • .markAsLive() ⇒ DAPIAddress
  • .isBanned() ⇒ boolean
  • .toJSON() ⇒ RawDAPIAddress

---

new DAPIAddress(address)

Param	Type
address	RawDAPIAddress | DAPIAddress | string

---

dapiAddress.getHost() ⇒ string

Get host

Kind: instance method of DAPIAddress

---

dapiAddress.setHost(host) ⇒ DAPIAddress

Set host

Kind: instance method of DAPIAddress

Param	Type
host	string

---

dapiAddress.getHttpPort() ⇒ number

Get HTTP port

Kind: instance method of DAPIAddress

---

dapiAddress.setHttpPort(port) ⇒ DAPIAddress

Set HTTP port

Kind: instance method of DAPIAddress

Param	Type
port	number

---

dapiAddress.getGrpcPort() ⇒ number

Get gRPC port

Kind: instance method of DAPIAddress

---

dapiAddress.setGrpcPort(port) ⇒ DAPIAddress

Set gRPC port

Kind: instance method of DAPIAddress

Param	Type
port	number

---

dapiAddress.getProRegTxHash() ⇒ string

Get ProRegTx hash

Kind: instance method of DAPIAddress

---

dapiAddress.getBanStartTime() ⇒ number

Kind: instance method of DAPIAddress

---

dapiAddress.getBanCount() ⇒ number

Kind: instance method of DAPIAddress

---

dapiAddress.markAsBanned() ⇒ DAPIAddress

Mark address as banned

Kind: instance method of DAPIAddress

---

dapiAddress.markAsLive() ⇒ DAPIAddress

Mark address as live

Kind: instance method of DAPIAddress

---

dapiAddress.isBanned() ⇒ boolean

Kind: instance method of DAPIAddress

---

dapiAddress.toJSON() ⇒ RawDAPIAddress

Return DAPIAddress as plain object

Kind: instance method of DAPIAddress

---

ListDAPIAddressProvider

Kind: global class

• ListDAPIAddressProvider
  • new ListDAPIAddressProvider(addresses, [options])
  • .getLiveAddress() ⇒ Promise.<(DAPIAddress|undefined)>
  • .getAllAddresses() ⇒ Array.<DAPIAddress>
  • .setAddresses(addresses) ⇒ ListDAPIAddressProvider
  • .hasLiveAddresses() ⇒ Promise.<boolean>
  • .getLiveAddresses() ⇒ Array.<DAPIAddress>

---

new ListDAPIAddressProvider(addresses, [options])

Param	Type
addresses	Array.<DAPIAddress>
[options]	DAPIClientOptions

---

listDAPIAddressProvider.getLiveAddress() ⇒ Promise.<(DAPIAddress|undefined)>

Get random address

Kind: instance method of ListDAPIAddressProvider

---

listDAPIAddressProvider.getAllAddresses() ⇒ Array.<DAPIAddress>

Get all addresses

Kind: instance method of ListDAPIAddressProvider

---

listDAPIAddressProvider.setAddresses(addresses) ⇒ ListDAPIAddressProvider

Set addresses

Kind: instance method of ListDAPIAddressProvider

Param	Type
addresses	Array.<DAPIAddress>

---

listDAPIAddressProvider.hasLiveAddresses() ⇒ Promise.<boolean>

Check if we have live addresses left

Kind: instance method of ListDAPIAddressProvider
Returns: Promise.<boolean> - - True if there are live address left

---

listDAPIAddressProvider.getLiveAddresses() ⇒ Array.<DAPIAddress>

Get live addresses

Kind: instance method of ListDAPIAddressProvider

---

SimplifiedMasternodeListDAPIAddressProvider

Kind: global class

• SimplifiedMasternodeListDAPIAddressProvider
  • new SimplifiedMasternodeListDAPIAddressProvider(smlProvider, listDAPIAddressProvider, addressWhiteList)
  • .getLiveAddress() ⇒ Promise.<DAPIAddress>
  • .hasLiveAddresses() ⇒ Promise.<boolean>

---

new SimplifiedMasternodeListDAPIAddressProvider(smlProvider, listDAPIAddressProvider, addressWhiteList)

Param	Type
smlProvider	SimplifiedMasternodeListProvider
listDAPIAddressProvider	ListDAPIAddressProvider
addressWhiteList	Array.<DAPIAddress>

---

simplifiedMasternodeListDAPIAddressProvider.getLiveAddress() ⇒ Promise.<DAPIAddress>

Get random live DAPI address from SML

Kind: instance method of SimplifiedMasternodeListDAPIAddressProvider

---

simplifiedMasternodeListDAPIAddressProvider.hasLiveAddresses() ⇒ Promise.<boolean>

Check if we have live addresses left

Kind: instance method of SimplifiedMasternodeListDAPIAddressProvider

---

DAPIClientError

Kind: global class

---

new DAPIClientError(message)

Param	Type
message	string

---

SimplifiedMasternodeListProvider

Kind: global class

• SimplifiedMasternodeListProvider
  • new SimplifiedMasternodeListProvider(jsonRpcTransport, [options])
  • .getSimplifiedMNList() ⇒ Promise.<SimplifiedMNList>

---

new SimplifiedMasternodeListProvider(jsonRpcTransport, [options])

Param	Type	Default	Description
jsonRpcTransport	JsonRpcTransport		JsonRpcTransport instance
[options]	object		Options
[options.updateInterval]	number	60000
[options.network]	string

---

simplifiedMasternodeListProvider.getSimplifiedMNList() ⇒ Promise.<SimplifiedMNList>

Returns simplified masternode list

Kind: instance method of SimplifiedMasternodeListProvider

---

createDAPIAddressProviderFromOptions ⇒ DAPIAddressProvider | ListDAPIAddressProvider | SimplifiedMasternodeListDAPIAddressProvider | null

Kind: global typedef

Param	Type
options	DAPIClientOptions

---

RawDAPIAddress : object

Kind: global typedef
Properties

Name	Type	Default
host	string
[httpPort]	number	3000
[grpcPort]	number	3010
[proRegTxHash]	string

---

Classes

DAPIAddress

ListDAPIAddressProvider

SimplifiedMasternodeListDAPIAddressProvider

DAPIClientError

SimplifiedMasternodeListProvider

Typedefs

createDAPIAddressProviderFromOptions ⇒ DAPIAddressProvider | ListDAPIAddressProvider | SimplifiedMasternodeListDAPIAddressProvider | null

RawDAPIAddress : object

Interfaces

DAPIAddressProvider

DAPIAddressProvider

Kind: global interface

• DAPIAddressProvider
  • .getLiveAddress() ⇒ Promise.<DAPIAddress>
  • .hasLiveAddresses() ⇒ boolean

dapiAddressProvider.getLiveAddress() ⇒ Promise.<DAPIAddress>

Kind: instance method of DAPIAddressProvider

dapiAddressProvider.hasLiveAddresses() ⇒ boolean

Kind: instance method of DAPIAddressProvider

DAPIAddress

Kind: global class

• DAPIAddress
  • new DAPIAddress(address)
  • .getHost() ⇒ string
  • .setHost(host) ⇒ DAPIAddress
  • .getHttpPort() ⇒ number
  • .setHttpPort(port) ⇒ DAPIAddress
  • .getGrpcPort() ⇒ number
  • .setGrpcPort(port) ⇒ DAPIAddress
  • .getProRegTxHash() ⇒ string
  • .getBanStartTime() ⇒ number
  • .getBanCount() ⇒ number
  • .markAsBanned() ⇒ DAPIAddress
  • .markAsLive() ⇒ DAPIAddress
  • .isBanned() ⇒ boolean
  • .toJSON() ⇒ RawDAPIAddress

new DAPIAddress(address)

Param	Type
address	RawDAPIAddress | DAPIAddress | string

dapiAddress.getHost() ⇒ string

Get host

Kind: instance method of DAPIAddress

dapiAddress.setHost(host) ⇒ DAPIAddress

Set host

Kind: instance method of DAPIAddress

Param	Type
host	string

dapiAddress.getHttpPort() ⇒ number

Get HTTP port

Kind: instance method of DAPIAddress

dapiAddress.setHttpPort(port) ⇒ DAPIAddress

Set HTTP port

Kind: instance method of DAPIAddress

Param	Type
port	number

dapiAddress.getGrpcPort() ⇒ number

Get gRPC port

Kind: instance method of DAPIAddress

dapiAddress.setGrpcPort(port) ⇒ DAPIAddress

Set gRPC port

Kind: instance method of DAPIAddress

Param	Type
port	number

dapiAddress.getProRegTxHash() ⇒ string

Get ProRegTx hash

Kind: instance method of DAPIAddress

dapiAddress.getBanStartTime() ⇒ number

Kind: instance method of DAPIAddress

dapiAddress.getBanCount() ⇒ number

Kind: instance method of DAPIAddress

dapiAddress.markAsBanned() ⇒ DAPIAddress

Mark address as banned

Kind: instance method of DAPIAddress

dapiAddress.markAsLive() ⇒ DAPIAddress

Mark address as live

Kind: instance method of DAPIAddress

dapiAddress.isBanned() ⇒ boolean

Kind: instance method of DAPIAddress

dapiAddress.toJSON() ⇒ RawDAPIAddress

Return DAPIAddress as plain object

Kind: instance method of DAPIAddress

ListDAPIAddressProvider

Kind: global class

• ListDAPIAddressProvider
  • new ListDAPIAddressProvider(addresses, [options])
  • .getLiveAddress() ⇒ Promise.<(DAPIAddress|undefined)>
  • .getAllAddresses() ⇒ Array.<DAPIAddress>
  • .setAddresses(addresses) ⇒ ListDAPIAddressProvider
  • .hasLiveAddresses() ⇒ Promise.<boolean>
  • .getLiveAddresses() ⇒ Array.<DAPIAddress>

new ListDAPIAddressProvider(addresses, [options])

Param	Type
addresses	Array.<DAPIAddress>
[options]	DAPIClientOptions

listDAPIAddressProvider.getLiveAddress() ⇒ Promise.<(DAPIAddress|undefined)>

Get random address

Kind: instance method of ListDAPIAddressProvider

listDAPIAddressProvider.getAllAddresses() ⇒ Array.<DAPIAddress>

Get all addresses

Kind: instance method of ListDAPIAddressProvider

listDAPIAddressProvider.setAddresses(addresses) ⇒ ListDAPIAddressProvider

Set addresses

Kind: instance method of ListDAPIAddressProvider

Param	Type
addresses	Array.<DAPIAddress>

listDAPIAddressProvider.hasLiveAddresses() ⇒ Promise.<boolean>

Check if we have live addresses left

Kind: instance method of ListDAPIAddressProvider
Returns: Promise.<boolean> - - True if there are live address left

listDAPIAddressProvider.getLiveAddresses() ⇒ Array.<DAPIAddress>

Get live addresses

Kind: instance method of ListDAPIAddressProvider

SimplifiedMasternodeListDAPIAddressProvider

Kind: global class

• SimplifiedMasternodeListDAPIAddressProvider
  • new SimplifiedMasternodeListDAPIAddressProvider(smlProvider, listDAPIAddressProvider, addressWhiteList)
  • .getLiveAddress() ⇒ Promise.<DAPIAddress>
  • .hasLiveAddresses() ⇒ Promise.<boolean>

new SimplifiedMasternodeListDAPIAddressProvider(smlProvider, listDAPIAddressProvider, addressWhiteList)

Param	Type
smlProvider	SimplifiedMasternodeListProvider
listDAPIAddressProvider	ListDAPIAddressProvider
addressWhiteList	Array.<DAPIAddress>

simplifiedMasternodeListDAPIAddressProvider.getLiveAddress() ⇒ Promise.<DAPIAddress>

Get random live DAPI address from SML

Kind: instance method of SimplifiedMasternodeListDAPIAddressProvider

simplifiedMasternodeListDAPIAddressProvider.hasLiveAddresses() ⇒ Promise.<boolean>

Check if we have live addresses left

Kind: instance method of SimplifiedMasternodeListDAPIAddressProvider

DAPIClientError

Kind: global class

new DAPIClientError(message)

Param	Type
message	string

SimplifiedMasternodeListProvider

Kind: global class

• SimplifiedMasternodeListProvider
  • new SimplifiedMasternodeListProvider(jsonRpcTransport, [options])
  • .getSimplifiedMNList() ⇒ Promise.<SimplifiedMNList>

new SimplifiedMasternodeListProvider(jsonRpcTransport, [options])

Param	Type	Default	Description
jsonRpcTransport	JsonRpcTransport		JsonRpcTransport instance
[options]	object		Options
[options.updateInterval]	number	60000
[options.network]	string

simplifiedMasternodeListProvider.getSimplifiedMNList() ⇒ Promise.<SimplifiedMNList>

Returns simplified masternode list

Kind: instance method of SimplifiedMasternodeListProvider

createDAPIAddressProviderFromOptions ⇒ DAPIAddressProvider | ListDAPIAddressProvider | SimplifiedMasternodeListDAPIAddressProvider | null

Kind: global typedef

Param	Type
options	DAPIClientOptions

RawDAPIAddress : object

Kind: global typedef
Properties

Name	Type	Default
host	string
[httpPort]	number	3000
[grpcPort]	number	3010
[proRegTxHash]	string