{"_id":"@autonomies/nevermined-sdk-js","_rev":"4-1702b444afc41c3d9a9c06a9739362ba","name":"@autonomies/nevermined-sdk-js","dist-tags":{"latest":"0.0.3"},"versions":{"0.0.1":{"name":"@autonomies/nevermined-sdk-js","version":"0.0.1","description":"Javascript SDK for connecting with Nevermined Data Platform. Patched version for autonomies project.","main":"./dist/node/sdk.js","typings":"./dist/node/sdk.d.ts","unpkg":"./dist/browser/sdk.cjs2.min.js","scripts":{"start":"npm link @nevermined-io/contracts @nevermined-io/secret-store-client && npm run build:watch","build":"npm run clean && npm run build:tsc && npm run build:dist","build:tsc":"tsc --sourceMap","build:metadata":"./scripts/get-metadata.js > src/metadata.json","build:dist":"cross-env NODE_ENV=production webpack","build:watch":"tsc -w","test":"mocha","test:watch":"mocha -w --watch-extensions js,ts,json","test:cover":"nyc --report-dir coverage/unit mocha","integration":"mocha --opts integration/mocha.opts ./integration/**/*.test.ts","integration:production":"export NETWORK_NAME=production; yarn integration","integration:staging":"export NETWORK_NAME=staging; yarn integration","integration:integration":"export NETWORK_NAME=integration; yarn integration","integration:watch":"mocha -w --watch-extensions js,ts,json --opts integration/mocha.opts ./integration/**/*.test.ts","integration:cover":"nyc --report-dir coverage/integration mocha --opts integration/mocha.opts ./integration/**/*.test.ts","clean":"rm -rf ./dist/ ./doc/ ./.nyc_output","lint":"eslint --ignore-path .gitignore --ext .ts,.tsx .","lint:fix":"eslint --fix --ignore-path .gitignore --ext .ts,.tsx .","format":"prettier --parser typescript --ignore-path .gitignore --write '**/*.{js,jsx,ts,tsx}'","doc":"typedoc --mode modules --out ./doc/ ./src/","doc:json":"./scripts/typedoc.js","merge-coverages":"npx lcov-result-merger \"coverage/*/lcov.info\" coverage/lcov.info","report-coverage":"npm run report-coverage:unit && npm run report-coverage:integration","report-coverage:unit":"cat coverage/unit/lcov.info | codacy-coverage --token 71ef0d15f6f04ac29b31d704b28f866a","report-coverage:integration":"cat coverage/integration/lcov.info | codacy-coverage --token 71ef0d15f6f04ac29b31d704b28f866a","run":"ts-node","release":"release-it --non-interactive","changelog":"auto-changelog --commit-limit false && sed -i 's/keyko-io/nevermind-/nevermined-io//' CHANGELOG.md","prepublishOnly":"npm run build","prebuild":"npm run build:metadata","prepare":"npm run build:metadata"},"repository":{"type":"git","url":"git+https://github.com/nevermined-io/sdk-js.git"},"keywords":[],"author":{"name":"Nevermined","email":"root@nevermined.io"},"license":"Apache-2.0","bugs":{"url":"https://github.com/nevermined-io/sdk-js/issues"},"homepage":"https://github.com/nevermined-io/sdk-js#readme","peerDependencies":{"web3":"^1.2.3"},"dependencies":{"@nevermined-io/contracts":"^1.1.8","@nevermined-io/secret-store-client":"^0.0.16","bignumber.js":"^9.0.0","circom":"^0.5.45","circomlib":"^0.5.3","deprecated-decorator":"^0.1.6","ffjavascript":"^0.2.38","ganache-cli":"^6.12.2","jose":"^3.3.1","node-fetch":"^2.6.1","save-file":"^2.3.1","snarkjs":"^0.4.6","uuid":"^3.4.0","web3":"1.3.5","web3-eth-contract":"1.3.5","web3-utils":"^1.5.2","whatwg-url":"^7.1.0"},"devDependencies":{"@babel/core":"^7.15.5","@babel/preset-env":"^7.15.4","@release-it/bumper":"^1.4.1","@truffle/hdwallet-provider":"^1.0.42","@types/chai":"^4.2.12","@types/chai-as-promised":"^7.1.3","@types/chai-spies":"^1.0.1","@types/mocha":"^5.2.7","@types/node":"^12.19.8","@types/node-fetch":"^2.5.7","@types/temp":"^0.8.34","@typescript-eslint/eslint-plugin":"^2.34.0","@typescript-eslint/parser":"^2.34.0","auto-changelog":"^1.16.4","babel-loader":"^8.2.2","chai":"^4.2.0","chai-as-promised":"^7.1.1","chai-spies":"^1.0.0","cross-env":"^6.0.3","eslint":"^6.8.0","eslint-config-prettier":"^6.11.0","eslint-plugin-prettier":"^3.1.4","lcov-result-merger":"^3.1.0","mocha":"^7.2.0","mock-local-storage":"^1.1.15","nyc":"^14.1.1","ora":"^4.1.1","prettier":"^1.19.1","source-map-support":"^0.5.19","ts-node":"^8.10.2","typedoc":"^0.15.8","typescript":"^3.9.7","uglifyjs-webpack-plugin":"^2.2.0","webpack":"^4.46.0","webpack-cli":"^3.3.12","webpack-merge":"^4.2.2"},"nyc":{"include":["src/**/*.ts"],"extension":[".ts"],"require":["ts-node/register"],"reporter":["text-summary","lcov","html"],"sourceMap":true,"instrument":true},"release-it":{"hooks":{"after:bump":"npm run changelog && npm run doc:json"},"plugins":{"@release-it/bumper":{"out":["package.json","package-lock.json"]}},"git":{"tagName":"v${version}"},"github":{"release":true,"assets":["dist/sdk-js.json"]},"npm":{"publish":false}},"jest":{"moduleNameMapper":{"jose/(.*)":"<rootDir>/node_modules/jose/dist/node/cjs/$1"},"collectCoverageFrom":["src/**/*.{ts,tsx}","!src/serviceWorker.ts","!src/**/*.d.ts"]},"gitHead":"6adc88c03f9d170d44f67acc5a4967b7994196d5","_id":"@autonomies/nevermined-sdk-js@0.0.1","_nodeVersion":"16.9.1","_npmVersion":"8.1.0","dist":{"integrity":"sha512-9AbKW4g1NDqhY6JrQFKM6eNB3IzIRiLWG/tJpb6mVabNoA7Mfkdjp9tQ2hflifPvh57dH0BYT03LK6vNDFx01Q==","shasum":"90628827692150e587ec49ed2b3bda4cc3d0d01b","tarball":"https://registry.npmjs.org/@autonomies/nevermined-sdk-js/-/nevermined-sdk-js-0.0.1.tgz","fileCount":330,"unpackedSize":81983774,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDwyjky3rhfskm9FP7qlUYvzN1KPxxWXPPdsyjsRQd+xwIhAMYDzWglTJZqnEJ/K6hyPl9+RIDQ+Bj2PX7tIwedRvlt"}]},"_npmUser":{"name":"autonomies","email":"elod@keyko.io"},"directories":{},"maintainers":[{"name":"autonomies","email":"elod@keyko.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nevermined-sdk-js_0.0.1_1634296332893_0.2703530850823441"},"_hasShrinkwrap":false},"0.0.2":{"name":"@autonomies/nevermined-sdk-js","version":"0.0.2","description":"Javascript SDK for connecting with Nevermined Data Platform. Patched version for autonomies project.","main":"./dist/node/sdk.js","typings":"./dist/node/sdk.d.ts","unpkg":"./dist/browser/sdk.cjs2.min.js","scripts":{"start":"npm link @nevermined-io/contracts @nevermined-io/secret-store-client && npm run build:watch","build":"npm run clean && npm run build:tsc && npm run build:dist","build:tsc":"tsc --sourceMap","build:metadata":"./scripts/get-metadata.js > src/metadata.json","build:dist":"cross-env NODE_ENV=production webpack","build:watch":"tsc -w","test":"mocha","test:watch":"mocha -w --watch-extensions js,ts,json","test:cover":"nyc --report-dir coverage/unit mocha","integration":"mocha --opts integration/mocha.opts ./integration/**/*.test.ts","integration:production":"export NETWORK_NAME=production; yarn integration","integration:staging":"export NETWORK_NAME=staging; yarn integration","integration:integration":"export NETWORK_NAME=integration; yarn integration","integration:watch":"mocha -w --watch-extensions js,ts,json --opts integration/mocha.opts ./integration/**/*.test.ts","integration:cover":"nyc --report-dir coverage/integration mocha --opts integration/mocha.opts ./integration/**/*.test.ts","clean":"rm -rf ./dist/ ./doc/ ./.nyc_output","lint":"eslint --ignore-path .gitignore --ext .ts,.tsx .","lint:fix":"eslint --fix --ignore-path .gitignore --ext .ts,.tsx .","format":"prettier --parser typescript --ignore-path .gitignore --write '**/*.{js,jsx,ts,tsx}'","doc":"typedoc --mode modules --out ./doc/ ./src/","doc:json":"./scripts/typedoc.js","merge-coverages":"npx lcov-result-merger \"coverage/*/lcov.info\" coverage/lcov.info","report-coverage":"npm run report-coverage:unit && npm run report-coverage:integration","report-coverage:unit":"cat coverage/unit/lcov.info | codacy-coverage --token 71ef0d15f6f04ac29b31d704b28f866a","report-coverage:integration":"cat coverage/integration/lcov.info | codacy-coverage --token 71ef0d15f6f04ac29b31d704b28f866a","run":"ts-node","release":"release-it --non-interactive","changelog":"auto-changelog --commit-limit false && sed -i 's/keyko-io/nevermind-/nevermined-io//' CHANGELOG.md","prepublishOnly":"npm run build","prebuild":"npm run build:metadata","prepare":"npm run build:metadata"},"repository":{"type":"git","url":"git+https://github.com/nevermined-io/sdk-js.git"},"keywords":[],"author":{"name":"Nevermined","email":"root@nevermined.io"},"license":"Apache-2.0","bugs":{"url":"https://github.com/nevermined-io/sdk-js/issues"},"homepage":"https://github.com/nevermined-io/sdk-js#readme","peerDependencies":{"web3":"^1.2.3"},"dependencies":{"@nevermined-io/contracts":"^1.1.8","@nevermined-io/secret-store-client":"^0.0.16","bignumber.js":"^9.0.0","circom":"^0.5.45","circomlib":"^0.5.3","deprecated-decorator":"^0.1.6","ffjavascript":"^0.2.38","ganache-cli":"^6.12.2","jose":"^4.1.1","node-fetch":"^2.6.1","save-file":"^2.3.1","snarkjs":"^0.4.6","uuid":"^3.4.0","web3":"1.3.5","web3-eth-contract":"1.3.5","web3-utils":"^1.5.2","whatwg-url":"^7.1.0"},"devDependencies":{"@babel/core":"^7.15.5","@babel/preset-env":"^7.15.4","@release-it/bumper":"^1.4.1","@truffle/hdwallet-provider":"^1.0.42","@types/chai":"^4.2.12","@types/chai-as-promised":"^7.1.3","@types/chai-spies":"^1.0.1","@types/mocha":"^5.2.7","@types/node":"^12.19.8","@types/node-fetch":"^2.5.7","@types/temp":"^0.8.34","@typescript-eslint/eslint-plugin":"^2.34.0","@typescript-eslint/parser":"^2.34.0","auto-changelog":"^1.16.4","babel-loader":"^8.2.2","chai":"^4.2.0","chai-as-promised":"^7.1.1","chai-spies":"^1.0.0","cross-env":"^6.0.3","eslint":"^6.8.0","eslint-config-prettier":"^6.11.0","eslint-plugin-prettier":"^3.1.4","lcov-result-merger":"^3.1.0","mocha":"^7.2.0","mock-local-storage":"^1.1.15","nyc":"^14.1.1","ora":"^4.1.1","prettier":"^1.19.1","source-map-support":"^0.5.19","ts-node":"^8.10.2","typedoc":"^0.15.8","typescript":"^3.9.7","uglifyjs-webpack-plugin":"^2.2.0","webpack":"^4.46.0","webpack-cli":"^3.3.12","webpack-merge":"^4.2.2"},"nyc":{"include":["src/**/*.ts"],"extension":[".ts"],"require":["ts-node/register"],"reporter":["text-summary","lcov","html"],"sourceMap":true,"instrument":true},"release-it":{"hooks":{"after:bump":"npm run changelog && npm run doc:json"},"plugins":{"@release-it/bumper":{"out":["package.json","package-lock.json"]}},"git":{"tagName":"v${version}"},"github":{"release":true,"assets":["dist/sdk-js.json"]},"npm":{"publish":false}},"jest":{"collectCoverageFrom":["src/**/*.{ts,tsx}","!src/serviceWorker.ts","!src/**/*.d.ts"]},"gitHead":"c23138090dff4a8b084cd5b48643ea4597404e16","_id":"@autonomies/nevermined-sdk-js@0.0.2","_nodeVersion":"14.17.3","_npmVersion":"7.22.0","dist":{"integrity":"sha512-j6IkOTZYd+mdTmUcmqX2mhguyeXTU85nQFrJGlNVBT8D+X3Z9znQ7liTnUlK9SkAkRa16NtYnEo54lAO15BPng==","shasum":"e03f0412ae5d9e2de9d1e92ea6a1ac145dbbff75","tarball":"https://registry.npmjs.org/@autonomies/nevermined-sdk-js/-/nevermined-sdk-js-0.0.2.tgz","fileCount":330,"unpackedSize":82884443,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAGffKrRsj3T++y0yXzU7HVgo8gwWOuN3BFbMGmzVAs3AiBEqEHpvO/UMXtgg0/Cc+nF9Efja9apsQcO7KCfj2mgYQ=="}]},"_npmUser":{"name":"autonomies","email":"elod@keyko.io"},"directories":{},"maintainers":[{"name":"autonomies","email":"elod@keyko.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nevermined-sdk-js_0.0.2_1635430848129_0.6739703537727197"},"_hasShrinkwrap":false},"0.0.3":{"name":"@autonomies/nevermined-sdk-js","version":"0.0.3","description":"Javascript SDK for connecting with Nevermined Data Platform. Patched version for autonomies project.","main":"./dist/node/sdk.js","typings":"./dist/node/sdk.d.ts","unpkg":"./dist/browser/sdk.cjs2.min.js","scripts":{"start":"npm link @nevermined-io/contracts @nevermined-io/secret-store-client && npm run build:watch","build":"npm run clean && npm run build:tsc && npm run build:dist","build:tsc":"tsc --sourceMap","build:metadata":"./scripts/get-metadata.js > src/metadata.json","build:dist":"cross-env NODE_ENV=production webpack","build:watch":"tsc -w","test":"mocha","test:watch":"mocha -w --watch-extensions js,ts,json","test:cover":"nyc --report-dir coverage/unit mocha","integration":"mocha --opts integration/mocha.opts ./integration/**/*.test.ts","integration:production":"export NETWORK_NAME=production; yarn integration","integration:staging":"export NETWORK_NAME=staging; yarn integration","integration:integration":"export NETWORK_NAME=integration; yarn integration","integration:watch":"mocha -w --watch-extensions js,ts,json --opts integration/mocha.opts ./integration/**/*.test.ts","integration:cover":"nyc --report-dir coverage/integration mocha --opts integration/mocha.opts ./integration/**/*.test.ts","clean":"rm -rf ./dist/ ./doc/ ./.nyc_output","lint":"eslint --ignore-path .gitignore --ext .ts,.tsx .","lint:fix":"eslint --fix --ignore-path .gitignore --ext .ts,.tsx .","format":"prettier --parser typescript --ignore-path .gitignore --write '**/*.{js,jsx,ts,tsx}'","doc":"typedoc --mode modules --out ./doc/ ./src/","doc:json":"./scripts/typedoc.js","merge-coverages":"npx lcov-result-merger \"coverage/*/lcov.info\" coverage/lcov.info","report-coverage":"npm run report-coverage:unit && npm run report-coverage:integration","report-coverage:unit":"cat coverage/unit/lcov.info | codacy-coverage --token 71ef0d15f6f04ac29b31d704b28f866a","report-coverage:integration":"cat coverage/integration/lcov.info | codacy-coverage --token 71ef0d15f6f04ac29b31d704b28f866a","run":"ts-node","release":"release-it --non-interactive","changelog":"auto-changelog --commit-limit false && sed -i 's/keyko-io/nevermind-/nevermined-io//' CHANGELOG.md","prepublishOnly":"npm run build","prebuild":"npm run build:metadata","prepare":"npm run build:metadata"},"repository":{"type":"git","url":"git+https://github.com/nevermined-io/sdk-js.git"},"keywords":[],"author":{"name":"Nevermined","email":"root@nevermined.io"},"license":"Apache-2.0","bugs":{"url":"https://github.com/nevermined-io/sdk-js/issues"},"homepage":"https://github.com/nevermined-io/sdk-js#readme","peerDependencies":{"web3":"^1.2.3"},"dependencies":{"@nevermined-io/contracts":"^1.1.8","@nevermined-io/secret-store-client":"^0.0.16","bignumber.js":"^9.0.0","circom":"^0.5.45","circomlib":"^0.5.3","deprecated-decorator":"^0.1.6","ffjavascript":"^0.2.38","ganache-cli":"^6.12.2","jose":"^4.1.1","node-fetch":"^2.6.1","save-file":"^2.3.1","snarkjs":"^0.4.6","uuid":"^3.4.0","web3":"1.3.5","web3-eth-contract":"1.3.5","web3-utils":"^1.5.2","whatwg-url":"^7.1.0"},"devDependencies":{"@babel/core":"^7.15.5","@babel/preset-env":"^7.15.4","@release-it/bumper":"^1.4.1","@truffle/hdwallet-provider":"^1.0.42","@types/chai":"^4.2.12","@types/chai-as-promised":"^7.1.3","@types/chai-spies":"^1.0.1","@types/mocha":"^5.2.7","@types/node":"^12.19.8","@types/node-fetch":"^2.5.7","@types/temp":"^0.8.34","@typescript-eslint/eslint-plugin":"^2.34.0","@typescript-eslint/parser":"^2.34.0","auto-changelog":"^1.16.4","babel-loader":"^8.2.2","chai":"^4.2.0","chai-as-promised":"^7.1.1","chai-spies":"^1.0.0","cross-env":"^6.0.3","eslint":"^6.8.0","eslint-config-prettier":"^6.11.0","eslint-plugin-prettier":"^3.1.4","lcov-result-merger":"^3.1.0","mocha":"^7.2.0","mock-local-storage":"^1.1.15","nyc":"^14.1.1","ora":"^4.1.1","prettier":"^1.19.1","source-map-support":"^0.5.19","ts-node":"^8.10.2","typedoc":"^0.15.8","typescript":"^3.9.7","uglifyjs-webpack-plugin":"^2.2.0","webpack":"^4.46.0","webpack-cli":"^3.3.12","webpack-merge":"^4.2.2"},"nyc":{"include":["src/**/*.ts"],"extension":[".ts"],"require":["ts-node/register"],"reporter":["text-summary","lcov","html"],"sourceMap":true,"instrument":true},"release-it":{"hooks":{"after:bump":"npm run changelog && npm run doc:json"},"plugins":{"@release-it/bumper":{"out":["package.json","package-lock.json"]}},"git":{"tagName":"v${version}"},"github":{"release":true,"assets":["dist/sdk-js.json"]},"npm":{"publish":false}},"jest":{"collectCoverageFrom":["src/**/*.{ts,tsx}","!src/serviceWorker.ts","!src/**/*.d.ts"]},"gitHead":"e3963fe5760a250aa2b7a1eb06e09ef8e4f5b3b0","_id":"@autonomies/nevermined-sdk-js@0.0.3","_nodeVersion":"14.17.3","_npmVersion":"7.22.0","dist":{"integrity":"sha512-rxLtM7i5wNWD0+oaxmH785iajWVkTiq75K7T9dqmUClKv5Sa5vX7ZamlU4j3v5nGR6VrhCsFgO+QoosmNI0IQg==","shasum":"882a90af0ac6375062b63b6950f2c5c3b0d62196","tarball":"https://registry.npmjs.org/@autonomies/nevermined-sdk-js/-/nevermined-sdk-js-0.0.3.tgz","fileCount":330,"unpackedSize":82884462,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhzGs5CRA9TVsSAnZWagAAnF0P/2222vlZtG6uNV0Liilz\nP0+yo8mvppIc0zpcUrvzybxlfoKu0XDHoTSE9fpIlxRM+LmG05KJaXXCcqDz\neFaTXkYENhzinZ575nvefNDMI+tFdkn+NFRuLQ6Xv2nEbNi9SUE8zt+99TkB\ne7c8OXJ62a13GVJmao6X18WhV085OfrfYbbdqqDWi7urSVPkKj9HqQTNMYiv\n0OP32TH5QZmqHoz3ZYu6w7w4LH+nQHSXmTf4jOC723ZYMGRWwooBAno6B/DE\nRjoyRnb4Z5h/62yrq6KO38AJO4JP9DFfefDETeFvwAltqGmTq70H7PQ64w6D\nhqXhu4BOELlD9s4L8neXrQrW8A6MuldO/O/TfScthpTpoJVo/LtLmME7JNCB\nMUKxUdxvd/d27HNu08TtfUbDqhtKTGMhlf/cl/feEfyHC4rNYoAZgdXoK5Xf\nUsa//V3O/syP/2ESS/zf5L6+YLGEP9SBk+O/dZTDlpTtzQqABO69HE9g3MWg\nxxGhRY8NIUthYTbd5gJcseYUiJqAp//FTWOSsEPksOOSTHiFuBH1LN8xirDc\nDXuePduehO3yBxDF61fo8kzwlAG5HP4ErnKd+Tegwj64cd0f13od0wCZnwjT\n3YjoVR2ABF9O0ygGtbYsLwk58uGyYuuf1OJEi4tCvMtOIDoMvDxQITIOI1Et\nJzIy\r\n=ZxPf\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIH3z+u4ELNnt56/GE60/NtkknlrCORNp1lhQmsWG/DhkAiBUlz6heKCgGRNV5pcezhm0dJwfMGyZ5R6eLOs7+ZjorQ=="}]},"_npmUser":{"name":"autonomies","email":"elod@keyko.io"},"directories":{},"maintainers":[{"name":"autonomies","email":"elod@keyko.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nevermined-sdk-js_0.0.3_1635431378900_0.37503049999473825"},"_hasShrinkwrap":false}},"time":{"created":"2021-10-15T11:12:12.830Z","0.0.1":"2021-10-15T11:12:13.464Z","modified":"2022-04-04T16:40:07.430Z","0.0.2":"2021-10-28T14:20:48.496Z","0.0.3":"2021-10-28T14:29:39.403Z"},"maintainers":[{"name":"autonomies","email":"elod@keyko.io"}],"description":"Javascript SDK for connecting with Nevermined Data Platform. Patched version for autonomies project.","homepage":"https://github.com/nevermined-io/sdk-js#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/nevermined-io/sdk-js.git"},"author":{"name":"Nevermined","email":"root@nevermined.io"},"bugs":{"url":"https://github.com/nevermined-io/sdk-js/issues"},"license":"Apache-2.0","readme":"[![banner](https://raw.githubusercontent.com/nevermined-io/assets/main/images/logo/banner_logo.png)](https://nevermined.io)\n\n# Javascript/Typescript API for Nevermined Data platform\n\n> Javascript SDK for connecting with Nevermined Data Platform\n> [nevermined.io](https://nevermined.io)\n\n![CI Build](https://github.com/nevermined-io/sdk-js/workflows/Build/badge.svg)\n\n---\n\n## Table of Contents\n\n* [Javascript/Typescript API for Nevermined Data platform](#javascripttypescript-api-for-nevermined-data-platform)\n  * [Table of Contents](#table-of-contents)\n  * [Get started](#get-started)\n    * [Examples](#examples)\n  * [Documentation](#documentation)\n    * [Migration Guide](#migration-guide)\n  * [Development](#development)\n  * [Testing](#testing)\n    * [Unit Tests](#unit-tests)\n    * [Integration Tests](#integration-tests)\n  * [Code Style](#code-style)\n  * [Production build](#production-build)\n  * [Releases](#releases)\n  * [Attribution](#attribution)\n  * [License](#license)\n\n---\n\n## Get started\n\nStart by adding the package to your dependencies:\n\n```bash\nnpm i @nevermined-io/nevermined-sdk-js\n```\n\nThe package exposes `Nevermined` and `Logger` which you can import in your code like this:\n\n```js\n// ES6\nimport { Nevermined, Logger } from '@nevermined-io/nevermined-sdk-js'\n\n// ES2015\nconst { Nevermined, Logger } = require('@nevermined-io/nevermined-sdk-js')\n```\n\nYou can then connect to the [Smart Contracts](https://github.com/nevermined-io/contracts), [Metadata API](https://github.com/nevermined-io/metadata), [Gateway](https://github.com/nevermined-io/gateway) instances, e.g.:\n\n```js\nconst nevermined: Nevermined = await Nevermined.getInstance({\n    // the node of the blockchain to connect to, could also be infura\n    nodeUri: 'http://localhost:8545',\n    // the uri of metadata\n    metadataUri: 'http://localhost:5000',\n    // the uri of gateway\n    gatewayUri: 'http://localhost:8030',\n    // the uri of faucet\n    faucetUri: 'http://localhost:3001',\n    // address that gateway uses\n    gatewayAddress: '0x00bd138abd70e2f00903268f3db08f2d25677c9e'\n    // the uri to the parity node you want to use for encryption and decryption\n    parityUri: 'http://localhost:9545',\n    // the uri of the secret store that holds the keys\n    secretStoreUri: 'http://localhost:12001'\n})\n```\n\n### Examples\n\nYou can see how `nevermined-sdk-js` is used on:\n\n* [Integration test](/src/integration/nevermined/)\n\n## Documentation\n\nYou can generate the raw TypeDoc documentation locally by running:\n\n```bash\n# will output to ./doc folder\nnpm run doc\n```\n\n### Migration Guide\n\nInstructions on how to migrate between breaking versions:\n\n* [Migration Guide](MIGRATION.md)\n\n## Development\n\nTo start development you need to:\n\n```bash\nnpm i\nnpm start\n```\n\n## Testing\n\n### Unit Tests\n\nFor unit tests, running [`ganache-cli`](https://github.com/trufflesuite/ganache-cli) is required before starting the tests. It's best to start it on a different port so it doesn't clash with anything running in [Nevermined Tools](https://github.com/nevermined-io/tools):\n\n```bash\nnpm i -g ganache-cli\nganache-cli --port 18545\nexport ETH_PORT=18545\n```\n\nTo start unit tests, run:\n\n```bash\nnpm test\n```\n\nor to watch for changes:\n\n```bash\nnpm run test:watch\n```\n\nto create code coverage information:\n\n```bash\nnpm run test:cover\n```\n\n### Integration Tests\n\nBesides a running `ganache-cli` instance, a locally running Nevermined network is required.\nTo do so before running the tests, use [Nevermined Tools](https://github.com/nevermined-io/tools):\n\n```bash\ngit clone https://github.com/nevermined-io/tools\ncd tools\n\n./start_nevermined.sh --no-marketplace\n```\n\nIn another terminal window, run this script and export the seed phrase:\n\n```bash\n# copies the contract artifacts once the local Nevermined network is up and running\n./scripts/wait-nevermined.sh\n\n# export Spree accounts seed phrase\nexport SEED_WORDS=\"taxi music thumb unique chat sand crew more leg another off lamp\"\n```\n\nOnce everything is up, run the integration tests:\n\n```bash\nnpm run integration\n```\n\nto generate code coverage information during test, run:\n\n```bash\nnpm run integration:cover\n```\n\n## Code Style\n\nFor linting and auto-formatting you can use:\n\n```bash\n# lint all ts with eslint\nnpm run lint\n\n# auto format all ts with prettier, taking all configs into account\nnpm run format\n```\n\n## Production build\n\nTo create a production build:\n\n```bash\nnpm run build\n```\n\n## Releases\n\nFrom a clean `master` branch you can run any release task doing the following:\n\n* bumps the project version in `package.json`, `package-lock.json`\n* auto-generates and updates the CHANGELOG.md file from commit messages\n* creates a Git tag\n* commits and pushes everything\n* creates a GitHub release with commit messages as description\n* Git tag push will trigger Travis to do a npm release\n\nYou can execute the script using arguments to bump the version accordingly:\n\n* To bump a patch version: `npm run release`\n* To bump a minor version: `npm run release minor`\n* To bump a major version: `npm run release major`\n\nFor the GitHub releases steps a GitHub personal access token, exported as `GITHUB_TOKEN` is required. [Setup](https://github.com/release-it/release-it#github-releases)\n\n## Attribution\n\nThis library is based in the [Ocean Protocol](https://oceanprotocol.com) [Squid JS](https://github.com/oceanprotocol/squid-js) library.\nIt keeps the same Apache v2 License and adds some improvements. See [NOTICE file](NOTICE).\n\n## License\n\n```\nCopyright 2020 Keyko GmbH\nThis product includes software developed at\nBigchainDB GmbH and Ocean Protocol (https://www.oceanprotocol.com/)\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","readmeFilename":"README.md"}