@perpx/js-sdk 0.0.1

package/build/esm/src/lib/onboarding.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @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
+ */
+export declare const exportMnemonicAndPrivateKey: (entropy: Uint8Array, path?: string) => {
+    mnemonic: string;
+    privateKey: Uint8Array | null;
+    publicKey: Uint8Array | null;
+};
+/**
+ * @description Get private information for onboarding using an Ethereum Signature.
+ *
+ * @returns Mnemonic and Public/Private HD keys
+ */
+export declare const deriveHDKeyFromEthereumSignature: (signature: string) => {
+    mnemonic: string;
+    privateKey: Uint8Array | null;
+    publicKey: Uint8Array | null;
+};
+/**
+ * @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
+ */
+export declare const deriveHDKeyFromMnemonic: (mnemonic: string, path?: string) => {
+    privateKey: Uint8Array | null;
+    publicKey: Uint8Array | null;
+};
+//# sourceMappingURL=onboarding.d.ts.map

package/build/esm/src/lib/onboarding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onboarding.d.ts","sourceRoot":"","sources":["../../../../src/lib/onboarding.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,2BAA2B,GACtC,SAAS,UAAU,EACnB,OAAM,MAA4B,KACjC;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAC9B,SAAS,EAAE,UAAU,GAAG,IAAI,CAAC;CAS9B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gCAAgC,GAC3C,WAAW,MAAM,KAChB;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAC9B,SAAS,EAAE,UAAU,GAAG,IAAI,CAAC;CAa9B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,uBAAuB,GAClC,UAAU,MAAM,EAChB,OAAM,MAA4B,KACjC;IACD,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAC9B,SAAS,EAAE,UAAU,GAAG,IAAI,CAAC;CAe9B,CAAC"}

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

@@ -0,0 +1,69 @@
+import { HDKey } from '@scure/bip32';
+import { entropyToMnemonic, mnemonicToSeedSync } from '@scure/bip39';
+import { wordlist } from '@scure/bip39/wordlists/english';
+import { keccak256 } from 'ethereum-cryptography/keccak';
+import { stripHexPrefix } from './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
+ */
+export const exportMnemonicAndPrivateKey = (entropy, path = "m/44'/118'/0'/0/0") => {
+    const mnemonic = entropyToMnemonic(entropy, wordlist);
+    const { privateKey, publicKey } = deriveHDKeyFromMnemonic(mnemonic, path);
+    return {
+        mnemonic,
+        privateKey,
+        publicKey,
+    };
+};
+/**
+ * @description Get private information for onboarding using an Ethereum Signature.
+ *
+ * @returns Mnemonic and Public/Private HD keys
+ */
+export const deriveHDKeyFromEthereumSignature = (signature) => {
+    const buffer = Buffer.from(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 = keccak256(rsValues);
+    return exportMnemonicAndPrivateKey(entropy);
+};
+/**
+ * @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
+ */
+export const deriveHDKeyFromMnemonic = (mnemonic, path = "m/44'/118'/0'/0/0") => {
+    const seed = mnemonicToSeedSync(mnemonic);
+    const hdkey = HDKey.fromMasterSeed(seed);
+    const derivedHdkey = hdkey.derive(path);
+    if (!hdkey.privateKey) {
+        throw new Error('null hd key');
+    }
+    return {
+        privateKey: derivedHdkey.privateKey,
+        publicKey: derivedHdkey.publicKey,
+    };
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib25ib2FyZGluZy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvb25ib2FyZGluZy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsS0FBSyxFQUFFLE1BQU0sY0FBYyxDQUFDO0FBQ3JDLE9BQU8sRUFBRSxpQkFBaUIsRUFBRSxrQkFBa0IsRUFBRSxNQUFNLGNBQWMsQ0FBQztBQUNyRSxPQUFPLEVBQUUsUUFBUSxFQUFFLE1BQU0sZ0NBQWdDLENBQUM7QUFDMUQsT0FBTyxFQUFFLFNBQVMsRUFBRSxNQUFNLDhCQUE4QixDQUFDO0FBRXpELE9BQU8sRUFBRSxjQUFjLEVBQUUsTUFBTSxXQUFXLENBQUM7QUFFM0M7Ozs7Ozs7Ozs7OztHQVlHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sMkJBQTJCLEdBQUcsQ0FDekMsT0FBbUIsRUFDbkIsT0FBZSxtQkFBbUIsRUFLbEMsRUFBRTtJQUNGLE1BQU0sUUFBUSxHQUFHLGlCQUFpQixDQUFDLE9BQU8sRUFBRSxRQUFRLENBQUMsQ0FBQztJQUN0RCxNQUFNLEVBQUUsVUFBVSxFQUFFLFNBQVMsRUFBRSxHQUFHLHVCQUF1QixDQUFDLFFBQVEsRUFBRSxJQUFJLENBQUMsQ0FBQztJQUMxRSxPQUFPO1FBQ0wsUUFBUTtRQUNSLFVBQVU7UUFDVixTQUFTO0tBQ1YsQ0FBQztBQUNKLENBQUMsQ0FBQztBQUVGOzs7O0dBSUc7QUFDSCxNQUFNLENBQUMsTUFBTSxnQ0FBZ0MsR0FBRyxDQUM5QyxTQUFpQixFQUtqQixFQUFFO0lBQ0YsTUFBTSxNQUFNLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxjQUFjLENBQUMsU0FBUyxDQUFDLEVBQUUsS0FBSyxDQUFDLENBQUM7SUFFN0QsSUFBSSxNQUFNLENBQUMsTUFBTSxLQUFLLEVBQUUsRUFBRSxDQUFDO1FBQ3pCLE1BQU0sSUFBSSxLQUFLLENBQUMsNEJBQTRCLENBQUMsQ0FBQztJQUNoRCxDQUFDO0lBRUQsMEVBQTBFO0lBQzFFLE1BQU0sUUFBUSxHQUFHLE1BQU0sQ0FBQyxRQUFRLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDO0lBQ3hDLDJFQUEyRTtJQUMzRSxNQUFNLE9BQU8sR0FBRyxTQUFTLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDcEMsT0FBTywyQkFBMkIsQ0FBQyxPQUFPLENBQUMsQ0FBQztBQUM5QyxDQUFDLENBQUM7QUFFRjs7Ozs7Ozs7Ozs7O0dBWUc7QUFDSCxNQUFNLENBQUMsTUFBTSx1QkFBdUIsR0FBRyxDQUNyQyxRQUFnQixFQUNoQixPQUFlLG1CQUFtQixFQUlsQyxFQUFFO0lBQ0YsTUFBTSxJQUFJLEdBQUcsa0JBQWtCLENBQUMsUUFBUSxDQUFDLENBQUM7SUFFMUMsTUFBTSxLQUFLLEdBQUcsS0FBSyxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUN6QyxNQUFNLFlBQVksR0FBRyxLQUFLLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBRXhDLElBQUksQ0FBQyxLQUFLLENBQUMsVUFBVSxFQUFFLENBQUM7UUFDdEIsTUFBTSxJQUFJLEtBQUssQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUNqQyxDQUFDO0lBRUQsT0FBTztRQUNMLFVBQVUsRUFBRSxZQUFZLENBQUMsVUFBVTtRQUNuQyxTQUFTLEVBQUUsWUFBWSxDQUFDLFNBQVM7S0FDbEMsQ0FBQztBQUNKLENBQUMsQ0FBQyJ9

package/build/esm/src/lib/trading-key-utils.d.ts

@@ -0,0 +1,37 @@
+import { AuthenticatorType } from '../clients/constants';
+import { type Get } from '../clients/modules/get';
+/**
+ * @description Create a new random wallet and return mnemonic + address metadata.
+ *
+ * @returns The mnemonic, private key hex, public key, and address.
+ */
+export declare const createNewRandomPerpxWallet: () => Promise<{
+    privateKeyHex: string;
+    mnemonic: string;
+    publicKey: string;
+    address: string;
+} | undefined>;
+/**
+ * @description Build authenticator args to authorize a trading key for subaccount 0.
+ *
+ * Allows place order, cancel order, and batch cancel only.
+ */
+export declare const getAuthorizeNewTradingKeyArguments: ({ generatedWalletPubKey, }: {
+    generatedWalletPubKey: string;
+}) => {
+    type: AuthenticatorType;
+    data: Uint8Array;
+};
+type Awaited<T> = T extends Promise<infer U> ? U : T;
+/**
+ * @description Parse authenticators into trading-key metadata.
+ *
+ * Returns entries that match the format produced by getAuthorizeNewTradingKeyArguments.
+ */
+export declare const getAuthorizedTradingKeysMetadata: (authorizedKeys: Awaited<ReturnType<Get["getAuthenticators"]>>["accountAuthenticators"]) => Array<{
+    id: string;
+    publicKey: string;
+    address: string;
+}>;
+export {};
+//# sourceMappingURL=trading-key-utils.d.ts.map

package/build/esm/src/lib/trading-key-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trading-key-utils.d.ts","sourceRoot":"","sources":["../../../../src/lib/trading-key-utils.ts"],"names":[],"mappings":"AAKA,OAAO,EAEL,iBAAiB,EAIlB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAKlD;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,QAAa,OAAO,CACzD;IAAE,aAAa,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAwB5F,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,kCAAkC,GAAI,4BAEhD;IACD,qBAAqB,EAAE,MAAM,CAAC;CAC/B,KAAG;IAAE,IAAI,EAAE,iBAAiB,CAAC;IAAC,IAAI,EAAE,UAAU,CAAA;CA6C9C,CAAC;AAGF,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAGrD;;;;GAIG;AACH,eAAO,MAAM,gCAAgC,GAC3C,gBAAgB,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,KACrF,KAAK,CAAC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CA+B1D,CAAC"}

package/build/esm/src/lib/trading-key-utils.js

@@ -0,0 +1,111 @@
+import { fromBase64, toBase64, toBech32, toHex } from '@cosmjs/encoding';
+import { rawSecp256k1PubkeyToRawAddress } from '@cosmjs/tendermint-rpc';
+import { generateMnemonic } from '@scure/bip39';
+import { wordlist } from '@scure/bip39/wordlists/english';
+import { AuthenticatorType, TYPE_URL_BATCH_CANCEL, TYPE_URL_MSG_CANCEL_ORDER, TYPE_URL_MSG_PLACE_ORDER, } from '../clients/constants';
+import LocalWallet from '../clients/modules/local-wallet';
+import { BECH32_PREFIX } from './constants';
+import { deriveHDKeyFromMnemonic } from './onboarding';
+/**
+ * @description Create a new random wallet and return mnemonic + address metadata.
+ *
+ * @returns The mnemonic, private key hex, public key, and address.
+ */
+export const createNewRandomPerpxWallet = async () => {
+    const mnemonic = generateMnemonic(wordlist, 128);
+    const { privateKey: privateKeyRaw } = deriveHDKeyFromMnemonic(mnemonic);
+    const wallet = await LocalWallet.fromMnemonic(mnemonic, BECH32_PREFIX);
+    const privateKeyHex = privateKeyRaw != null ? `0x${toHex(privateKeyRaw)}` : undefined;
+    const publicKey = wallet.pubKey;
+    const address = wallet.address;
+    if (privateKeyHex == null || publicKey == null || address == null) {
+        return undefined;
+    }
+    return {
+        // 12 english words
+        mnemonic,
+        // toHex of the raw private key bits
+        privateKeyHex,
+        // base64, not hex
+        publicKey: publicKey.value,
+        // valid perpx address corresponding to the key pair
+        address,
+    };
+};
+/**
+ * @description Build authenticator args to authorize a trading key for subaccount 0.
+ *
+ * Allows place order, cancel order, and batch cancel only.
+ */
+export const getAuthorizeNewTradingKeyArguments = ({ generatedWalletPubKey, }) => {
+    const wrapAndEncode64 = (s) => toBase64(new TextEncoder().encode(s));
+    const messageFilterSubAuth = [
+        {
+            type: AuthenticatorType.MESSAGE_FILTER,
+            config: wrapAndEncode64(TYPE_URL_MSG_PLACE_ORDER),
+        },
+        {
+            type: AuthenticatorType.MESSAGE_FILTER,
+            config: wrapAndEncode64(TYPE_URL_MSG_CANCEL_ORDER),
+        },
+        {
+            type: AuthenticatorType.MESSAGE_FILTER,
+            config: wrapAndEncode64(TYPE_URL_BATCH_CANCEL),
+        },
+    ];
+    const anyOfMessageFilterConfigB64 = wrapAndEncode64(JSON.stringify(messageFilterSubAuth));
+    const subAuth = [
+        {
+            type: AuthenticatorType.SIGNATURE_VERIFICATION,
+            config: generatedWalletPubKey,
+        },
+        {
+            type: AuthenticatorType.ANY_OF,
+            config: anyOfMessageFilterConfigB64,
+        },
+        // we limit to cross markets to make it slightly harder to drain user funds on low liquidity markets with trading keys
+        // could undo this in the future if people are angry about it
+        {
+            type: AuthenticatorType.SUBACCOUNT_FILTER,
+            config: wrapAndEncode64('0'),
+        },
+    ];
+    const jsonString = JSON.stringify(subAuth);
+    const encodedData = new TextEncoder().encode(jsonString);
+    const topLevelType = AuthenticatorType.ALL_OF;
+    return {
+        type: topLevelType,
+        data: encodedData,
+    };
+};
+const isTruthy = (n) => Boolean(n);
+/**
+ * @description Parse authenticators into trading-key metadata.
+ *
+ * Returns entries that match the format produced by getAuthorizeNewTradingKeyArguments.
+ */
+export const getAuthorizedTradingKeysMetadata = (authorizedKeys) => {
+    return authorizedKeys
+        .map(({ config, id, type }) => {
+        var _a;
+        if (type !== AuthenticatorType.ALL_OF) {
+            return null;
+        }
+        const parsedConfig = JSON.parse(new TextDecoder().decode(config));
+        if (parsedConfig == null) {
+            return null;
+        }
+        const publicKey = (_a = parsedConfig.find((t) => t.type === AuthenticatorType.SIGNATURE_VERIFICATION)) === null || _a === void 0 ? void 0 : _a.config;
+        if (publicKey == null || typeof publicKey !== 'string') {
+            return null;
+        }
+        const address = toBech32(BECH32_PREFIX, rawSecp256k1PubkeyToRawAddress(fromBase64(publicKey)));
+        return {
+            id: id.toString(),
+            publicKey,
+            address,
+        };
+    })
+        .filter(isTruthy);
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJhZGluZy1rZXktdXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL3RyYWRpbmcta2V5LXV0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxVQUFVLEVBQUUsUUFBUSxFQUFFLFFBQVEsRUFBRSxLQUFLLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUN6RSxPQUFPLEVBQUUsOEJBQThCLEVBQUUsTUFBTSx3QkFBd0IsQ0FBQztBQUN4RSxPQUFPLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxjQUFjLENBQUM7QUFDaEQsT0FBTyxFQUFFLFFBQVEsRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBRTFELE9BQU8sRUFFTCxpQkFBaUIsRUFDakIscUJBQXFCLEVBQ3JCLHlCQUF5QixFQUN6Qix3QkFBd0IsR0FDekIsTUFBTSxzQkFBc0IsQ0FBQztBQUU5QixPQUFPLFdBQVcsTUFBTSxpQ0FBaUMsQ0FBQztBQUMxRCxPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBQzVDLE9BQU8sRUFBRSx1QkFBdUIsRUFBRSxNQUFNLGNBQWMsQ0FBQztBQUV2RDs7OztHQUlHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sMEJBQTBCLEdBQUcsS0FBSyxJQUU3QyxFQUFFO0lBQ0YsTUFBTSxRQUFRLEdBQUcsZ0JBQWdCLENBQUMsUUFBUSxFQUFFLEdBQUcsQ0FBQyxDQUFDO0lBQ2pELE1BQU0sRUFBRSxVQUFVLEVBQUUsYUFBYSxFQUFFLEdBQUcsdUJBQXVCLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDeEUsTUFBTSxNQUFNLEdBQUcsTUFBTSxXQUFXLENBQUMsWUFBWSxDQUFDLFFBQVEsRUFBRSxhQUFhLENBQUMsQ0FBQztJQUV2RSxNQUFNLGFBQWEsR0FBRyxhQUFhLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxLQUFLLEtBQUssQ0FBQyxhQUFhLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUM7SUFDdEYsTUFBTSxTQUFTLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQztJQUNoQyxNQUFNLE9BQU8sR0FBRyxNQUFNLENBQUMsT0FBTyxDQUFDO0lBRS9CLElBQUksYUFBYSxJQUFJLElBQUksSUFBSSxTQUFTLElBQUksSUFBSSxJQUFJLE9BQU8sSUFBSSxJQUFJLEVBQUUsQ0FBQztRQUNsRSxPQUFPLFNBQVMsQ0FBQztJQUNuQixDQUFDO0lBRUQsT0FBTztRQUNMLG1CQUFtQjtRQUNuQixRQUFRO1FBQ1Isb0NBQW9DO1FBQ3BDLGFBQWE7UUFDYixrQkFBa0I7UUFDbEIsU0FBUyxFQUFFLFNBQVMsQ0FBQyxLQUFLO1FBQzFCLG9EQUFvRDtRQUNwRCxPQUFPO0tBQ1IsQ0FBQztBQUNKLENBQUMsQ0FBQztBQUVGOzs7O0dBSUc7QUFDSCxNQUFNLENBQUMsTUFBTSxrQ0FBa0MsR0FBRyxDQUFDLEVBQ2pELHFCQUFxQixHQUd0QixFQUFpRCxFQUFFO0lBQ2xELE1BQU0sZUFBZSxHQUFHLENBQUMsQ0FBUyxFQUFVLEVBQUUsQ0FBQyxRQUFRLENBQUMsSUFBSSxXQUFXLEVBQUUsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUVyRixNQUFNLG9CQUFvQixHQUFHO1FBQzNCO1lBQ0UsSUFBSSxFQUFFLGlCQUFpQixDQUFDLGNBQWM7WUFDdEMsTUFBTSxFQUFFLGVBQWUsQ0FBQyx3QkFBd0IsQ0FBQztTQUNsRDtRQUNEO1lBQ0UsSUFBSSxFQUFFLGlCQUFpQixDQUFDLGNBQWM7WUFDdEMsTUFBTSxFQUFFLGVBQWUsQ0FBQyx5QkFBeUIsQ0FBQztTQUNuRDtRQUNEO1lBQ0UsSUFBSSxFQUFFLGlCQUFpQixDQUFDLGNBQWM7WUFDdEMsTUFBTSxFQUFFLGVBQWUsQ0FBQyxxQkFBcUIsQ0FBQztTQUMvQztLQUNGLENBQUM7SUFFRixNQUFNLDJCQUEyQixHQUFHLGVBQWUsQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLG9CQUFvQixDQUFDLENBQUMsQ0FBQztJQUUxRixNQUFNLE9BQU8sR0FBRztRQUNkO1lBQ0UsSUFBSSxFQUFFLGlCQUFpQixDQUFDLHNCQUFzQjtZQUM5QyxNQUFNLEVBQUUscUJBQXFCO1NBQzlCO1FBQ0Q7WUFDRSxJQUFJLEVBQUUsaUJBQWlCLENBQUMsTUFBTTtZQUM5QixNQUFNLEVBQUUsMkJBQTJCO1NBQ3BDO1FBQ0Qsc0hBQXNIO1FBQ3RILDZEQUE2RDtRQUM3RDtZQUNFLElBQUksRUFBRSxpQkFBaUIsQ0FBQyxpQkFBaUI7WUFDekMsTUFBTSxFQUFFLGVBQWUsQ0FBQyxHQUFHLENBQUM7U0FDN0I7S0FDRixDQUFDO0lBRUYsTUFBTSxVQUFVLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUMzQyxNQUFNLFdBQVcsR0FBRyxJQUFJLFdBQVcsRUFBRSxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUN6RCxNQUFNLFlBQVksR0FBRyxpQkFBaUIsQ0FBQyxNQUFNLENBQUM7SUFFOUMsT0FBTztRQUNMLElBQUksRUFBRSxZQUFZO1FBQ2xCLElBQUksRUFBRSxXQUFXO0tBQ2xCLENBQUM7QUFDSixDQUFDLENBQUM7QUFJRixNQUFNLFFBQVEsR0FBRyxDQUFJLENBQW9DLEVBQVUsRUFBRSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0FBQztBQUVqRjs7OztHQUlHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sZ0NBQWdDLEdBQUcsQ0FDOUMsY0FBc0YsRUFDM0IsRUFBRTtJQUM3RCxPQUFPLGNBQWM7U0FDbEIsR0FBRyxDQUFDLENBQUMsRUFBRSxNQUFNLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSxFQUFFLEVBQUU7O1FBQzVCLElBQUksSUFBSSxLQUFLLGlCQUFpQixDQUFDLE1BQU0sRUFBRSxDQUFDO1lBQ3RDLE9BQU8sSUFBSSxDQUFDO1FBQ2QsQ0FBQztRQUNELE1BQU0sWUFBWSxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxXQUFXLEVBQUUsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLENBRW5ELENBQUM7UUFDZCxJQUFJLFlBQVksSUFBSSxJQUFJLEVBQUUsQ0FBQztZQUN6QixPQUFPLElBQUksQ0FBQztRQUNkLENBQUM7UUFFRCxNQUFNLFNBQVMsR0FBRyxNQUFBLFlBQVksQ0FBQyxJQUFJLENBQ2pDLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUMsSUFBSSxLQUFLLGlCQUFpQixDQUFDLHNCQUFzQixDQUMzRCwwQ0FBRSxNQUFNLENBQUM7UUFDVixJQUFJLFNBQVMsSUFBSSxJQUFJLElBQUksT0FBTyxTQUFTLEtBQUssUUFBUSxFQUFFLENBQUM7WUFDdkQsT0FBTyxJQUFJLENBQUM7UUFDZCxDQUFDO1FBRUQsTUFBTSxPQUFPLEdBQUcsUUFBUSxDQUN0QixhQUFhLEVBQ2IsOEJBQThCLENBQUMsVUFBVSxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQ3RELENBQUM7UUFDRixPQUFPO1lBQ0wsRUFBRSxFQUFFLEVBQUUsQ0FBQyxRQUFRLEVBQUU7WUFDakIsU0FBUztZQUNULE9BQU87U0FDUixDQUFDO0lBQ0osQ0FBQyxDQUFDO1NBQ0QsTUFBTSxDQUFDLFFBQVEsQ0FBQyxDQUFDO0FBQ3RCLENBQUMsQ0FBQyJ9

package/build/esm/src/lib/utils.d.ts

@@ -0,0 +1,49 @@
+import { AxiosProxyConfig } from 'axios';
+import { HttpsProxyAgent } from 'https-proxy-agent';
+/**
+ * Returns a random integer value between 0 and (n-1).
+ */
+export declare function randomInt(n: number): number;
+/**
+ * Generate a random clientId.
+ */
+export declare function generateRandomClientId(): number;
+/**
+ * Deterministically generate a valid clientId from an arbitrary string by performing a
+ * quick hashing function on the string.
+ */
+export declare function clientIdFromString(input: string): number;
+/**
+ * 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.
+ */
+export declare function sleep(ms: number): Promise<void>;
+/**
+ * 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.
+ */
+export declare function getGovAddNewMarketTitle(ticker: string): string;
+/**
+ * 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.
+ */
+export declare function getGovAddNewMarketSummary(ticker: string, delayBlocks: number): string;
+/**
+ * @description Estimate local clock offset from a request/response round trip.
+ *
+ * @returns Millisecond offset to align local time with server time.
+ */
+export declare function calculateClockOffsetFromFetchDateHeader(clientRequestStartTime: number, serverReportedTime: number, clientRequestEndTime: number): number;
+/**
+ * @description Build an HTTPS proxy agent from Axios proxy config.
+ *
+ * @returns A proxy agent suitable for axios/WebSocket usage.
+ */
+export declare function getProxyAgent(proxy: AxiosProxyConfig): HttpsProxyAgent<string>;
+//# sourceMappingURL=utils.d.ts.map

package/build/esm/src/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,OAAO,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIpD;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;GAEG;AACH,wBAAgB,sBAAsB,IAAI,MAAM,CAE/C;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAWxD;AAED;;;;GAIG;AACH,wBAAsB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAErD;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE9D;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAErF;AAED;;;;GAIG;AACH,wBAAgB,uCAAuC,CACrD,sBAAsB,EAAE,MAAM,EAC9B,kBAAkB,EAAE,MAAM,EAC1B,oBAAoB,EAAE,MAAM,GAC3B,MAAM,CAQR;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,gBAAgB,GAAG,eAAe,CAAC,MAAM,CAAC,CAG9E"}

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

@@ -0,0 +1,79 @@
+import { HttpsProxyAgent } from 'https-proxy-agent';
+import { MAX_UINT_32 } from '../clients/constants';
+/**
+ * Returns a random integer value between 0 and (n-1).
+ */
+export function randomInt(n) {
+    return Math.floor(Math.random() * n);
+}
+/**
+ * Generate a random clientId.
+ */
+export function generateRandomClientId() {
+    return randomInt(MAX_UINT_32 + 1);
+}
+/**
+ * Deterministically generate a valid clientId from an arbitrary string by performing a
+ * quick hashing function on the string.
+ */
+export 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.
+ */
+export 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.
+ */
+export 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.
+ */
+export 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.`;
+}
+/**
+ * @description Estimate local clock offset from a request/response round trip.
+ *
+ * @returns Millisecond offset to align local time with server time.
+ */
+export 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);
+}
+/**
+ * @description Build an HTTPS proxy agent from Axios proxy config.
+ *
+ * @returns A proxy agent suitable for axios/WebSocket usage.
+ */
+export function getProxyAgent(proxy) {
+    const auth = proxy.auth ? `${proxy.auth.username}:${proxy.auth.password}@` : '';
+    return new HttpsProxyAgent(`${proxy.protocol}://${auth}${proxy.host}:${proxy.port}`);
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFBRSxlQUFlLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQUVwRCxPQUFPLEVBQUUsV0FBVyxFQUFFLE1BQU0sc0JBQXNCLENBQUM7QUFFbkQ7O0dBRUc7QUFDSCxNQUFNLFVBQVUsU0FBUyxDQUFDLENBQVM7SUFDakMsT0FBTyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQztBQUN2QyxDQUFDO0FBRUQ7O0dBRUc7QUFDSCxNQUFNLFVBQVUsc0JBQXNCO0lBQ3BDLE9BQU8sU0FBUyxDQUFDLFdBQVcsR0FBRyxDQUFDLENBQUMsQ0FBQztBQUNwQyxDQUFDO0FBRUQ7OztHQUdHO0FBQ0gsTUFBTSxVQUFVLGtCQUFrQixDQUFDLEtBQWE7SUFDOUMsSUFBSSxJQUFJLEdBQVcsQ0FBQyxDQUFDO0lBQ3JCLElBQUksS0FBSyxDQUFDLE1BQU0sS0FBSyxDQUFDO1FBQUUsT0FBTyxJQUFJLENBQUM7SUFDcEMsS0FBSyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxHQUFHLEtBQUssQ0FBQyxNQUFNLEVBQUUsQ0FBQyxFQUFFLEVBQUUsQ0FBQztRQUN0QyxJQUFJLEdBQUcsQ0FBQyxJQUFJLElBQUksQ0FBQyxDQUFDLEdBQUcsSUFBSSxHQUFHLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxpQ0FBaUM7UUFDbEYsSUFBSSxJQUFJLENBQUMsQ0FBQyxDQUFDLGlDQUFpQztJQUM5QyxDQUFDO0lBRUQsMERBQTBEO0lBQzFELHNEQUFzRDtJQUN0RCxPQUFPLElBQUksR0FBRyxDQUFDLElBQUksRUFBRSxDQUFDO0FBQ3hCLENBQUM7QUFFRDs7OztHQUlHO0FBQ0gsTUFBTSxDQUFDLEtBQUssVUFBVSxLQUFLLENBQUMsRUFBVTtJQUNwQyxPQUFPLElBQUksT0FBTyxDQUFDLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQyxVQUFVLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUM7QUFDM0QsQ0FBQztBQUVEOzs7OztHQUtHO0FBQ0gsTUFBTSxVQUFVLHVCQUF1QixDQUFDLE1BQWM7SUFDcEQsT0FBTyxPQUFPLE1BQU0sbUJBQW1CLENBQUM7QUFDMUMsQ0FBQztBQUVEOzs7Ozs7R0FNRztBQUNILE1BQU0sVUFBVSx5QkFBeUIsQ0FBQyxNQUFjLEVBQUUsV0FBbUI7SUFDM0UsT0FBTyxxRUFBcUUsTUFBTSx3R0FBd0csV0FBVyxVQUFVLENBQUM7QUFDbE4sQ0FBQztBQUVEOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUsdUNBQXVDLENBQ3JELHNCQUE4QixFQUM5QixrQkFBMEIsRUFDMUIsb0JBQTRCO0lBRTVCLCtGQUErRjtJQUMvRixNQUFNLGlDQUFpQyxHQUFHLENBQUMsc0JBQXNCLEdBQUcsb0JBQW9CLENBQUMsR0FBRyxDQUFDLENBQUM7SUFFOUYsOEZBQThGO0lBQzlGLE1BQU0sTUFBTSxHQUFHLGtCQUFrQixHQUFHLGlDQUFpQyxDQUFDO0lBRXRFLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsQ0FBQztBQUM1QixDQUFDO0FBRUQ7Ozs7R0FJRztBQUNILE1BQU0sVUFBVSxhQUFhLENBQUMsS0FBdUI7SUFDbkQsTUFBTSxJQUFJLEdBQUcsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsR0FBRyxLQUFLLENBQUMsSUFBSSxDQUFDLFFBQVEsSUFBSSxLQUFLLENBQUMsSUFBSSxDQUFDLFFBQVEsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUM7SUFDaEYsT0FBTyxJQUFJLGVBQWUsQ0FBQyxHQUFHLEtBQUssQ0FBQyxRQUFRLE1BQU0sSUFBSSxHQUFHLEtBQUssQ0FBQyxJQUFJLElBQUksS0FBSyxDQUFDLElBQUksRUFBRSxDQUFDLENBQUM7QUFDdkYsQ0FBQyJ9

package/build/esm/src/lib/validation.d.ts

@@ -0,0 +1,35 @@
+import { Transfer, OrderFlags, ICancelOrder, IPlaceOrder, IBatchCancelOrder } from '../clients/types';
+import { UserError } from './errors';
+/**
+ * @describe validatePlaceOrderMessage validates that an order to place has fields that would be
+ *  valid on-chain.
+ */
+export declare function validatePlaceOrderMessage(subaccountNumber: number, order: IPlaceOrder): UserError | undefined;
+/**
+ * @describe validateCancelOrderMessage validates that an order to cancel has fields that would be
+ *  valid on-chain.
+ */
+export declare function validateCancelOrderMessage(subaccountNumber: number, order: ICancelOrder): UserError | undefined;
+/**
+ * @describe validateBatchCancelOrderMessage validates that orders to batch cancel have fields that would be
+ *  valid on-chain.
+ */
+export declare function validateBatchCancelOrderMessage(subaccountNumber: number, orders: IBatchCancelOrder): UserError | undefined;
+/**
+ * @describe validateTransferMessage validates that a transfer to place has fields that would be
+ *  valid on-chain.
+ */
+export declare function validateTransferMessage(transfer: Transfer): UserError | undefined;
+/**
+ * @description Validate that an order flag is a supported value.
+ */
+export declare function verifyOrderFlags(orderFlags: OrderFlags): boolean;
+/**
+ * @description Determine whether an order flag represents a stateful order.
+ */
+export declare function isStatefulOrder(orderFlags: OrderFlags): boolean;
+/**
+ * @description Validate a Perpx bech32 address with prefix check.
+ */
+export declare function isValidAddress(address: string): boolean;
+//# sourceMappingURL=validation.d.ts.map

package/build/esm/src/lib/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../../../src/lib/validation.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,QAAQ,EACR,UAAU,EACV,YAAY,EACZ,WAAW,EACX,iBAAiB,EAClB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,gBAAgB,EAAE,MAAM,EACxB,KAAK,EAAE,WAAW,GACjB,SAAS,GAAG,SAAS,CAyBvB;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACxC,gBAAgB,EAAE,MAAM,EACxB,KAAK,EAAE,YAAY,GAClB,SAAS,GAAG,SAAS,CA6BvB;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,gBAAgB,EAAE,MAAM,EACxB,MAAM,EAAE,iBAAiB,GACxB,SAAS,GAAG,SAAS,CAoBvB;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,CA2BjF;AA0BD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAMhE;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAE/D;AAYD;;GAEG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAGvD"}

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

@@ -0,0 +1,147 @@
+import { decode } from 'bech32';
+import Long from 'long';
+import { BECH32_PREFIX, MAX_SUBACCOUNT_NUMBER, MAX_UINT_32 } from '../clients/constants';
+import { OrderFlags, } from '../clients/types';
+import { UserError } from './errors';
+/**
+ * @describe validatePlaceOrderMessage validates that an order to place has fields that would be
+ *  valid on-chain.
+ */
+export function validatePlaceOrderMessage(subaccountNumber, order) {
+    if (!verifyNumberIsUint32(order.clientId)) {
+        return new UserError(`clientId: ${order.clientId} is not a valid uint32`);
+    }
+    if (order.quantums.lessThanOrEqual(Long.ZERO)) {
+        return new UserError(`quantums: ${order.quantums} cannot be <= 0`);
+    }
+    if (order.subticks.lessThanOrEqual(Long.ZERO)) {
+        return new UserError(`subticks: ${order.subticks} cannot be <= 0`);
+    }
+    if (!verifySubaccountNumber(subaccountNumber)) {
+        return new UserError(`subaccountNumber: ${subaccountNumber} cannot be < 0 or > ${MAX_SUBACCOUNT_NUMBER}`);
+    }
+    if (!isStatefulOrder(order.orderFlags) && !verifyGoodTilBlock(order.goodTilBlock)) {
+        return new UserError(`goodTilBlock: ${order.goodTilBlock} is not a valid uint32 or is 0`);
+    }
+    if (isStatefulOrder(order.orderFlags) && !verifyGoodTilBlockTime(order.goodTilBlockTime)) {
+        return new 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.
+ */
+export function validateCancelOrderMessage(subaccountNumber, order) {
+    if (!verifyNumberIsUint32(order.clientId)) {
+        return new UserError(`clientId: ${order.clientId} is not a valid uint32`);
+    }
+    if (!isStatefulOrder(order.orderFlags) && !verifyGoodTilBlock(order.goodTilBlock)) {
+        return new UserError(`goodTilBlock: ${order.goodTilBlock} is not a valid uint32 or is 0`);
+    }
+    if (!isStatefulOrder(order.orderFlags) && order.goodTilBlockTime !== undefined) {
+        return new UserError(`goodTilBlockTime is ${order.goodTilBlockTime}, but should not be set for non-stateful orders`);
+    }
+    if (isStatefulOrder(order.orderFlags) && !verifyGoodTilBlockTime(order.goodTilBlockTime)) {
+        return new UserError(`goodTilBlockTime: ${order.goodTilBlockTime} is not a valid uint32 or is 0`);
+    }
+    if (isStatefulOrder(order.orderFlags) && order.goodTilBlock !== undefined) {
+        return new UserError(`goodTilBlock is ${order.goodTilBlock}, but should not be set for stateful orders`);
+    }
+    if (!verifySubaccountNumber(subaccountNumber)) {
+        return new UserError(`subaccountNumber: ${subaccountNumber} cannot be < 0 or > ${MAX_SUBACCOUNT_NUMBER}`);
+    }
+    return undefined;
+}
+/**
+ * @describe validateBatchCancelOrderMessage validates that orders to batch cancel have fields that would be
+ *  valid on-chain.
+ */
+export function validateBatchCancelOrderMessage(subaccountNumber, orders) {
+    for (const orderBatch of orders.shortTermOrders) {
+        for (const clientId of orderBatch.clientIds) {
+            if (!verifyNumberIsUint32(clientId)) {
+                return new UserError(`clientId: ${clientId} is not a valid uint32`);
+            }
+        }
+    }
+    if (!verifyGoodTilBlock(orders.goodTilBlock)) {
+        return new UserError(`goodTilBlock: ${orders.goodTilBlock} is not a valid uint32 or is 0`);
+    }
+    if (!verifySubaccountNumber(subaccountNumber)) {
+        return new UserError(`subaccountNumber: ${subaccountNumber} cannot be < 0 or > ${MAX_SUBACCOUNT_NUMBER}`);
+    }
+    return undefined;
+}
+/**
+ * @describe validateTransferMessage validates that a transfer to place has fields that would be
+ *  valid on-chain.
+ */
+export function validateTransferMessage(transfer) {
+    if (!verifySubaccountNumber(transfer.sender.number || 0)) {
+        return new UserError(`senderSubaccountNumber: ${transfer.sender.number || 0} cannot be < 0 or > ${MAX_SUBACCOUNT_NUMBER}`);
+    }
+    if (!verifySubaccountNumber(transfer.recipient.number || 0)) {
+        return new UserError(`recipientSubaccountNumber: ${transfer.recipient.number || 0} cannot be < 0 or > ${MAX_SUBACCOUNT_NUMBER}`);
+    }
+    if (transfer.assetId !== 0) {
+        return new UserError(`asset id: ${transfer.assetId} not supported`);
+    }
+    if (transfer.amount.lessThanOrEqual(Long.ZERO)) {
+        return new UserError(`amount: ${transfer.amount} cannot be <= 0`);
+    }
+    const addressError = verifyIsBech32(transfer.recipient.owner);
+    if (addressError !== undefined) {
+        return new 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 <= MAX_SUBACCOUNT_NUMBER;
+}
+function verifyNumberIsUint32(num) {
+    return num >= 0 && num <= MAX_UINT_32;
+}
+/**
+ * @description Validate that an order flag is a supported value.
+ */
+export function verifyOrderFlags(orderFlags) {
+    return (orderFlags === OrderFlags.SHORT_TERM ||
+        orderFlags === OrderFlags.LONG_TERM ||
+        orderFlags === OrderFlags.CONDITIONAL);
+}
+/**
+ * @description Determine whether an order flag represents a stateful order.
+ */
+export function isStatefulOrder(orderFlags) {
+    return orderFlags === OrderFlags.LONG_TERM || orderFlags === OrderFlags.CONDITIONAL;
+}
+function verifyIsBech32(address) {
+    try {
+        decode(address);
+    }
+    catch (error) {
+        return error;
+    }
+    return undefined;
+}
+/**
+ * @description Validate a Perpx bech32 address with prefix check.
+ */
+export function isValidAddress(address) {
+    // An address is valid if it starts with the BECH32_PREFIX + '1' and is Bech32 format.
+    return address.startsWith(`${BECH32_PREFIX}1`) && verifyIsBech32(address) === undefined;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvdmFsaWRhdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsTUFBTSxFQUFFLE1BQU0sUUFBUSxDQUFDO0FBQ2hDLE9BQU8sSUFBSSxNQUFNLE1BQU0sQ0FBQztBQUV4QixPQUFPLEVBQUUsYUFBYSxFQUFFLHFCQUFxQixFQUFFLFdBQVcsRUFBRSxNQUFNLHNCQUFzQixDQUFDO0FBQ3pGLE9BQU8sRUFFTCxVQUFVLEdBSVgsTUFBTSxrQkFBa0IsQ0FBQztBQUMxQixPQUFPLEVBQUUsU0FBUyxFQUFFLE1BQU0sVUFBVSxDQUFDO0FBRXJDOzs7R0FHRztBQUNILE1BQU0sVUFBVSx5QkFBeUIsQ0FDdkMsZ0JBQXdCLEVBQ3hCLEtBQWtCO0lBRWxCLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxLQUFLLENBQUMsUUFBUSxDQUFDLEVBQUUsQ0FBQztRQUMxQyxPQUFPLElBQUksU0FBUyxDQUFDLGFBQWEsS0FBSyxDQUFDLFFBQVEsd0JBQXdCLENBQUMsQ0FBQztJQUM1RSxDQUFDO0lBQ0QsSUFBSSxLQUFLLENBQUMsUUFBUSxDQUFDLGVBQWUsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQztRQUM5QyxPQUFPLElBQUksU0FBUyxDQUFDLGFBQWEsS0FBSyxDQUFDLFFBQVEsaUJBQWlCLENBQUMsQ0FBQztJQUNyRSxDQUFDO0lBQ0QsSUFBSSxLQUFLLENBQUMsUUFBUSxDQUFDLGVBQWUsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQztRQUM5QyxPQUFPLElBQUksU0FBUyxDQUFDLGFBQWEsS0FBSyxDQUFDLFFBQVEsaUJBQWlCLENBQUMsQ0FBQztJQUNyRSxDQUFDO0lBQ0QsSUFBSSxDQUFDLHNCQUFzQixDQUFDLGdCQUFnQixDQUFDLEVBQUUsQ0FBQztRQUM5QyxPQUFPLElBQUksU0FBUyxDQUNsQixxQkFBcUIsZ0JBQWdCLHVCQUF1QixxQkFBcUIsRUFBRSxDQUNwRixDQUFDO0lBQ0osQ0FBQztJQUNELElBQUksQ0FBQyxlQUFlLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsa0JBQWtCLENBQUMsS0FBSyxDQUFDLFlBQVksQ0FBQyxFQUFFLENBQUM7UUFDbEYsT0FBTyxJQUFJLFNBQVMsQ0FBQyxpQkFBaUIsS0FBSyxDQUFDLFlBQVksZ0NBQWdDLENBQUMsQ0FBQztJQUM1RixDQUFDO0lBQ0QsSUFBSSxlQUFlLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsc0JBQXNCLENBQUMsS0FBSyxDQUFDLGdCQUFnQixDQUFDLEVBQUUsQ0FBQztRQUN6RixPQUFPLElBQUksU0FBUyxDQUNsQixxQkFBcUIsS0FBSyxDQUFDLGdCQUFnQixnQ0FBZ0MsQ0FDNUUsQ0FBQztJQUNKLENBQUM7SUFFRCxPQUFPLFNBQVMsQ0FBQztBQUNuQixDQUFDO0FBRUQ7OztHQUdHO0FBQ0gsTUFBTSxVQUFVLDBCQUEwQixDQUN4QyxnQkFBd0IsRUFDeEIsS0FBbUI7SUFFbkIsSUFBSSxDQUFDLG9CQUFvQixDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsRUFBRSxDQUFDO1FBQzFDLE9BQU8sSUFBSSxTQUFTLENBQUMsYUFBYSxLQUFLLENBQUMsUUFBUSx3QkFBd0IsQ0FBQyxDQUFDO0lBQzVFLENBQUM7SUFDRCxJQUFJLENBQUMsZUFBZSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLGtCQUFrQixDQUFDLEtBQUssQ0FBQyxZQUFZLENBQUMsRUFBRSxDQUFDO1FBQ2xGLE9BQU8sSUFBSSxTQUFTLENBQUMsaUJBQWlCLEtBQUssQ0FBQyxZQUFZLGdDQUFnQyxDQUFDLENBQUM7SUFDNUYsQ0FBQztJQUNELElBQUksQ0FBQyxlQUFlLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxJQUFJLEtBQUssQ0FBQyxnQkFBZ0IsS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUMvRSxPQUFPLElBQUksU0FBUyxDQUNsQix1QkFBdUIsS0FBSyxDQUFDLGdCQUFnQixpREFBaUQsQ0FDL0YsQ0FBQztJQUNKLENBQUM7SUFDRCxJQUFJLGVBQWUsQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxzQkFBc0IsQ0FBQyxLQUFLLENBQUMsZ0JBQWdCLENBQUMsRUFBRSxDQUFDO1FBQ3pGLE9BQU8sSUFBSSxTQUFTLENBQ2xCLHFCQUFxQixLQUFLLENBQUMsZ0JBQWdCLGdDQUFnQyxDQUM1RSxDQUFDO0lBQ0osQ0FBQztJQUNELElBQUksZUFBZSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsSUFBSSxLQUFLLENBQUMsWUFBWSxLQUFLLFNBQVMsRUFBRSxDQUFDO1FBQzFFLE9BQU8sSUFBSSxTQUFTLENBQ2xCLG1CQUFtQixLQUFLLENBQUMsWUFBWSw2Q0FBNkMsQ0FDbkYsQ0FBQztJQUNKLENBQUM7SUFDRCxJQUFJLENBQUMsc0JBQXNCLENBQUMsZ0JBQWdCLENBQUMsRUFBRSxDQUFDO1FBQzlDLE9BQU8sSUFBSSxTQUFTLENBQ2xCLHFCQUFxQixnQkFBZ0IsdUJBQXVCLHFCQUFxQixFQUFFLENBQ3BGLENBQUM7SUFDSixDQUFDO0lBRUQsT0FBTyxTQUFTLENBQUM7QUFDbkIsQ0FBQztBQUVEOzs7R0FHRztBQUNILE1BQU0sVUFBVSwrQkFBK0IsQ0FDN0MsZ0JBQXdCLEVBQ3hCLE1BQXlCO0lBRXpCLEtBQUssTUFBTSxVQUFVLElBQUksTUFBTSxDQUFDLGVBQWUsRUFBRSxDQUFDO1FBQ2hELEtBQUssTUFBTSxRQUFRLElBQUksVUFBVSxDQUFDLFNBQVMsRUFBRSxDQUFDO1lBQzVDLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxRQUFRLENBQUMsRUFBRSxDQUFDO2dCQUNwQyxPQUFPLElBQUksU0FBUyxDQUFDLGFBQWEsUUFBUSx3QkFBd0IsQ0FBQyxDQUFDO1lBQ3RFLENBQUM7UUFDSCxDQUFDO0lBQ0gsQ0FBQztJQUVELElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxNQUFNLENBQUMsWUFBWSxDQUFDLEVBQUUsQ0FBQztRQUM3QyxPQUFPLElBQUksU0FBUyxDQUFDLGlCQUFpQixNQUFNLENBQUMsWUFBWSxnQ0FBZ0MsQ0FBQyxDQUFDO0lBQzdGLENBQUM7SUFFRCxJQUFJLENBQUMsc0JBQXNCLENBQUMsZ0JBQWdCLENBQUMsRUFBRSxDQUFDO1FBQzlDLE9BQU8sSUFBSSxTQUFTLENBQ2xCLHFCQUFxQixnQkFBZ0IsdUJBQXVCLHFCQUFxQixFQUFFLENBQ3BGLENBQUM7SUFDSixDQUFDO0lBRUQsT0FBTyxTQUFTLENBQUM7QUFDbkIsQ0FBQztBQUVEOzs7R0FHRztBQUNILE1BQU0sVUFBVSx1QkFBdUIsQ0FBQyxRQUFrQjtJQUN4RCxJQUFJLENBQUMsc0JBQXNCLENBQUMsUUFBUSxDQUFDLE1BQVEsQ0FBQyxNQUFNLElBQUksQ0FBQyxDQUFDLEVBQUUsQ0FBQztRQUMzRCxPQUFPLElBQUksU0FBUyxDQUNsQiwyQkFDRSxRQUFRLENBQUMsTUFBUSxDQUFDLE1BQU0sSUFBSSxDQUM5Qix1QkFBdUIscUJBQXFCLEVBQUUsQ0FDL0MsQ0FBQztJQUNKLENBQUM7SUFDRCxJQUFJLENBQUMsc0JBQXNCLENBQUMsUUFBUSxDQUFDLFNBQVcsQ0FBQyxNQUFNLElBQUksQ0FBQyxDQUFDLEVBQUUsQ0FBQztRQUM5RCxPQUFPLElBQUksU0FBUyxDQUNsQiw4QkFDRSxRQUFRLENBQUMsU0FBVyxDQUFDLE1BQU0sSUFBSSxDQUNqQyx1QkFBdUIscUJBQXFCLEVBQUUsQ0FDL0MsQ0FBQztJQUNKLENBQUM7SUFDRCxJQUFJLFFBQVEsQ0FBQyxPQUFPLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDM0IsT0FBTyxJQUFJLFNBQVMsQ0FBQyxhQUFhLFFBQVEsQ0FBQyxPQUFPLGdCQUFnQixDQUFDLENBQUM7SUFDdEUsQ0FBQztJQUNELElBQUksUUFBUSxDQUFDLE1BQU0sQ0FBQyxlQUFlLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUM7UUFDL0MsT0FBTyxJQUFJLFNBQVMsQ0FBQyxXQUFXLFFBQVEsQ0FBQyxNQUFNLGlCQUFpQixDQUFDLENBQUM7SUFDcEUsQ0FBQztJQUVELE1BQU0sWUFBWSxHQUFzQixjQUFjLENBQUMsUUFBUSxDQUFDLFNBQVcsQ0FBQyxLQUFLLENBQUMsQ0FBQztJQUNuRixJQUFJLFlBQVksS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUMvQixPQUFPLElBQUksU0FBUyxDQUFDLFlBQVksQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDO0lBQ2hELENBQUM7SUFDRCxPQUFPLFNBQVMsQ0FBQztBQUNuQixDQUFDO0FBRUQsU0FBUyxrQkFBa0IsQ0FBQyxZQUFnQztJQUMxRCxJQUFJLFlBQVksS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUMvQixPQUFPLEtBQUssQ0FBQztJQUNmLENBQUM7SUFFRCxPQUFPLG9CQUFvQixDQUFDLFlBQVksQ0FBQyxJQUFJLFlBQVksR0FBRyxDQUFDLENBQUM7QUFDaEUsQ0FBQztBQUVELFNBQVMsc0JBQXNCLENBQUMsZ0JBQW9DO0lBQ2xFLElBQUksZ0JBQWdCLEtBQUssU0FBUyxFQUFFLENBQUM7UUFDbkMsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUQsT0FBTyxvQkFBb0IsQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLGdCQUFnQixHQUFHLENBQUMsQ0FBQztBQUN4RSxDQUFDO0FBRUQsU0FBUyxzQkFBc0IsQ0FBQyxnQkFBd0I7SUFDdEQsT0FBTyxnQkFBZ0IsSUFBSSxDQUFDLElBQUksZ0JBQWdCLElBQUkscUJBQXFCLENBQUM7QUFDNUUsQ0FBQztBQUVELFNBQVMsb0JBQW9CLENBQUMsR0FBVztJQUN2QyxPQUFPLEdBQUcsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLFdBQVcsQ0FBQztBQUN4QyxDQUFDO0FBRUQ7O0dBRUc7QUFDSCxNQUFNLFVBQVUsZ0JBQWdCLENBQUMsVUFBc0I7SUFDckQsT0FBTyxDQUNMLFVBQVUsS0FBSyxVQUFVLENBQUMsVUFBVTtRQUNwQyxVQUFVLEtBQUssVUFBVSxDQUFDLFNBQVM7UUFDbkMsVUFBVSxLQUFLLFVBQVUsQ0FBQyxXQUFXLENBQ3RDLENBQUM7QUFDSixDQUFDO0FBRUQ7O0dBRUc7QUFDSCxNQUFNLFVBQVUsZUFBZSxDQUFDLFVBQXNCO0lBQ3BELE9BQU8sVUFBVSxLQUFLLFVBQVUsQ0FBQyxTQUFTLElBQUksVUFBVSxLQUFLLFVBQVUsQ0FBQyxXQUFXLENBQUM7QUFDdEYsQ0FBQztBQUVELFNBQVMsY0FBYyxDQUFDLE9BQWU7SUFDckMsSUFBSSxDQUFDO1FBQ0gsTUFBTSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQ2xCLENBQUM7SUFBQyxPQUFPLEtBQUssRUFBRSxDQUFDO1FBQ2YsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUQsT0FBTyxTQUFTLENBQUM7QUFDbkIsQ0FBQztBQUVEOztHQUVHO0FBQ0gsTUFBTSxVQUFVLGNBQWMsQ0FBQyxPQUFlO0lBQzVDLHNGQUFzRjtJQUN0RixPQUFPLE9BQU8sQ0FBQyxVQUFVLENBQUMsR0FBRyxhQUFhLEdBQUcsQ0FBQyxJQUFJLGNBQWMsQ0FBQyxPQUFPLENBQUMsS0FBSyxTQUFTLENBQUM7QUFDMUYsQ0FBQyJ9

package/build/esm/src/network_optimizer.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @description Type guard helper for filtering falsy values.
+ */
+export declare const isTruthy: <T>(n?: T | false | null | undefined | 0) => n is T;
+export declare class NetworkOptimizer {
+    private validatorClients;
+    private indexerClients;
+    /**
+     * @description Pick the fastest validator node at latest or near-latest height.
+     *
+     * @returns The selected REST endpoint URL.
+     */
+    findOptimalNode(endpointUrls: string[], chainId: string): Promise<string>;
+    /**
+     * @description Pick the fastest indexer at latest or near-latest height.
+     *
+     * @returns The selected REST endpoint URL.
+     */
+    findOptimalIndexer(endpointUrls: string[]): Promise<string>;
+}
+//# sourceMappingURL=network_optimizer.d.ts.map

package/build/esm/src/network_optimizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network_optimizer.d.ts","sourceRoot":"","sources":["../../../src/network_optimizer.ts"],"names":[],"mappings":"AAgBA;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,IAAI,CAAC,GAAG,KAAK,GAAG,IAAI,GAAG,SAAS,GAAG,CAAC,KAAG,CAAC,IAAI,CAAe,CAAC;AAExF,qBAAa,gBAAgB;YACb,gBAAgB;IAoB9B,OAAO,CAAC,cAAc;IAetB;;;;OAIG;IACG,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAuC/E;;;;OAIG;IACG,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;CAsClE"}