Compare commits

...
8 Commits
11 changed files with 558 additions and 55 deletions
+1 -1
View File
@@ -16,7 +16,7 @@
"test:integration:free": "bash test/integration/test-free-tier.sh",
"test:integration:free:bchn": "bash test/integration/test-free-tier-bchn.sh",
"test:integration:free:testnet": "bash test/integration/testnet/test-free-tier.sh",
"test:temp": "mocha --timeout 30000 -g '#blockHeader' test/unit/electrumx.js",
"test:temp": "mocha --timeout 30000 -g '#hydrateUtxos' test/integration/",
"test:integration:api": "RESTURL=https://api.fullstack.cash/v3/ mocha --timeout 30000 test/integration",
"coverage": "nyc report --reporter=text-lcov | coveralls",
"coverage:report": "nyc --reporter=html mocha --timeout 25000 test/unit/",
+1 -1
View File
@@ -90,7 +90,7 @@ class BCHJS {
this.Generating = new Generating(libConfig)
this.HDNode = new HDNode(this.Address)
this.Mnemonic = new Mnemonic(this.Address)
this.Price = new Price()
this.Price = new Price(libConfig)
this.Script = new Script()
this.TransactionBuilder = TransactionBuilder
this.TransactionBuilder.setAddress(this.Address)
+1 -1
View File
@@ -116,7 +116,7 @@ class HDNode {
/**
* @api SLP.HDNode.toSLPAddress() toSLPAddress()
* @apiName toSLPAddress
* @apiGroup SLP
* @apiGroup HDNode
* @apiDescription Get slp address of HDNode.
*
* @apiExample Example usage:
+117 -22
View File
@@ -1,32 +1,127 @@
const axios = require("axios")
/**
* @api price.current() current()
* @apiName Price.
* @apiGroup Price
* @apiDescription Return current price of BCH in multiple currencies.
*
* @apiExample Example usage:
*(async () => {
* try {
* let current = await bchjs.Price.current('usd');
* console.log(current);
* } catch(error) {
* console.error(error)
* }
*})()
*
* // 26681
*/
let _this
class Price {
constructor(config) {
_this = this
if (config) {
this.restURL = config.restURL
this.apiToken = config.apiToken
}
// Add JWT token to the authorization header.
this.axiosOptions = {
headers: {
authorization: `Token ${this.apiToken}`
}
}
this.axios = axios
}
/**
* @api price.current() current()
* @apiName Price.
* @apiGroup Price
* @apiDescription Return current price of BCH in multiple currencies.
* This endpoint will be deprecated in favor of getUSD. It uses the Bitcoin.com
* price feed.
*
* @apiExample Example usage:
*(async () => {
* try {
* let current = await bchjs.Price.current('usd');
* console.log(current);
* } catch(err) {
* console.err(err)
* }
*})()
*
* // 26681
*/
async current(currency = "usd") {
try {
const response = await axios.get(
const response = await this.axios.get(
`https://index-api.bitcoin.com/api/v0/cash/price/${currency.toLowerCase()}`
)
// console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
return response.data.price
} catch (error) {
if (error.response && error.response.data) throw error.response.data
else throw error
} catch (err) {
if (err.response && err.response.data) throw err.response.data
else throw err
}
}
/**
* @api price.getUsd() getUsd()
* @apiName Price getUsd()
* @apiGroup Price
* @apiDescription Return current price of BCH in USD.
* This endpoint gets the USD price of BCH from the Coinbase API. The price
* comes from bch-api, so it has a better chance of working in Tor.
*
* @apiExample Example usage:
*(async () => {
* try {
* let current = await bchjs.Price.getUsd();
* console.log(current);
* } catch(err) {
* console.err(err)
* }
*})()
*
* // 266.81
*/
async getUsd() {
try {
const response = await this.axios.get(
`${this.restURL}price/usd`,
_this.axiosOptions
)
// console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
return response.data.usd
} catch (err) {
if (err.response && err.response.data) throw err.response.data
else throw err
}
}
/**
* @api price.rates() rates()
* @apiName Price rates()
* @apiGroup Price
* @apiDescription Return current price of BCH in several different currencies.
* This endpoint gets the price of BCH from the Coinbase API in many different
* currencies. The price
* comes from bch-api, so it has a better chance of working in Tor.
*
* @apiExample Example usage:
*(async () => {
* try {
* let current = await bchjs.Price.rates();
* console.log(current);
* } catch(err) {
* console.err(err)
* }
*})()
*
*/
async rates() {
try {
const response = await this.axios.get(
`${this.restURL}price/rates`,
_this.axiosOptions
)
// console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
return response.data
} catch (err) {
if (err.response && err.response.data) throw err.response.data
else throw err
}
}
}
+53 -9
View File
@@ -194,7 +194,7 @@ class Utils {
path = `${this.restURL}slp/list`
}
//console.log(`path: ${path}`)
// console.log(`path: ${path}`)
try {
let response
@@ -316,7 +316,7 @@ class Utils {
return response.data
}
throw new Error(`Input address must be a string or array of strings.`)
throw new Error("Input address must be a string or array of strings.")
} catch (error) {
if (error.response && error.response.data) throw error.response.data
throw error
@@ -499,7 +499,7 @@ class Utils {
typeof txid !== "string" ||
txid.length !== 64
)
throw new Error(`txid must be 64 character string.`)
throw new Error("txid must be 64 character string.")
const path = `${this.restURL}slp/validateTxid2/${txid}`
@@ -700,7 +700,7 @@ class Utils {
typeof txid !== "string" ||
txid.length !== 64
)
throw new Error(`txid string must be included.`)
throw new Error("txid string must be included.")
// console.log(`this.restURL: ${this.restURL}`)
const path = `${this.restURL}slp/txDetails/${txid}`
@@ -767,7 +767,8 @@ class Utils {
// Then pass that cache object back into this function every time its called.
if (cache) {
if (!(cache instanceof Object))
throw new Error(`decodeOpReturn cache parameter must be Object`)
throw new Error("decodeOpReturn cache parameter must be Object")
const cachedVal = cache[txid]
if (cachedVal) return cachedVal
}
@@ -775,7 +776,7 @@ class Utils {
try {
// Validate the txid input.
if (!txid || txid === "" || typeof txid !== "string")
throw new Error(`txid string must be included.`)
throw new Error("txid string must be included.")
// Retrieve the transaction object from the full node.
const path = `${this.restURL}rawtransactions/getRawTransaction/${txid}?verbose=true`
@@ -897,7 +898,7 @@ class Utils {
const decodeOpReturnCache = {}
const cachedTxValidation = {}
// Throw error if input is not an array.
if (!Array.isArray(utxos)) throw new Error(`Input must be an array.`)
if (!Array.isArray(utxos)) throw new Error("Input must be an array.")
// Loop through each element in the array and validate the input before
// further processing.
@@ -963,7 +964,8 @@ class Utils {
// to display the unknown state.
if (
!err.message ||
err.message.indexOf("scriptpubkey not op_return") === -1
(err.message.indexOf("scriptpubkey not op_return") === -1 &&
err.message.indexOf("lokad id") === -1)
) {
// console.log(`error from decodeOpReturn(${utxo.txid}): `, err)
@@ -1257,13 +1259,55 @@ class Utils {
* ]
* }
*
* (async () => {
* try {
* const utxos = [
* {
* utxos: [
* {
* txid: "d56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56",
* vout: 3,
* value: "6816",
* height: 606848,
* confirmations: 13,
* satoshis: 6816
* }
* ]
* }
* ]
*
* const utxoInfo = await bchjs.SLP.Utils.hydrateUtxos(utxos)
*
* console.log(`${JSON.stringify(utxoInfo, null, 2)}`)
* } catch (error) {
* console.error(error)
* }
* })()
*
* // returns
* {
* "slpUtxos": [
* {
* "utxos": [
* {
* "txid": "d56a2b446d8149c39ca7e06163fe8097168c3604915f631bc58777d669135a56",
* "vout": 3,
* "value": "6816",
* "height": 606848,
* "confirmations": 13,
* "satoshis": 6816,
* "isValid": false
* }
* ]
* }
* ]
*/
// Same as tokenUtxoDetails(), but reduces API calls by having bch-api server
// do the heavy lifting.
async hydrateUtxos(utxos) {
try {
// Throw error if input is not an array.
if (!Array.isArray(utxos)) throw new Error(`Input must be an array.`)
if (!Array.isArray(utxos)) throw new Error("Input must be an array.")
const response = await axios.post(
`${this.restURL}slp/hydrateUtxos`,
+10 -1
View File
@@ -1,4 +1,4 @@
const assert = require("assert")
const assert = require("chai").assert
const BCHJS = require("../../src/bch-js")
const bchjs = new BCHJS()
@@ -11,4 +11,13 @@ describe("#price", () => {
})
})
})
describe("#getUsd", () => {
it("should get the USD price of BCH", async () => {
const result = await bchjs.Price.getUsd()
// console.log(result)
assert.isNumber(result.usd)
})
})
})
+27 -1
View File
@@ -6,7 +6,7 @@ const chai = require("chai")
const assert = chai.assert
const BCHJS = require("../../src/bch-js")
const bchjs = new BCHJS()
let bchjs
// Inspect utility used for debugging.
const util = require("util")
@@ -25,6 +25,8 @@ describe(`#SLP`, () => {
beforeEach(async () => {
// Introduce a delay so that the BVT doesn't trip the rate limits.
await sleep(1000)
bchjs = new BCHJS()
})
describe("#util", () => {
@@ -437,6 +439,30 @@ describe(`#SLP`, () => {
assert.equal(data[0].isValid, false)
assert.equal(data[1].isValid, false)
})
it("should handle a dust attack", async () => {
// it("#dustattack", async () => {
const utxos = [
{
height: 655965,
tx_hash:
"a675af87dcd8d39be782737aa52e0076b52eb2f5ce355ffcb5567a64dd96b77e",
tx_pos: 151,
value: 547,
satoshis: 547,
txid:
"a675af87dcd8d39be782737aa52e0076b52eb2f5ce355ffcb5567a64dd96b77e",
vout: 151,
address: "bitcoincash:qq4dw3sm8qvglspy6w2qg0u2ugsy9zcfcqrpeflwww",
hdIndex: 11
}
]
const data = await bchjs.SLP.Utils.tokenUtxoDetails(utxos)
// console.log(`data: ${JSON.stringify(data, null, 2)}`)
assert.equal(data[0].isValid, false)
})
})
describe("#balancesForAddress", () => {
+55 -1
View File
@@ -89,7 +89,7 @@ describe(`#SLP`, () => {
}
})
it(`should fetch all balances for address: simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9`, async () => {
it(`should fetch all balances for address: slptest:qz0kc67pm4emjyr3gaaa2wstdaykg9m4yqwlzpj3w9`, async () => {
// Mock the call to rest.bitcoin.com
if (process.env.TEST === "unit") {
sandbox
@@ -139,6 +139,60 @@ describe(`#SLP`, () => {
])
})
})
describe("#tokenUtxoDetails", () => {
it("should hydrate UTXOs", async () => {
const bchAddr = bchjs.SLP.Address.toCashAddress(
"slptest:qz0kc67pm4emjyr3gaaa2wstdaykg9m4yqwlzpj3w9"
)
const utxos = await bchjs.Electrumx.utxo([bchAddr])
// console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
const utxoInfo = await bchjs.SLP.Utils.tokenUtxoDetails(
utxos.utxos[0].utxos
)
// console.log(`utxoInfo: ${JSON.stringify(utxoInfo, null, 2)}`)
assert.isArray(utxoInfo)
// first UTXO should be a PSF test token.
assert.equal(utxoInfo[0].isValid, true)
})
})
describe("#hydrateUtxos", () => {
// This test will error out if the LOCAL_RESTURL settings is not set properly
// in bch-api.
it("should hydrate UTXOs", async () => {
const bchAddr = bchjs.SLP.Address.toCashAddress(
"slptest:qz0kc67pm4emjyr3gaaa2wstdaykg9m4yqwlzpj3w9"
)
const utxos = await bchjs.Electrumx.utxo([bchAddr])
// console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
const utxoInfo = await bchjs.SLP.Utils.hydrateUtxos(utxos.utxos)
// console.log(`utxoInfo: ${JSON.stringify(utxoInfo, null, 2)}`)
assert.isArray(utxoInfo.slpUtxos[0].utxos)
// first UTXO should be a PSF test token.
assert.equal(utxoInfo.slpUtxos[0].utxos[0].isValid, true)
})
})
describe("#validateTxid2", () => {
it("should validate a token txid", async () => {
const txid =
"ad28116e0818339342dddfc5f58ca8a5379ceb9679b4e4cbd72f4de905415ec1"
const validated = await bchjs.SLP.Utils.validateTxid(txid)
// console.log(validated)
assert.equal(validated[0].valid, true)
})
})
})
// Promise-based sleep function
+214
View File
@@ -0,0 +1,214 @@
/*
Mocks for price.
*/
const mockRates = {
AED: "915.049218",
AFN: "19144.48874646",
ALGO: "826.6633482661356600405",
ALL: "26221.96098759",
AMD: "119977.82663822",
ANG: "446.841810455",
AOA: "162269.774275",
ARS: "19322.704621",
ATOM: "45.5920571010248851205",
AUD: "353.78913716",
AWG: "448.407",
AZN: "424.1182875",
BAL: "18.9361216125975755781",
BAM: "413.75759465",
BAND: "40.84187228461349099275",
BAT: "1169.75444148879972951",
BBD: "498.23",
BCH: "1.0",
BDT: "21107.92000745",
BGN: "413.93197515",
BHD: "93.93578597",
BIF: "481540.76228735",
BMD: "249.115",
BND: "337.84677362",
BOB: "1718.851399565",
BRL: "1396.737982",
BSD: "249.115",
BSV: "1.555324933590611026515",
BTC: "0.021265",
BTN: "18249.513962505",
BWP: "2848.17713393",
BYN: "637.963336685",
BYR: "6379633.36685000049823",
BZD: "501.752236985",
CAD: "328.80838319",
CDF: "488848.679106575",
CGLD: "121.0412516398620018305",
CHF: "226.8989243",
CLF: "7.110489445",
CLP: "196202.978234955",
CNH: "1664.25510705",
CNY: "1666.429881",
COMP: "2.4706436576415750709",
COP: "958730.858397465",
CRC: "150173.845981",
CUC: "248.997666835",
CVE: "23541.3675",
CZK: "5770.848621",
DAI: "247.0463573269230002455",
DASH: "3.327367317363110236645",
DJF: "44315.31795969",
DKK: "1575.7370741",
DOP: "14529.76988648",
DZD: "32107.28592277",
EEK: "3640.489633465",
EGP: "3911.404438",
EOS: "96.6873665825732601419",
ERN: "3736.727740265",
ETB: "9302.454572035",
ETC: "44.91795888928957612395",
ETH: "0.6574429621419051422355",
EUR: "211.595",
FJD: "533.11855575",
FKP: "192.55642863",
GBP: "192.87",
GEL: "804.64145",
GGP: "192.55642863",
GHS: "1448.776859925",
GIP: "192.55642863",
GMD: "12891.70125",
GNF: "2438630.43574976",
GTQ: "1936.689014855",
GYD: "52047.88891278",
HKD: "1930.67861725",
HNL: "6126.43736492",
HRK: "1605.40119007",
HTG: "15682.48428085",
HUF: "77261.419177275",
IDR: "3666848.2425",
ILS: "843.29662455",
IMP: "192.55642863",
INR: "18275.43761675",
IQD: "297176.65680577",
ISK: "34639.44075",
JEP: "192.55642863",
JMD: "36261.061070375",
JOD: "176.622535",
JPY: "26304.9247525",
KES: "27093.7474",
KGS: "20240.23303148",
KHR: "1021526.66327067",
KMF: "104678.164103975",
KNC: "275.5392102643512742545",
KRW: "284115.6575",
KWD: "76.196555935",
KYD: "207.44852333",
KZT: "106578.169689505",
LAK: "2300372.70137523",
LBP: "376426.60931701",
LINK: "22.8704181013371177476",
LKR: "45903.840861165",
LRC: "1428.4116972477063306",
LRD: "48689.521020355",
LSL: "4093.68786226",
LTC: "5.182877353583689269445",
LTL: "803.357262175",
LVL: "163.484459015",
LYD: "340.470203685",
MAD: "2290.86403115",
MDL: "4231.74490411",
MGA: "978918.42727237",
MKD: "13034.71219274",
MKR: "0.43727565410331105846",
MMK: "321367.16219401",
MNT: "706980.17312004",
MOP: "1987.157222705",
MRO: "88934.055",
MTL: "170.32939187",
MUR: "9942.18014823",
MVR: "3836.371",
MWK: "187533.350248305",
MXN: "5285.574344805",
MYR: "1033.2044625",
MZN: "18168.45667469",
NAD: "4120.3621",
NGN: "95465.8503",
NIO: "8675.07065117",
NMR: "8.6886689628111785348",
NOK: "2328.95371465",
NPR: "29198.52701022",
NZD: "378.934057915",
OMG: "74.27621574882972595255",
OMR: "95.913509955",
OXT: "1023.479868529169993565",
PAB: "249.115",
PEN: "892.41413087",
PGK: "870.976539545",
PHP: "12100.979598855",
PKR: "40413.26181118",
PLN: "968.71705891",
PYG: "1750259.579863715",
QAR: "907.08999375",
REN: "758.802924154736515935",
REP: "18.2168190127970744169",
REPV2: "18.225711080673967324",
RON: "1032.33256",
RSD: "24895.307525",
RUB: "19351.4774035",
RWF: "243426.179717085",
SAR: "934.309544225",
SBD: "2013.0584566",
SCR: "4561.388071665",
SEK: "2201.10291435",
SGD: "338.356712025",
SHP: "192.55642863",
SLL: "2482430.971263275",
SOS: "144000.839307095",
SRD: "3525.97371",
SSP: "32449.7199",
STD: "5232524.31108792",
SVC: "2178.147216215",
SZL: "4091.741526765",
THB: "7785.4665375",
TJS: "2568.96954016",
TMT: "871.9025",
TND: "686.00043125",
TOP: "578.0165522",
TRY: "1963.587954325",
TTD: "1689.460313635",
TWD: "7158.9423125",
TZS: "577510.41827928",
UAH: "7061.44019619",
UGX: "931508.2111739",
UMA: "30.09543944427665349095",
UNI: "79.18593747516647884725",
USD: "249.115",
USDC: "249.115",
UYU: "10688.478117885",
UZS: "2582693.606121005",
VEF: "61901998.996866715",
VES: "112695476.713406465",
VND: "5773814.12282902",
VUV: "28486.73470656",
WST: "653.35042289",
XAF: "138884.3079243",
XAG: "10.22661168355",
XAU: "0.1312935696",
XCD: "673.24574325",
XDR: "176.50246157",
XLM: "2936.20532162536435083",
XOF: "138884.3079243",
XPD: "0.1061030608",
XPF: "25265.84267069",
XPT: "0.2910211253",
XRP: "1014.931757995518373565",
XTZ: "113.8135051169590628124",
YER: "62365.930534515",
YFI: "0.0178703370267443543872",
ZAR: "4122.31765275",
ZEC: "3.87305659203980154283",
ZMK: "1308619.842149325",
ZMW: "5027.95231667",
ZRX: "644.844402797695193656",
ZWL: "80215.03"
}
module.exports = {
mockRates
}
+49 -18
View File
@@ -1,28 +1,59 @@
const chai = require("chai")
const assert = require("assert")
const assert = require("chai").assert
const BCHJS = require("../../src/bch-js")
const bchjs = new BCHJS()
const axios = require("axios")
const sinon = require("sinon")
const mockDataLib = require("./fixtures/price-mocks")
let mockData
describe("#Price", () => {
let sandbox
let bchjs
beforeEach(() => {
sandbox = sinon.createSandbox()
bchjs = new BCHJS()
mockData = Object.assign({}, mockDataLib)
})
afterEach(() => sandbox.restore())
describe("#current", () => {
describe("#single currency", () => {
let sandbox
beforeEach(() => (sandbox = sinon.createSandbox()))
afterEach(() => sandbox.restore())
it("should get current price for single currency", async () => {
sandbox
.stub(bchjs.Price.axios, "get")
.resolves({ data: { price: 24905 } })
it("should get current price for single currency", done => {
const data = 46347
const resolved = new Promise(r => r({ data: data }))
sandbox.stub(axios, "get").returns(resolved)
const result = await bchjs.Price.current("usd")
// console.log(result)
bchjs.Price.current("usd")
.then(result => {
assert.deepEqual(data.price, result)
})
.then(done, done)
})
assert.isNumber(result)
})
})
describe("#getUsd", () => {
it("should get the USD price of BCH", async () => {
sandbox.stub(bchjs.Price.axios, "get").resolves({ data: { usd: 249.87 } })
const result = await bchjs.Price.getUsd()
// console.log(result)
assert.isNumber(result)
})
})
describe("#rates", () => {
it("should get the price of BCH in several currencies", async () => {
sandbox
.stub(bchjs.Price.axios, "get")
.resolves({ data: mockData.mockRates })
const result = await bchjs.Price.rates()
// console.log(result)
assert.property(result, "USD")
assert.property(result, "CAD")
})
})
})
+30
View File
@@ -1735,6 +1735,36 @@ describe("#SLP Utils", () => {
assert.equal(data[0].isValid, null)
assert.equal(data[1].isValid, null)
})
// it("should handle a dust attack", async () => {
it("#dustattack", async () => {
// Mock external dependencies.
// Stub the calls to decodeOpReturn.
sandbox
.stub(slp.Utils, "decodeOpReturn")
.rejects(new Error("lokad id wrong size"))
const utxos = [
{
height: 655965,
tx_hash:
"a675af87dcd8d39be782737aa52e0076b52eb2f5ce355ffcb5567a64dd96b77e",
tx_pos: 151,
value: 547,
satoshis: 547,
txid:
"a675af87dcd8d39be782737aa52e0076b52eb2f5ce355ffcb5567a64dd96b77e",
vout: 151,
address: "bitcoincash:qq4dw3sm8qvglspy6w2qg0u2ugsy9zcfcqrpeflwww",
hdIndex: 11
}
]
const data = await slp.Utils.tokenUtxoDetails(utxos)
// console.log(`data: ${JSON.stringify(data, null, 2)}`)
assert.equal(data[0].isValid, false)
})
})
describe("#txDetails", () => {