@koibanx/build
TypeScript icon, indicating that this package has built-in type declarations

0.1.32 • Public • Published

Koibanx Build SDK

The intent of Koibanx is to build a platform to give the benefits of blockchain as a simple service, with metrics, management and flexibility. The main goal is to provide all the extra value that blockchain provides by using modules that anyone can use, without all the knowledge the blockchain implementations demand.

Each user will be able to build it’s projects, which will contain the modules that need to be used. In order to access those modules, given an API KEY, the user will configure and use the modules through the koibanx SDK or through the REST APIs.

SDK Documentation

Feast yourself

Installation

npm install @koibanx/build-sdk

Initialization

Node

Using ES6 import

import BuildSdk from '@koibanx/build-sdk';

const build = BuildSdk({
  baseURL: 'http://your-url',
  apiKey: '',
  secret: ''
});

With require

exports.__esModule = true;
const BuildSdk = require('@koibanx/build-sdk')["default"];

const build = BuildSdk({
  baseURL: 'http://your-url',
  apiKey: '',
  secret: ''
});

Types

  • Typescript (@koibanx/build-sdk/dist/index.d.ts)

Examples

Using ES6 import

import BuildSdk from "@koibanx/build-sdk";

(async () => {
  const build = BuildSdk({
      apiKey: '<APIKEY-PROJECT>',
      secret: '<SECRET-PROJECT>'
  })

  const ledger = await build.ledger()

  const catchError = (err, modulo) => {
      console.log('Modulo: ', modulo);
      console.log('details: ', err.details);
      console.log('shortMessage: ', err.message);
      console.log('errorCode: ', err.code);
  }

  ledger.getLedgerStatus().then((res) => {
      console.log('getLedgerStatus: ', res.toDate);
  }).catch((err) => catchError(err, 'getLedgerStatus'));

  ledger.getEstimatedRemainingLedgerUsage().then((res) => {
      console.log('getEstimatedRemainingLedgerUsage: ', res);
  }).catch((err) => catchError(err, 'getEstimatedRemainingLedgerUsage'));

  ledger.getFuelingLedgerAccount().then((res) => {
      console.log('getFuelingLedgerAccount: ', res);
  }).catch((err) => catchError(err, 'getFuelingLedgerAccount'));

  ledger.wallets.createWallet({})
      .then((res) => console.log('createWallet: ', res))
      .catch((err) => catchError(err, 'createWallet'));
})();

Readme

Keywords

none

Package Sidebar

Install

npm i @koibanx/build

Weekly Downloads

0

Version

0.1.32

License

ISC

Unpacked Size

26.2 kB

Total Files

17

Last publish

Collaborators

  • npm_koibanx
  • infra-koibanx