ibp-node-sdk

Blockchain Node.js SDK/Module

Node client library to use the IBM Cloud Blockchain Service.

This module will allow you to use native js functions to leverage the same functionality seen in the IBP APIs

Table of Contents

• Overview
• Prerequisites
• Installation
• Explore the SDK
• Using the SDK
  • Constructing service clients
  • Authentication
  • Receiving operation responses
  • Error Handling
• Generation
• License

Overview

The IBM Cloud Blockchain Node SDK allows developers to programmatically interact with the IBM Cloud Blockchain service.

This repository is generated from an OpenAPI file that describes all available APIs. It is recommended to read through the IBP API docs to see the list of capabilities. Any issues with this SDK can be opened here or against the IBM Blockchain Platform service through IBM Cloud support.

Prerequisites

• An IBM Cloud account.
• An IBM Blockchain Platform Service instance
• An IAM API key to allow the SDK to access your service instance. Create an account level api key here (alternatively you can create a service instance level api key from the IBM cloud UI).
• An installation of Node (version 12 or above) on your local machine.

Installation

Use this command to download and install the Blockchain Node SDK project. Once this is done your Node application will be able to use it:

npm i ibp-node-sdk

Explore the SDK

This module is generated from an OpenAPI (swagger) file. The same file populated our IBP APIs documentation. To find desired functionality start by browsing the IBP APIs documentation. Then find the corresponding node example to the right of the api documentation.

Alternatively you could manually browse the SDK's main file:

• blockchain/v3.ts.

Using the SDK

This section provides general information on how to use the services contained in this SDK.

Constructing service clients

Start by requiring the IBP Node SDK and then creating a client. Here's an example of how to construct an instance:

const ibp = require('ibp-node-sdk');

// Create an authenticator.
/* create an authenticator - see more examples below */
const authenticator = new ibp.IamAuthenticator({
	apikey: '{API-Key}',
});

// Create a service instance client
const client = ibp.BlockchainV3.newInstance({
	authenticator: authenticator,
	url: 'https://{API-Endpoint}',
});

// Service operations can now be called using the "client" variable.

Authentication

Blockchain services use token-based Identity and Access Management (IAM) authentication.

IAM authentication uses an API key to obtain an access token, which is then used to authenticate each API request. Access tokens are valid for a limited amount of time and must be regenerated.

To provide credentials to the SDK, you supply either an IAM service API key or an access token:

• Specify the IAM API key to have the SDK manage the lifecycle of the access token. The SDK requests an access token, ensures that the access token is valid, and refreshes it when necessary.
• Specify the access token if you want to manage the lifecycle yourself. For details, see Authenticating with IAM tokens.

Examples:

• Supplying the IAM API key and letting the SDK manage the access token for you:

// Example - letting the SDK manage the IAM access token
const ibp = require('ibp-node-sdk');

// Create the IAM authenticator.
const authenticator = new ibp.IamAuthenticator({
	apikey: '{API-Key}',
});

// Create a service instance client
const client = ibp.BlockchainV3.newInstance({
	authenticator: authenticator,
	url: 'https://{API-Endpoint}',
});

• Supplying the access token (a bearer token) and managing it yourself:

// Example - manage the IAM access token myself
const ibp = require('ibp-node-sdk');

// Create the BearerToken authenticator.
const authenticator = new ibp.IamAuthenticator({
	bearertoken: '{my IAM access token}',
});

// Create a service instance client
const client = ibp.BlockchainV3.newInstance({
	authenticator: authenticator,
	url: 'https://{API-Endpoint}',
});

...

// Later when the access token expires, the application must refresh the access token,
// then set the new access token on the authenticator.
// Subsequent request invocations will include the new access token.
authenticator.bearertoken = /* new access token */

For more information on authentication, including the full set of authentication schemes supported by the underlying Node Core library, see this page.

Receiving operation responses

Each service method (operation) will return the following values:

• response.result - An operation-specific result (if the operation is defined as returning a result).
• response.status - the HTTP status code returned in the response message
• response.headers - the HTTP headers returned in the response message

Example:

1. Here's an example of calling the GetComponent operation:

// Create an authenticator
const authenticator = new ibp.IamAuthenticator({
	apikey: '{API-Key}',
});

// Create client from the "BlockchainV3" class
const client = ibp.BlockchainV3.newInstance({
	authenticator: authenticator,
	url: 'https://{API-Endpoint}',
});

// Get data for component
try {
	const response = await client.getComponent({ id: '{Component-ID}' });
	console.log('status code:', resp.status);
	console.log('response headers:', resp.headers);
	console.log('response:', resp.result);
	// handle good response here
} catch (e) {
	console.error('status code:', e.status);
	console.error('response headers:', e.headers);
	console.error('response:', e.body);
	// handle error here
}

Error Handling

The SDK will do its bests to inspect the input for correctness (before sending the API). In the case of a bad input (such as a missing required field) it will throw an error.

1. The service method (the sdk operation) will throw an error e. This error can be parsed/read with e.toString().

In the case of an error response from the server endpoint, the Blockchain Node SDK will do the following:

1. The service method (the sdk operation) will throw an error e. This e object will contain the error message retrieved from the HTTP response if possible, or a generic error message otherwise.
2. The e.body field will contain the HTTP response as a string.
3. The e.status field will contain the HTTP response code as a number.

Generation

This is a note for developers of this repository on how to rebuild the SDK.

• this module was generated/built via the IBM Cloud OpenAPI SDK generator
  • SDK generator overview
  • Configuration option code
  • IBP's OpenAPI source

1. download the latest sdk generator release (should see the java file lib/openapi-sdkgen.jar)
2. clone/download the IBP OpenAPI file
3. build command w/o shell:

cd code/openapi-sdkgen
java -jar C:/code/openapi-sdkgen/lib/openapi-sdkgen-3.19.0.jar generate -g ibm-node --additional-properties initialize=true -i C:/code/cloud-api-docs/ibp.yaml -o C:/code/openapi-sdkgen/node_build --apiref C:/code/cloud-api-docs/apiref-node.json && cp -r C:/code/openapi-sdkgen/node_build/blockchain C:/code/ibp-node-sdk && cp -r C:/code/openapi-sdkgen/node_build/test C:/code/ibp-node-sdk
// inspect the output files in make a PR to this repo if they look okay

License

The IBM Cloud Blockchain Node SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.