@fruitsjs/monitor
TypeScript icon, indicating that this package has built-in type declarations

1.1.3 • Public • Published

@fruitsjs/monitor

A monitor to watch for specific changes on the the Fruits Eco-Blockchain platform

Due to average blocktime of 240 seconds, transactions stay pending for a certain time. It is a repeating pattern to watch for such changes and waiting for confirmation. This package simplifies this task.

Installation

@fruitsjs/monitor can be used with NodeJS or Web.

Using with NodeJS and/or modern web frameworks

Install using npm:

npm install @fruitsjs/monitor

or using yarn:

yarn add @fruitsjs/monitor

Example

import {Monitor} from '@fruitsjs/monitor'
import {composeApi} from "@fruitsjs/core";

// A method that checks if an account exists
// > IMPORTANT: Do not use closures, when you need to serialize the monitor
async function tryFetchAccount() {
    const api = composeApi({ nodeHost: 'https://testnet.fwallet.net/'})
    try{
        const {account} = await api.account.getAccount('1234')
        return account;
    }catch (e){
        // ignore error
        return null;
    }
}

// A comparing function to check if a certain condition for the returned data from fetch function
// is true. If it's true the monitor stops
function checkIfAccountExists(account) {
    return account !== null;
}

// Create your monitor
const monitor = new Monitor({
    asyncFetcherFn: tryFetchAccount,
    compareFn: checkIfAccountExists,
    intervalSecs: 10, // polling interval in seconds
    key: 'monitor-account',
    timeoutSecs: 2 * 240 // when reached timeout the monitor stops
});
// starts monitor
monitor.start();

// called when `checkIfAccountExists` returns true
monitor.onFulfilled(() => {
    console.log('Yay, account active');
});

// called when `timeoutSecs` is reached
monitor.onTimeout(() => {
    console.log('Hmm, something went wrong');
});

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 1.1.3
    1
    • latest

Version History

Package Sidebar

Install

npm i @fruitsjs/monitor

Weekly Downloads

11

Version

1.1.3

License

Apache-2.0

Unpacked Size

141 kB

Total Files

80

Last publish

Collaborators

  • fruits-eco-blockchain