npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@super-protocol/uplink-nodejs

v1.2.21-beta.0

Published

Storj-NodeJS bindings package

Downloads

1,663

Readme

uplink-nodejs binding

Codacy Badge

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: