@logsn/client

Documentation for the Logstore Client:

The Logstore Client is a Javascript library which serves to adds functionality for interacting with LogStore and has the following methods.

**constructor(config?: LogStoreClientConfig)**

This is the constructor for the LogStoreClient class. It takes an optional configuration object, config ****of type LogStoreClientConfig, which can be used to configure the client. .

import { StreamrClientConfig } from '@streamr/sdk;

export interface LogStoreClientConfig extends StreamrClientConfig {
	contracts?: StreamrClientConfig['contracts'] & {
		logStoreNodeManagerChainAddress?: string;
		logStoreStoreManagerChainAddress?: string;
		logStoreTheGraphUrl?: string;
	};
}

**queryStake(amount: BigNumberish, options = { usd: false })**

Stakes the specified amount of funds in order to perform queries. amount is a BigNumberish type and options is an object with a single optional property, usd, which is a boolean indicating whether the amount is in USD.

query(streamDefinition: StreamDefinition, options: QueryOptions, onMessage?: MessageListener)

Queries a stream for historical data.

streamDefinition is an object containing the stream ID and partition that should be queried. options is an object that defines the query options.

onMessage is an optional callback function that is called for each message retrieved from the stream.

Returns a Promise that resolves to a MessageStream object that provides an alternative way of iterating through the messages.

stakeOrCreateStore(streamIdOrPath: string, amount: BigNumberish)

Creates a stream in LogStore and/or stake some funds to the provided stream.

streamIdOrPath is the ID or path of the stream to be added.

amount is a BigNumberish type representing the amount to be staked on the stream.

async removeStreamFromLogStore(streamIdOrPath: string)

Removes a stream from LogStore.

streamIdOrPath is the ID or path of the stream to be removed.

isLogStoreStream(streamIdOrPath: string)

Checks if a stream is assigned to a storage node.

streamIdOrPath is the ID or path of the stream to check.

getLogStoreStreams()

Gets all streams assigned to a storage node.

Returns a Promise that resolves to an object with a blockNumber property indicating the current blockchain state and a Stream[] property representing the list of streams stored on LogStore nodes.

Code Examples and Snippets

import { LogStoreClient } from '@logsn/client';

// Initialize the logstore client
const logStoreClient = new LogStoreClient({
	auth: {
		privateKey: '0xabc123...',
	},
});

// Create a new stream
const newStream = await logStoreClient.createStream({
	id: 'domain/streamId',
});

// Adding the stream to logstore and staking some tokens to it
await logStoreClient.addStreamToLogStore(newStream.id, STAKE_AMOUNT);

// Staking some funds for the purpose of making a query
await logStoreClient.queryStake(STAKE_AMOUNT);

Using the HTTP Query API

The Logstore provides two methods to query data: Server-Sent Events (SSE) and HTTP GET requests.

// Create a query URL
const queryUrl = await logstoreClient.createQueryUrl(
  'http://some-broker-endpoint.com',
  { streamId, partition },
  "Last",
  { count: NUM_OF_LAST_MESSAGES },
);

Server-Sent Events (SSE)

// Fetch data using SSE
const streamResponse = await axios.get(queryUrl, {
  headers: { Authorization: `Basic ${token}`, Accept: "text/event-stream" },
  responseType: "stream",
});

HTTP GET Requests

// Fetch data using HTTP GET
const response = await axios.get(queryUrl, {
  headers: { Authorization: `Basic ${token}` },
}).then(({ data }) => data as HTTPQueryJSONResponse);

The API supports different types of queries and response formats. Regular HTTP responses are limited to 5000 messages per request. For real-time or incremental processing, use SSE.

For more detailed information, please refer to the Logstore API Reference.

Contributing

Installation

pnpm i

This will execute the modules NPM script which will produce the modules directory. modules contains the raw files of the streamr-network required to build the Log Store Client.

Browser Compatibility - modules

pnpm modules - used to install the source code as a dependency for browser compat.

Babel powered browser bundle currently does not emit tsyringe Typeinfo, and therefore causes bugs when imported to be extended. By including Streamr classes in bundle, we enable Babel to transpile with source.

Node Compatibility

"@streamr-client": "file:../../node_artifacts/fork-streamr-client-8.1.0.tgz", included in package.json. This way Node code can pick up forked streamr-client at @streamr-client.

Typescript can compile the forked streamr-client included in ../../node_artifacts for with Node.js. Also used for development speed as modules takes longer to setup.

pnpm build:modules - is also available for Node.

Building

For Node: pnpm build

For Browser: pnpm build-browser-production