@dydxprotocol/v4-client-js 1.1.13 → 1.1.14

package/src/codegen/helpers.ts

@@ -1,17 +1,17 @@
 /**
-* This file and any referenced files were automatically generated by @osmonauts/telescope@0.80.0
-* DO NOT MODIFY BY HAND. Instead, download the latest proto files for your chain
-* and run the transpile command or yarn proto command to regenerate this bundle.
-*/
+ * This file and any referenced files were automatically generated by @osmonauts/telescope@0.80.0
+ * DO NOT MODIFY BY HAND. Instead, download the latest proto files for your chain
+ * and run the transpile command or yarn proto command to regenerate this bundle.
+ */
 
-import * as _m0 from "protobufjs/minimal";
+import * as _m0 from 'protobufjs/minimal';
 import Long from 'long';
 
 // @ts-ignore
 if (_m0.util.Long !== Long) {
-    _m0.util.Long = (Long as any);
+  _m0.util.Long = Long as any;
 
-    _m0.configure();
+  _m0.configure();
 }
 
 export { Long };
@@ -20,204 +20,203 @@ declare var self: any | undefined;
 declare var window: any | undefined;
 declare var global: any | undefined;
 var globalThis: any = (() => {
-    if (typeof globalThis !== 'undefined') return globalThis;
-    if (typeof self !== 'undefined') return self;
-    if (typeof window !== 'undefined') return window;
-    if (typeof global !== 'undefined') return global;
-    throw 'Unable to locate global object';
+  if (typeof globalThis !== 'undefined') return globalThis;
+  if (typeof self !== 'undefined') return self;
+  if (typeof window !== 'undefined') return window;
+  if (typeof global !== 'undefined') return global;
+  throw 'Unable to locate global object';
 })();
 
 const atob: (b64: string) => string =
-    globalThis.atob || ((b64) => globalThis.Buffer.from(b64, 'base64').toString('binary'));
+  globalThis.atob || ((b64) => globalThis.Buffer.from(b64, 'base64').toString('binary'));
 
 export function bytesFromBase64(b64: string): Uint8Array {
-    const bin = atob(b64);
-    const arr = new Uint8Array(bin.length);
-    for (let i = 0; i < bin.length; ++i) {
-        arr[i] = bin.charCodeAt(i);
-    }
-    return arr;
+  const bin = atob(b64);
+  const arr = new Uint8Array(bin.length);
+  for (let i = 0; i < bin.length; ++i) {
+    arr[i] = bin.charCodeAt(i);
+  }
+  return arr;
 }
 
 const btoa: (bin: string) => string =
-    globalThis.btoa || ((bin) => globalThis.Buffer.from(bin, 'binary').toString('base64'));
+  globalThis.btoa || ((bin) => globalThis.Buffer.from(bin, 'binary').toString('base64'));
 
 export function base64FromBytes(arr: Uint8Array): string {
-    const bin: string[] = [];
-    arr.forEach((byte) => {
-        bin.push(String.fromCharCode(byte));
-    });
-    return btoa(bin.join(''));
+  const bin: string[] = [];
+  arr.forEach((byte) => {
+    bin.push(String.fromCharCode(byte));
+  });
+  return btoa(bin.join(''));
 }
 
 export interface AminoHeight {
-    readonly revision_number?: string;
-    readonly revision_height?: string;
-};
+  readonly revision_number?: string;
+  readonly revision_height?: string;
+}
 
 export function omitDefault<T extends string | number | Long>(input: T): T | undefined {
-    if (typeof input === "string") {
-        return input === "" ? undefined : input;
-    }
+  if (typeof input === 'string') {
+    return input === '' ? undefined : input;
+  }
 
-    if (typeof input === "number") {
-        return input === 0 ? undefined : input;
-    }
+  if (typeof input === 'number') {
+    return input === 0 ? undefined : input;
+  }
 
-    if (Long.isLong(input)) {
-        return input.isZero() ? undefined : input;
-    }
+  if (Long.isLong(input)) {
+    return input.isZero() ? undefined : input;
+  }
 
-    throw new Error(`Got unsupported type ${typeof input}`);
-};
+  throw new Error(`Got unsupported type ${typeof input}`);
+}
 
 interface Duration {
-    /**
-     * Signed seconds of the span of time. Must be from -315,576,000,000
-     * to +315,576,000,000 inclusive. Note: these bounds are computed from:
-     * 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
-     */
-    seconds: Long;
-    /**
-     * Signed fractions of a second at nanosecond resolution of the span
-     * of time. Durations less than one second are represented with a 0
-     * `seconds` field and a positive or negative `nanos` field. For durations
-     * of one second or more, a non-zero value for the `nanos` field must be
-     * of the same sign as the `seconds` field. Must be from -999,999,999
-     * to +999,999,999 inclusive.
-     */
-
-    nanos: number;
+  /**
+   * Signed seconds of the span of time. Must be from -315,576,000,000
+   * to +315,576,000,000 inclusive. Note: these bounds are computed from:
+   * 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+   */
+  seconds: Long;
+  /**
+   * Signed fractions of a second at nanosecond resolution of the span
+   * of time. Durations less than one second are represented with a 0
+   * `seconds` field and a positive or negative `nanos` field. For durations
+   * of one second or more, a non-zero value for the `nanos` field must be
+   * of the same sign as the `seconds` field. Must be from -999,999,999
+   * to +999,999,999 inclusive.
+   */
+
+  nanos: number;
 }
 
 export function toDuration(duration: string): Duration {
-    return {
-        seconds: Long.fromNumber(Math.floor(parseInt(duration) / 1000000000)),
-        nanos: parseInt(duration) % 1000000000
-    };
-};
+  return {
+    seconds: Long.fromNumber(Math.floor(parseInt(duration) / 1000000000)),
+    nanos: parseInt(duration) % 1000000000,
+  };
+}
 
 export function fromDuration(duration: Duration): string {
-    return (parseInt(duration.seconds.toString()) * 1000000000 + duration.nanos).toString();
-};
+  return (parseInt(duration.seconds.toString()) * 1000000000 + duration.nanos).toString();
+}
 
 export function isSet(value: any): boolean {
-    return value !== null && value !== undefined;
-};
+  return value !== null && value !== undefined;
+}
 
 export function isObject(value: any): boolean {
-    return typeof value === 'object' && value !== null;
-};
+  return typeof value === 'object' && value !== null;
+}
 
 export interface PageRequest {
-    key: Uint8Array;
-    offset: Long;
-    limit: Long;
-    countTotal: boolean;
-    reverse: boolean;
-};
+  key: Uint8Array;
+  offset: Long;
+  limit: Long;
+  countTotal: boolean;
+  reverse: boolean;
+}
 
 export interface PageRequestParams {
-    "pagination.key"?: string;
-    "pagination.offset"?: string;
-    "pagination.limit"?: string;
-    "pagination.count_total"?: boolean;
-    "pagination.reverse"?: boolean;
-};
+  'pagination.key'?: string;
+  'pagination.offset'?: string;
+  'pagination.limit'?: string;
+  'pagination.count_total'?: boolean;
+  'pagination.reverse'?: boolean;
+}
 
 export interface Params {
-    params: PageRequestParams;
-};
+  params: PageRequestParams;
+}
 
 export const setPaginationParams = (options: Params, pagination?: PageRequest) => {
+  if (!pagination) {
+    return options;
+  }
 
-    if (!pagination) {
-        return options;
-    }
-
-    if (typeof pagination?.countTotal !== "undefined") {
-        options.params['pagination.count_total'] = pagination.countTotal;
-    }
-    if (typeof pagination?.key !== "undefined") {
-        // String to Uint8Array
-        // let uint8arr = new Uint8Array(Buffer.from(data,'base64')); 
-
-        // Uint8Array to String
-        options.params['pagination.key'] = Buffer.from(pagination.key).toString('base64');
-    }
-    if (typeof pagination?.limit !== "undefined") {
-      options.params["pagination.limit"] = pagination.limit.toString()
-    }
-    if (typeof pagination?.offset !== "undefined") {
-      options.params["pagination.offset"] = pagination.offset.toString()
-    }    
-    if (typeof pagination?.reverse !== "undefined") {
-        options.params['pagination.reverse'] = pagination.reverse;
-    }
+  if (typeof pagination?.countTotal !== 'undefined') {
+    options.params['pagination.count_total'] = pagination.countTotal;
+  }
+  if (typeof pagination?.key !== 'undefined') {
+    // String to Uint8Array
+    // let uint8arr = new Uint8Array(Buffer.from(data,'base64'));
 
-    return options;
+    // Uint8Array to String
+    options.params['pagination.key'] = Buffer.from(pagination.key).toString('base64');
+  }
+  if (typeof pagination?.limit !== 'undefined') {
+    options.params['pagination.limit'] = pagination.limit.toString();
+  }
+  if (typeof pagination?.offset !== 'undefined') {
+    options.params['pagination.offset'] = pagination.offset.toString();
+  }
+  if (typeof pagination?.reverse !== 'undefined') {
+    options.params['pagination.reverse'] = pagination.reverse;
+  }
+
+  return options;
 };
 
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 
 export type DeepPartial<T> = T extends Builtin
-    ? T
-    : T extends Long
+  ? T
+  : T extends Long
     ? string | number | Long
     : T extends Array<infer U>
-    ? Array<DeepPartial<U>>
-    : T extends ReadonlyArray<infer U>
-    ? ReadonlyArray<DeepPartial<U>>
-    : T extends {}
-    ? { [K in keyof T]?: DeepPartial<T[K]> }
-    : Partial<T>;
+      ? Array<DeepPartial<U>>
+      : T extends ReadonlyArray<infer U>
+        ? ReadonlyArray<DeepPartial<U>>
+        : T extends {}
+          ? { [K in keyof T]?: DeepPartial<T[K]> }
+          : Partial<T>;
 
 type KeysOfUnion<T> = T extends T ? keyof T : never;
 export type Exact<P, I extends P> = P extends Builtin
-    ? P
-    : P & { [K in keyof P]: Exact<P[K], I[K]> } & Record<Exclude<keyof I, KeysOfUnion<P>>, never>;
+  ? P
+  : P & { [K in keyof P]: Exact<P[K], I[K]> } & Record<Exclude<keyof I, KeysOfUnion<P>>, never>;
 
 export interface Rpc {
-    request(service: string, method: string, data: Uint8Array): Promise<Uint8Array>;
-};
+  request(service: string, method: string, data: Uint8Array): Promise<Uint8Array>;
+}
 
 interface Timestamp {
-    /**
-     * Represents seconds of UTC time since Unix epoch
-     * 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
-     * 9999-12-31T23:59:59Z inclusive.
-     */
-    seconds: Long;
-    /**
-     * Non-negative fractions of a second at nanosecond resolution. Negative
-     * second values with fractions must still have non-negative nanos values
-     * that count forward in time. Must be from 0 to 999,999,999
-     * inclusive.
-     */
-
-    nanos: number;
+  /**
+   * Represents seconds of UTC time since Unix epoch
+   * 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+   * 9999-12-31T23:59:59Z inclusive.
+   */
+  seconds: Long;
+  /**
+   * Non-negative fractions of a second at nanosecond resolution. Negative
+   * second values with fractions must still have non-negative nanos values
+   * that count forward in time. Must be from 0 to 999,999,999
+   * inclusive.
+   */
+
+  nanos: number;
 }
 
 export function toTimestamp(date: Date): Timestamp {
-    const seconds = numberToLong(date.getTime() / 1_000);
-    const nanos = date.getTime() % 1000 * 1000000;
-    return {
-        seconds,
-        nanos
-    };
-};
+  const seconds = numberToLong(date.getTime() / 1_000);
+  const nanos = (date.getTime() % 1000) * 1000000;
+  return {
+    seconds,
+    nanos,
+  };
+}
 
 export function fromTimestamp(t: Timestamp): Date {
-    let millis = t.seconds.toNumber() * 1000;
-    millis += t.nanos / 1000000;
-    return new Date(millis);
-};
+  let millis = t.seconds.toNumber() * 1000;
+  millis += t.nanos / 1000000;
+  return new Date(millis);
+}
 
 const fromJSON = (object: any): Timestamp => {
-    return {
-        seconds: isSet(object.seconds) ? Long.fromString(object.seconds) : Long.ZERO,
-        nanos: isSet(object.nanos) ? Number(object.nanos) : 0
-    };
+  return {
+    seconds: isSet(object.seconds) ? Long.fromString(object.seconds) : Long.ZERO,
+    nanos: isSet(object.nanos) ? Number(object.nanos) : 0,
+  };
 };
 
 const timestampFromJSON = (object: any): Timestamp => {
@@ -225,18 +224,18 @@ const timestampFromJSON = (object: any): Timestamp => {
     seconds: isSet(object.seconds) ? Long.fromValue(object.seconds) : Long.ZERO,
     nanos: isSet(object.nanos) ? Number(object.nanos) : 0,
   };
-}
-  
+};
+
 export function fromJsonTimestamp(o: any): Timestamp {
   if (o instanceof Date) {
     return toTimestamp(o);
-  } else if (typeof o === "string") {
+  } else if (typeof o === 'string') {
     return toTimestamp(new Date(o));
   } else {
     return timestampFromJSON(o);
   }
 }
-  
+
 function numberToLong(number: number) {
-    return Long.fromNumber(number);
+  return Long.fromNumber(number);
 }

package/src/codegen/index.ts

@@ -1,6 +1,5 @@
 /**
-  * This file and any referenced files were automatically generated by @osmonauts/telescope@0.80.0
-  * DO NOT MODIFY BY HAND. Instead, download the latest proto files for your chain
-  * and run the transpile command or yarn proto command to regenerate this bundle.
-  */
- 
+ * This file and any referenced files were automatically generated by @osmonauts/telescope@0.80.0
+ * DO NOT MODIFY BY HAND. Instead, download the latest proto files for your chain
+ * and run the transpile command or yarn proto command to regenerate this bundle.
+ */

package/src/lib/errors.ts

@@ -1,13 +1,10 @@
-import {
-  BroadcastTxSyncResponse,
-} from '@cosmjs/tendermint-rpc/build/tendermint37';
+import { BroadcastTxSyncResponse } from '@cosmjs/tendermint-rpc/build/tendermint37';
 
 /**
  * An edge-case was hit in the client that should never have been reached.
  */
 export class UnexpectedClientError extends Error {
-  constructor(
-  ) {
+  constructor() {
     super('An unexpected error occurred on the client');
     this.name = 'UnexpectedClientError';
   }
@@ -21,10 +18,7 @@ export class BroadcastErrorObject extends Error {
   code: number;
   codespace?: string;
 
-  constructor(
-    message: string,
-    result: BroadcastTxSyncResponse,
-  ) {
+  constructor(message: string, result: BroadcastTxSyncResponse) {
     super(message);
     this.name = 'BroadcastError';
     this.result = result;

package/src/lib/onboarding.ts

@@ -18,7 +18,10 @@ import { stripHexPrefix } from './helpers';
  *
  * @returns Mnemonic and priv/pub keys
  */
-export const exportMnemonicAndPrivateKey = (entropy: Uint8Array, path: string = "m/44'/118'/0'/0/0"): {
+export const exportMnemonicAndPrivateKey = (
+  entropy: Uint8Array,
+  path: string = "m/44'/118'/0'/0/0",
+): {
   mnemonic: string;
   privateKey: Uint8Array | null;
   publicKey: Uint8Array | null;
@@ -45,7 +48,9 @@ export const exportMnemonicAndPrivateKey = (entropy: Uint8Array, path: string =
  *
  * @returns Mnemonic and Public/Private HD keys
  */
-export const deriveHDKeyFromEthereumSignature = (signature: string): {
+export const deriveHDKeyFromEthereumSignature = (
+  signature: string,
+): {
   mnemonic: string;
   privateKey: Uint8Array | null;
   publicKey: Uint8Array | null;

package/src/lib/utils.ts

@@ -3,9 +3,7 @@ import { MAX_UINT_32 } from '../clients/constants';
 /**
  * Returns a random integer value between 0 and (n-1).
  */
-export function randomInt(
-  n: number,
-): number {
+export function randomInt(n: number): number {
   return Math.floor(Math.random() * n);
 }
 
@@ -20,19 +18,17 @@ export function generateRandomClientId(): number {
  * Deterministically generate a valid clientId from an arbitrary string by performing a
  * quick hashing function on the string.
  */
-export function clientIdFromString(
-  input: string,
-): number {
+export function clientIdFromString(input: string): number {
   let hash: number = 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 = (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);
+  return hash + 2 ** 31;
 }
 
 /**
@@ -61,9 +57,6 @@ export function getGovAddNewMarketTitle(ticker: string): string {
  * @param delayBlocks number of blocks to wait before activating the market.
  * @returns summary for the gov proposal.
  */
-export function getGovAddNewMarketSummary(
-  ticker: string,
-  delayBlocks: number,
-): string {
+export function getGovAddNewMarketSummary(ticker: string, delayBlocks: number): string {
   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.`;
 }

package/src/lib/validation.ts

@@ -2,12 +2,7 @@ import { decode } from 'bech32';
 import Long from 'long';
 
 import { MAX_SUBACCOUNT_NUMBER, MAX_UINT_32 } from '../clients/constants';
-import {
-  Transfer,
-  OrderFlags,
-  ICancelOrder,
-  IPlaceOrder,
-} from '../clients/types';
+import { Transfer, OrderFlags, ICancelOrder, IPlaceOrder } from '../clients/types';
 import { UserError } from './errors';
 
 /**
@@ -36,7 +31,9 @@ export function validatePlaceOrderMessage(
     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 new UserError(
+      `goodTilBlockTime: ${order.goodTilBlockTime} is not a valid uint32 or is 0`,
+    );
   }
 
   return undefined;
@@ -57,13 +54,19 @@ export function validateCancelOrderMessage(
     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`);
+    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`);
+    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`);
+    return new UserError(
+      `goodTilBlock is ${order.goodTilBlock}, but should not be set for stateful orders`,
+    );
   }
   if (!verifySubaccountNumber(subaccountNumber)) {
     return new UserError(
@@ -90,14 +93,10 @@ export function validateTransferMessage(transfer: Transfer): UserError | undefin
     );
   }
   if (transfer.assetId !== 0) {
-    return new UserError(
-      `asset id: ${transfer.assetId} not supported`,
-    );
+    return new UserError(`asset id: ${transfer.assetId} not supported`);
   }
   if (transfer.amount.lessThanOrEqual(Long.ZERO)) {
-    return new UserError(
-      `amount: ${transfer.amount} cannot be <= 0`,
-    );
+    return new UserError(`amount: ${transfer.amount} cannot be <= 0`);
   }
 
   const addressError: Error | undefined = verifyIsBech32(transfer.recipient!!.owner);
@@ -132,8 +131,11 @@ function verifyNumberIsUint32(num: number): boolean {
 }
 
 export function verifyOrderFlags(orderFlags: OrderFlags): boolean {
-  return orderFlags === OrderFlags.SHORT_TERM ||
-    orderFlags === OrderFlags.LONG_TERM || orderFlags === OrderFlags.CONDITIONAL;
+  return (
+    orderFlags === OrderFlags.SHORT_TERM ||
+    orderFlags === OrderFlags.LONG_TERM ||
+    orderFlags === OrderFlags.CONDITIONAL
+  );
 }
 
 export function isStatefulOrder(orderFlags: OrderFlags): boolean {
@@ -152,5 +154,5 @@ function verifyIsBech32(address: string): Error | undefined {
 
 export function isValidAddress(address: string): boolean {
   // An address is valid if it starts with `dydx1` and is Bech32 format.
-  return address.startsWith('dydx1') && (verifyIsBech32(address) === undefined);
+  return address.startsWith('dydx1') && verifyIsBech32(address) === undefined;
 }