recordskeeper-sdk v1.0.0

RecordsKeeper-nodejs-sdk

It is an infrastructure to build RecordsKeeper blockchain-based applications, products and is used to work around applications that are built on top of this blockchain platform.

Getting Started

Before you begin you'll need to have nodejs and npm installed. There are several options for installation for depending on the operating system you are using. Step 1: Create a new directory and make a package.json file inside it.

{
  "dependencies": {
    "recordskeeper-sdk": "^0.1.0"
  }
}

Step 2: Run the following command.

npm i

Creating Config

Create Config file and import config parameters:

    
   var config = require('./config.json');

Importing RecordsKeeper SDK

Import recordskeepr library first to get started with the functionality.:

    var recordskeeper = require('recordskeeper-sdk'); 

Libraries

• Addresses Library to work with RecordsKeeper addresses. You can generate new address, check all addresses, check address validity, check address permissions, check address balance by using Address class. You just have to pass parameters to invoke the pre-defined functions.

• Assets Library to work with RecordsKeeper assets. You can create new assets and list all assets by using Assets class. You just have to pass parameters to invoke the pre-defined functions.

• Block Library to work with RecordsKeeper block informaion. You can collect block information by using block class. You just have to pass parameters to invoke the pre-defined functions.

• Blockchain Library to work with RecordsKeeper block informaion. You can collect block information by using block class. You just have to pass parameters to invoke the pre-defined functions.

• Permissions Library to work with RecordsKeeper permissions. You can grant and revoke permissions like connect, send, receive, create, issue, mine, activate, admin by using Assets class. You just have to pass parameters to invoke the pre-defined functions.

• Stream Library to work with RecordsKeeper streams. You can publish, retrieve and verify stream data by using stream class. You just have to pass parameters to invoke the pre-defined functions.

• Transaction Library to work with RecordsKeeper transactions. You can send transaction, create raw transaction, sign raw transaction, send raw transaction, send signed transaction, retrieve transaction information and calculate transaction's fees by using transaction class. You just have to pass parameters to invoke the pre-defined functions.

• Wallet Library to work with RecordsKeeper wallet functionalities. You can create wallet, dump wallet into a file, backup wallet into a file, import wallet from a file, lock wallet, unlock wallet, change wallet's password, retrieve private key, retrieve wallet's information, sign and verify message by using wallet class. You just have to pass parameters to invoke the pre-defined functions.

Unit Tests

First install the mocha framework by running the following command:

npm install --save-dev mocha

Create Config file and import config parameters:

    
   var config = require('./config.json');

Under node_modules/recordskeeper.

• To run all the test cases:

npm test

• To run a particular test case file:

npm test test_file name

• To run a particular test case:

npm test test_name

Documentation

The complete docs are here: RecordsKeeper nodejs-sdk documentation.

License

Copyright (c) 2016-2018 Recordskeeper License: GNU General Public License version 3, see COPYING

Portions copyright (c) 2014-2017 Coin Sciences Ltd Portions copyright (c) 2009-2016 The Bitcoin Core developers Portions copyright many others - see individual files