trade-node

A framework for financial apps.
Copyright (c) 2018 Rafael da Silva Rocha
https://github.com/rochars/trade-node

Installation

npm install trade-node

trade-node

trade-node is a framework for the creation of financial apps.

trade-node implements a paradigm for financial apps where the operations themselves (called occurrences) are objects responsible for updating the state of an asset holder every time they occur.

The asset holder state at a given timestamp may be loaded from a source (like a database) and then updated with a series of occurrences - raw operation data loaded as occurrence objects. This outputs a new state for the Holder.

It uses the concept of holders, subjects and occurrences

A subject is anything that can be traded.

A holder is someone who owns subjects.

A holder state is updated by occurrences.

A subject is anything that can be traded

A subject may be the share of a corporation, livestock and so on.

A holder is a entity that owns subjects

A holder owns subjects. The holder state is updated by occurrences.

Occurrences happen with subjects and change the state of the holder

A occurrence may be caused by the holder, like the purchase of units of some subject. They can also represent third-party events, like a stock split. In both cases they should change the state of the holder.

Extending the framework

trade-node should be extended with new types of occurrences and subjects.

The holder state signature can be defined according to the needs of the application.

Use

const trade = require("trade-node");

var subject = new trade.Subject("GOOG");
var occurrence = new trade.Occurrence(
    subject,
    "2018-01-02 00:00:00",
    {"quantity": 1, "value": 1});
var holder = new trade.Holder();

holder.trade(occurrence);
console.log(holder.state);
// { GOOG: { quantity: 1, value: 1 } }

License

Copyright (c) 2018 Rafael da Silva Rocha

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.