Merge pull request #64 from web3data/feature/stellar

Added stellar support

Author: taylorjdawson

dist/web3data.min.js

@@ -84,7 +84,7 @@
       ·
       ·
       ·
-      <button onClick="runBlockchain('bch')" id="goBtn">Blockchain Method</button>
+      <button onClick="runBlockchain('xlm')" id="goBtn">Blockchain Method</button>
     </div>
     <div id="output">
       <p>Results<p>
@@ -108,14 +108,14 @@
         console.log('status ->', status.type)
       })
 
-      web3data.on({eventName: 'block'}, data => {
-        console.log('block', data)
-        setResult(data)
-      })
-      web3data.on({eventName: 'block', filters: { number: 605859 }}, data => {
-        console.log('block NUMBER', data)
-        setResult(data)
-      })
+      // web3data.on({eventName: 'block'}, data => {
+      //   console.log('block', data)
+      //   setResult(data)
+      // })
+      // web3data.on({eventName: 'block', filters: { number: 26811436 }}, data => {
+      //   console.log('block NUMBER', data)
+      //   setResult(data)
+      // })
       web3data.on({eventName: 'transaction'}, data => {
         console.log('transaction', data)
         setResult(data)
@@ -140,7 +140,7 @@
     }
 
     // run specific blockchain things
-    const activeBlockchain = 'btc'
+    const activeBlockchain = 'xlm'
     function runBlockchain(namespace) {
       namespace = namespace || activeBlockchain
       const apiKey = document.querySelector('#apikey-input').value

docs/api.md

@@ -1,6 +1,6 @@
 {
   "name": "web3data-js",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "A javascript wrapper for accessing amberdata's public API.",
   "main": "index.js",
   "browser": "dist/web3data.min.js",

examples/index.html

@@ -13,6 +13,7 @@ module.exports.BLOCKCHAIN_ID_BITCOIN_SV = 'a818635d36dbe125e26167c4438e2217'
 module.exports.BLOCKCHAIN_ID_LITECOIN = 'f94be61fd9f4fa684f992ddfd4e92272'
 module.exports.BLOCKCHAIN_ID_RIPPLE = '2b8a5d8975e8c2a2ed92450450979a3c'
 module.exports.BLOCKCHAIN_ID_ZCASH = 'b7d4f994f33c709be4ce6cbae31d7b8e'
+module.exports.BLOCKCHAIN_ID_STELLAR = '822e2ebe02f74df8'
 
 /* Endpoints */
 module.exports.ADDRESSES_ENDPOINT = '/addresses'
@@ -106,5 +107,30 @@ module.exports.LTC_METHODS = {
   transaction: ['getTransactions', 'getTransaction', 'getPendingTransactions']
 }
 
+module.exports.XLM_METHODS = {
+  address: [
+    'getAllAddresses',
+    'getInformation',
+    'getMetadata',
+    'getTransactions',
+    // 'getPendingTransactions',
+    'getBalance',
+    'getMetrics'
+  ],
+  block: [
+    'getBlocks',
+    'getBlock',
+    'getBlockNumber',
+    'getTransactions',
+    'getTransactionFromBlock',
+    'getMetrics'
+  ],
+  transaction: [
+    'getTransactions',
+    'getTransaction'
+    // 'getPendingTransactions'
+  ]
+}
+
 /* HTTP Response codes */
 module.exports.HTTP_CODE_NOT_FOUND = 404

package.json

@@ -19,6 +19,7 @@ const Btc = require('./btc')
 const Bch = require('./bch')
 const Bsv = require('./bsv')
 const Ltc = require('./ltc')
+const Xlm = require('./xlm')
 const Zec = require('./zec')
 const WebSocketClient = require('./websocket')
 
@@ -128,6 +129,7 @@ class Web3Data extends Web3DataFactory {
     this.bch = new Bch(Web3DataFactory, apiKey, options)
     this.bsv = new Bsv(Web3DataFactory, apiKey, options)
     this.ltc = new Ltc(Web3DataFactory, apiKey, options)
+    this.xlm = new Xlm(Web3DataFactory, apiKey, options)
     this.zec = new Zec(Web3DataFactory, apiKey, options)
 
     this.websocket = null

src/constants.js

@@ -0,0 +1,25 @@
+const {
+  BLOCKCHAIN_ID_STELLAR: BLOCKCHAIN_ID,
+  BTC_METHODS: METHODS
+} = require('./constants')
+const {methodFactory} = require('./utils')
+
+/**
+ * Class for all Stellar based methods.
+ *
+ * @private
+ */
+class Xlm {
+  constructor(Web3data, apiKey, options) {
+    options.blockchainId = BLOCKCHAIN_ID
+    this.web3data = new Web3data(apiKey, options)
+    methodFactory(this, METHODS)
+  }
+
+  /* See Web3Data class for details on rpc method */
+  rpc(method, params) {
+    return this.web3data.rpc(method, params)
+  }
+}
+
+module.exports = Xlm

src/web3data.js

@@ -0,0 +1,30 @@
+import test from 'ava'
+import {setUpPolly, getNewWeb3DataInstance} from "./utils";
+import { XLM_METHODS as METHODS } from "../src/constants";
+
+/***********************************
+ * -------- Tests Setup ---------- *
+ **********************************/
+test.before(t => {
+  t.context.polly = setUpPolly('xlm')
+})
+
+test.after(async t => {
+  await t.context.polly.stop()
+})
+
+test.beforeEach(t => {
+  t.context.web3data = getNewWeb3DataInstance()
+});
+
+/*********************************
+ * ----------- Tests ----------- *
+ *********************************/
+
+test('Check the xlm namespace contains all defined methods', t => {
+  for(const namespace of Object.keys(METHODS)) {
+    for (const method of METHODS[namespace]) {
+      t.truthy(t.context.web3data.xlm[namespace][method])
+    }
+  }
+})

src/xlm.js

@@ -6,7 +6,7 @@ import { BTC_METHODS as METHODS } from "../src/constants";
  * -------- Tests Setup ---------- *
  **********************************/
 test.before(t => {
-  t.context.polly = setUpPolly('ltc')
+  t.context.polly = setUpPolly('zec')
 })
 
 test.after(async t => {