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

@oceanprotocol/secret-store-client

v0.0.15

Published

JavaScript secret store client for Ocean Protocol

Downloads

29

Readme

banner

secret-store-client-js

🔑JavaScript implementation of the parity secret store for use in ocean.

npm Travis (.com) GitHub contributors Codacy Badge


Table of Contents


Introduction

This client abstracts the interface of the Parity Secret Store to just two methods encryptDocument and decryptDocument. It uses a local parity node to sign the generation of keys and stores them remotely into an instance of the secret store.

Get started

Start by adding the package to your dependencies:

npm i @oceanprotocol/secret-store-client

Usage

To get a new instance of SecretStore do the following:

import SecretStore from "@oceanprotocol/secret-store-client"

const secretStore = new SecretStore({
    secretStoreUri: "https://secret-store.dev-ocean.com", 
    parityUri: "http://localhost:8545",
    address: "0xed243adfb84a6626eba46178ccb567481c6e655d",
    password: "unittest",
    threshold: 2,
})

To encrypt a document do the following:

const testDocument = {
    so: "ocean",
    soWow: true,
}

// generate random 64 digit numerical id
const serverKeyId = generateRandomId()
/* this will:
 * - sign the given serverKeyId with the private key from the given address (unlocked with given password)
 * - generate a server key based in the given serverKeyId
 * - generate a document key derived from the server key
 * - store the document key in secret store
 * - encrypt the document and return it
 */
const encryptedDocument = await secretStore.encryptDocument(serverKeyId, testDocument)

To decrypt a document do the following:

/* this will:
 * - sign the given serverKeyId with the private key from the given address (unlocked with given password)
 * - retrieve the document key from secret store
 * - decrypt the document and return it
 */
const decryptedDocument = await secretStore.decryptDocument(serverKeyId, encryptedDocument)

Now both documents are the same:

assert(testDocument.so === decryptedDocument.so)

Development

To start development you need to:

npm i
npm start

Testing

Testing needs a local instance of parity client and secret store. You can spin up these services using oceanprotocol/barge:

git clone https://github.com/oceanprotocol/barge
cd barge
bash -x start_ocean.sh --latest --no-brizo --no-pleuston --local-spree-node 2>&1 > start_ocean.log &

To start test you need to:

npm run test

To run a single testsuite ParityClient for example:

npm run test -- -g "ParityClient"

To watch tests

npm run test:watch

This will start a watcher for changes of the code.

To create code coverage

npm run test:cover

Documentation

To create code documentation

npm run doc

Production build

npm run build

npm releases

For a new patch release, execute on the machine where you're logged into your npm account:

npm run release

In case you have 2FA setup on npm.js, pass a code as One Time Password:

npm run release --otp <yourcode>

Command is powered by release-it package, defined in the package.json.

That's what the command does without any user interaction:

  • create release commit by updating version in package.json
  • create tag for that release commit
  • push commit & tag
  • create a new release on GitHub, with change log auto-generated from commit messages
  • publish to npm as a new release

If you want to create a minor or major release, use these commands:

npm run release-minor
npm run release-major

License

Copyright 2018 Ocean Protocol Foundation Ltd.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.