uplink-nodejs binding

Developed using v1.2.2 storj/uplink-c

API documentation and tutorial

About The Project

Storj is one of the most popular Cloud Storage which is Decentralized, Secure, Private, Reliable, Affordable

How it works:

• Objects are encrypted
• Encrypted objects are split into smaller pieces.
• Object pieces are globally distributed.
• Objects are retrieved when you need them.

This project is built with C/C++ and the building result is binding libraries of uplink in nodejs.

Getting Started

Prerequisites

• please ensure make is already installed.
• proper C/C++ compiler toolchain, like GCC
• please ensure Node.js with version 10 or higher is installed

   $ node -v

• please ensure node-gyp dependencies is already installed.

   $ npm install -g node-gyp

  • Make sure your PATH includes the $GOPATH/bin directory, so that your commands can be easily used Refer: Install the Go Tools:

    $ export PATH=$PATH:$GOPATH/bin

Building the Package

• download the source project

   $ git clone https://github.com/storj-thirdparty/uplink-nodejs.git

  • after changing the source code, build it

    $ npm run preinstall

Testing the Results

The source project includes testing script to test it locally.

• need to build and release the binaries to root directory of the project

  $ npm install

• creat secret.txt in root directory of project and input api key getting from access panel whiling creating Access Grant in storj.io
• In /test/testcase.js, change the satelliteURL with the information getting from access panel whiling creating Access Grant in storj.io
• run the test

  $ npm test

Usage

• Install the storj-nodejs Node.js package

  $ npm install uplink-nodejs

• Set Environment variable
  • MacOS
    • Set DYLD_LIBRARY_PATH environment variable

      $ export  DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$PWD/node_modules/uplink-nodejs/

      OR
    • Copy libuplinkc. files from $PROJECTROOT/node_modules/uplink-nodejs/ to /usr/local/lib
  • Linux
    • Set LD_LIBRARY_PATH environment variable

      $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD/node_modules/uplink-nodejs/

      OR
    • Copy libuplinkc. files from $PROJECTROOT/node_modules/uplink-nodejs/ to /usr/lib
    • Windows
      • Set Path environment variable to libuplinkc. which is $PROJECTROOT/node_modules/uplink-nodejs
• In node application, import the package and call functions

  const storj = require("uplink-nodejs");
  const libUplink = new storj.Uplink();

Documentation

For more information on function definations and diagrams, check out the Detail or jump to:

• Uplink-nodejs Binding Functions
• Flow Diagram
• libuplink Documentation
• Testing

Storj-Nodejs Changelog

[1.2.5]-29-04-2021

• Updated ReadMe.md

[1.2.5]-28-04-2021

• Updated ReadMe.md

[1.2.4]-19-04-2021

• Added version with libuplinkc filename
• Changed default path of libiplinkc for MacOS

[1.2.3]-10-02-2021

• Tagged uplink-c v1.2.2
• Updated documentation

[1.2.0]-29-01-2021

• Updated HelloStorj.js
• Updated package.json
• Updated documentation

[1.0.9] - 27-11-2020

• Merged PR

[1.0.7] - 03-09-2020

• Added functions and updated code according to uplink-c v1.1.0 master branch

[1.0.7] - 24-08-2020

• Updated Make file

[1.0.6] - 10-08-2020

• Changed function structures
• Updates documentation
• Updated HelloStorj.js

[1.0.5] - 13-07-2020

• Added Testcases
• Updates documentation

[1.0.5] - 29-06-2020

• Bugs fixed
• Removed docs folder

[1.0.4] - 25-06-2020

• Asyncronous function
• Changed HelloStorj.js
• Splitted c files

[1.0.3] - 09-06-2020

Changelog:

• Updated ReadMe
• Removed Warnings
• Improved Memory managment and memory leaks
• Changed module name

[1.0.2] - 09-05-2020

Changelog:

• Updated module version

[0.10.2] - 06-05-2020

Changelog:

• Updated README.md
• Add Makefile
• Resloved MacOS Image not fount issue

[0.10.1] - 14-04-2020

Changelog:

• Updated README.md

[0.10.0] - 13-04-2020

Changelog:

• Updated README.md
• Updated Project according to RC 1.0
• Resolved windows issue

[0.9.2] - 05-02-2020

Changelog:

• Updated README.md
• Updated Error statements

[0.9.1] - 27-01-2020

Changelog:

• Automated creation of libuplink.so file.
• Removed dependency from ref modules

[0.8.8] - 25-11-2019

Changelog:

• Removed download_file and upload_file function from library.

[0.8.7] - 18-11-2019

Changelog:

• Updated new_uplink fucntion parameters
• Changes made in UplinkConfig->Volatile structure

[0.8.6] - 14-11-2019

Changelog:

• Updated package to reads path from .env config file