CashAccounts.check and CashAccounts.reverseLookup w/ unit and integration tests.

Author: Gabriel Cardona

lib/CashAccounts.ts

@@ -1,5 +1,9 @@
 import axios, { AxiosResponse } from "axios"
-import { CashAccountLookupResult } from "bitcoin-com-rest"
+import {
+  CashAccountCheckResult,
+  CashAccountLookupResult,
+  CashAccountReverseLookupResult
+} from "bitcoin-com-rest"
 import { resturl } from "./BITBOX"
 
 export class CashAccounts {
@@ -27,4 +31,33 @@ export class CashAccounts {
       else throw error
     }
   }
+
+  public async check(
+    account: string,
+    number: number
+  ): Promise<CashAccountCheckResult> {
+    try {
+      const response: AxiosResponse = await axios.get(
+        `${this.restURL}cashAccounts/check/${account}/${number}`
+      )
+      return response.data
+    } catch (error) {
+      if (error.response && error.response.data) throw error.response.data
+      else throw error
+    }
+  }
+
+  public async reverseLookup(
+    cashAddress: string
+  ): Promise<CashAccountReverseLookupResult> {
+    try {
+      const response: AxiosResponse = await axios.get(
+        `${this.restURL}cashAccounts/reverseLookup/${cashAddress}`
+      )
+      return response.data
+    } catch (error) {
+      if (error.response && error.response.data) throw error.response.data
+      else throw error
+    }
+  }
 }

lib/interfaces/vendors.d.ts

@@ -307,4 +307,24 @@ declare module "bitcoin-com-rest" {
       payment: string[]
     }
   }
+
+  export interface CashAccountCheckResult {
+    identifier: string
+    block: number
+    results: string[]
+  }
+
+  export interface CashAccountReverseLookupResult {
+    results: SingleCashAccountReverseLookupResult[]
+  }
+
+  export interface SingleCashAccountReverseLookupResult {
+    accountEmoji: any
+    nameText: string
+    accountNumber: number
+    accountHash: string
+    accountCollisionLength: number
+    payloadType: number
+    payloadAddress: string
+  }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bitbox-sdk",
-  "version": "8.3.3",
+  "version": "8.4.0",
   "description": "BITBOX SDK for Bitcoin Cash",
   "author": "Gabriel Cardona <gabriel@bitcoin.com>",
   "contributors": [

test/unit/CashAccounts.ts

@@ -0,0 +1,126 @@
+// imports
+import axios from "axios"
+import {
+  CashAccountCheckResult,
+  CashAccountLookupResult,
+  CashAccountReverseLookupResult
+} from "bitcoin-com-rest"
+import * as chai from "chai"
+import * as util from "util"
+import { BITBOX, resturl } from "../../lib/BITBOX"
+import { CashAccounts } from "../../lib/CashAccounts"
+
+// consts
+const bitbox: BITBOX = new BITBOX()
+const assert: Chai.AssertStatic = chai.assert
+
+// TODO: port from require to import syntax
+const sinon = require("sinon")
+const cashAccountsMock = require("./fixtures/cashaccounts-mock.js")
+
+util.inspect.defaultOptions = {
+  showHidden: true,
+  colors: true,
+  depth: 3
+}
+
+describe("#CashAccounts", (): void => {
+  describe("#CashAccountsConstructor", (): void => {
+    it("should create instance of CashAccounts", (): void => {
+      const cashAccounts: CashAccounts = new CashAccounts()
+      assert.equal(cashAccounts instanceof CashAccounts, true)
+    })
+
+    it("should have a restURL property", (): void => {
+      const cashAccounts: CashAccounts = new CashAccounts()
+      assert.equal(cashAccounts.restURL, resturl)
+    })
+  })
+
+  describe("#lookup", () => {
+    let sandbox: any
+    beforeEach(() => (sandbox = sinon.sandbox.create()))
+    afterEach(() => sandbox.restore())
+
+    it(`should lookup CashAccount details by account, number and collision`, async (): Promise<
+      any
+    > => {
+      // Mock out data for unit test, to prevent live network call.
+      const data: any = cashAccountsMock.lookup
+      const resolved: any = new Promise(r => r({ data: data }))
+      sandbox.stub(axios, "get").returns(resolved)
+
+      const account: string = "cgcardona"
+      const number: number = 122
+      const collision: number = 6383276713
+
+      const result = (await bitbox.CashAccounts.lookup(
+        account,
+        number,
+        collision
+      )) as CashAccountLookupResult
+      //console.log(`result: ${JSON.stringify(result,null,2)}`)
+
+      assert.hasAllKeys(result, ["identifier", "information"])
+    })
+  })
+
+  describe("#check", () => {
+    let sandbox: any
+    beforeEach(() => (sandbox = sinon.sandbox.create()))
+    afterEach(() => sandbox.restore())
+
+    it(`should check CashAccount by account and number`, async (): Promise<
+      any
+    > => {
+      // Mock out data for unit test, to prevent live network call.
+      const data: any = cashAccountsMock.check
+      const resolved: any = new Promise(r => r({ data: data }))
+      sandbox.stub(axios, "get").returns(resolved)
+
+      const account: string = "cgcardona"
+      const number: number = 122
+
+      const result = (await bitbox.CashAccounts.check(
+        account,
+        number
+      )) as CashAccountCheckResult
+      //console.log(`result: ${JSON.stringify(result,null,2)}`)
+
+      assert.hasAllKeys(result, ["identifier", "block", "results"])
+    })
+  })
+
+  describe("#reverseLookup", () => {
+    let sandbox: any
+    beforeEach(() => (sandbox = sinon.sandbox.create()))
+    afterEach(() => sandbox.restore())
+
+    it(`should reverse lookup CashAccount details by cash address`, async (): Promise<
+      any
+    > => {
+      // Mock out data for unit test, to prevent live network call.
+      const data: any = cashAccountsMock.reverseLookup
+      const resolved: any = new Promise(r => r({ data: data }))
+      sandbox.stub(axios, "get").returns(resolved)
+
+      const cashAddress: string =
+        "bitcoincash:qr4aadjrpu73d2wxwkxkcrt6gqxgu6a7usxfm96fst"
+
+      const result = (await bitbox.CashAccounts.reverseLookup(
+        cashAddress
+      )) as CashAccountReverseLookupResult
+      //console.log(`result: ${JSON.stringify(result,null,2)}`)
+
+      assert.hasAllKeys(result.results[0], [
+        "accountEmoji",
+        "nameText",
+        "accountNumber",
+        "accountHash",
+        "accountCollisionLength",
+        "payloadType",
+        "payloadAddress"
+      ])
+    })
+  })
+})