Differential D16783 Diff 49718 modules/chronik-client/README.md

Changeset View

Standalone View

modules/chronik-client/README.md

	Show First 20 Lines • Show All 69 Lines • ▼ Show 20 Lines
	// Subscribe to blocks			// Subscribe to blocks
	ws.subscribeToBlocks();			ws.subscribeToBlocks();

	// Subscribe to scripts:			// Subscribe to scripts:
	ws.subscribeToScript('p2pkh', 'b8ae1c47effb58f72f7bca819fe7fc252f9e852e');			ws.subscribeToScript('p2pkh', 'b8ae1c47effb58f72f7bca819fe7fc252f9e852e');
	// Unsubscribe:			// Unsubscribe:
	ws.unsubscribeFromScript('p2pkh', 'b8ae1c47effb58f72f7bca819fe7fc252f9e852e');			ws.unsubscribeFromScript('p2pkh', 'b8ae1c47effb58f72f7bca819fe7fc252f9e852e');

	// You may also subscribe to addresses, tokenIds, and lokadIds. See integration tests.			// You may also subscribe to addresses, tokenIds, lokadIds, and plugins. See integration tests.
	```			```

	## Changelog			## Changelog

	- 0.10.1 - Deprecate client-side ping keepAlive. Server-side is now available.			- 0.10.1 - Deprecate client-side ping keepAlive. Server-side is now available.
	- 0.11.0 - Add support for `chronikInfo()` method to `ChronikClientNode`			- 0.11.0 - Add support for `chronikInfo()` method to `ChronikClientNode`
	- 0.11.1 - Do not try next server if error is unrelated to server failure			- 0.11.1 - Do not try next server if error is unrelated to server failure
	- 0.12.0 - Add support for `block(hashOrHeight)` and `blocks(startHeight, endHeight)` methods to `ChronikClientNode`			- 0.12.0 - Add support for `block(hashOrHeight)` and `blocks(startHeight, endHeight)` methods to `ChronikClientNode`
	Show All 17 Lines
	- 0.26.1 - If websocket takes longer than 5s to connect, try the next ws			- 0.26.1 - If websocket takes longer than 5s to connect, try the next ws
	- 0.26.2 - Return type `number` for `timeFirstSeen` from `chronik.token()` endpoint in `ChronikClientNode`			- 0.26.2 - Return type `number` for `timeFirstSeen` from `chronik.token()` endpoint in `ChronikClientNode`
	- 0.27.0 - Support for `lokadId` endpoints and websocket subscriptions			- 0.27.0 - Support for `lokadId` endpoints and websocket subscriptions
	- 0.28.0 - Support for websocket subscriptions by `tokenID`			- 0.28.0 - Support for websocket subscriptions by `tokenID`
	- 0.28.1 - Upgrading dependencies [D16375](https://reviews.bitcoinabc.org/D16375)			- 0.28.1 - Upgrading dependencies [D16375](https://reviews.bitcoinabc.org/D16375)
	- 0.28.2 - Improve failoverProxy to switch servers on error state [D16584](https://reviews.bitcoinabc.org/D16584)			- 0.28.2 - Improve failoverProxy to switch servers on error state [D16584](https://reviews.bitcoinabc.org/D16584)
	- 0.29.0 - Support for `plugins` endpoints: `utxos` and `groups` [D16605](https://reviews.bitcoinabc.org/D16605)			- 0.29.0 - Support for `plugins` endpoints: `utxos` and `groups` [D16605](https://reviews.bitcoinabc.org/D16605)
	- 1.0.0 - (Breaking change) Deprecate NNG chronik and rename all `InNode` classes and types [D16627](https://reviews.bitcoinabc.org/D16627). Users may no longer import `ChronikClientNode` class to run in-node chronik-client and must import `ChronikClient` (which is no longer the NNG class). [D16710](https://reviews.bitcoinabc.org/D16710)			- 1.0.0 - (Breaking change) Deprecate NNG chronik and rename all `InNode` classes and types [D16627](https://reviews.bitcoinabc.org/D16627). Users may no longer import `ChronikClientNode` class to run in-node chronik-client and must import `ChronikClient` (which is no longer the NNG class). [D16710](https://reviews.bitcoinabc.org/D16710)
				- 1.1.0 - Support websocket subscriptions to plugins [D16710](https://reviews.bitcoinabc.org/D16710)