@hyperlane-xyz/sdk 1.0.0-beta0 → 1.0.0-beta1

package/dist/utils/number.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertDecimalValue = exports.mulBigAndFixed = exports.fixedToBig = exports.bigToFixed = void 0;
+const ethers_1 = require("ethers");
+/**
+ * Converts a BigNumber to a FixedNumber of the format fixed128x18.
+ * @param big The BigNumber to convert.
+ * @returns A FixedNumber representation of a BigNumber.
+ */
+function bigToFixed(big) {
+    return ethers_1.FixedNumber.from(big.toString());
+}
+exports.bigToFixed = bigToFixed;
+/**
+ * Converts a FixedNumber (of any format) to a BigNumber.
+ * @param fixed The FixedNumber to convert.
+ * @param ceil If true, the ceiling of fixed is used. Otherwise, the floor is used.
+ * @returns A BigNumber representation of a FixedNumber.
+ */
+function fixedToBig(fixed, ceil = false) {
+    const fixedAsInteger = ceil ? fixed.ceiling() : fixed.floor();
+    return ethers_1.BigNumber.from(fixedAsInteger.toFormat('fixed256x0').toString());
+}
+exports.fixedToBig = fixedToBig;
+/**
+ * Multiplies a BigNumber by a FixedNumber, returning the BigNumber product.
+ * @param big The BigNumber to multiply.
+ * @param fixed The FixedNumber to multiply.
+ * @param ceil If true, the ceiling of the product is used. Otherwise, the floor is used.
+ * @returns The BigNumber product.
+ */
+function mulBigAndFixed(big, fixed, ceil = false) {
+    // Converts big to a FixedNumber, multiplies it by fixed, and converts the product back
+    // to a BigNumber.
+    return fixedToBig(fixed.mulUnsafe(bigToFixed(big)), ceil);
+}
+exports.mulBigAndFixed = mulBigAndFixed;
+/**
+ * Converts a value with `fromDecimals` decimals to a value with `toDecimals` decimals.
+ * Incurs a loss of precision when `fromDecimals` > `toDecimals`.
+ * @param value The value to convert.
+ * @param fromDecimals The number of decimals `value` has.
+ * @param toDecimals The number of decimals to convert `value` to.
+ * @returns `value` represented with `toDecimals` decimals.
+ */
+function convertDecimalValue(value, fromDecimals, toDecimals) {
+    if (fromDecimals === toDecimals) {
+        return value;
+    }
+    else if (fromDecimals > toDecimals) {
+        return value.div(Math.pow(10, (fromDecimals - toDecimals)));
+    }
+    else {
+        // if (fromDecimals < toDecimals)
+        return value.mul(Math.pow(10, (toDecimals - fromDecimals)));
+    }
+}
+exports.convertDecimalValue = convertDecimalValue;
+//# sourceMappingURL=number.js.map

package/dist/utils/number.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.js","sourceRoot":"","sources":["../../src/utils/number.ts"],"names":[],"mappings":";;;AAAA,mCAAgD;AAEhD;;;;GAIG;AACH,SAAgB,UAAU,CAAC,GAAc;IACvC,OAAO,oBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;AAC1C,CAAC;AAFD,gCAEC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,KAAkB,EAAE,IAAI,GAAG,KAAK;IACzD,MAAM,cAAc,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IAC9D,OAAO,kBAAS,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;AAC1E,CAAC;AAHD,gCAGC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAC5B,GAAc,EACd,KAAkB,EAClB,IAAI,GAAG,KAAK;IAEZ,uFAAuF;IACvF,kBAAkB;IAClB,OAAO,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;AAC5D,CAAC;AARD,wCAQC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,KAAgB,EAChB,YAAoB,EACpB,UAAkB;IAElB,IAAI,YAAY,KAAK,UAAU,EAAE;QAC/B,OAAO,KAAK,CAAC;KACd;SAAM,IAAI,YAAY,GAAG,UAAU,EAAE;QACpC,OAAO,KAAK,CAAC,GAAG,CAAC,SAAA,EAAE,EAAI,CAAC,YAAY,GAAG,UAAU,CAAC,CAAA,CAAC,CAAC;KACrD;SAAM;QACL,iCAAiC;QACjC,OAAO,KAAK,CAAC,GAAG,CAAC,SAAA,EAAE,EAAI,CAAC,UAAU,GAAG,YAAY,CAAC,CAAA,CAAC,CAAC;KACrD;AACH,CAAC;AAbD,kDAaC"}

package/dist/utils/objects.d.ts

@@ -0,0 +1,7 @@
+export declare function objMapEntries<K extends string, I = any, O = any>(obj: Record<K, I>, func: (k: K, _: I) => O): [K, O][];
+export declare function objMap<K extends string, I = any, O = any>(obj: Record<K, I>, func: (k: K, _: I) => O): Record<K, O>;
+export declare function promiseObjAll<K extends string, V>(obj: {
+    [key in K]: Promise<V>;
+}): Promise<Record<K, V>>;
+export declare function pick<K extends string, V = any>(obj: Record<K, V>, keys: K[]): Record<K, V>;
+//# sourceMappingURL=objects.d.ts.map

package/dist/utils/objects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.d.ts","sourceRoot":"","sources":["../../src/utils/objects.ts"],"names":[],"mappings":"AAEA,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,EAC9D,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACjB,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,GACtB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAEV;AAGD,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,EACvD,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACjB,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,gBAMxB;AAGD,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE;KACrD,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CACvB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAKxB;AAGD,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,gBAM3E"}

package/dist/utils/objects.js

@@ -0,0 +1,29 @@
+"use strict";
+// TODO move to utils package
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pick = exports.promiseObjAll = exports.objMap = exports.objMapEntries = void 0;
+function objMapEntries(obj, func) {
+    return Object.entries(obj).map(([k, v]) => [k, func(k, v)]);
+}
+exports.objMapEntries = objMapEntries;
+// Map over the values of the object
+function objMap(obj, func) {
+    return Object.fromEntries(objMapEntries(obj, func));
+}
+exports.objMap = objMap;
+// promiseObjectAll :: {k: Promise a} -> Promise {k: a}
+function promiseObjAll(obj) {
+    const promiseList = Object.entries(obj).map(([name, promise]) => promise.then((result) => [name, result]));
+    return Promise.all(promiseList).then(Object.fromEntries);
+}
+exports.promiseObjAll = promiseObjAll;
+// Get the subset of the object from key list
+function pick(obj, keys) {
+    const ret = {};
+    for (const key of keys) {
+        ret[key] = obj[key];
+    }
+    return ret;
+}
+exports.pick = pick;
+//# sourceMappingURL=objects.js.map

package/dist/utils/objects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.js","sourceRoot":"","sources":["../../src/utils/objects.ts"],"names":[],"mappings":";AAAA,6BAA6B;;;AAE7B,SAAgB,aAAa,CAC3B,GAAiB,EACjB,IAAuB;IAEvB,OAAO,MAAM,CAAC,OAAO,CAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAM,EAAE,IAAI,CAAC,CAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3E,CAAC;AALD,sCAKC;AAED,oCAAoC;AACpC,SAAgB,MAAM,CACpB,GAAiB,EACjB,IAAuB;IAEvB,OAAO,MAAM,CAAC,WAAW,CAAI,aAAa,CAAU,GAAG,EAAE,IAAI,CAAC,CAG7D,CAAC;AACJ,CAAC;AARD,wBAQC;AAED,uDAAuD;AACvD,SAAgB,aAAa,CAAsB,GAElD;IACC,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,CAC7D,OAAsB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CACzD,CAAC;IACF,OAAO,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;AAC3D,CAAC;AAPD,sCAOC;AAED,6CAA6C;AAC7C,SAAgB,IAAI,CAA4B,GAAiB,EAAE,IAAS;IAC1E,MAAM,GAAG,GAA0B,EAAE,CAAC;IACtC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;KACrB;IACD,OAAO,GAAmB,CAAC;AAC7B,CAAC;AAND,oBAMC"}

package/dist/utils/time.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Sleep async for some time.
+ *
+ * @param ms the number of milliseconds to sleep
+ * @returns A delay promise
+ */
+export declare function delay(ms: number): Promise<void>;
+//# sourceMappingURL=time.d.ts.map

package/dist/utils/time.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"time.d.ts","sourceRoot":"","sources":["../../src/utils/time.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C"}

package/dist/utils/time.js

@@ -0,0 +1,15 @@
+"use strict";
+// TODO move to utils package
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.delay = void 0;
+/**
+ * Sleep async for some time.
+ *
+ * @param ms the number of milliseconds to sleep
+ * @returns A delay promise
+ */
+function delay(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+exports.delay = delay;
+//# sourceMappingURL=time.js.map

package/dist/utils/time.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"time.js","sourceRoot":"","sources":["../../src/utils/time.ts"],"names":[],"mappings":";AAAA,6BAA6B;;;AAE7B;;;;;GAKG;AACH,SAAgB,KAAK,CAAC,EAAU;IAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC;AAFD,sBAEC"}

package/dist/utils/utils.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=utils.test.d.ts.map

package/dist/utils/utils.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.test.d.ts","sourceRoot":"","sources":["../../src/utils/utils.test.ts"],"names":[],"mappings":""}

package/dist/utils/utils.test.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const ethers_1 = require("ethers");
+const number_1 = require("./number");
+describe('utils', () => {
+    describe('bigToFixed', () => {
+        it('converts a BigNumber to a FixedNumber', () => {
+            const big = ethers_1.BigNumber.from('1234');
+            const fixed = (0, number_1.bigToFixed)(big);
+            (0, chai_1.expect)(fixed.toUnsafeFloat()).to.equal(1234);
+        });
+    });
+    describe('fixedToBig', () => {
+        it('converts a FixedNumber to a floored BigNumber', () => {
+            const fixed = ethers_1.FixedNumber.from('12.34');
+            const big = (0, number_1.fixedToBig)(fixed);
+            (0, chai_1.expect)(big.toNumber()).to.equal(12);
+        });
+        it('converts a FixedNumber to a ceilinged BigNumber', () => {
+            const fixed = ethers_1.FixedNumber.from('12.34');
+            const big = (0, number_1.fixedToBig)(fixed, true);
+            (0, chai_1.expect)(big.toNumber()).to.equal(13);
+        });
+    });
+    describe('mulBigAndFixed', () => {
+        it('gets the floored product of a BigNumber and FixedNumber', () => {
+            const big = ethers_1.BigNumber.from('1000');
+            const fixed = ethers_1.FixedNumber.from('1.2345');
+            const product = (0, number_1.mulBigAndFixed)(big, fixed);
+            (0, chai_1.expect)(product.toNumber()).to.equal(1234);
+        });
+        it('gets the ceilinged product of a BigNumber and FixedNumber', () => {
+            const big = ethers_1.BigNumber.from('1000');
+            const fixed = ethers_1.FixedNumber.from('1.2345');
+            const product = (0, number_1.mulBigAndFixed)(big, fixed, true);
+            (0, chai_1.expect)(product.toNumber()).to.equal(1235);
+        });
+    });
+});
+//# sourceMappingURL=utils.test.js.map

package/dist/utils/utils.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.test.js","sourceRoot":"","sources":["../../src/utils/utils.test.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAC9B,mCAAgD;AAEhD,qCAAkE;AAElE,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,GAAG,GAAG,kBAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACnC,MAAM,KAAK,GAAG,IAAA,mBAAU,EAAC,GAAG,CAAC,CAAC;YAE9B,IAAA,aAAM,EAAC,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACvD,MAAM,KAAK,GAAG,oBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACxC,MAAM,GAAG,GAAG,IAAA,mBAAU,EAAC,KAAK,CAAC,CAAC;YAE9B,IAAA,aAAM,EAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,MAAM,KAAK,GAAG,oBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACxC,MAAM,GAAG,GAAG,IAAA,mBAAU,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAEpC,IAAA,aAAM,EAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;YACjE,MAAM,GAAG,GAAG,kBAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACnC,MAAM,KAAK,GAAG,oBAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzC,MAAM,OAAO,GAAG,IAAA,uBAAc,EAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAE3C,IAAA,aAAM,EAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,GAAG,GAAG,kBAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACnC,MAAM,KAAK,GAAG,oBAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzC,MAAM,OAAO,GAAG,IAAA,uBAAc,EAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YAEjD,IAAA,aAAM,EAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@hyperlane-xyz/sdk",
   "description": "The official SDK for the Hyperlane Network",
-  "version": "1.0.0-beta0",
+  "version": "1.0.0-beta1",
   "dependencies": {
     "@hyperlane-xyz/celo-ethers-provider": "^0.1.1",
-    "@hyperlane-xyz/core": "1.0.0-beta0",
-    "@hyperlane-xyz/utils": "1.0.0-beta0",
+    "@hyperlane-xyz/core": "1.0.0-beta1",
+    "@hyperlane-xyz/utils": "1.0.0-beta1",
     "@types/debug": "^4.1.7",
     "coingecko-api": "^1.0.10",
     "cross-fetch": "^3.1.5",