Skip to content

iota-pico/lib-nodejs

Repository files navigation

GitHub license Build Status

IOTA Pico Framework Lib for NodeJS

The IOTA Pico Framework library is an alternative to the official iota.lib.js

The library is a bundle of all the following components:

If you want to run in the browser try the alternate version @iota-pico/lib-browser

Installation

npm install @iota-pico/lib-nodejs --save

The library also has a dependency of big-integer which should get installed with the main package.

There are two variants of the library

If you don't want all of the proof of work algorithms, there are some alternative smaller packages:

TypeScript Definitions

TypeScript definitions can be found in the pkg/iota-pico-lib-nodejs.d.ts and should be located automatically by your developments tools.

Usage

The library is compiled into a CommonJS that can be included directly in the NodeJS. You can see various usage scenarios in the following browser tutorials:

Documentation

The documentation for each part of the library can be found in it's relevant repository:

Tutorials

Tutorials can be found in the following repo @iota-pico/tutorials

Contributing

Contributions are always welcome to the project. Feel free to raise issues, create pull requests or just make suggestions.

Authors

Come and find us on the IOTA Discord development channels

License

This project is licensed under the MIT License - see the LICENSE file for details.