squid-js

🦑 JavaScript client library for Ocean Protocol oceanprotocol.com

---

🐲🦑 THERE BE DRAGONS AND SQUIDS. This is in alpha state and you can expect running into problems. If you run into them, please open up a new issue. 🦑🐲

---

• Get started
  • Examples
• Documentation
• Development
  • Testing
  • Production build
  • npm releases
• License

---

Get started

Start by adding the package to your dependencies:

npm i @oceanprotocol/squid --save

The package exposes Ocean and Logger which you can import in your code like this:

// ES6
import { Ocean, Logger } from '@oceanprotocol/squid'

// ES2015
const { Ocean, Logger } = require('@oceanprotocol/squid')

You can then connect to a running Keeper & Aquarius instance, e.g.:

const ocean: Ocean = await Ocean.getInstance({
    // the node of the blockchain to connect to, could also be infura
    nodeUri: "http://localhost:8545",
    // the uri of aquarius
    aquariusUri: "http://localhost:5000",
    // the uri of brizo
    brizoUri: "http://localhost:8030",
    // address that brizo uses
    brizoAddress: "0x00bd138abd70e2f00903268f3db08f2d25677c9e"
    // the uri to the parity node you want to use for encryption and decryption
    parityUri: "http://localhost:9545",
    // the uri of the secret store that holds the keys
    secretStoreUri: "http://localhost:12001"
})

Examples

You can see how squid-js is used on:

• Integration test
• Tuna

Documentation

Docs: squid-js API Reference →

Alternatively, you can generate the raw TypeDoc documentation locally by running:

# will output to ./doc folder
npm run doc

Development

To start development you need to:

npm i
npm start

Testing

To start unit tests you need to:

ganache-cli &
npm run test

or to watch for changes

ganache-cli &
npm run test:watch

to create code coverage

ganache-cli &
npm run test:cover

This will start a watcher for changes of the code.

ganache-cli can be installed following this instructions.

Production build

npm run build

npm releases

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

./bumpversion path

git tag with the latest version and git push

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.