Merge pull request #41 from ostdotcom/base_tokens_api

Add base tokens service.

CHANGELOG.md

@@ -1,11 +1,15 @@
+[OST JAVA SDK v2.1.0](https://github.com/ostdotcom/ost-sdk-java/tree/v2.1.0)
+---
+
+* Added base tokens module to V2 API's
+
 [OST Javascript SDK v2.0.0](https://github.com/ostdotcom/ost-sdk-js/tree/v2.0.0)
 ---
 
 * OST API V2 interaction layer implementation.
 * Removed API V0 and V1 support.
 * [README.md](README.md) has API V2 usage instructions
 
-
 [OST Javascript SDK v1.1.0](https://github.com/ostdotcom/ost-sdk-js/tree/v1.1.0)
 ---
 

README.md

@@ -10,10 +10,9 @@ OST is a complete technology solution enabling mainstream businesses
 to easily launch blockchain-based economies without 
 requiring blockchain development.
 
-At the core of OST is the concept of OST-powered Brand Tokens (BTs). 
-BTs are white-label cryptocurrency tokens with utility representations 
+Brand Tokens (BTs) are white-label cryptocurrency tokens with utility representations 
 running on highly-scalable Ethereum-based side blockchains, 
-backed by OST tokens staked on Ethereum mainnet. Within a business’s 
+backed by value token (such as OST, USDC) staked on Ethereum mainnet. Within a business’s 
 token economy, BTs can only be transferred to whitelisted user addresses. 
 This ensures that they stay within the token economy.
 
@@ -56,8 +55,7 @@ Initialize the SDK object:
 
 ```node.js
 // the latest valid API endpoint is "https://api.ost.com/mainnet/v2/"
-const ostObj = new OSTSDK({apiKey: <api_key>, apiSecret: <api_secret>, apiEndpoint: <api_endpoint>,
-config: {timeout: <timeout>});
+const ostObj = new OSTSDK({apiKey: <api_key>, apiSecret: <api_secret>, apiEndpoint: <api_endpoint>,config: {timeout: <timeout>}});
 ```
 
 
@@ -240,7 +238,7 @@ rulesService.getList({}).then(function(res) { console.log(JSON.stringify(res));
 
 #### Price Points Module
 
-To know the OST price point in USD and when it was last updated, 
+To know the value token (such as OST, USDC) price point in pay currency and when it was last updated, 
 use services provided by the Price Points module.
 
 ```node.js
@@ -297,10 +295,10 @@ let transferTo = "0xa31e988eebc89d0bc3e4a9a5463545ea534593e4",
 transferAmount = '1',
 tokenHolderSender = "0xa9632350057c2226c5a10418b1c3bc9acdf7e2ee",
 payCurrencyCode = "USD",
-ostToUsd = "23757000000000000" // get price-point response
+intendedPricePoint = "23757000000000000" // get price-point response
 raw_calldata = JSON.stringify({
             method: "pay",  
-            parameters: [tokenHolderSender, [transferTo],[transferAmount], payCurrencyCode, ostToUsd]
+            parameters: [tokenHolderSender, [transferTo],[transferAmount], payCurrencyCode, intendedPricePoint]
         });
    meta_property = {
       "name": "transaction_name" , //like, download
@@ -423,3 +421,18 @@ Get Chain Detail:
 chainsService.get({chain_id: 2000}).then(function(res) { console.log(JSON.stringify(res)); }).catch(function(err) { console.log(JSON.stringify(err)); });
 ```
 
+### Base Tokens Module
+
+To get information about the value tokens (such as OST, USDC) available on the OST Platform interface, use services
+provided by the Base Tokens module. You can use this service to obtain the base token details
+on OST Platform interface.
+
+```node.js
+const baseTokensService = ostObj.services.base_tokens;
+```
+
+Get Token Detail:
+
+```node.js
+baseTokensService.get({}).then(function(res) { console.log(JSON.stringify(res)); }).catch(function(err) { console.log(JSON.stringify(err)); });
+```

VERSION

@@ -1 +1 @@
-2.0.0
+2.1.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ostdotcom/ost-sdk-js",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "OST Platform SDK for JavaScript.",
   "main": "index.js",
   "scripts": {

services/base_tokens.js

@@ -0,0 +1,47 @@
+"use strict";
+
+/**
+ * Base Tokens Service
+ *
+ * @module /services/base_tokens
+ */
+
+// Hide request object
+var _requestObj = null;
+
+/**
+ * Base tokens service constructor.
+ *
+ * @constructor
+ */
+const baseTokens = function (requestObj) {
+    const oThis = this;
+
+    // Assign request object
+    _requestObj = requestObj;
+
+    // Define the url prefix
+    oThis.urlPrefix = '/base-tokens';
+
+    return oThis;
+};
+
+baseTokens.prototype = {
+
+    /**
+     * Get base tokens details.
+     *
+     * @param {object} params
+     *
+     * @public
+     */
+    get: function (params) {
+        const oThis = this;
+        params = params || {};
+
+        return _requestObj.get(oThis.urlPrefix, params);
+    }
+
+};
+
+module.exports = baseTokens;

services/manifest.js

@@ -19,7 +19,7 @@ const rootPrefix = ".."
   , recoveryOwnersKlass = require(rootPrefix + '/services/recovery_owners')
   , rulesKlass = require(rootPrefix + '/services/rules')
   , transactionsKlass = require(rootPrefix + '/services/transactions')
-
+  , baseTokensKlass = require(rootPrefix + '/services/base_tokens')
 ;
 
 // hide request object
@@ -48,6 +48,7 @@ const manifest = function (params) {
   oThis.recovery_owners = new recoveryOwnersKlass(_requestObj);
   oThis.rules = new rulesKlass(_requestObj);
   oThis.transactions = new transactionsKlass(_requestObj);
+  oThis.base_tokens = new baseTokensKlass(_requestObj);
 
   return oThis;
 };
@@ -76,6 +77,7 @@ manifest.prototype = {
 
   transactions: null,
 
+  base_tokens: null
 };
 
 module.exports = manifest;

test/index.js

@@ -32,6 +32,7 @@ const rootPrefix = "..",
     recoveryOwnersService = ostObj.services.recovery_owners,
     rulesService = ostObj.services.rules,
     transactionsService = ostObj.services.transactions,
+    baseTokensService = ostObj.services.base_tokens,
 
 
     userId = process.env.OST_KIT_USER_ID,
@@ -307,6 +308,15 @@ function testSignature() {
     });
 }
 
+function getBaseTokensDetails() {
+
+  it("test get base token details ", async function () {
+    let res = await baseTokensService.get({}).catch(function (err) {
+      assert.fail('get base token details testcase is failed');
+    });
+    assert.equal(res.success, true);
+  });
+}
 
 async function generateRandomAddrs() {
     let buffer = await require('crypto').randomBytes(20);
@@ -315,6 +325,7 @@ async function generateRandomAddrs() {
 
 
 function testcases() {
+    getBaseTokensDetails();
     createUser();
     userList();
     getChain();