https://github.com/vaporyjs/vaporyjs-blockstream
Vapory blocks into a reliable stream of blocks
https://github.com/vaporyjs/vaporyjs-blockstream
cryptocurrency vapory
Last synced: 4 months ago
JSON representation
Vapory blocks into a reliable stream of blocks
- Host: GitHub
- URL: https://github.com/vaporyjs/vaporyjs-blockstream
- Owner: vaporyjs
- License: mit
- Created: 2018-03-04T04:43:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T00:50:53.000Z (over 2 years ago)
- Last Synced: 2024-04-26T01:42:33.473Z (about 1 year ago)
- Topics: cryptocurrency, vapory
- Language: TypeScript
- Homepage: https://vapory.org
- Size: 138 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/vaporyjs/vaporyjs-blockstream) [](https://coveralls.io/github/vaporyjs/vaporyjs-blockstream?branch=master) [](https://badge.fury.io/js/vaporyjs-blockstream)
A library to turn an unreliable remote source of Vapory blocks into a reliable stream of blocks. Handles block and log removals on chain reorganization and block and log backfills on skipped blocks.
# Usage
## Full Example
```typescript
// blockRetention is how many blocks of history to keep in memory. it defaults to 100 if not supplied
const configuration = { blockRetention: 100 };
async function getBlockByHash(hash: string): Promise {
const response = await fetch("http://localhost:8545", {
method: "POST",
headers: new Headers({"Content-Type": "application/json"}),
body: { jsonrpc: "2.0", id: 1, method: "vap_getBlockByHash", params: [hash, false] }
});
return await response.json();
}
async function getLogs(filterOptions: FilterOptions): Promise {
const response = await fetch("http://localhost:8545", {
method: "POST",
headers: new Headers({"Content-Type": "application/json"}),
body: { jsonrpc: "2.0", id: 1, method: "vap_getLogs", params: [filterOptions] }
});
return await response.json();
}
async function getLatestBlock(): Promise {
const response = await fetch("http://localhost:8545", {
method: "POST",
headers: new Headers({"Content-Type": "application/json"}),
body: { jsonrpc: "2.0", id: 1, method: "vap_getBlockByNumber", params: ["latest", false] }
});
return await response.json();
}
const blockAndLogStreamer = new BlockAndLogStreamer(getBlockByHash, getLogs, configuration);
const onBlockAddedSubscriptionToken = blockAndLogStreamer.subscribeToOnBlockAdded(block => console.log(block));
const onLogAddedSubscriptionToken = blockAndLogStreamer.subscribeToOnLogAdded(log => console.log(log));
const onBlockRemovedSubscriptionToken = blockAndLogStreamer.subscribeToOnBlockRemoved(block => console.log(block));
const onLogRemovedSubscriptionToken = blockAndLogStreamer.subscribeToOnLogRemoved(log => console.log(log));
const logFilterToken = blockAndLogStreamer.addLogFilter({address: "0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef", topics: ["0xbadf00dbadf00dbadf00dbadf00dbadf00dbadf00dbadf00dbadf00dbaadf00d"]});
blockAndLogStreamer.reconcileNewBlock(getLatestBlock());
// you will get a callback for the block and any logs that match the filter here
triggerBlockMining();
triggerBlockMining();
triggerBlockMining();
blockAndLogStreamer.reconcileNewBlock(getLatestBlock());
// you will get a callback for all blocks and logs that match the filter that have been added to the chain since the previous call to reconcileNewBlock
triggerChainReorg();
blockAndLogStreamer.reconcileNewBlock(getLatestBlock());
// you will get a callback for block/log removals that occurred due to the chain re-org, followed by block/log additions
blockAndLogStreamer.unsubscribeFromOnBlockAdded(onBlockAddedSubscriptionToken);
blockAndLogStreamer.unsubscribeFromOnBlockRemoved(onBlockRemovedSubscriptionToken);
blockAndLogStreamer.unsubscribeFromOnLogAdded(onLogAddedSubscriptionToken);
blockAndLogStreamer.unsubscribeFromOnLogRemoved(onLogRemovedSubscriptionToken);
blockAndLogStreamer.removeLogFilter(logFilterToken);
console.log(blockAndLogStreamer.getLatestReconciledBlock());
```
## Signatures
Note: if you have a TypeScript aware editor this will all be available in the tooltip
* [Filter/FilterOptions](https://github.com/vaporyjs/vaporyjs-blockstream/blob/master/source/models/filters.ts#L1-L10) - More details at [Parity JSON-RPC Wiki](https://github.com/paritytech/parity/wiki/JSONRPC-vap-module#vap_newfilter)
* [Block](https://github.com/vaporyjs/vaporyjs-blockstream/blob/master/source/models/block.ts#L3-L22) - More details at [Parity JSON-RPC Wiki](https://github.com/paritytech/parity/wiki/JSONRPC-vap-module#vap_getblockbyhash)
* [Log](https://github.com/vaporyjs/vaporyjs-blockstream/blob/master/source/models/log.ts#L1-L10) - More details at [Parity JSON-RPC Wiki](https://github.com/paritytech/parity/wiki/JSONRPC-vap-module#vap_getfilterchanges)
# Development
## Build
```
docker build -t blockstream .
```
or
```
npm run build
```
## Test
```
docker run blockstream
````
or
```
npm run test
```