@dydxprotocol/v4-client-js 2.2.0 → 2.3.1

package/build/cjs/src/lib/errors.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserError = exports.BroadcastErrorObject = exports.UnexpectedClientError = void 0;
+/**
+ * An edge-case was hit in the client that should never have been reached.
+ */
+class UnexpectedClientError extends Error {
+    constructor() {
+        super('An unexpected error occurred on the client');
+        this.name = 'UnexpectedClientError';
+    }
+}
+exports.UnexpectedClientError = UnexpectedClientError;
+/**
+ * An error occurred during the broadcasting process.
+ */
+class BroadcastErrorObject extends Error {
+    constructor(message, result) {
+        super(message);
+        this.name = 'BroadcastError';
+        this.result = result;
+        this.code = result.code;
+        this.codespace = result.codespace;
+    }
+}
+exports.BroadcastErrorObject = BroadcastErrorObject;
+/**
+ * User error occurred during a client operation.
+ */
+class UserError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'UserError';
+    }
+}
+exports.UserError = UserError;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2xpYi9lcnJvcnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBRUE7O0dBRUc7QUFDSCxNQUFhLHFCQUFzQixTQUFRLEtBQUs7SUFDOUM7UUFDRSxLQUFLLENBQUMsNENBQTRDLENBQUMsQ0FBQztRQUNwRCxJQUFJLENBQUMsSUFBSSxHQUFHLHVCQUF1QixDQUFDO0lBQ3RDLENBQUM7Q0FDRjtBQUxELHNEQUtDO0FBRUQ7O0dBRUc7QUFDSCxNQUFhLG9CQUFxQixTQUFRLEtBQUs7SUFLN0MsWUFBWSxPQUFlLEVBQUUsTUFBK0I7UUFDMUQsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ2YsSUFBSSxDQUFDLElBQUksR0FBRyxnQkFBZ0IsQ0FBQztRQUM3QixJQUFJLENBQUMsTUFBTSxHQUFHLE1BQU0sQ0FBQztRQUNyQixJQUFJLENBQUMsSUFBSSxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUM7UUFDeEIsSUFBSSxDQUFDLFNBQVMsR0FBRyxNQUFNLENBQUMsU0FBUyxDQUFDO0lBQ3BDLENBQUM7Q0FDRjtBQVpELG9EQVlDO0FBRUQ7O0dBRUc7QUFDSCxNQUFhLFNBQVUsU0FBUSxLQUFLO0lBQ2xDLFlBQVksT0FBZTtRQUN6QixLQUFLLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDZixJQUFJLENBQUMsSUFBSSxHQUFHLFdBQVcsQ0FBQztJQUMxQixDQUFDO0NBQ0Y7QUFMRCw4QkFLQyJ9

package/build/cjs/src/lib/helpers.js

@@ -0,0 +1,98 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ByteArrayEncoding = void 0;
+exports.convertPartialTransactionOptionsToFull = convertPartialTransactionOptionsToFull;
+exports.stripHexPrefix = stripHexPrefix;
+exports.bigIntToBytes = bigIntToBytes;
+exports.encodeJson = encodeJson;
+const encoding_1 = require("@cosmjs/encoding");
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const long_1 = __importDefault(require("long"));
+const constants_1 = require("./constants");
+/**
+ * @description Either return undefined or insert default sequence value into
+ * `partialTransactionOptions` if it does not exist.
+ *
+ * @returns undefined or full TransactionOptions.
+ */
+function convertPartialTransactionOptionsToFull(partialTransactionOptions) {
+    if (partialTransactionOptions === undefined) {
+        return undefined;
+    }
+    return {
+        sequence: constants_1.DEFAULT_SEQUENCE,
+        ...partialTransactionOptions,
+    };
+}
+/**
+ * @description Strip '0x' prefix from input string. If there is no '0x' prefix, return the original
+ * input.
+ *
+ * @returns input without '0x' prefix or original input if no prefix.
+ */
+function stripHexPrefix(input) {
+    if (input.indexOf('0x') === 0) {
+        return input.slice(2);
+    }
+    return input;
+}
+function toBigInt(u) {
+    if (u.length <= 1) {
+        return BigInt(0);
+    }
+    // eslint-disable-next-line no-bitwise
+    const negated = (u[0] & 1) === 1;
+    const hex = Buffer.from(u.slice(1)).toString('hex');
+    const abs = BigInt(`0x${hex}`);
+    return negated ? -abs : abs;
+}
+function bigIntToBytes(value) {
+    const absoluteValue = value < 0 ? value * BigInt(-1) : value;
+    const nonPaddedHexValue = absoluteValue.toString(16);
+    const paddedHexValue = nonPaddedHexValue.length % 2 === 0 ? nonPaddedHexValue : `0${nonPaddedHexValue}`;
+    const numberBytes = Buffer.from(paddedHexValue, 'hex');
+    const signedBytes = Uint8Array.of(value < 0 ? 3 : 2, ...numberBytes);
+    return signedBytes;
+}
+var ByteArrayEncoding;
+(function (ByteArrayEncoding) {
+    ByteArrayEncoding["HEX"] = "hex";
+    ByteArrayEncoding["BIGINT"] = "bigint";
+})(ByteArrayEncoding || (exports.ByteArrayEncoding = ByteArrayEncoding = {}));
+function encodeJson(object, byteArrayEncoding = ByteArrayEncoding.HEX) {
+    // eslint-disable-next-line prefer-arrow-callback
+    return JSON.stringify(object, function replacer(_key, value) {
+        // Even though we set the an UInt8Array as the value,
+        // it comes in here as an object with UInt8Array as the buffer property.
+        if (value instanceof bignumber_js_1.default) {
+            return value.toString();
+        }
+        if (typeof value === 'bigint') {
+            return value.toString();
+        }
+        if (value instanceof long_1.default) {
+            return value.toString();
+        }
+        if ((value === null || value === void 0 ? void 0 : value.buffer) instanceof Uint8Array) {
+            if (byteArrayEncoding === ByteArrayEncoding.HEX) {
+                return (0, encoding_1.toHex)(value.buffer);
+            }
+            else {
+                return toBigInt(value.buffer).toString();
+            }
+        }
+        else if (value instanceof Uint8Array) {
+            if (byteArrayEncoding === ByteArrayEncoding.HEX) {
+                return (0, encoding_1.toHex)(value);
+            }
+            else {
+                return toBigInt(value).toString();
+            }
+        }
+        return value;
+    });
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFhQSx3RkFXQztBQVFELHdDQU1DO0FBYUQsc0NBUUM7QUFPRCxnQ0FnQ0M7QUFsR0QsK0NBQXlDO0FBQ3pDLGdFQUFxQztBQUNyQyxnREFBd0I7QUFHeEIsMkNBQStDO0FBRS9DOzs7OztHQUtHO0FBQ0gsU0FBZ0Isc0NBQXNDLENBQ3BELHlCQUFxRDtJQUVyRCxJQUFJLHlCQUF5QixLQUFLLFNBQVMsRUFBRSxDQUFDO1FBQzVDLE9BQU8sU0FBUyxDQUFDO0lBQ25CLENBQUM7SUFFRCxPQUFPO1FBQ0wsUUFBUSxFQUFFLDRCQUFnQjtRQUMxQixHQUFHLHlCQUF5QjtLQUM3QixDQUFDO0FBQ0osQ0FBQztBQUVEOzs7OztHQUtHO0FBQ0gsU0FBZ0IsY0FBYyxDQUFDLEtBQWE7SUFDMUMsSUFBSSxLQUFLLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDO1FBQzlCLE9BQU8sS0FBSyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN4QixDQUFDO0lBRUQsT0FBTyxLQUFLLENBQUM7QUFDZixDQUFDO0FBRUQsU0FBUyxRQUFRLENBQUMsQ0FBYTtJQUM3QixJQUFJLENBQUMsQ0FBQyxNQUFNLElBQUksQ0FBQyxFQUFFLENBQUM7UUFDbEIsT0FBTyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDbkIsQ0FBQztJQUNELHNDQUFzQztJQUN0QyxNQUFNLE9BQU8sR0FBWSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsS0FBSyxDQUFDLENBQUM7SUFDMUMsTUFBTSxHQUFHLEdBQVcsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQzVELE1BQU0sR0FBRyxHQUFXLE1BQU0sQ0FBQyxLQUFLLEdBQUcsRUFBRSxDQUFDLENBQUM7SUFDdkMsT0FBTyxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUM7QUFDOUIsQ0FBQztBQUVELFNBQWdCLGFBQWEsQ0FBQyxLQUFhO0lBQ3pDLE1BQU0sYUFBYSxHQUFHLEtBQUssR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssR0FBRyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDO0lBQzdELE1BQU0saUJBQWlCLEdBQUcsYUFBYSxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUNyRCxNQUFNLGNBQWMsR0FDbEIsaUJBQWlCLENBQUMsTUFBTSxHQUFHLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLGlCQUFpQixDQUFDLENBQUMsQ0FBQyxJQUFJLGlCQUFpQixFQUFFLENBQUM7SUFDbkYsTUFBTSxXQUFXLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxjQUFjLEVBQUUsS0FBSyxDQUFDLENBQUM7SUFDdkQsTUFBTSxXQUFXLEdBQUcsVUFBVSxDQUFDLEVBQUUsQ0FBQyxLQUFLLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsRUFBRSxHQUFHLFdBQVcsQ0FBQyxDQUFDO0lBQ3JFLE9BQU8sV0FBVyxDQUFDO0FBQ3JCLENBQUM7QUFFRCxJQUFZLGlCQUdYO0FBSEQsV0FBWSxpQkFBaUI7SUFDM0IsZ0NBQVcsQ0FBQTtJQUNYLHNDQUFpQixDQUFBO0FBQ25CLENBQUMsRUFIVyxpQkFBaUIsaUNBQWpCLGlCQUFpQixRQUc1QjtBQUVELFNBQWdCLFVBQVUsQ0FDeEIsTUFBZSxFQUNmLG9CQUF1QyxpQkFBaUIsQ0FBQyxHQUFHO0lBRTVELGlEQUFpRDtJQUNqRCxPQUFPLElBQUksQ0FBQyxTQUFTLENBQUMsTUFBTSxFQUFFLFNBQVMsUUFBUSxDQUFDLElBQUksRUFBRSxLQUFLO1FBQ3pELHFEQUFxRDtRQUNyRCx3RUFBd0U7UUFDeEUsSUFBSSxLQUFLLFlBQVksc0JBQVMsRUFBRSxDQUFDO1lBQy9CLE9BQU8sS0FBSyxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQzFCLENBQUM7UUFDRCxJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVEsRUFBRSxDQUFDO1lBQzlCLE9BQU8sS0FBSyxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQzFCLENBQUM7UUFDRCxJQUFJLEtBQUssWUFBWSxjQUFJLEVBQUUsQ0FBQztZQUMxQixPQUFPLEtBQUssQ0FBQyxRQUFRLEVBQUUsQ0FBQztRQUMxQixDQUFDO1FBQ0QsSUFBSSxDQUFBLEtBQUssYUFBTCxLQUFLLHVCQUFMLEtBQUssQ0FBRSxNQUFNLGFBQVksVUFBVSxFQUFFLENBQUM7WUFDeEMsSUFBSSxpQkFBaUIsS0FBSyxpQkFBaUIsQ0FBQyxHQUFHLEVBQUUsQ0FBQztnQkFDaEQsT0FBTyxJQUFBLGdCQUFLLEVBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1lBQzdCLENBQUM7aUJBQU0sQ0FBQztnQkFDTixPQUFPLFFBQVEsQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLENBQUMsUUFBUSxFQUFFLENBQUM7WUFDM0MsQ0FBQztRQUNILENBQUM7YUFBTSxJQUFJLEtBQUssWUFBWSxVQUFVLEVBQUUsQ0FBQztZQUN2QyxJQUFJLGlCQUFpQixLQUFLLGlCQUFpQixDQUFDLEdBQUcsRUFBRSxDQUFDO2dCQUNoRCxPQUFPLElBQUEsZ0JBQUssRUFBQyxLQUFLLENBQUMsQ0FBQztZQUN0QixDQUFDO2lCQUFNLENBQUM7Z0JBQ04sT0FBTyxRQUFRLENBQUMsS0FBSyxDQUFDLENBQUMsUUFBUSxFQUFFLENBQUM7WUFDcEMsQ0FBQztRQUNILENBQUM7UUFDRCxPQUFPLEtBQUssQ0FBQztJQUNmLENBQUMsQ0FBQyxDQUFDO0FBQ0wsQ0FBQyJ9

package/build/cjs/src/lib/onboarding.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deriveHDKeyFromMnemonic = exports.deriveHDKeyFromEthereumSignature = exports.exportMnemonicAndPrivateKey = void 0;
+const bip32_1 = require("@scure/bip32");
+const bip39_1 = require("@scure/bip39");
+const english_1 = require("@scure/bip39/wordlists/english");
+const keccak_1 = require("ethereum-cryptography/keccak");
+const helpers_1 = require("./helpers");
+/**
+ * @description Get Mnemonic and priv/pub keys from privateKeyBytes and BIP44 HD path
+ *
+ * @url https://github.com/confio/cosmos-hd-key-derivation-spec#bip44
+ *
+ * @param entropy used to generate mnemonic
+ *
+ * @param path BIP44 HD Path. Default is The Cosmos Hub path
+ *
+ * @throws Error if the hdkey does not exist
+ *
+ * @returns Mnemonic and priv/pub keys
+ */
+const exportMnemonicAndPrivateKey = (entropy, path = "m/44'/118'/0'/0/0") => {
+    const mnemonic = (0, bip39_1.entropyToMnemonic)(entropy, english_1.wordlist);
+    const { privateKey, publicKey } = (0, exports.deriveHDKeyFromMnemonic)(mnemonic, path);
+    return {
+        mnemonic,
+        privateKey,
+        publicKey,
+    };
+};
+exports.exportMnemonicAndPrivateKey = exportMnemonicAndPrivateKey;
+/**
+ * @description Get private information for onboarding using an Ethereum Signature.
+ *
+ * @returns Mnemonic and Public/Private HD keys
+ */
+const deriveHDKeyFromEthereumSignature = (signature) => {
+    const buffer = Buffer.from((0, helpers_1.stripHexPrefix)(signature), 'hex');
+    if (buffer.length !== 65) {
+        throw new Error('Signature must be 65 bytes');
+    }
+    // Remove the 'v' value by taking only the first 64 bytes of the signature
+    const rsValues = buffer.subarray(0, 64);
+    // Hash the 'r' and 's' values down to 32 bytes (256 bits) using Keccak-256
+    const entropy = (0, keccak_1.keccak256)(rsValues);
+    return (0, exports.exportMnemonicAndPrivateKey)(entropy);
+};
+exports.deriveHDKeyFromEthereumSignature = deriveHDKeyFromEthereumSignature;
+/**
+ * @description Derive priv/pub keys from mnemonic and BIP44 HD path
+ *
+ * @url https://github.com/confio/cosmos-hd-key-derivation-spec#bip44
+ *
+ * @param mnemonic used to generate seed
+ *
+ * @param path BIP44 HD Path. Default is The Cosmos Hub path
+ *
+ * @throws Error if the hdkey does not exist
+ *
+ * @returns Priv/pub keys
+ */
+const deriveHDKeyFromMnemonic = (mnemonic, path = "m/44'/118'/0'/0/0") => {
+    const seed = (0, bip39_1.mnemonicToSeedSync)(mnemonic);
+    const hdkey = bip32_1.HDKey.fromMasterSeed(seed);
+    const derivedHdkey = hdkey.derive(path);
+    if (!hdkey.privateKey) {
+        throw new Error('null hd key');
+    }
+    return {
+        privateKey: derivedHdkey.privateKey,
+        publicKey: derivedHdkey.publicKey,
+    };
+};
+exports.deriveHDKeyFromMnemonic = deriveHDKeyFromMnemonic;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib25ib2FyZGluZy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvb25ib2FyZGluZy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSx3Q0FBcUM7QUFDckMsd0NBQXFFO0FBQ3JFLDREQUEwRDtBQUMxRCx5REFBeUQ7QUFFekQsdUNBQTJDO0FBRTNDOzs7Ozs7Ozs7Ozs7R0FZRztBQUNJLE1BQU0sMkJBQTJCLEdBQUcsQ0FDekMsT0FBbUIsRUFDbkIsT0FBZSxtQkFBbUIsRUFLbEMsRUFBRTtJQUNGLE1BQU0sUUFBUSxHQUFHLElBQUEseUJBQWlCLEVBQUMsT0FBTyxFQUFFLGtCQUFRLENBQUMsQ0FBQztJQUN0RCxNQUFNLEVBQUUsVUFBVSxFQUFFLFNBQVMsRUFBRSxHQUFHLElBQUEsK0JBQXVCLEVBQUMsUUFBUSxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQzFFLE9BQU87UUFDTCxRQUFRO1FBQ1IsVUFBVTtRQUNWLFNBQVM7S0FDVixDQUFDO0FBQ0osQ0FBQyxDQUFDO0FBZlcsUUFBQSwyQkFBMkIsK0JBZXRDO0FBRUY7Ozs7R0FJRztBQUNJLE1BQU0sZ0NBQWdDLEdBQUcsQ0FDOUMsU0FBaUIsRUFLakIsRUFBRTtJQUNGLE1BQU0sTUFBTSxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBQSx3QkFBYyxFQUFDLFNBQVMsQ0FBQyxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBRTdELElBQUksTUFBTSxDQUFDLE1BQU0sS0FBSyxFQUFFLEVBQUUsQ0FBQztRQUN6QixNQUFNLElBQUksS0FBSyxDQUFDLDRCQUE0QixDQUFDLENBQUM7SUFDaEQsQ0FBQztJQUVELDBFQUEwRTtJQUMxRSxNQUFNLFFBQVEsR0FBRyxNQUFNLENBQUMsUUFBUSxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQztJQUN4QywyRUFBMkU7SUFDM0UsTUFBTSxPQUFPLEdBQUcsSUFBQSxrQkFBUyxFQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ3BDLE9BQU8sSUFBQSxtQ0FBMkIsRUFBQyxPQUFPLENBQUMsQ0FBQztBQUM5QyxDQUFDLENBQUM7QUFsQlcsUUFBQSxnQ0FBZ0Msb0NBa0IzQztBQUVGOzs7Ozs7Ozs7Ozs7R0FZRztBQUNJLE1BQU0sdUJBQXVCLEdBQUcsQ0FDckMsUUFBZ0IsRUFDaEIsT0FBZSxtQkFBbUIsRUFJbEMsRUFBRTtJQUNGLE1BQU0sSUFBSSxHQUFHLElBQUEsMEJBQWtCLEVBQUMsUUFBUSxDQUFDLENBQUM7SUFFMUMsTUFBTSxLQUFLLEdBQUcsYUFBSyxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUN6QyxNQUFNLFlBQVksR0FBRyxLQUFLLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBRXhDLElBQUksQ0FBQyxLQUFLLENBQUMsVUFBVSxFQUFFLENBQUM7UUFDdEIsTUFBTSxJQUFJLEtBQUssQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUNqQyxDQUFDO0lBRUQsT0FBTztRQUNMLFVBQVUsRUFBRSxZQUFZLENBQUMsVUFBVTtRQUNuQyxTQUFTLEVBQUUsWUFBWSxDQUFDLFNBQVM7S0FDbEMsQ0FBQztBQUNKLENBQUMsQ0FBQztBQXBCVyxRQUFBLHVCQUF1QiwyQkFvQmxDIn0=

package/build/cjs/src/lib/utils.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.randomInt = randomInt;
+exports.generateRandomClientId = generateRandomClientId;
+exports.clientIdFromString = clientIdFromString;
+exports.sleep = sleep;
+exports.getGovAddNewMarketTitle = getGovAddNewMarketTitle;
+exports.getGovAddNewMarketSummary = getGovAddNewMarketSummary;
+exports.calculateClockOffsetFromFetchDateHeader = calculateClockOffsetFromFetchDateHeader;
+const constants_1 = require("../clients/constants");
+/**
+ * Returns a random integer value between 0 and (n-1).
+ */
+function randomInt(n) {
+    return Math.floor(Math.random() * n);
+}
+/**
+ * Generate a random clientId.
+ */
+function generateRandomClientId() {
+    return randomInt(constants_1.MAX_UINT_32 + 1);
+}
+/**
+ * Deterministically generate a valid clientId from an arbitrary string by performing a
+ * quick hashing function on the string.
+ */
+function clientIdFromString(input) {
+    let hash = 0;
+    if (input.length === 0)
+        return hash;
+    for (let i = 0; i < input.length; i++) {
+        hash = (hash << 5) - hash + input.charCodeAt(i); // eslint-disable-line no-bitwise
+        hash |= 0; // eslint-disable-line no-bitwise
+    }
+    // Bitwise operators covert the value to a 32-bit integer.
+    // We must coerce this into a 32-bit unsigned integer.
+    return hash + 2 ** 31;
+}
+/**
+ * Pauses the execution of the program for a specified time.
+ * @param ms - The number of milliseconds to pause the program.
+ * @returns A promise that resolves after the specified number of milliseconds.
+ */
+async function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+/**
+ * Returns a title to use for a gov proposal that adds a new market.
+ *
+ * @param ticker ticker symbol for the new market.
+ * @returns title for the gov proposal.
+ */
+function getGovAddNewMarketTitle(ticker) {
+    return `Add ${ticker} perpetual market`;
+}
+/**
+ * Returns a summary to use for a gov proposal that adds a new market.
+ *
+ * @param ticker ticker symbol for the new market.
+ * @param delayBlocks number of blocks to wait before activating the market.
+ * @returns summary for the gov proposal.
+ */
+function getGovAddNewMarketSummary(ticker, delayBlocks) {
+    return `Add the x/prices, x/perpetuals and x/clob parameters needed for a ${ticker} perpetual market. Create the market in INITIALIZING status and transition it to ACTIVE status after ${delayBlocks} blocks.`;
+}
+function calculateClockOffsetFromFetchDateHeader(clientRequestStartTime, serverReportedTime, clientRequestEndTime) {
+    // use midpoint, so assume that time for request reach server === time for response to reach us
+    const estimatedLocalTimeAtServerArrival = (clientRequestStartTime + clientRequestEndTime) / 2;
+    // we need an offset such that estimatedLocalTimeAtServerArrival + offset = serverReportedTime
+    const offset = serverReportedTime - estimatedLocalTimeAtServerArrival;
+    return Math.floor(offset);
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBS0EsOEJBRUM7QUFLRCx3REFFQztBQU1ELGdEQVdDO0FBT0Qsc0JBRUM7QUFRRCwwREFFQztBQVNELDhEQUVDO0FBRUQsMEZBWUM7QUEzRUQsb0RBQW1EO0FBRW5EOztHQUVHO0FBQ0gsU0FBZ0IsU0FBUyxDQUFDLENBQVM7SUFDakMsT0FBTyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQztBQUN2QyxDQUFDO0FBRUQ7O0dBRUc7QUFDSCxTQUFnQixzQkFBc0I7SUFDcEMsT0FBTyxTQUFTLENBQUMsdUJBQVcsR0FBRyxDQUFDLENBQUMsQ0FBQztBQUNwQyxDQUFDO0FBRUQ7OztHQUdHO0FBQ0gsU0FBZ0Isa0JBQWtCLENBQUMsS0FBYTtJQUM5QyxJQUFJLElBQUksR0FBVyxDQUFDLENBQUM7SUFDckIsSUFBSSxLQUFLLENBQUMsTUFBTSxLQUFLLENBQUM7UUFBRSxPQUFPLElBQUksQ0FBQztJQUNwQyxLQUFLLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEdBQUcsS0FBSyxDQUFDLE1BQU0sRUFBRSxDQUFDLEVBQUUsRUFBRSxDQUFDO1FBQ3RDLElBQUksR0FBRyxDQUFDLElBQUksSUFBSSxDQUFDLENBQUMsR0FBRyxJQUFJLEdBQUcsS0FBSyxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLGlDQUFpQztRQUNsRixJQUFJLElBQUksQ0FBQyxDQUFDLENBQUMsaUNBQWlDO0lBQzlDLENBQUM7SUFFRCwwREFBMEQ7SUFDMUQsc0RBQXNEO0lBQ3RELE9BQU8sSUFBSSxHQUFHLENBQUMsSUFBSSxFQUFFLENBQUM7QUFDeEIsQ0FBQztBQUVEOzs7O0dBSUc7QUFDSSxLQUFLLFVBQVUsS0FBSyxDQUFDLEVBQVU7SUFDcEMsT0FBTyxJQUFJLE9BQU8sQ0FBQyxDQUFDLE9BQU8sRUFBRSxFQUFFLENBQUMsVUFBVSxDQUFDLE9BQU8sRUFBRSxFQUFFLENBQUMsQ0FBQyxDQUFDO0FBQzNELENBQUM7QUFFRDs7Ozs7R0FLRztBQUNILFNBQWdCLHVCQUF1QixDQUFDLE1BQWM7SUFDcEQsT0FBTyxPQUFPLE1BQU0sbUJBQW1CLENBQUM7QUFDMUMsQ0FBQztBQUVEOzs7Ozs7R0FNRztBQUNILFNBQWdCLHlCQUF5QixDQUFDLE1BQWMsRUFBRSxXQUFtQjtJQUMzRSxPQUFPLHFFQUFxRSxNQUFNLHdHQUF3RyxXQUFXLFVBQVUsQ0FBQztBQUNsTixDQUFDO0FBRUQsU0FBZ0IsdUNBQXVDLENBQ3JELHNCQUE4QixFQUM5QixrQkFBMEIsRUFDMUIsb0JBQTRCO0lBRTVCLCtGQUErRjtJQUMvRixNQUFNLGlDQUFpQyxHQUFHLENBQUMsc0JBQXNCLEdBQUcsb0JBQW9CLENBQUMsR0FBRyxDQUFDLENBQUM7SUFFOUYsOEZBQThGO0lBQzlGLE1BQU0sTUFBTSxHQUFHLGtCQUFrQixHQUFHLGlDQUFpQyxDQUFDO0lBRXRFLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsQ0FBQztBQUM1QixDQUFDIn0=

package/build/cjs/src/lib/validation.js

@@ -0,0 +1,150 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validatePlaceOrderMessage = validatePlaceOrderMessage;
+exports.validateCancelOrderMessage = validateCancelOrderMessage;
+exports.validateBatchCancelOrderMessage = validateBatchCancelOrderMessage;
+exports.validateTransferMessage = validateTransferMessage;
+exports.verifyOrderFlags = verifyOrderFlags;
+exports.isStatefulOrder = isStatefulOrder;
+exports.isValidAddress = isValidAddress;
+const bech32_1 = require("bech32");
+const long_1 = __importDefault(require("long"));
+const constants_1 = require("../clients/constants");
+const types_1 = require("../clients/types");
+const errors_1 = require("./errors");
+/**
+ * @describe validatePlaceOrderMessage validates that an order to place has fields that would be
+ *  valid on-chain.
+ */
+function validatePlaceOrderMessage(subaccountNumber, order) {
+    if (!verifyNumberIsUint32(order.clientId)) {
+        return new errors_1.UserError(`clientId: ${order.clientId} is not a valid uint32`);
+    }
+    if (order.quantums.lessThanOrEqual(long_1.default.ZERO)) {
+        return new errors_1.UserError(`quantums: ${order.quantums} cannot be <= 0`);
+    }
+    if (order.subticks.lessThanOrEqual(long_1.default.ZERO)) {
+        return new errors_1.UserError(`subticks: ${order.subticks} cannot be <= 0`);
+    }
+    if (!verifySubaccountNumber(subaccountNumber)) {
+        return new errors_1.UserError(`subaccountNumber: ${subaccountNumber} cannot be < 0 or > ${constants_1.MAX_SUBACCOUNT_NUMBER}`);
+    }
+    if (!isStatefulOrder(order.orderFlags) && !verifyGoodTilBlock(order.goodTilBlock)) {
+        return new errors_1.UserError(`goodTilBlock: ${order.goodTilBlock} is not a valid uint32 or is 0`);
+    }
+    if (isStatefulOrder(order.orderFlags) && !verifyGoodTilBlockTime(order.goodTilBlockTime)) {
+        return new errors_1.UserError(`goodTilBlockTime: ${order.goodTilBlockTime} is not a valid uint32 or is 0`);
+    }
+    return undefined;
+}
+/**
+ * @describe validateCancelOrderMessage validates that an order to cancel has fields that would be
+ *  valid on-chain.
+ */
+function validateCancelOrderMessage(subaccountNumber, order) {
+    if (!verifyNumberIsUint32(order.clientId)) {
+        return new errors_1.UserError(`clientId: ${order.clientId} is not a valid uint32`);
+    }
+    if (!isStatefulOrder(order.orderFlags) && !verifyGoodTilBlock(order.goodTilBlock)) {
+        return new errors_1.UserError(`goodTilBlock: ${order.goodTilBlock} is not a valid uint32 or is 0`);
+    }
+    if (!isStatefulOrder(order.orderFlags) && order.goodTilBlockTime !== undefined) {
+        return new errors_1.UserError(`goodTilBlockTime is ${order.goodTilBlockTime}, but should not be set for non-stateful orders`);
+    }
+    if (isStatefulOrder(order.orderFlags) && !verifyGoodTilBlockTime(order.goodTilBlockTime)) {
+        return new errors_1.UserError(`goodTilBlockTime: ${order.goodTilBlockTime} is not a valid uint32 or is 0`);
+    }
+    if (isStatefulOrder(order.orderFlags) && order.goodTilBlock !== undefined) {
+        return new errors_1.UserError(`goodTilBlock is ${order.goodTilBlock}, but should not be set for stateful orders`);
+    }
+    if (!verifySubaccountNumber(subaccountNumber)) {
+        return new errors_1.UserError(`subaccountNumber: ${subaccountNumber} cannot be < 0 or > ${constants_1.MAX_SUBACCOUNT_NUMBER}`);
+    }
+    return undefined;
+}
+/**
+ * @describe validateBatchCancelOrderMessage validates that orders to batch cancel have fields that would be
+ *  valid on-chain.
+ */
+function validateBatchCancelOrderMessage(subaccountNumber, orders) {
+    for (const orderBatch of orders.shortTermOrders) {
+        for (const clientId of orderBatch.clientIds) {
+            if (!verifyNumberIsUint32(clientId)) {
+                return new errors_1.UserError(`clientId: ${clientId} is not a valid uint32`);
+            }
+        }
+    }
+    if (!verifyGoodTilBlock(orders.goodTilBlock)) {
+        return new errors_1.UserError(`goodTilBlock: ${orders.goodTilBlock} is not a valid uint32 or is 0`);
+    }
+    if (!verifySubaccountNumber(subaccountNumber)) {
+        return new errors_1.UserError(`subaccountNumber: ${subaccountNumber} cannot be < 0 or > ${constants_1.MAX_SUBACCOUNT_NUMBER}`);
+    }
+    return undefined;
+}
+/**
+ * @describe validateTransferMessage validates that a transfer to place has fields that would be
+ *  valid on-chain.
+ */
+function validateTransferMessage(transfer) {
+    if (!verifySubaccountNumber(transfer.sender.number || 0)) {
+        return new errors_1.UserError(`senderSubaccountNumber: ${transfer.sender.number || 0} cannot be < 0 or > ${constants_1.MAX_SUBACCOUNT_NUMBER}`);
+    }
+    if (!verifySubaccountNumber(transfer.recipient.number || 0)) {
+        return new errors_1.UserError(`recipientSubaccountNumber: ${transfer.recipient.number || 0} cannot be < 0 or > ${constants_1.MAX_SUBACCOUNT_NUMBER}`);
+    }
+    if (transfer.assetId !== 0) {
+        return new errors_1.UserError(`asset id: ${transfer.assetId} not supported`);
+    }
+    if (transfer.amount.lessThanOrEqual(long_1.default.ZERO)) {
+        return new errors_1.UserError(`amount: ${transfer.amount} cannot be <= 0`);
+    }
+    const addressError = verifyIsBech32(transfer.recipient.owner);
+    if (addressError !== undefined) {
+        return new errors_1.UserError(addressError.toString());
+    }
+    return undefined;
+}
+function verifyGoodTilBlock(goodTilBlock) {
+    if (goodTilBlock === undefined) {
+        return false;
+    }
+    return verifyNumberIsUint32(goodTilBlock) && goodTilBlock > 0;
+}
+function verifyGoodTilBlockTime(goodTilBlockTime) {
+    if (goodTilBlockTime === undefined) {
+        return false;
+    }
+    return verifyNumberIsUint32(goodTilBlockTime) && goodTilBlockTime > 0;
+}
+function verifySubaccountNumber(subaccountNumber) {
+    return subaccountNumber >= 0 && subaccountNumber <= constants_1.MAX_SUBACCOUNT_NUMBER;
+}
+function verifyNumberIsUint32(num) {
+    return num >= 0 && num <= constants_1.MAX_UINT_32;
+}
+function verifyOrderFlags(orderFlags) {
+    return (orderFlags === types_1.OrderFlags.SHORT_TERM ||
+        orderFlags === types_1.OrderFlags.LONG_TERM ||
+        orderFlags === types_1.OrderFlags.CONDITIONAL);
+}
+function isStatefulOrder(orderFlags) {
+    return orderFlags === types_1.OrderFlags.LONG_TERM || orderFlags === types_1.OrderFlags.CONDITIONAL;
+}
+function verifyIsBech32(address) {
+    try {
+        (0, bech32_1.decode)(address);
+    }
+    catch (error) {
+        return error;
+    }
+    return undefined;
+}
+function isValidAddress(address) {
+    // An address is valid if it starts with `dydx1` and is Bech32 format.
+    return address.startsWith('dydx1') && verifyIsBech32(address) === undefined;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvdmFsaWRhdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQWlCQSw4REE0QkM7QUFNRCxnRUFnQ0M7QUFNRCwwRUF1QkM7QUFNRCwwREEyQkM7QUEwQkQsNENBTUM7QUFFRCwwQ0FFQztBQVlELHdDQUdDO0FBcE1ELG1DQUFnQztBQUNoQyxnREFBd0I7QUFFeEIsb0RBQTBFO0FBQzFFLDRDQU0wQjtBQUMxQixxQ0FBcUM7QUFFckM7OztHQUdHO0FBQ0gsU0FBZ0IseUJBQXlCLENBQ3ZDLGdCQUF3QixFQUN4QixLQUFrQjtJQUVsQixJQUFJLENBQUMsb0JBQW9CLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUM7UUFDMUMsT0FBTyxJQUFJLGtCQUFTLENBQUMsYUFBYSxLQUFLLENBQUMsUUFBUSx3QkFBd0IsQ0FBQyxDQUFDO0lBQzVFLENBQUM7SUFDRCxJQUFJLEtBQUssQ0FBQyxRQUFRLENBQUMsZUFBZSxDQUFDLGNBQUksQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDO1FBQzlDLE9BQU8sSUFBSSxrQkFBUyxDQUFDLGFBQWEsS0FBSyxDQUFDLFFBQVEsaUJBQWlCLENBQUMsQ0FBQztJQUNyRSxDQUFDO0lBQ0QsSUFBSSxLQUFLLENBQUMsUUFBUSxDQUFDLGVBQWUsQ0FBQyxjQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQztRQUM5QyxPQUFPLElBQUksa0JBQVMsQ0FBQyxhQUFhLEtBQUssQ0FBQyxRQUFRLGlCQUFpQixDQUFDLENBQUM7SUFDckUsQ0FBQztJQUNELElBQUksQ0FBQyxzQkFBc0IsQ0FBQyxnQkFBZ0IsQ0FBQyxFQUFFLENBQUM7UUFDOUMsT0FBTyxJQUFJLGtCQUFTLENBQ2xCLHFCQUFxQixnQkFBZ0IsdUJBQXVCLGlDQUFxQixFQUFFLENBQ3BGLENBQUM7SUFDSixDQUFDO0lBQ0QsSUFBSSxDQUFDLGVBQWUsQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxLQUFLLENBQUMsWUFBWSxDQUFDLEVBQUUsQ0FBQztRQUNsRixPQUFPLElBQUksa0JBQVMsQ0FBQyxpQkFBaUIsS0FBSyxDQUFDLFlBQVksZ0NBQWdDLENBQUMsQ0FBQztJQUM1RixDQUFDO0lBQ0QsSUFBSSxlQUFlLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsc0JBQXNCLENBQUMsS0FBSyxDQUFDLGdCQUFnQixDQUFDLEVBQUUsQ0FBQztRQUN6RixPQUFPLElBQUksa0JBQVMsQ0FDbEIscUJBQXFCLEtBQUssQ0FBQyxnQkFBZ0IsZ0NBQWdDLENBQzVFLENBQUM7SUFDSixDQUFDO0lBRUQsT0FBTyxTQUFTLENBQUM7QUFDbkIsQ0FBQztBQUVEOzs7R0FHRztBQUNILFNBQWdCLDBCQUEwQixDQUN4QyxnQkFBd0IsRUFDeEIsS0FBbUI7SUFFbkIsSUFBSSxDQUFDLG9CQUFvQixDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsRUFBRSxDQUFDO1FBQzFDLE9BQU8sSUFBSSxrQkFBUyxDQUFDLGFBQWEsS0FBSyxDQUFDLFFBQVEsd0JBQXdCLENBQUMsQ0FBQztJQUM1RSxDQUFDO0lBQ0QsSUFBSSxDQUFDLGVBQWUsQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxLQUFLLENBQUMsWUFBWSxDQUFDLEVBQUUsQ0FBQztRQUNsRixPQUFPLElBQUksa0JBQVMsQ0FBQyxpQkFBaUIsS0FBSyxDQUFDLFlBQVksZ0NBQWdDLENBQUMsQ0FBQztJQUM1RixDQUFDO0lBQ0QsSUFBSSxDQUFDLGVBQWUsQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFDLElBQUksS0FBSyxDQUFDLGdCQUFnQixLQUFLLFNBQVMsRUFBRSxDQUFDO1FBQy9FLE9BQU8sSUFBSSxrQkFBUyxDQUNsQix1QkFBdUIsS0FBSyxDQUFDLGdCQUFnQixpREFBaUQsQ0FDL0YsQ0FBQztJQUNKLENBQUM7SUFDRCxJQUFJLGVBQWUsQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxzQkFBc0IsQ0FBQyxLQUFLLENBQUMsZ0JBQWdCLENBQUMsRUFBRSxDQUFDO1FBQ3pGLE9BQU8sSUFBSSxrQkFBUyxDQUNsQixxQkFBcUIsS0FBSyxDQUFDLGdCQUFnQixnQ0FBZ0MsQ0FDNUUsQ0FBQztJQUNKLENBQUM7SUFDRCxJQUFJLGVBQWUsQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFDLElBQUksS0FBSyxDQUFDLFlBQVksS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUMxRSxPQUFPLElBQUksa0JBQVMsQ0FDbEIsbUJBQW1CLEtBQUssQ0FBQyxZQUFZLDZDQUE2QyxDQUNuRixDQUFDO0lBQ0osQ0FBQztJQUNELElBQUksQ0FBQyxzQkFBc0IsQ0FBQyxnQkFBZ0IsQ0FBQyxFQUFFLENBQUM7UUFDOUMsT0FBTyxJQUFJLGtCQUFTLENBQ2xCLHFCQUFxQixnQkFBZ0IsdUJBQXVCLGlDQUFxQixFQUFFLENBQ3BGLENBQUM7SUFDSixDQUFDO0lBRUQsT0FBTyxTQUFTLENBQUM7QUFDbkIsQ0FBQztBQUVEOzs7R0FHRztBQUNILFNBQWdCLCtCQUErQixDQUM3QyxnQkFBd0IsRUFDeEIsTUFBeUI7SUFFekIsS0FBSyxNQUFNLFVBQVUsSUFBSSxNQUFNLENBQUMsZUFBZSxFQUFFLENBQUM7UUFDaEQsS0FBSyxNQUFNLFFBQVEsSUFBSSxVQUFVLENBQUMsU0FBUyxFQUFFLENBQUM7WUFDNUMsSUFBSSxDQUFDLG9CQUFvQixDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUM7Z0JBQ3BDLE9BQU8sSUFBSSxrQkFBUyxDQUFDLGFBQWEsUUFBUSx3QkFBd0IsQ0FBQyxDQUFDO1lBQ3RFLENBQUM7UUFDSCxDQUFDO0lBQ0gsQ0FBQztJQUVELElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxNQUFNLENBQUMsWUFBWSxDQUFDLEVBQUUsQ0FBQztRQUM3QyxPQUFPLElBQUksa0JBQVMsQ0FBQyxpQkFBaUIsTUFBTSxDQUFDLFlBQVksZ0NBQWdDLENBQUMsQ0FBQztJQUM3RixDQUFDO0lBRUQsSUFBSSxDQUFDLHNCQUFzQixDQUFDLGdCQUFnQixDQUFDLEVBQUUsQ0FBQztRQUM5QyxPQUFPLElBQUksa0JBQVMsQ0FDbEIscUJBQXFCLGdCQUFnQix1QkFBdUIsaUNBQXFCLEVBQUUsQ0FDcEYsQ0FBQztJQUNKLENBQUM7SUFFRCxPQUFPLFNBQVMsQ0FBQztBQUNuQixDQUFDO0FBRUQ7OztHQUdHO0FBQ0gsU0FBZ0IsdUJBQXVCLENBQUMsUUFBa0I7SUFDeEQsSUFBSSxDQUFDLHNCQUFzQixDQUFDLFFBQVEsQ0FBQyxNQUFRLENBQUMsTUFBTSxJQUFJLENBQUMsQ0FBQyxFQUFFLENBQUM7UUFDM0QsT0FBTyxJQUFJLGtCQUFTLENBQ2xCLDJCQUNFLFFBQVEsQ0FBQyxNQUFRLENBQUMsTUFBTSxJQUFJLENBQzlCLHVCQUF1QixpQ0FBcUIsRUFBRSxDQUMvQyxDQUFDO0lBQ0osQ0FBQztJQUNELElBQUksQ0FBQyxzQkFBc0IsQ0FBQyxRQUFRLENBQUMsU0FBVyxDQUFDLE1BQU0sSUFBSSxDQUFDLENBQUMsRUFBRSxDQUFDO1FBQzlELE9BQU8sSUFBSSxrQkFBUyxDQUNsQiw4QkFDRSxRQUFRLENBQUMsU0FBVyxDQUFDLE1BQU0sSUFBSSxDQUNqQyx1QkFBdUIsaUNBQXFCLEVBQUUsQ0FDL0MsQ0FBQztJQUNKLENBQUM7SUFDRCxJQUFJLFFBQVEsQ0FBQyxPQUFPLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDM0IsT0FBTyxJQUFJLGtCQUFTLENBQUMsYUFBYSxRQUFRLENBQUMsT0FBTyxnQkFBZ0IsQ0FBQyxDQUFDO0lBQ3RFLENBQUM7SUFDRCxJQUFJLFFBQVEsQ0FBQyxNQUFNLENBQUMsZUFBZSxDQUFDLGNBQUksQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDO1FBQy9DLE9BQU8sSUFBSSxrQkFBUyxDQUFDLFdBQVcsUUFBUSxDQUFDLE1BQU0saUJBQWlCLENBQUMsQ0FBQztJQUNwRSxDQUFDO0lBRUQsTUFBTSxZQUFZLEdBQXNCLGNBQWMsQ0FBQyxRQUFRLENBQUMsU0FBVyxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQ25GLElBQUksWUFBWSxLQUFLLFNBQVMsRUFBRSxDQUFDO1FBQy9CLE9BQU8sSUFBSSxrQkFBUyxDQUFDLFlBQVksQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDO0lBQ2hELENBQUM7SUFDRCxPQUFPLFNBQVMsQ0FBQztBQUNuQixDQUFDO0FBRUQsU0FBUyxrQkFBa0IsQ0FBQyxZQUFnQztJQUMxRCxJQUFJLFlBQVksS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUMvQixPQUFPLEtBQUssQ0FBQztJQUNmLENBQUM7SUFFRCxPQUFPLG9CQUFvQixDQUFDLFlBQVksQ0FBQyxJQUFJLFlBQVksR0FBRyxDQUFDLENBQUM7QUFDaEUsQ0FBQztBQUVELFNBQVMsc0JBQXNCLENBQUMsZ0JBQW9DO0lBQ2xFLElBQUksZ0JBQWdCLEtBQUssU0FBUyxFQUFFLENBQUM7UUFDbkMsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUQsT0FBTyxvQkFBb0IsQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLGdCQUFnQixHQUFHLENBQUMsQ0FBQztBQUN4RSxDQUFDO0FBRUQsU0FBUyxzQkFBc0IsQ0FBQyxnQkFBd0I7SUFDdEQsT0FBTyxnQkFBZ0IsSUFBSSxDQUFDLElBQUksZ0JBQWdCLElBQUksaUNBQXFCLENBQUM7QUFDNUUsQ0FBQztBQUVELFNBQVMsb0JBQW9CLENBQUMsR0FBVztJQUN2QyxPQUFPLEdBQUcsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLHVCQUFXLENBQUM7QUFDeEMsQ0FBQztBQUVELFNBQWdCLGdCQUFnQixDQUFDLFVBQXNCO0lBQ3JELE9BQU8sQ0FDTCxVQUFVLEtBQUssa0JBQVUsQ0FBQyxVQUFVO1FBQ3BDLFVBQVUsS0FBSyxrQkFBVSxDQUFDLFNBQVM7UUFDbkMsVUFBVSxLQUFLLGtCQUFVLENBQUMsV0FBVyxDQUN0QyxDQUFDO0FBQ0osQ0FBQztBQUVELFNBQWdCLGVBQWUsQ0FBQyxVQUFzQjtJQUNwRCxPQUFPLFVBQVUsS0FBSyxrQkFBVSxDQUFDLFNBQVMsSUFBSSxVQUFVLEtBQUssa0JBQVUsQ0FBQyxXQUFXLENBQUM7QUFDdEYsQ0FBQztBQUVELFNBQVMsY0FBYyxDQUFDLE9BQWU7SUFDckMsSUFBSSxDQUFDO1FBQ0gsSUFBQSxlQUFNLEVBQUMsT0FBTyxDQUFDLENBQUM7SUFDbEIsQ0FBQztJQUFDLE9BQU8sS0FBSyxFQUFFLENBQUM7UUFDZixPQUFPLEtBQUssQ0FBQztJQUNmLENBQUM7SUFFRCxPQUFPLFNBQVMsQ0FBQztBQUNuQixDQUFDO0FBRUQsU0FBZ0IsY0FBYyxDQUFDLE9BQWU7SUFDNUMsc0VBQXNFO0lBQ3RFLE9BQU8sT0FBTyxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsSUFBSSxjQUFjLENBQUMsT0FBTyxDQUFDLEtBQUssU0FBUyxDQUFDO0FBQzlFLENBQUMifQ==

package/build/cjs/src/network_optimizer.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetworkOptimizer = exports.isTruthy = void 0;
+const indexer_client_1 = require("./clients/indexer-client");
+const validator_client_1 = require("./clients/validator-client");
+const helpers_1 = require("./lib/helpers");
+const types_1 = require("./types");
+class PingResponse {
+    constructor(height) {
+        this.height = height;
+        this.responseTime = new Date();
+    }
+}
+const isTruthy = (n) => Boolean(n);
+exports.isTruthy = isTruthy;
+class NetworkOptimizer {
+    async validatorClients(endpointUrls, chainId) {
+        return (await Promise.all(endpointUrls.map((endpointUrl) => validator_client_1.ValidatorClient.connect(new types_1.ValidatorConfig(endpointUrl, chainId, {
+            CHAINTOKEN_DENOM: 'placeholder',
+            CHAINTOKEN_DECIMALS: 18,
+            USDC_DENOM: 'uusdc',
+            USDC_DECIMALS: 6,
+        })).catch((_) => undefined)))).filter(exports.isTruthy);
+    }
+    indexerClients(endpointUrls) {
+        return endpointUrls
+            .map((endpointUrl) => new indexer_client_1.IndexerClient(
+        // socket is not used for finding optimal indexer, but required as a parameter to the config
+        new types_1.IndexerConfig(endpointUrl, endpointUrl.replace('https://', 'wss://').replace('http://', 'ws://'))))
+            .filter(exports.isTruthy);
+    }
+    async findOptimalNode(endpointUrls, chainId) {
+        if (endpointUrls.length === 0) {
+            const errorResponse = {
+                error: {
+                    message: 'No nodes provided',
+                },
+            };
+            return (0, helpers_1.encodeJson)(errorResponse);
+        }
+        const clients = await this.validatorClients(endpointUrls, chainId);
+        const responses = (await Promise.all(clients
+            .map(async (client) => {
+            const block = await client.get.latestBlock();
+            const response = new PingResponse(block.header.height);
+            return {
+                endpoint: client.config.restEndpoint,
+                height: response.height,
+                time: response.responseTime.getTime(),
+            };
+        })
+            .map((promise) => promise.catch((_) => undefined)))).filter(exports.isTruthy);
+        if (responses.length === 0) {
+            throw new Error('Could not connect to endpoints');
+        }
+        const maxHeight = Math.max(...responses.map(({ height }) => height));
+        return (responses
+            // Only consider nodes at `maxHeight` or `maxHeight - 1`
+            .filter(({ height }) => height === maxHeight || height === maxHeight - 1)
+            // Return the endpoint with the fastest response time
+            .sort((a, b) => a.time - b.time)[0].endpoint);
+    }
+    async findOptimalIndexer(endpointUrls) {
+        if (endpointUrls.length === 0) {
+            const errorResponse = {
+                error: {
+                    message: 'No URL provided',
+                },
+            };
+            return (0, helpers_1.encodeJson)(errorResponse);
+        }
+        const clients = this.indexerClients(endpointUrls);
+        const responses = (await Promise.all(clients
+            .map(async (client) => {
+            const block = await client.utility.getHeight();
+            const response = new PingResponse(+block.height);
+            return {
+                endpoint: client.config.restEndpoint,
+                height: response.height,
+                time: response.responseTime.getTime(),
+            };
+        })
+            .map((promise) => promise.catch((_) => undefined)))).filter(exports.isTruthy);
+        if (responses.length === 0) {
+            throw new Error('Could not connect to endpoints');
+        }
+        const maxHeight = Math.max(...responses.map(({ height }) => height));
+        return (responses
+            // Only consider nodes at `maxHeight` or `maxHeight - 1`
+            .filter(({ height }) => height === maxHeight || height === maxHeight - 1)
+            // Return the endpoint with the fastest response time
+            .sort((a, b) => a.time - b.time)[0].endpoint);
+    }
+}
+exports.NetworkOptimizer = NetworkOptimizer;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibmV0d29ya19vcHRpbWl6ZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbmV0d29ya19vcHRpbWl6ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsNkRBQXlEO0FBQ3pELGlFQUE2RDtBQUM3RCwyQ0FBMkM7QUFDM0MsbUNBQXlEO0FBRXpELE1BQU0sWUFBWTtJQUtoQixZQUFZLE1BQWM7UUFDeEIsSUFBSSxDQUFDLE1BQU0sR0FBRyxNQUFNLENBQUM7UUFDckIsSUFBSSxDQUFDLFlBQVksR0FBRyxJQUFJLElBQUksRUFBRSxDQUFDO0lBQ2pDLENBQUM7Q0FDRjtBQUVNLE1BQU0sUUFBUSxHQUFHLENBQUksQ0FBb0MsRUFBVSxFQUFFLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDO0FBQTNFLFFBQUEsUUFBUSxZQUFtRTtBQUV4RixNQUFhLGdCQUFnQjtJQUNuQixLQUFLLENBQUMsZ0JBQWdCLENBQzVCLFlBQXNCLEVBQ3RCLE9BQWU7UUFFZixPQUFPLENBQ0wsTUFBTSxPQUFPLENBQUMsR0FBRyxDQUNmLFlBQVksQ0FBQyxHQUFHLENBQUMsQ0FBQyxXQUFXLEVBQUUsRUFBRSxDQUMvQixrQ0FBZSxDQUFDLE9BQU8sQ0FDckIsSUFBSSx1QkFBZSxDQUFDLFdBQVcsRUFBRSxPQUFPLEVBQUU7WUFDeEMsZ0JBQWdCLEVBQUUsYUFBYTtZQUMvQixtQkFBbUIsRUFBRSxFQUFFO1lBQ3ZCLFVBQVUsRUFBRSxPQUFPO1lBQ25CLGFBQWEsRUFBRSxDQUFDO1NBQ2pCLENBQUMsQ0FDSCxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsU0FBUyxDQUFDLENBQzFCLENBQ0YsQ0FDRixDQUFDLE1BQU0sQ0FBQyxnQkFBUSxDQUFDLENBQUM7SUFDckIsQ0FBQztJQUVPLGNBQWMsQ0FBQyxZQUFzQjtRQUMzQyxPQUFPLFlBQVk7YUFDaEIsR0FBRyxDQUNGLENBQUMsV0FBVyxFQUFFLEVBQUUsQ0FDZCxJQUFJLDhCQUFhO1FBQ2YsNEZBQTRGO1FBQzVGLElBQUkscUJBQWEsQ0FDZixXQUFXLEVBQ1gsV0FBVyxDQUFDLE9BQU8sQ0FBQyxVQUFVLEVBQUUsUUFBUSxDQUFDLENBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRSxPQUFPLENBQUMsQ0FDdEUsQ0FDRixDQUNKO2FBQ0EsTUFBTSxDQUFDLGdCQUFRLENBQUMsQ0FBQztJQUN0QixDQUFDO0lBRUQsS0FBSyxDQUFDLGVBQWUsQ0FBQyxZQUFzQixFQUFFLE9BQWU7UUFDM0QsSUFBSSxZQUFZLENBQUMsTUFBTSxLQUFLLENBQUMsRUFBRSxDQUFDO1lBQzlCLE1BQU0sYUFBYSxHQUFHO2dCQUNwQixLQUFLLEVBQUU7b0JBQ0wsT0FBTyxFQUFFLG1CQUFtQjtpQkFDN0I7YUFDRixDQUFDO1lBQ0YsT0FBTyxJQUFBLG9CQUFVLEVBQUMsYUFBYSxDQUFDLENBQUM7UUFDbkMsQ0FBQztRQUNELE1BQU0sT0FBTyxHQUFHLE1BQU0sSUFBSSxDQUFDLGdCQUFnQixDQUFDLFlBQVksRUFBRSxPQUFPLENBQUMsQ0FBQztRQUNuRSxNQUFNLFNBQVMsR0FBRyxDQUNoQixNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQ2YsT0FBTzthQUNKLEdBQUcsQ0FBQyxLQUFLLEVBQUUsTUFBTSxFQUFFLEVBQUU7WUFDcEIsTUFBTSxLQUFLLEdBQUcsTUFBTSxNQUFNLENBQUMsR0FBRyxDQUFDLFdBQVcsRUFBRSxDQUFDO1lBQzdDLE1BQU0sUUFBUSxHQUFHLElBQUksWUFBWSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLENBQUM7WUFDdkQsT0FBTztnQkFDTCxRQUFRLEVBQUUsTUFBTSxDQUFDLE1BQU0sQ0FBQyxZQUFZO2dCQUNwQyxNQUFNLEVBQUUsUUFBUSxDQUFDLE1BQU07Z0JBQ3ZCLElBQUksRUFBRSxRQUFRLENBQUMsWUFBWSxDQUFDLE9BQU8sRUFBRTthQUN0QyxDQUFDO1FBQ0osQ0FBQyxDQUFDO2FBQ0QsR0FBRyxDQUFDLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUNyRCxDQUNGLENBQUMsTUFBTSxDQUFDLGdCQUFRLENBQUMsQ0FBQztRQUVuQixJQUFJLFNBQVMsQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDM0IsTUFBTSxJQUFJLEtBQUssQ0FBQyxnQ0FBZ0MsQ0FBQyxDQUFDO1FBQ3BELENBQUM7UUFDRCxNQUFNLFNBQVMsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsU0FBUyxDQUFDLEdBQUcsQ0FBQyxDQUFDLEVBQUUsTUFBTSxFQUFFLEVBQUUsRUFBRSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUM7UUFDckUsT0FBTyxDQUNMLFNBQVM7WUFDUCx3REFBd0Q7YUFDdkQsTUFBTSxDQUFDLENBQUMsRUFBRSxNQUFNLEVBQUUsRUFBRSxFQUFFLENBQUMsTUFBTSxLQUFLLFNBQVMsSUFBSSxNQUFNLEtBQUssU0FBUyxHQUFHLENBQUMsQ0FBQztZQUN6RSxxREFBcUQ7YUFDcEQsSUFBSSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQyxDQUFDLElBQUksR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsUUFBUSxDQUMvQyxDQUFDO0lBQ0osQ0FBQztJQUVELEtBQUssQ0FBQyxrQkFBa0IsQ0FBQyxZQUFzQjtRQUM3QyxJQUFJLFlBQVksQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDOUIsTUFBTSxhQUFhLEdBQUc7Z0JBQ3BCLEtBQUssRUFBRTtvQkFDTCxPQUFPLEVBQUUsaUJBQWlCO2lCQUMzQjthQUNGLENBQUM7WUFDRixPQUFPLElBQUEsb0JBQVUsRUFBQyxhQUFhLENBQUMsQ0FBQztRQUNuQyxDQUFDO1FBQ0QsTUFBTSxPQUFPLEdBQUcsSUFBSSxDQUFDLGNBQWMsQ0FBQyxZQUFZLENBQUMsQ0FBQztRQUNsRCxNQUFNLFNBQVMsR0FBRyxDQUNoQixNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQ2YsT0FBTzthQUNKLEdBQUcsQ0FBQyxLQUFLLEVBQUUsTUFBTSxFQUFFLEVBQUU7WUFDcEIsTUFBTSxLQUFLLEdBQUcsTUFBTSxNQUFNLENBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRSxDQUFDO1lBQy9DLE1BQU0sUUFBUSxHQUFHLElBQUksWUFBWSxDQUFDLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1lBQ2pELE9BQU87Z0JBQ0wsUUFBUSxFQUFFLE1BQU0sQ0FBQyxNQUFNLENBQUMsWUFBWTtnQkFDcEMsTUFBTSxFQUFFLFFBQVEsQ0FBQyxNQUFNO2dCQUN2QixJQUFJLEVBQUUsUUFBUSxDQUFDLFlBQVksQ0FBQyxPQUFPLEVBQUU7YUFDdEMsQ0FBQztRQUNKLENBQUMsQ0FBQzthQUNELEdBQUcsQ0FBQyxDQUFDLE9BQU8sRUFBRSxFQUFFLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FDckQsQ0FDRixDQUFDLE1BQU0sQ0FBQyxnQkFBUSxDQUFDLENBQUM7UUFFbkIsSUFBSSxTQUFTLENBQUMsTUFBTSxLQUFLLENBQUMsRUFBRSxDQUFDO1lBQzNCLE1BQU0sSUFBSSxLQUFLLENBQUMsZ0NBQWdDLENBQUMsQ0FBQztRQUNwRCxDQUFDO1FBQ0QsTUFBTSxTQUFTLEdBQUcsSUFBSSxDQUFDLEdBQUcsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxFQUFFLE1BQU0sRUFBRSxFQUFFLEVBQUUsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDO1FBQ3JFLE9BQU8sQ0FDTCxTQUFTO1lBQ1Asd0RBQXdEO2FBQ3ZELE1BQU0sQ0FBQyxDQUFDLEVBQUUsTUFBTSxFQUFFLEVBQUUsRUFBRSxDQUFDLE1BQU0sS0FBSyxTQUFTLElBQUksTUFBTSxLQUFLLFNBQVMsR0FBRyxDQUFDLENBQUM7WUFDekUscURBQXFEO2FBQ3BELElBQUksQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLEVBQUUsRUFBRSxDQUFDLENBQUMsQ0FBQyxJQUFJLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FDL0MsQ0FBQztJQUNKLENBQUM7Q0FDRjtBQWpIRCw0Q0FpSEMifQ==

package/build/cjs/src/types.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClobPairId = void 0;
+__exportStar(require("./clients/types"), exports);
+__exportStar(require("./clients/constants"), exports);
+var ClobPairId;
+(function (ClobPairId) {
+    ClobPairId[ClobPairId["PERPETUAL_PAIR_BTC_USD"] = 0] = "PERPETUAL_PAIR_BTC_USD";
+    ClobPairId[ClobPairId["PERPETUAL_PAIR_ETH_USD"] = 1] = "PERPETUAL_PAIR_ETH_USD";
+})(ClobPairId || (exports.ClobPairId = ClobPairId = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFLQSxrREFBZ0M7QUFDaEMsc0RBQW9DO0FBa0NwQyxJQUFZLFVBR1g7QUFIRCxXQUFZLFVBQVU7SUFDcEIsK0VBQTBCLENBQUE7SUFDMUIsK0VBQTBCLENBQUE7QUFDNUIsQ0FBQyxFQUhXLFVBQVUsMEJBQVYsVUFBVSxRQUdyQiJ9