blockchainiz v1.4.1

Description

Blockchainiz is a platform to access the blockchain. It is dedicated to banks and insurance companies. This package is a node library to interact more easily with the Blockchainiz API.

Installation

Simply use NPM with the following command:

npm install blockchainiz --save

This will download the package and add an entry in your project's package.json file.

Setup

In your project's source code, you need to start by importing the blockchainiz package and specify the options you want to use:

const blockchainiz = require('blockchainiz')({
  publicKey: 'your public key',
  privateKey: 'your private key',
  useSandbox: true,
});

There are 3 options that you can set. You NEED to specify them in order for the package to work:

Reference REST API

Set the API key set to use

blockchainiz.setKeys(publicKey, privateKey);

Set the version of the API to use

blockchainiz.useSandbox(shouldUseSandbox);

Get infos about the Bitcoin node

blockchainiz.getInfoNodeBitcoin(function (err, data) {
  // data contains the informations
});

Get infos about the Ethereum node

blockchainiz.getInfoNodeEthereum(function (err, data) {
  // data contains the informations
});

Create a new notary in the API

As of today, only the Bitcoin blockchain can be used to host notaries.

blockchainiz.postNotary(format, data, function (err, data) {
  // data contains the response of Blockchainiz
});

Get a particular notary

blockchainiz.getNotary(format, txid, function (err, data) {
  // data contains the response of Blockchainiz
});

blockindex and blocktime won't be included if the notary has not been mined in a bloc yet

Get all the notaries added with a particular key set

blockchainiz.getNotaries(format, function (err, data) {
  // data contains all the notaries
});

The data parameter of the callback contains an array of objects. Each object represents a notary and follows the same format as in the method getNotary.

Add a new smart contract on Ethereum

blockchainiz.postContractEthereumSolidity(sourceCode, parameters, contractName, callbackUrl, function (err, data) {
  // data contains the response of Blockchainiz
});

Get infos about a smart contract added with Blockchainiz

blockchainiz.getContract(id, function (err, data) {
  // data contains the response of Blockchainiz
});

amount and address won't be included if the contract has not been mined yet

Call a function on an Ethereum smart contract

blockchainiz.postContractEthereumSolidityFunction(parameters, id, functionName, function (err, data) {
  // data contains the response of Blockchainiz
});

result will only be present if the function is constant and returns something. txid will only be present if the function is not constant and so trigger an Ethereum transaction

Reference Socket.io

In order to receiver a socket.io event, you must first subscribe to it. More informations on the full documentation of the API: https://www.sandbox.blockchainiz.io/#socket-io

Subscribe to new Ethereum block event

blockchainiz.listenerNewBlockEthereum();

Subscribe to smart contract event

blockchainiz.listenerContract(contractId, eventName);

Receive error messages

blockchainiz.onErrorText(function (event, error) {
  // event contains the name of the event who triggered the error
  // error contains the error message
});

Receive smart contract events

blockchainiz.onListenerContract(function (id, event, data) {
  // id is the blockchainiz id number of the smart contract
  // event is the name of the Ethereum event received
  // data is the data sent by the Ethereum event
});

Receive new Ethereum block event

blockchainiz.onNewBlockEthereum(function (hash) {
  // hash of the new block
});

Next steps

The documentation of the API itself is available here: https://www.sandbox.blockchainiz.io/

You can sign up for a pair of keys on our website: https://www.blockchainiz.io/