MultichainClient

Api Code Documentation / Exports / service/Client.h / MultichainClient

service/Client.h.MultichainClient

Implemented by

• RpcMultichainClient

Table of contents

Methods

• getInfo
• getLastBlockInfo
• getLatestValues
• getOrCreateStream
• getPeerInfo
• getRpcClient
• getValue
• getValues
• isValidAddress
• latestValuesForKey
• listBlocksByHeight
• listStreamBlockItemsByHeight
• ping
• setValue
• streamItems
• streams
• updateStreamItem
• updateValue
• v2_readStreamItems

Methods

getInfo

▸ getInfo(): any

Returns

any

Defined in

src/service/Client.h.ts:141

---

getLastBlockInfo

▸ getLastBlockInfo(skip?): Promise<BlockInfo>

Get the latest block, possibly skipping a few.

Parameters

Name	Type	Description
skip?	number	number of blocks to skip, default 0 (= latest block)

Returns

Promise<BlockInfo>

Defined in

src/service/Client.h.ts:119

---

getLatestValues

▸ getLatestValues(streamName, key, nValues?): Promise<StreamItemPair[]>

Parameters

Name	Type
streamName	string
key	string
nValues?	number

Returns

Promise<StreamItemPair[]>

Defined in

src/service/Client.h.ts:168

---

getOrCreateStream

▸ getOrCreateStream(options): any

Parameters

Name	Type
options	CreateStreamOptions

Returns

any

Defined in

src/service/Client.h.ts:132

---

getPeerInfo

▸ getPeerInfo(): Promise<PeerInfo[]>

Returns

Promise<PeerInfo[]>

Defined in

src/service/Client.h.ts:144

---

getRpcClient

▸ getRpcClient(): RpcClient

Returns

RpcClient

Defined in

src/service/Client.h.ts:182

---

getValue

▸ getValue(streamName, key): Promise<StreamItemPair>

Parameters

Name	Type
streamName	string
key	string

Returns

Promise<StreamItemPair>

Defined in

src/service/Client.h.ts:171

---

getValues

▸ getValues(streamName, key, nValues?): Promise<StreamItemPair[]>

Parameters

Name	Type
streamName	string
key	string
nValues?	number

Returns

Promise<StreamItemPair[]>

Defined in

src/service/Client.h.ts:165

---

isValidAddress

▸ isValidAddress(address): Promise<any>

Parameters

Name	Type
address	string

Returns

Promise<any>

Defined in

src/service/Client.h.ts:148

---

latestValuesForKey

▸ latestValuesForKey(streamId, key, nValues?): Promise<any[]>

Parameters

Name	Type
streamId	string
key	string
nValues?	number

Returns

Promise<any[]>

Defined in

src/service/Client.h.ts:151

---

listBlocksByHeight

▸ listBlocksByHeight(to, from?, verbose?): Promise<BlockListItem[]>

Retrieve all blocks metadata by block height range. You can retrieve the current maximum block height through calling getLastBlockInfo

Parameters

Name	Type	Description
to	number	highest block height to return (inclusive)
from?	number	lowest block to return (inclusive), defaults to 0
verbose?	boolean	verbose output, defaults to false

Returns

Promise<BlockListItem[]>

Defined in

src/service/Client.h.ts:129

---

listStreamBlockItemsByHeight

▸ listStreamBlockItemsByHeight(streamName, to, from?, verbose?): Promise<Item[]>

Retrieve all items within a stream by block height range.

Parameters

Name	Type	Description
streamName	string	Stream Name to Read
to	number	Highest block height to retrieve (inclusive)
from?	number	Lowest block height to retrieve (inclusive), defaults to 0
verbose?	boolean	Get verbose data (not typed!)

Returns

Promise<Item[]>

Defined in

src/service/Client.h.ts:198

---

ping

▸ ping(): any

Returns

any

Defined in

src/service/Client.h.ts:146

---

setValue

▸ setValue(streamName, streamKey, object): Promise<void>

Parameters

Name	Type
streamName	string
streamKey	StreamKey
object	any

Returns

Promise<void>

Defined in

src/service/Client.h.ts:174

---

streamItems

▸ streamItems(streamId): Promise<StreamItem[]>

Parameters

Name	Type
streamId	string

Returns

Promise<StreamItem[]>

Defined in

src/service/Client.h.ts:138

---

streams

▸ streams(stream?): Promise<Stream[]>

Parameters

Name	Type
stream?	string

Returns

Promise<Stream[]>

Defined in

src/service/Client.h.ts:135

---

updateStreamItem

▸ updateStreamItem(streamId, key, object): Promise<string>

Parameters

Name	Type
streamId	string
key	string | string[]
object	any

Returns

Promise<string>

Defined in

src/service/Client.h.ts:158

---

updateValue

▸ updateValue(streamName, key, updateCallback): Promise<void>

Parameters

Name	Type
streamName	string
key	string
updateCallback	(current: Resource) => Resource

Returns

Promise<void>

Defined in

src/service/Client.h.ts:176

---

v2_readStreamItems

▸ v2_readStreamItems(streamName, key, nValues?): Promise<Item[]>

Parameters

Name	Type
streamName	string
key	string
nValues?	number

Returns

Promise<Item[]>

Defined in

src/service/Client.h.ts:184