npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@web3-systems/multichain-in-memory-database

v0.1.0-beta.3

Published

In-memory database for multichain EVM state: transactions, receipts, logs and memoized computes.

Downloads

10

Readme

Multichain In-Memory Database

Build Coverage Status ts GPLv3 license npm

The @web3-systems/multichain-in-memory-database node module is an in-memory database for multichain EVM state: transactions, receipts, logs and memoized computes.

Blockchain state is loaded into the memory for high-performance queries in both the browser and backend systems.

To learn more about indexing, queries, DynamicViews and other database related features reference LokiJS

💾 Installation

Install NPM package:

npm install @web3-systems/multichain-in-memory-database
yarn add @web3-systems/multichain-in-memory-database

Clone from Github:

git clone https://github.com/web3-systems/multichain-in-memory-database

📖 Overview

The multichain databases/caches are managed using a MultichainInMemoryDatabase instance. The instance is an adapter for the LokiJS multi-environment, in-memory database with performant indexing and queries.

🏎️ Quickstart

In just a few lines a new chain database can be initialized - enabling advanced search queries in both browsers and backends.

import MultichainInMemoryDatabase from '@web3-systems/multichain-in-memory-database';
const chainIdDefault = 1;
let inMemoryDatabase: MultichainInMemoryDatabase;
inMemoryDatabase = new MultichainInMemoryDatabase(chainIdDefault);
inMemoryDatabase.initializeDefaultCollections(chainIdDefault, 'indexeddb');
inMemoryDatabase.insertMultiple('transactions', transactionList, chainIdDefault);
const findQuery = {data: { $eq: '0x0' }};
const documents = inMemoryDatabase.find('transactions', findQuery, chainIdDefault);

🪜 Examples

Simple Search - FindQuery

The primary operators currently supported are:

$eq - filter for document(s) with property of (strict) equality $ne - filter for document(s) with property not equal to provided value $aeq - filter for document(s) with property of abstract (loose) equality $dteq - filter for document(s) with date property equal to provided date value $gt - filter for document(s) with property greater than provided value $gte - filter for document(s) with property greater or equal to provided value $lt - filter for document(s) with property less than provided value $lte - filter for document(s) with property less than or equal to provided value $between - filter for documents(s) with property between provided vals.

Find Transaction Hash

To find a single transaction use a find query with an equal operator matching the hash.

export interface FindQuery {
  [key: string]: any;
}

The FindQuery object is similar to a MongoDB find filter object.

const findQuery = {
    hash: { 
        $eq: '0x0' 
    },
};

Advanced Search - ChainedQuery

ChainedQuery Interface All inputs are optional when constucting a chained query.

export interface ChainedQuery {
  find?: any;
  where?: any;
  simplesort?: any;
  offset?: any;
  limit?: any;
}

Basic ChainedQuery

A straight-forward example is using limit and find to return the first a single transaction matching the data inputs.

const chainedQuery = {
    limit: 1,
    find: {
        data: {
            $eq: '0x2'
        },
    },
};

const documents = inMemoryDatabase.search('transactions', chainedQuery, 1);
/*
    [
        {
            hash: '0x0',
            data: '0x2',
        }
    ]
*/

Complex ChainedQuery

A straight-forward example is using limit and find to return the first a single transaction matching the data inputs.

const chainedQuery = {
    offset: 0,
    limit: 10,
    find: {
        data: {
            $eq: '0x2'
        },
    },
    simplesort: 'blockNumber',
    where: () =>{},
};

const documents = inMemoryDatabase.search('transactions', chainedQuery, 1);
/*
    [
        {
            hash: '0x0',
            data: '0x2',
        }
    ]
*/

💻 Developer Experience

The package is setup using the TSDX zero-config CLI which includes:

  • Typescript
  • Rollup
  • Jest
  • Prettier
  • ESLint