Evernode All-in-One Developer Kit

This package consolidates existing CLI tools, such as hpdevkit and evdevkit, along with Evernode development-related npm packages, into a single development kit. Depending on the installation mode, it can function either as a CLI tool or as a composite npm package.

Install as a CLI Tool (Global)

Prerequisites

To use the Evernode Kit as a CLI tool, you need to install:

• Node.js on your development machine.
• Docker.

Cross-Platform Support

This package is a global npm module that supports both Linux and Windows.

Installation

1. Ensure the prerequisites are installed.
2. Install the evernode package globally by running:

   npm install -g evernode

Usage

Once installed as a CLI tool, you can use the evernodecli command. To see the available commands, run:

evernodecli help

Updating the CLI Tool

To update evernodecli to the latest version, run:

evernodecli update

Uninstallation

To uninstall evernodecli, run:

evernodecli uninstall

Note: On Linux platforms, you may need root privileges for installation, updates, and uninstallation. Prefix the above commands with sudo if necessary.

Install as an npm Package (Local)

Prerequisites

To use the Evernode Kit as a local npm package, you need to install:

• Node.js on your development machine.

Installation

1. Ensure the prerequisites are installed.
2. Create a directory and initialize a Node.js workspace by running:

   npm init

3. Install the evernode package locally by running:

   npm install evernode

Usage

In your Node.js project, require the evernode package to access its functionality. Example usage:

/*
    The Evernode package includes the following built-in npm packages:
    - EvernodeClient: evernode-js-client
    - HotPocketClient: hotpocket-js-client
    - HotPocketContract: hotpocket-nodejs-contract
    - EverPocketContract: everpocket-nodejs-contract
*/

const { EvernodeClient, HotPocketClient, HotPocketContract, EverPocketContract } = require('evernode');

async function main() {
    // Configure the Evernode client to use the testnet
    await EvernodeClient.Defaults.useNetwork('testnet');

    // Fetch and print the governor address
    const governorAddress = EvernodeClient.Defaults.values.governorAddress;
    console.log('Governor address:', governorAddress);
}

main();

Updating the npm Package

To update the evernode package to the latest version, run:

npm update evernode