@bitgo/sdk-core 3.0.0 → 4.0.0

package/dist/src/index.d.ts

@@ -8,5 +8,6 @@ import { EddsaUtils } from './bitgo/utils/tss/eddsa/eddsa';
 export { EddsaUtils };
 export { GShare, SignShare, YShare } from './account-lib/mpc/tss/eddsa/types';
 import * as common from './common';
+export * from './units';
 export { common };
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,CAAC;AACtB,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,CAAC;AACtB,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,CAAC"}

package/dist/src/index.js

@@ -33,4 +33,5 @@ const eddsa_1 = require("./bitgo/utils/tss/eddsa/eddsa");
 Object.defineProperty(exports, "EddsaUtils", { enumerable: true, get: function () { return eddsa_1.EddsaUtils; } });
 const common = __importStar(require("./common"));
 exports.common = common;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLGdEQUE4QjtBQUM5Qiw0REFBNEM7QUFDNUMsd0NBQXNCO0FBQ3RCLDBDQUF3QjtBQUN4QixpREFBK0I7QUFDL0IsaURBQWlDO0FBQ2pDLHlEQUEyRDtBQUNsRCwyRkFEQSxrQkFBVSxPQUNBO0FBRW5CLGlEQUFtQztBQUMxQix3QkFBTSIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gJy4vYWNjb3VudC1saWInO1xuZXhwb3J0ICogYXMgYWNjb3VudExpYiBmcm9tICcuL2FjY291bnQtbGliJztcbmV4cG9ydCAqIGZyb20gJy4vYXBpJztcbmV4cG9ydCAqIGZyb20gJy4vYml0Z28nO1xuZXhwb3J0ICogZnJvbSAnLi9iaXRnb2pzRXJyb3InO1xuZXhwb3J0ICogYXMgY29pbnMgZnJvbSAnLi9jb2lucyc7XG5pbXBvcnQgeyBFZGRzYVV0aWxzIH0gZnJvbSAnLi9iaXRnby91dGlscy90c3MvZWRkc2EvZWRkc2EnO1xuZXhwb3J0IHsgRWRkc2FVdGlscyB9O1xuZXhwb3J0IHsgR1NoYXJlLCBTaWduU2hhcmUsIFlTaGFyZSB9IGZyb20gJy4vYWNjb3VudC1saWIvbXBjL3Rzcy9lZGRzYS90eXBlcyc7XG5pbXBvcnQgKiBhcyBjb21tb24gZnJvbSAnLi9jb21tb24nO1xuZXhwb3J0IHsgY29tbW9uIH07XG4iXX0=
+__exportStar(require("./units"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLGdEQUE4QjtBQUM5Qiw0REFBNEM7QUFDNUMsd0NBQXNCO0FBQ3RCLDBDQUF3QjtBQUN4QixpREFBK0I7QUFDL0IsaURBQWlDO0FBQ2pDLHlEQUEyRDtBQUNsRCwyRkFEQSxrQkFBVSxPQUNBO0FBRW5CLGlEQUFtQztBQUUxQix3QkFBTTtBQURmLDBDQUF3QiIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gJy4vYWNjb3VudC1saWInO1xuZXhwb3J0ICogYXMgYWNjb3VudExpYiBmcm9tICcuL2FjY291bnQtbGliJztcbmV4cG9ydCAqIGZyb20gJy4vYXBpJztcbmV4cG9ydCAqIGZyb20gJy4vYml0Z28nO1xuZXhwb3J0ICogZnJvbSAnLi9iaXRnb2pzRXJyb3InO1xuZXhwb3J0ICogYXMgY29pbnMgZnJvbSAnLi9jb2lucyc7XG5pbXBvcnQgeyBFZGRzYVV0aWxzIH0gZnJvbSAnLi9iaXRnby91dGlscy90c3MvZWRkc2EvZWRkc2EnO1xuZXhwb3J0IHsgRWRkc2FVdGlscyB9O1xuZXhwb3J0IHsgR1NoYXJlLCBTaWduU2hhcmUsIFlTaGFyZSB9IGZyb20gJy4vYWNjb3VudC1saWIvbXBjL3Rzcy9lZGRzYS90eXBlcyc7XG5pbXBvcnQgKiBhcyBjb21tb24gZnJvbSAnLi9jb21tb24nO1xuZXhwb3J0ICogZnJvbSAnLi91bml0cyc7XG5leHBvcnQgeyBjb21tb24gfTtcbiJdfQ==

package/dist/src/units.d.ts

@@ -0,0 +1,29 @@
+import BigNumber from 'bignumber.js';
+/**
+ * Converts an amount of coin in base units (such as satoshis, cents, or wei) to full units (such as bitcoin, dollars, or ether)
+ * @param baseUnits number of base units
+ * @param coin coin ticker
+ */
+export declare function toFullUnits(baseUnits: number | string | BigNumber, coin: string): string;
+/**
+ * Converts an amount of coin in base units (such as satoshis, cents, or wei) to full units (such as bitcoin, dollars, or ether) fixed amount
+ * @param baseUnits number of base units
+ * @param coin coin ticker
+ */
+export declare function toFullUnitsFixed(baseUnits: number | string | BigNumber, coin: string): string;
+/**
+ * Converts an amount of coin in full units (such as bitcoin, dollars, or ether) to base units (such as satoshis, cents, or wei)
+ * @param fullUnits number of full units
+ * @param coin coin ticker
+ */
+export declare function toBaseUnits(fullUnits: number | string | BigNumber, coin: string): string;
+/**
+ * Converts price and quantity for a coin into base units market value
+ * (note, price might be 2 decimal places longer than priceIn decimal places for base units)
+ * @param coin - which coin to calculate for
+ * @param price - price of a unit of the coin specified
+ * @param quantity - number of coins
+ * @param priceIn - numerator of trading pair, for example USD of BTC/USD
+ */
+export declare function toMarketValueBaseUnits(coin: string, price: number | string | BigNumber, quantity: string | number | bigint, priceIn?: string): bigint;
+//# sourceMappingURL=units.d.ts.map

package/dist/src/units.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"units.d.ts","sourceRoot":"","sources":["../../src/units.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,cAAc,CAAC;AAIrC;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAExF;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAG7F;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAExF;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,EAClC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAClC,OAAO,SAAU,GAChB,MAAM,CAKR"}

package/dist/src/units.js

@@ -0,0 +1,52 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toMarketValueBaseUnits = exports.toBaseUnits = exports.toFullUnitsFixed = exports.toFullUnits = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const statics_1 = require("@bitgo/statics");
+/**
+ * Converts an amount of coin in base units (such as satoshis, cents, or wei) to full units (such as bitcoin, dollars, or ether)
+ * @param baseUnits number of base units
+ * @param coin coin ticker
+ */
+function toFullUnits(baseUnits, coin) {
+    return new bignumber_js_1.default(baseUnits).div(10 ** statics_1.coins.get(coin).decimalPlaces).toString();
+}
+exports.toFullUnits = toFullUnits;
+/**
+ * Converts an amount of coin in base units (such as satoshis, cents, or wei) to full units (such as bitcoin, dollars, or ether) fixed amount
+ * @param baseUnits number of base units
+ * @param coin coin ticker
+ */
+function toFullUnitsFixed(baseUnits, coin) {
+    const decimalPlaces = statics_1.coins.get(coin).decimalPlaces;
+    return new bignumber_js_1.default(baseUnits).div(10 ** decimalPlaces).toFixed(decimalPlaces);
+}
+exports.toFullUnitsFixed = toFullUnitsFixed;
+/**
+ * Converts an amount of coin in full units (such as bitcoin, dollars, or ether) to base units (such as satoshis, cents, or wei)
+ * @param fullUnits number of full units
+ * @param coin coin ticker
+ */
+function toBaseUnits(fullUnits, coin) {
+    return new bignumber_js_1.default(fullUnits).times(10 ** statics_1.coins.get(coin).decimalPlaces).toString();
+}
+exports.toBaseUnits = toBaseUnits;
+/**
+ * Converts price and quantity for a coin into base units market value
+ * (note, price might be 2 decimal places longer than priceIn decimal places for base units)
+ * @param coin - which coin to calculate for
+ * @param price - price of a unit of the coin specified
+ * @param quantity - number of coins
+ * @param priceIn - numerator of trading pair, for example USD of BTC/USD
+ */
+function toMarketValueBaseUnits(coin, price, quantity, priceIn = 'tsusd') {
+    const roundFactor = BigInt(1000000);
+    const priceInBaseUnitsBy100 = Math.round(Number(toBaseUnits(price, priceIn)) * 100);
+    const decimalPlacesCoinBy100 = BigInt(toBaseUnits(1, coin)) * BigInt(100);
+    return (roundFactor * BigInt(quantity) * BigInt(priceInBaseUnitsBy100)) / (decimalPlacesCoinBy100 * roundFactor);
+}
+exports.toMarketValueBaseUnits = toMarketValueBaseUnits;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidW5pdHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdW5pdHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEsZ0VBQXFDO0FBRXJDLDRDQUF1QztBQUV2Qzs7OztHQUlHO0FBQ0gsU0FBZ0IsV0FBVyxDQUFDLFNBQXNDLEVBQUUsSUFBWTtJQUM5RSxPQUFPLElBQUksc0JBQVMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxHQUFHLENBQUMsRUFBRSxJQUFJLGVBQUssQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsYUFBYSxDQUFDLENBQUMsUUFBUSxFQUFFLENBQUM7QUFDdEYsQ0FBQztBQUZELGtDQUVDO0FBRUQ7Ozs7R0FJRztBQUNILFNBQWdCLGdCQUFnQixDQUFDLFNBQXNDLEVBQUUsSUFBWTtJQUNuRixNQUFNLGFBQWEsR0FBRyxlQUFLLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDLGFBQWEsQ0FBQztJQUNwRCxPQUFPLElBQUksc0JBQVMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxHQUFHLENBQUMsRUFBRSxJQUFJLGFBQWEsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxhQUFhLENBQUMsQ0FBQztBQUNsRixDQUFDO0FBSEQsNENBR0M7QUFFRDs7OztHQUlHO0FBQ0gsU0FBZ0IsV0FBVyxDQUFDLFNBQXNDLEVBQUUsSUFBWTtJQUM5RSxPQUFPLElBQUksc0JBQVMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxLQUFLLENBQUMsRUFBRSxJQUFJLGVBQUssQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsYUFBYSxDQUFDLENBQUMsUUFBUSxFQUFFLENBQUM7QUFDeEYsQ0FBQztBQUZELGtDQUVDO0FBRUQ7Ozs7Ozs7R0FPRztBQUNILFNBQWdCLHNCQUFzQixDQUNwQyxJQUFZLEVBQ1osS0FBa0MsRUFDbEMsUUFBa0MsRUFDbEMsT0FBTyxHQUFHLE9BQU87SUFFakIsTUFBTSxXQUFXLEdBQUcsTUFBTSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQ3BDLE1BQU0scUJBQXFCLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsV0FBVyxDQUFDLEtBQUssRUFBRSxPQUFPLENBQUMsQ0FBQyxHQUFHLEdBQUcsQ0FBQyxDQUFDO0lBQ3BGLE1BQU0sc0JBQXNCLEdBQUcsTUFBTSxDQUFDLFdBQVcsQ0FBQyxDQUFDLEVBQUUsSUFBSSxDQUFDLENBQUMsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDMUUsT0FBTyxDQUFDLFdBQVcsR0FBRyxNQUFNLENBQUMsUUFBUSxDQUFDLEdBQUcsTUFBTSxDQUFDLHFCQUFxQixDQUFDLENBQUMsR0FBRyxDQUFDLHNCQUFzQixHQUFHLFdBQVcsQ0FBQyxDQUFDO0FBQ25ILENBQUM7QUFWRCx3REFVQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBCaWdOdW1iZXIgZnJvbSAnYmlnbnVtYmVyLmpzJztcblxuaW1wb3J0IHsgY29pbnMgfSBmcm9tICdAYml0Z28vc3RhdGljcyc7XG5cbi8qKlxuICogQ29udmVydHMgYW4gYW1vdW50IG9mIGNvaW4gaW4gYmFzZSB1bml0cyAoc3VjaCBhcyBzYXRvc2hpcywgY2VudHMsIG9yIHdlaSkgdG8gZnVsbCB1bml0cyAoc3VjaCBhcyBiaXRjb2luLCBkb2xsYXJzLCBvciBldGhlcilcbiAqIEBwYXJhbSBiYXNlVW5pdHMgbnVtYmVyIG9mIGJhc2UgdW5pdHNcbiAqIEBwYXJhbSBjb2luIGNvaW4gdGlja2VyXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiB0b0Z1bGxVbml0cyhiYXNlVW5pdHM6IG51bWJlciB8IHN0cmluZyB8IEJpZ051bWJlciwgY29pbjogc3RyaW5nKTogc3RyaW5nIHtcbiAgcmV0dXJuIG5ldyBCaWdOdW1iZXIoYmFzZVVuaXRzKS5kaXYoMTAgKiogY29pbnMuZ2V0KGNvaW4pLmRlY2ltYWxQbGFjZXMpLnRvU3RyaW5nKCk7XG59XG5cbi8qKlxuICogQ29udmVydHMgYW4gYW1vdW50IG9mIGNvaW4gaW4gYmFzZSB1bml0cyAoc3VjaCBhcyBzYXRvc2hpcywgY2VudHMsIG9yIHdlaSkgdG8gZnVsbCB1bml0cyAoc3VjaCBhcyBiaXRjb2luLCBkb2xsYXJzLCBvciBldGhlcikgZml4ZWQgYW1vdW50XG4gKiBAcGFyYW0gYmFzZVVuaXRzIG51bWJlciBvZiBiYXNlIHVuaXRzXG4gKiBAcGFyYW0gY29pbiBjb2luIHRpY2tlclxuICovXG5leHBvcnQgZnVuY3Rpb24gdG9GdWxsVW5pdHNGaXhlZChiYXNlVW5pdHM6IG51bWJlciB8IHN0cmluZyB8IEJpZ051bWJlciwgY29pbjogc3RyaW5nKTogc3RyaW5nIHtcbiAgY29uc3QgZGVjaW1hbFBsYWNlcyA9IGNvaW5zLmdldChjb2luKS5kZWNpbWFsUGxhY2VzO1xuICByZXR1cm4gbmV3IEJpZ051bWJlcihiYXNlVW5pdHMpLmRpdigxMCAqKiBkZWNpbWFsUGxhY2VzKS50b0ZpeGVkKGRlY2ltYWxQbGFjZXMpO1xufVxuXG4vKipcbiAqIENvbnZlcnRzIGFuIGFtb3VudCBvZiBjb2luIGluIGZ1bGwgdW5pdHMgKHN1Y2ggYXMgYml0Y29pbiwgZG9sbGFycywgb3IgZXRoZXIpIHRvIGJhc2UgdW5pdHMgKHN1Y2ggYXMgc2F0b3NoaXMsIGNlbnRzLCBvciB3ZWkpXG4gKiBAcGFyYW0gZnVsbFVuaXRzIG51bWJlciBvZiBmdWxsIHVuaXRzXG4gKiBAcGFyYW0gY29pbiBjb2luIHRpY2tlclxuICovXG5leHBvcnQgZnVuY3Rpb24gdG9CYXNlVW5pdHMoZnVsbFVuaXRzOiBudW1iZXIgfCBzdHJpbmcgfCBCaWdOdW1iZXIsIGNvaW46IHN0cmluZyk6IHN0cmluZyB7XG4gIHJldHVybiBuZXcgQmlnTnVtYmVyKGZ1bGxVbml0cykudGltZXMoMTAgKiogY29pbnMuZ2V0KGNvaW4pLmRlY2ltYWxQbGFjZXMpLnRvU3RyaW5nKCk7XG59XG5cbi8qKlxuICogQ29udmVydHMgcHJpY2UgYW5kIHF1YW50aXR5IGZvciBhIGNvaW4gaW50byBiYXNlIHVuaXRzIG1hcmtldCB2YWx1ZVxuICogKG5vdGUsIHByaWNlIG1pZ2h0IGJlIDIgZGVjaW1hbCBwbGFjZXMgbG9uZ2VyIHRoYW4gcHJpY2VJbiBkZWNpbWFsIHBsYWNlcyBmb3IgYmFzZSB1bml0cylcbiAqIEBwYXJhbSBjb2luIC0gd2hpY2ggY29pbiB0byBjYWxjdWxhdGUgZm9yXG4gKiBAcGFyYW0gcHJpY2UgLSBwcmljZSBvZiBhIHVuaXQgb2YgdGhlIGNvaW4gc3BlY2lmaWVkXG4gKiBAcGFyYW0gcXVhbnRpdHkgLSBudW1iZXIgb2YgY29pbnNcbiAqIEBwYXJhbSBwcmljZUluIC0gbnVtZXJhdG9yIG9mIHRyYWRpbmcgcGFpciwgZm9yIGV4YW1wbGUgVVNEIG9mIEJUQy9VU0RcbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIHRvTWFya2V0VmFsdWVCYXNlVW5pdHMoXG4gIGNvaW46IHN0cmluZyxcbiAgcHJpY2U6IG51bWJlciB8IHN0cmluZyB8IEJpZ051bWJlcixcbiAgcXVhbnRpdHk6IHN0cmluZyB8IG51bWJlciB8IGJpZ2ludCxcbiAgcHJpY2VJbiA9ICd0c3VzZCdcbik6IGJpZ2ludCB7XG4gIGNvbnN0IHJvdW5kRmFjdG9yID0gQmlnSW50KDEwMDAwMDApO1xuICBjb25zdCBwcmljZUluQmFzZVVuaXRzQnkxMDAgPSBNYXRoLnJvdW5kKE51bWJlcih0b0Jhc2VVbml0cyhwcmljZSwgcHJpY2VJbikpICogMTAwKTtcbiAgY29uc3QgZGVjaW1hbFBsYWNlc0NvaW5CeTEwMCA9IEJpZ0ludCh0b0Jhc2VVbml0cygxLCBjb2luKSkgKiBCaWdJbnQoMTAwKTtcbiAgcmV0dXJuIChyb3VuZEZhY3RvciAqIEJpZ0ludChxdWFudGl0eSkgKiBCaWdJbnQocHJpY2VJbkJhc2VVbml0c0J5MTAwKSkgLyAoZGVjaW1hbFBsYWNlc0NvaW5CeTEwMCAqIHJvdW5kRmFjdG9yKTtcbn1cbiJdfQ==