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

market-transactions-engine

v1.0.2

Published

A market transactions engine to take a number of buy and sell orders, determine a price and filling the orders upon supply and demand

Downloads

12

Readme

Market Transactions Engine.

NPM Version   Unit Test

npm i market-transactions-engine

A market engine to determine price and fulfill orders based on supply and demand. This is designed for utilization as an embedded market engine in discrete simulations/games.

Example simulation: https://prehistoric.tech, simulation source

How it works

imports:

import { Order, MarketTransactionsEngine } from 'market-transactions-engine';

The market is simulated by discrete Order, which takes this form:

interface Order {
    orderId: string;
    resourceName: string;
    orderType: boolean; // buy or sell. buy=true, sell=false
    unitPrice: number;
    // for buy orders, the unitPrice represent the highest price payable
    // for sell orders, the unitPrice represent the lowest price accepted
    quantity: number;
    delivered: boolean;
    settlePrice?: number;
    quantityFulfilled?: number;
}

Market engine takes a list of above orders, and process them at once, filling the orders with the highest buy price and lowest sell price until the prices meet.

Order are updated in place, hence they may be controlled by other entities instead of being tied to MarketTransactionsEngine.

A very quick example:

let engine = new MarketTransactionsEngine();
let order1 = new Order("Rice", true, 1.2, 1); // commodity, buy/sell, unit price, quantity
let order2 = new Order("Rice", true, 1.1, 1);
let order3 = new Order("Rice", false, 1, 1.5);
engine.addOrders([order1, order2, order3]);
engine.processOrders();
let riceReport = engine.getData().get("Rice");
// Rice Report:
{
  sellOrdersCount: 1,
  buyOrdersCount: 2,
  sellOrdersVolume: 1.5,
  buyOrdersVolume: 2,
  sellOrdersDelivered: 1,
  buyOrdersDelivered: 2,
  actualVolume: 1.5,
  actualPrice: 1.1
}

// order2 is updated in this process and is half filled per market:
Order {
  orderId: '25a3877a-fdf1-487c-b2c2-1fb6f97cde3e',
  resourceName: 'Rice',
  orderType: true,
  unitPrice: 1.1,
  quantity: 1,
  delivered: true,
  settlePrice: 1.1,
  quantityFulfilled: 0.5
}

See tests for more robust examples