Almonte: Removed the limitations as the packaged is already deployed to NPM

2021-05-18T12:13:49Z

Removed the limitations as the packaged is already deployed to NPM

New page

<languages />
<translate>
{{#seo:
|title=Node JS module Ardor
|titlemode=replace
|keywords=ardor learning hub, ardor documentation, blockchain, proof of stake, ardor, ignis, jelurida, development, ardor wiki, wiki, tutorials, advanced tutorials, how to, Node JS module
|description=Guide for the Node JS module which can be used for JavaScript application development using the Ardor platform APIs.
}}
[[Category:Advanced_guides]]
__TOC__
==Introduction== 


Existing client API library for Ardor suffer from the following limitations:


#The API library sends the passphrase directly to the remote node in order to sign transactions, this means that the remote node has to be trusted which limits the usability of the API library.
#Some client libraries does implement local transaction signing but still were unable to validate unsigned bytes data returned from a random remote node thus still making it somewhat insecure to submit transactions to a random remote node.
#Client API libraries are developed by 3rd party developers so sometimes lag behind recent changes.


To address these problems we introduced a simple Node JS module which can be used for JavaScript application development using the Ardor platform APIs.


This node JS module is now integral part of the core. It is wrapper of the existing Ardor Wallet JavaScript code configured as a node JS module.

The official Ardor NPM package link is the following https://www.npmjs.com/package/ardor

==Use Cases== 


#The Node JS module is able to work securely against any random Ardor node without trusting the node.
#When submitting a transaction, data submitted to a remote node is validated against the returned unsigned bytes.
#Transactions are signed locally so that the account passphrase is never submitted to a remote node.
#Message encrytption can be performed client side.
#API calls work at a higher level compared to the APIs provided by the existing test page, so that for example, complex numeric conversions and various formatting functions are already implemented by the API library.
#Updates to this API library will follow the standard Ardor release process and will be maintained by core developers.

==Getting Started== 


To quickly get started using the node JS module, see instructions for [[Node_JS_module#Setup using Ardor installation|Setup using Ardor installation]] or the setup using the official [https://www.npmjs.com/package/ardor NPM Ardor package]

=== Setup using NPM ===

*<code>npm i ardor</code>

*<code>echo n | copy /-y node_modules\ardor\sample\*.* *.*</code> - copy the Ardor samples without overwriting existing files

=== Setup using Ardor installation ===

* Install the Ardor software (no need to download the blockchain)
* Install Node JS and NPM from [https://nodejs.org nodejs.org]
*Open a command prompt
* Navigate to the Ardor installation folder
**<code>cd html/www/js</code> - make sure the folder has write permissions
**<code>npm install</code>
**<code>cd sample</code>

== Run Examples ==

* Configure the remote node, Ardor account and default chain by editing the <code>config.json</code> file
* Invoke any of the available samples using node, for example <code>node send.money.js</code>

== Packaging and Distribution ==

If installed from Ardor installation, the Ardor package no longer depends on a local Ardor node.
You can use the content of the <code>html/www/js</code> folder as a standalone module.

== Warning ==

Your passphrase or private key are submitted to a remote node only when invoking specific APIs which require them to operate like the startForging API.

We recommend that you avoid using these APIs in your scripts when connecting to an untrusted remote node.
</translate>

Node JS module - Revision history

Almonte: Removed the limitations as the packaged is already deployed to NPM