hpcore/examples/nodejs_contract/hp-contract-lib.js

const fs = require('fs');
const tty = require('tty');

// Hot Pocket contract library version 0.5.0

const MAX_SEQ_PACKET_SIZE = 128 * 1024;
const controlMessages = {
    contractEnd: "contract_end",
    unlChangeset: "unl_changeset"
}
Object.freeze(controlMessages);

const clientProtocols = {
    json: "json",
    bson: "bson"
}
Object.freeze(clientProtocols);

const PATCH_CONFIG_PATH = "../patch.cfg";
const POST_EXEC_SCRIPT_NAME = "post_exec.sh";

/*
 * Class members prefixed with '__' represent private members until ES spec fully supports '#' notation.
 */

class HotPocketContract {

    constructor() {
        this.__controlChannel = null;
        this.__clientProtocol = null;

        this.__executeContract = (hpargs, contractFunc) => {
            // Keeps track of all the tasks (promises) that must be awaited before the termination.
            const pendingTasks = [];
            const nplChannel = new NplChannel(hpargs.npl_fd);

            const users = new UsersCollection(hpargs.user_in_fd, hpargs.users, this.__clientProtocol);
            const unl = new UnlCollection(hpargs.readonly, hpargs.unl, nplChannel, pendingTasks);
            const executionContext = new ContractContext(hpargs, users, unl, this.__controlChannel);

            invokeCallback(contractFunc, executionContext).catch(errHandler).finally(() => {
                // Wait for any pending tasks added during execution.
                Promise.all(pendingTasks).catch(errHandler).finally(() => {
                    nplChannel.close();
                    this.__terminate();
                });
            });
        }

        this.__terminate = () => {
            this.__controlChannel.send({ type: controlMessages.contractEnd });
            this.__controlChannel.close();
        }
    }

    init(contractFunc, clientProtocol = clientProtocols.json) {

        return new Promise(resolve => {
            if (this.__controlChannel) { // Already initialized.
                resolve(false);
                return;
            }

            this.__clientProtocol = clientProtocol;

            // Check whether we are running on a console and provide error.
            if (tty.isatty(process.stdin.fd)) {
                console.error("Error: Hot Pocket smart contracts must be executed via Hot Pocket.");
                resolve(false);
                return;
            }

            // Parse HotPocket args.
            fs.readFile(process.stdin.fd, 'utf8', (err, argsJson) => {
                const hpargs = JSON.parse(argsJson);
                this.__controlChannel = new ControlChannel(hpargs.control_fd);
                this.__executeContract(hpargs, contractFunc);
                resolve(true);
            });
        });
    }
}

class ContractContext {

    constructor(hpargs, users, unl, controlChannel) {
        this.__controlChannel = controlChannel;
        this.readonly = hpargs.readonly;
        this.timestamp = hpargs.timestamp;
        this.users = users;
        this.unl = unl; // Not available in readonly mode.
        this.lcl_seq_no = hpargs.lcl_seq_no; // Not available in readonly mode.
        this.lcl_hash = hpargs.lcl_hash; // Not available in readonly mode.
        this.__patchConfig = new PatchConfig();
    }

    // Returns the config values in patch config.
    getConfig() {
        return this.__patchConfig.getConfig();
    }

    // Updates the config with given config object and save the patch config.
    updateConfig(config) {
        return this.__patchConfig.updateConfig(config);
    }
}

// Handles patch config manipulation.
class PatchConfig {

    // Loads the config value if there's a patch config file. Otherwise throw error.
    getConfig() {
        if (!fs.existsSync(PATCH_CONFIG_PATH))
            throw "Patch config file does not exist.";

        return new Promise((resolve, reject) => {
            fs.readFile(PATCH_CONFIG_PATH, 'utf8', function (err, data) {
                if (err) reject(err);
                else resolve(JSON.parse(data));
            });
        });
    }

    updateConfig(config) {

        this.validateConfig(config);

        return new Promise((resolve, reject) => {
            // Format json to match with the patch.cfg json format created by HP at the startup.
            fs.writeFile(PATCH_CONFIG_PATH, JSON.stringify(config, null, 4), (err) => {
                if (err) reject(err);
                else resolve();
            });
        });
    }

    validateConfig(config) {
        // Validate all config fields.
        if (!config.version)
            throw "Contract version is not specified.";
        if (!config.unl || !config.unl.length)
            throw "UNL list cannot be empty.";
        for (let pubKey of config.unl) {
            // Pubkeys are validated against length, ed prefix and hex characters.
            if (!pubKey.length)
                throw "UNL pubKey not specified.";
            else if (!(/^(e|E)(d|D)[0-9a-fA-F]{64}$/g.test(pubKey)))
                throw "Invalid UNL pubKey specified.";
        }
        if (!config.bin_path || !config.bin_path.length)
            throw "Binary path cannot be empty.";
        if (config.roundtime < 1 && config.roundtime > 3600000)
            throw "Round time must be between 1 and 3600000ms inclusive.";
        if (config.stage_slice < 1 || config.stage_slice > 33)
            throw "Stage slice must be between 1 and 33 percent inclusive.";
        if (config.consensus != "public" && config.consensus != "private")
            throw "Invalid consensus flag configured in patch file. Valid values: public|private";
        if (config.npl != "public" && config.npl != "private")
            throw "Invalid npl flag configured in patch file. Valid values: public|private";
        if (config.round_limits.user_input_bytes < 0 || config.round_limits.user_output_bytes < 0 || config.round_limits.npl_output_bytes < 0 ||
            config.round_limits.proc_cpu_seconds < 0 || config.round_limits.proc_mem_bytes < 0 || config.round_limits.proc_ofd_count < 0)
            throw "Invalid round limits.";
        if (config.max_input_ledger_offset < 0)
            throw "Invalid max input ledger offset";
    }
}

class UsersCollection {

    constructor(userInputsFd, usersObj, clientProtocol) {
        this.__users = {};
        this.__infd = userInputsFd;

        Object.entries(usersObj).forEach(([pubKey, arr]) => {

            const outfd = arr[0]; // First array element is the output fd.
            arr.splice(0, 1); // Remove first element (output fd). The rest are pairs of msg offset/length tuples.

            const channel = new UserChannel(outfd, clientProtocol);
            this.__users[pubKey] = new User(pubKey, channel, arr);
        });
    }

    // Returns the User for the specified pubkey. Returns null if not found.
    find(pubKey) {
        return this.__users[pubKey]
    }

    // Returns all the currently connected users.
    list() {
        return Object.values(this.__users);
    }

    count() {
        return Object.keys(this.__users).length;
    }

    async read(input) {
        const [offset, size] = input;
        const buf = Buffer.alloc(size);
        await readAsync(this.__infd, buf, offset, size);
        return buf;
    }
}

class User {

    constructor(pubKey, channel, inputs) {
        this.pubKey = pubKey;
        this.inputs = inputs;
        this.__channel = channel;
    }

    async send(msg) {
        await this.__channel.send(msg);
    }
}

class UserChannel {

    constructor(outfd, clientProtocol) {
        this.__outfd = outfd;
        this.__clientProtocol = clientProtocol;
    }

    send(msg) {
        const messageBuf = this.serialize(msg);
        let headerBuf = Buffer.alloc(4);
        // Writing message length in big endian format.
        headerBuf.writeUInt32BE(messageBuf.byteLength)
        return writevAsync(this.__outfd, [headerBuf, messageBuf]);
    }

    serialize(msg) {

        if (!msg)
            throw "Cannot serialize null content.";

        if (Buffer.isBuffer(msg))
            return msg;

        if (this.__clientProtocol == clientProtocols.bson) {
            return Buffer.from(msg);
        }
        else { // json

            // In JSON, we need to ensure that the final buffer contains a string.
            if (typeof msg === "string" || msg instanceof String)
                return Buffer.from(msg);
            else
                return Buffer.from(JSON.stringify(msg));
        }
    }
}

class UnlCollection {

    constructor(readonly, unl, channel, pendingTasks) {
        this.nodes = {};
        this.__readonly = readonly;
        this.__pendingTasks = pendingTasks;

        if (!readonly) {
            unl.forEach(pubKey => {
                this.nodes[pubKey] = new UnlNode(pubKey);
            });

            this.__channel = channel;
        }
    }

    // Returns the unl node for the specified pubkey. Returns null if not found.
    find(pubKey) {
        return this.nodes[pubKey];
    }

    // Returns all the unl nodes.
    list() {
        return Object.values(this.nodes);
    }

    count() {
        return Object.keys(this.nodes).length;
    }

    // Registers for NPL messages.
    onMessage(callback) {

        if (this.__readonly)
            throw "NPL messages not available in readonly mode.";

        this.__channel.consume((pubKey, msg) => {
            this.__pendingTasks.push(invokeCallback(callback, this.nodes[pubKey], msg));
        });
    }

    // Broadcasts a message to all unl nodes (including self if self is part of unl).
    async send(msg) {
        if (this.__readonly)
            throw "NPL messages not available in readonly mode.";

        await this.__channel.send(msg);
    }
}

// Represents a node that's part of unl.
class UnlNode {

    constructor(pubKey) {
        this.pubKey = pubKey;
    }
}

// Represents the node-party-line that can be used to communicate with unl nodes.
class NplChannel {

    constructor(fd) {
        this.__fd = fd;
        this.__readStream = null;
    }

    consume(onMessage) {

        this.__readStream = fs.createReadStream(null, { fd: this.__fd, highWaterMark: MAX_SEQ_PACKET_SIZE });

        // From the hotpocket when sending the npl messages first it sends the pubkey of the particular node
        // and then the message, First data buffer is taken as pubkey and the second one as message,
        // then npl message object is constructed and the event is emmited.
        let pubKey = null;

        this.__readStream.on("data", (data) => {
            if (!pubKey) {
                pubKey = data.toString();
            }
            else {
                onMessage(pubKey, data);
                pubKey = null;
            }
        });

        this.__readStream.on("error", (err) => { });
    }

    send(msg) {
        const buf = Buffer.from(msg);
        if (buf.length > MAX_SEQ_PACKET_SIZE)
            throw ("NPL message exceeds max size " + MAX_SEQ_PACKET_SIZE);
        return writeAsync(this.__fd, buf);
    }

    close() {
        this.__readStream && this.__readStream.close();
    }
}


class ControlChannel {

    constructor(fd) {
        this.__fd = fd;
        this.__readStream = null;
    }

    consume(onMessage) {
        this.__readStream = fs.createReadStream(null, { fd: this.__fd, highWaterMark: MAX_SEQ_PACKET_SIZE });
        this.__readStream.on("data", onMessage);
        this.__readStream.on("error", (err) => { });
    }

    send(obj) {
        const buf = Buffer.from(JSON.stringify(obj));
        if (buf.length > MAX_SEQ_PACKET_SIZE)
            throw ("Control message exceeds max size " + MAX_SEQ_PACKET_SIZE);
        return writeAsync(this.__fd, buf);
    }

    close() {
        this.__readStream && this.__readStream.close();
    }
}

const writeAsync = (fd, buf) => new Promise(resolve => fs.write(fd, buf, resolve));
const writevAsync = (fd, bufList) => new Promise(resolve => fs.writev(fd, bufList, resolve));
const readAsync = (fd, buf, offset, size) => new Promise(resolve => fs.read(fd, buf, 0, size, offset, resolve));

const invokeCallback = async (callback, ...args) => {
    if (!callback)
        return;

    if (callback.constructor.name === 'AsyncFunction') {
        await callback(...args).catch(errHandler);
    }
    else {
        callback(...args);
    }
}

const errHandler = (err) => console.log(err);

module.exports = {
    Contract: HotPocketContract,
    clientProtocols,
    POST_EXEC_SCRIPT_NAME,
}