Comparing version 1.0.1 to 1.1.0-0
181
index.js
"use strict"; | ||
module.exports = require("./lib/insight.js"); | ||
/** | ||
* @typedef {Object} InsightUtxo | ||
* @property {String} address | ||
* @property {String} txid | ||
* @property {Number} vout | ||
* @property {String} scriptPubKey | ||
* @property {Number} amount | ||
* @property {Number} satoshis | ||
* @property {Number} height | ||
* @property {Number} confirmations | ||
*/ | ||
/** | ||
* @typedef {[InsightSocketEventName,InsightSocketEventData]} InsightPush | ||
*/ | ||
/** | ||
* @typedef {String} InsightSocketEventName | ||
*/ | ||
/** | ||
* @typedef {Object} InstantBalance | ||
* @property {String} addrStr | ||
* @property {Number} balance | ||
* @property {Number} balanceSat | ||
* @property {Number} _utxoCount | ||
* @property {Array<Number>} _utxoAmounts | ||
* | ||
* @example | ||
* { | ||
* addrStr: 'Xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', | ||
* balance: 10.01, | ||
* balanceSat: 1001000000, | ||
* } | ||
*/ | ||
/** | ||
* @typedef InsightBalance | ||
* @property {String} addrStr | ||
* @property {Number} balance | ||
* @property {Number} balanceSat | ||
* @property {Number} totalReceived | ||
* @property {Number} totalReceivedSat | ||
* @property {Number} totalSent | ||
* @property {Number} totalSentSat | ||
* @property {Number} unconfirmedBalance | ||
* @property {Number} unconfirmedBalanceSat | ||
* @property {Number} unconfirmedAppearances | ||
* @property {Number} txAppearances | ||
*/ | ||
/** | ||
* @typedef {Object} InsightSocketEventData | ||
* @property {String} txid - hex | ||
* @property {Number} valueOut - float | ||
* @property {Array<Record<Base58CheckAddr, Number>>} vout - addr and duffs | ||
* @property {Boolean} isRBF | ||
* @property {Boolean} txlock | ||
* | ||
* @example | ||
* { | ||
* txid: 'd2cc7cb8e8d2149f8c4475aee6797b4732eab020f8eb24e8912d0054787b0966', | ||
* valueOut: 0.00099775, | ||
* vout: [ | ||
* { XcacUoyPYLokA1fZjc9ZfpV7hvALrDrERA: 40000 }, | ||
* { Xo6M4MxnHWzrksja6JnFjHuSa35SMLQ9J3: 59775 } | ||
* ], | ||
* isRBF: false, | ||
* txlock: true | ||
* } | ||
*/ | ||
/** | ||
* @typedef {Object} InsightTxResponse | ||
* @property {Number} pagesTotal | ||
* @property {Array<InsightTx>} txs | ||
*/ | ||
/** | ||
* @typedef {Object} InsightTx | ||
* @property {String} txid | ||
* @property {Number} confirmations | ||
* @property {Number} time | ||
* @property {Boolean} txlock | ||
* @property {Number} version | ||
* @property {Array<InsightTxVin>} vin | ||
* @property {Array<InsightTxVout>} vout | ||
* @property {Number} fees | ||
*/ | ||
/** | ||
* @typedef {Object} InsightTxVin | ||
* @property {String} addr - base58check-encoded address | ||
* @property {String} txid - the input's original output transaction id (hex) | ||
* @property {Number} value - float value in DASH | ||
* @property {Number} valueSat - integer value in DUFFs | ||
* @property {Number} vout - the input's original outputIndex | ||
*/ | ||
/** | ||
* @typedef {Object} InsightTxVout | ||
* @property {String} value - string value in DASH | ||
* @property {Object} scriptPubKey | ||
* @property {Array<String>} scriptPubKey.addresses | ||
* @property {String} scriptPubKey.hex | ||
* @property {String} spentTxId - not a UTXO, was spend in the indicated transaction | ||
*/ | ||
// | ||
// | ||
// Core vs Insight Conversion | ||
// | ||
// | ||
/** | ||
* @typedef {Object} CoreUtxo | ||
* @property {String} txId | ||
* @property {Number} outputIndex | ||
* @property {String} address | ||
* @property {String} script | ||
* @property {Number} satoshis | ||
*/ | ||
// | ||
// | ||
// Socket.IO nonsense | ||
// | ||
// | ||
/** | ||
* @typedef {Object} SocketIoConnect | ||
* @property {String} sid | ||
* @property {Array<String>} upgrades | ||
* @property {Number} pingInterval | ||
* @property {Number} pingTimeout | ||
*/ | ||
/** | ||
* @typedef {Object} SocketPayment | ||
* @property {String} address - base58check pay-to address | ||
* @property {Number} satoshis - duffs, duh | ||
* @property {Number} timestamp - in milliseconds since epoch | ||
* @property {String} txid - in hex | ||
* @property {Boolean} txlock | ||
*/ | ||
// | ||
// | ||
// AWS LB Cookie Nonsense | ||
// | ||
// | ||
/** | ||
* @typedef {Object} CookieStore | ||
* @property {CookieStoreSet} set | ||
* @property {CookieStoreGet} get | ||
*/ | ||
/** | ||
* @typedef {Function} CookieStoreSet | ||
* @param {String} url | ||
* @param {import('http').IncomingMessage} resp | ||
* @returns {Promise<void>} | ||
*/ | ||
/** | ||
* @typedef {Function} CookieStoreGet | ||
* @param {String} url | ||
* @returns {Promise<String>} | ||
*/ | ||
// | ||
// | ||
// Helper Types | ||
// | ||
// | ||
/** | ||
* @typedef {String} Base58CheckAddr | ||
*/ |
@@ -13,7 +13,3 @@ "use strict"; | ||
/** | ||
* @param {Object} opts | ||
* @param {Object.<String,any>} opts.form | ||
* @param {Boolean | String} opts.json | ||
* @param {String} opts.method | ||
* @param {String} opts.url | ||
* @param {import('@root/request').RequestOptions} opts | ||
*/ | ||
@@ -20,0 +16,0 @@ module.exports = async function request(opts) { |
{ | ||
"name": "dashsight", | ||
"version": "1.0.1", | ||
"version": "1.1.0-0", | ||
"description": "SDK for Dash's flavor of the Insight API", | ||
"main": "index.js", | ||
"browser": { | ||
"./ws/index.js": "./ws/browser-ws.js", | ||
"./lib/request.js": "./lib/browser-request.js" | ||
}, | ||
"bin": { | ||
@@ -16,3 +20,4 @@ "dashsight-balance": "bin/balance.js", | ||
"fmt": "npx prettier@2 --write '**/*.{md,js}'", | ||
"test": "echo \"Error: no test specified\" && exit 1" | ||
"test": "echo \"Error: no test specified\" && exit 1", | ||
"prepublish": "./bin/re-export-types" | ||
}, | ||
@@ -45,6 +50,8 @@ "files": [ | ||
"homepage": "https://github.com/dashhive/dashsight.js#readme", | ||
"optionalDependencies": { | ||
"dotenv": "^16.0.1" | ||
}, | ||
"dependencies": { | ||
"@root/request": "^1.8.3", | ||
"dotenv": "^16.0.1" | ||
"@root/request": "^1.9.0-8" | ||
} | ||
} |
195
types.js
@@ -1,180 +0,21 @@ | ||
/** | ||
* @typedef {Object} InsightUtxo | ||
* @property {String} address | ||
* @property {String} txid | ||
* @property {Number} vout | ||
* @property {String} scriptPubKey | ||
* @property {Number} amount | ||
* @property {Number} satoshis | ||
* @property {Number} height | ||
* @property {Number} confirmations | ||
*/ | ||
// auto-generated with ./bin/re-export-types | ||
// DO NOT EDIT | ||
/** | ||
* @typedef {[InsightSocketEventName, InsightSocketEventData]} InsightPush | ||
* @typedef {import('./').InsightUtxo} InsightUtxo | ||
* @typedef {import('./').InsightPush} InsightPush | ||
* @typedef {import('./').InsightSocketEventName} InsightSocketEventName | ||
* @typedef {import('./').InstantBalance} InstantBalance | ||
* @typedef {import('./').InsightSocketEventData} InsightSocketEventData | ||
* @typedef {import('./').InsightTxResponse} InsightTxResponse | ||
* @typedef {import('./').InsightTx} InsightTx | ||
* @typedef {import('./').InsightTxVin} InsightTxVin | ||
* @typedef {import('./').InsightTxVout} InsightTxVout | ||
* @typedef {import('./').CoreUtxo} CoreUtxo | ||
* @typedef {import('./').SocketIoConnect} SocketIoConnect | ||
* @typedef {import('./').SocketPayment} SocketPayment | ||
* @typedef {import('./').CookieStore} CookieStore | ||
* @typedef {import('./').CookieStoreSet} CookieStoreSet | ||
* @typedef {import('./').CookieStoreGet} CookieStoreGet | ||
* @typedef {import('./').Base58CheckAddr} Base58CheckAddr | ||
*/ | ||
/** | ||
* @typedef {String} InsightSocketEventName | ||
*/ | ||
/** | ||
* @typedef {Object} InstantBalance | ||
* @property {String} addrStr | ||
* @property {Number} balance | ||
* @property {Number} balanceSat | ||
* @property {Number} _utxoCount | ||
* @property {Array<Number>} _utxoAmounts | ||
* | ||
* @example | ||
* { | ||
* addrStr: 'Xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', | ||
* balance: 10.01, | ||
* balanceSat: 1001000000, | ||
* } | ||
*/ | ||
/** | ||
* @typedef InsightBalance | ||
* @property {String} addrStr | ||
* @property {Number} balance | ||
* @property {Number} balanceSat | ||
* @property {Number} totalReceived | ||
* @property {Number} totalReceivedSat | ||
* @property {Number} totalSent | ||
* @property {Number} totalSentSat | ||
* @property {Number} unconfirmedBalance | ||
* @property {Number} unconfirmedBalanceSat | ||
* @property {Number} unconfirmedAppearances | ||
* @property {Number} txAppearances | ||
*/ | ||
/** | ||
* @typedef {Object} InsightSocketEventData | ||
* @property {String} txid - hex | ||
* @property {Number} valueOut - float | ||
* @property {Array<Record<Base58CheckAddr, Number>>} vout - addr and duffs | ||
* @property {Boolean} isRBF | ||
* @property {Boolean} txlock | ||
* | ||
* @example | ||
* { | ||
* txid: 'd2cc7cb8e8d2149f8c4475aee6797b4732eab020f8eb24e8912d0054787b0966', | ||
* valueOut: 0.00099775, | ||
* vout: [ | ||
* { XcacUoyPYLokA1fZjc9ZfpV7hvALrDrERA: 40000 }, | ||
* { Xo6M4MxnHWzrksja6JnFjHuSa35SMLQ9J3: 59775 } | ||
* ], | ||
* isRBF: false, | ||
* txlock: true | ||
* } | ||
*/ | ||
/** | ||
* @typedef {Object} InsightTxResponse | ||
* @property {Number} pagesTotal | ||
* @property {Array<InsightTx>} txs | ||
*/ | ||
/** | ||
* @typedef {Object} InsightTx | ||
* @property {String} txid | ||
* @property {Number} confirmations | ||
* @property {Number} time | ||
* @property {Boolean} txlock | ||
* @property {Number} version | ||
* @property {Array<InsightTxVin>} vin | ||
* @property {Array<InsightTxVout>} vout | ||
* @property {Number} fees | ||
*/ | ||
/** | ||
* @typedef {Object} InsightTxVin | ||
* @property {String} addr - base58check-encoded address | ||
* @property {String} txid - the input's original output transaction id (hex) | ||
* @property {Number} value - float value in DASH | ||
* @property {Number} valueSat - integer value in DUFFs | ||
* @property {Number} vout - the input's original outputIndex | ||
*/ | ||
/** | ||
* @typedef {Object} InsightTxVout | ||
* @property {String} value - string value in DASH | ||
* @property {Object} scriptPubKey | ||
* @property {Array<String>} scriptPubKey.addresses | ||
* @property {String} scriptPubKey.hex | ||
* @property {String} spentTxId - not a UTXO, was spend in the indicated transaction | ||
*/ | ||
// | ||
// | ||
// Core vs Insight Conversion | ||
// | ||
// | ||
/** | ||
* @typedef {Object} CoreUtxo | ||
* @property {String} txId | ||
* @property {Number} outputIndex | ||
* @property {String} address | ||
* @property {String} script | ||
* @property {Number} satoshis | ||
*/ | ||
// | ||
// | ||
// Socket.IO nonsense | ||
// | ||
// | ||
/** | ||
* @typedef {Object} SocketIoConnect | ||
* @property {String} sid | ||
* @property {Array<String>} upgrades | ||
* @property {Number} pingInterval | ||
* @property {Number} pingTimeout | ||
*/ | ||
/** | ||
* @typedef {Object} SocketPayment | ||
* @property {String} address - base58check pay-to address | ||
* @property {Number} satoshis - duffs, duh | ||
* @property {Number} timestamp - in milliseconds since epoch | ||
* @property {String} txid - in hex | ||
* @property {Boolean} txlock | ||
*/ | ||
// | ||
// | ||
// AWS LB Cookie Nonsense | ||
// | ||
// | ||
/** | ||
* @typedef {Object} CookieStore | ||
* @property {CookieStoreSet} set | ||
* @property {CookieStoreGet} get | ||
*/ | ||
/** | ||
* @typedef {Function} CookieStoreSet | ||
* @param {String} url | ||
* @param {import('http').IncomingMessage} resp | ||
* @returns {Promise<void>} | ||
*/ | ||
/** | ||
* @typedef {Function} CookieStoreGet | ||
* @param {String} url | ||
* @returns {Promise<String>} | ||
*/ | ||
// | ||
// | ||
// Helper Types | ||
// | ||
// | ||
/** | ||
* @typedef {String} Base58CheckAddr | ||
*/ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
36870
18
992
2
- Removeddotenv@^16.0.1
Updated@root/request@^1.9.0-8