snet-sdk-js

SingularityNET SDK for JavaScript

Getting Started

This repo hosts multiple SDKs for JavaScript. Currently supported platforms

1. Node.js using grpc-node
2. Browser (Web) using grpc-web

You can find more details about each sdk within the respective package folders.

1. Node.js under packages/nodejs directory
2. Web under packages/web directory

These SDKs are under active development and not ready for production use yet. If you find any bug or something doesn't work as expected, please create an issue.

Usage

All the SDKs assume that there is enough eth balance to cover the gas cost and AGI tokens in the wallet to cover the service execution cost.

The SDKs chose a default PaymentChannelManagementStrategy which is the simplest form of picking an existing Payment Channel if any or creates a new Payment Channel if no channel is found. This can be easily overridden by providing your own strategy to the SDK at the time of construction. Documentation on creating custom strategies will be available soon.

Development

This is a monorepo which is setup a little differently. It does not use any external tools like lerna or any other popular tool.

There are 3 packages out of which only 2 of them are published to npm

1. core
2. nodejs (published)
3. web (published)

The way the core package is shared across nodejs and web is by creating a symlink to core under each package. This setup has been tested on macOS and should work on any standard Linux distribution but it has not been tested on Windows OS.

Build

Navigate to the specific package which needs to be build and then run the following command

npm run build

Publish

Navigate to the specific package which needs to be published and then run the following command

npm run publish

Handling Signature / Binary

The grpc API metadata is a map of key, value pair to store the headers.
The value can be either String or Buffer.

All binary headers should have -bin suffix in their names. Vice versa. A String header's name must not end with this.

NodeSDK and WebSDK use grpc and @improbable-eng/grpc-web respectively to make grpc API calls.

NodeSDK

The grpc package used in node allows to use buffer in the raw binary format without any modification.
So the signature returned by the signData method in the Account class can be directly passed on to the grpc metadata.
e.g.

async getPaymentMetadata() {
   const signature = await this._generateSignature(currentBlockNumber);
   const metadata = [{ 
                     'snet-payment-channel-signature-bin': signature 
                    }];
   return metadata;
 }

WebSDK

Browsers don't have native support for http2.0 which is the base for grpc.
The package @improbable-eng/grpc-web acts as a wrapper around grpc and allows developers to make grpc calls from the browser.

In order to transfer buffer signatures in the headers, the value has to converted first to base64 string.
A buffer can be converted to base64 string using the javascript function Array.prototype.toString("base64").

e.g.

async getPaymentMetadata() {
   const signature = await this._generateSignature(channel.channelId, channel.state.nonce, amount);
   const metadata = [{ 
                     'snet-payment-channel-signature-bin': signature.toString('base64') 
                    }];
   return metadata;
 }

[LICENSE](https://github.com/singnet/snet-sdk-js/blob/master/LICENSE) file for details.