Ethernity Cloud SDK JS

This project provides a set of tools and scripts to work with the Ethernity Cloud SDK in a JavaScript environment.

Table of Contents

• Installation
• Usage
  • Scripts
• Project Structure
• Contributing
• License

Installation

To install the package and its dependencies, run:

npm install ethernity-cloud-sdk-js

Usage

After installation, you can use the provided scripts to build, publish, and initialize your project.

Pre-requisites

The sdk requires the following to be installed on your system:

• Node.js v20.04 or higher
• npm
• docker (daemon running in the background for build and publish scripts)

Operating System compatibility

The sdk has been tested on the following operating systems:

• MacOS
• Ubuntu 20.04
• Windows 10

Blockchain compatibility

• Bloxberg:
  • Testnet - tested and working
  • Mainnet - to be provided during the following updates
• Polyhon:
  • Amoy Testnet - to be provided during the following updates
  • Mainnet - to be provided during the following updates

Scripts

• Initialize: To initialize the project, run:

  npm run ecld-init

  at this step, all the initial configurations will be set up and the project will be ready to be built, published and run.

• Build: To build the project, run:

  npm run ecld-build

  the project will be built and the docker repository output will be stored in the registry/ directory. This is the stage where the backend functions are added to the secure images.

• Publish: To publish the project, run:

  npm run ecld-publish

  Required after build, to build and integrate the secure certificates that will be used during executions and to register the project to the Ethernity Cloud Image Register.

• Run: To run the project, run:

  npm run start

  command to start the demo application and test the integration.

Project Structure

.gitignore
build.js
build.sh
demo/
init.js
nodenithy/
package.json
postinstall.js
publish.js
pynithy/

Notable Directories and Files

• build.js: Script to build the project.
• init.js: Script to initialize the project.
• publish.js: Script to publish the project.
• postinstall.js: Script that runs after the package is installed.
• nodenithy/: Contains various scripts and modules for the project.
• pynithy/: Contains Python-related scripts and configurations.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the AGPL-3.0 License. See the LICENSE file for details.