@dydxprotocol/v4-client-js 1.2.0 → 1.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dydxprotocol/v4-client-js",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "General client library for the new dYdX system (v4 decentralized)",
   "main": "build/src/index.js",
   "scripts": {
@@ -12,7 +12,6 @@
     "lint": "eslint --ext .ts,.js .",
     "prepublishOnly": "npm run compile",
     "start": "node build/src/index.js",
-    "transpile": "rm -rf src/codegen && telescope transpile --protoDirs ./proto --outPath ./src/codegen --no-includeAminos --includeLCDClients --includeRPCClients",
     "test": "NODE_ENV=test jest --testPathIgnorePatterns=__tests__/modules/client/*",
     "test:watch": "npm test -- --watch",
     "test-integration": "NODE_ENV=test jest",
@@ -37,7 +36,7 @@
     "@cosmjs/stargate": "^0.32.1",
     "@cosmjs/tendermint-rpc": "^0.32.1",
     "@cosmjs/utils": "^0.32.1",
-    "@dydxprotocol/v4-proto": "5.0.0-dev.0",
+    "@dydxprotocol/v4-proto": "6.0.1",
     "@osmonauts/lcd": "^0.6.0",
     "@scure/bip32": "^1.1.5",
     "@scure/bip39": "^1.1.1",
@@ -53,7 +52,6 @@
   },
   "devDependencies": {
     "@dydxprotocol/node-service-base-dev": "^0.2.6",
-    "@osmonauts/telescope": "0.80.0",
     "@protobufs/cosmos": "^0.0.11",
     "@protobufs/gogoproto": "^0.0.10",
     "@types/ffi-napi": "^4.0.4",
@@ -77,6 +75,7 @@
     "stream-http": "^3.2.0",
     "ts-loader": "^9.4.2",
     "ts-proto": "^1.165.1",
+    "util": "^0.12.5",
     "webpack": "^5.77.0",
     "webpack-cli": "^5.0.1"
   }

package/src/clients/composite-client.ts

@@ -714,6 +714,7 @@ async batchCancelShortTermOrdersWithMarketId(
   subaccount: SubaccountInfo,
   shortTermOrders: OrderBatchWithMarketId[],
   goodTilBlock: number,
+  broadcastMode?: BroadcastMode,
 ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
   const orderBatches = await Promise.all(
     shortTermOrders.map(async ({ marketId, clobPairId, clientIds }) => ({
@@ -728,6 +729,7 @@ async batchCancelShortTermOrdersWithMarketId(
     subaccount,
     orderBatches,
     goodTilBlock,
+    broadcastMode
   );
 }
 
@@ -743,11 +745,13 @@ async batchCancelShortTermOrdersWithMarketId(
     subaccount: SubaccountInfo,
     shortTermOrders: OrderBatch[],
     goodTilBlock: number,
+    broadcastMode?: BroadcastMode,
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
     return this.validatorClient.post.batchCancelShortTermOrders(
       subaccount,
       shortTermOrders,
       goodTilBlock,
+      broadcastMode,
     );
   }
 

package/src/clients/modules/get.ts

@@ -491,9 +491,9 @@ export class Get {
     return GovV1Module.QueryProposalsResponse.decode(data);
   }
 
-  async getWithdrawalAndTransferGatingStatus(): Promise<SubaccountsModule.QueryGetWithdrawalAndTransfersBlockedInfoResponse> {
+  async getWithdrawalAndTransferGatingStatus(perpetualId: number): Promise<SubaccountsModule.QueryGetWithdrawalAndTransfersBlockedInfoResponse> {
     const requestData = Uint8Array.from(
-      SubaccountsModule.QueryGetWithdrawalAndTransfersBlockedInfoRequest.encode({}).finish(),
+      SubaccountsModule.QueryGetWithdrawalAndTransfersBlockedInfoRequest.encode({ perpetualId }).finish(),
     );
 
     const data = await this.sendQuery(

package/src/clients/native.ts

@@ -1211,14 +1211,14 @@ export async function getWithdrawalCapacityByDenom(payload: string): Promise<str
   }
 }
 
-export async function getWithdrawalAndTransferGatingStatus(): Promise<string> {
+export async function getWithdrawalAndTransferGatingStatus(perpetualId: number): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
       throw new UserError('client is not connected. Call connectClient() first');
     }
 
-    const response = await client.validatorClient.get.getWithdrawalAndTransferGatingStatus();
+    const response = await client.validatorClient.get.getWithdrawalAndTransferGatingStatus(perpetualId);
     return encodeJson(response);
   } catch (error) {
     return wrappedError(error);

package/src/clients/types.ts

@@ -59,6 +59,11 @@ export interface IPlaceOrder extends IBasicOrder {
 
 export interface ICancelOrder extends IBasicOrder {}
 
+export interface IBatchCancelOrder {
+  shortTermOrders: { clobPairId: number; clientIds: number[] }[];
+  goodTilBlock: number;
+}
+
 // How long to wait and how often to check when calling Broadcast with
 // Method.BroadcastTxCommit
 export interface BroadcastOptions {

package/src/index.ts

@@ -2,6 +2,7 @@
 export * from './types';
 
 // Utility functions.
+export * as helpers from './lib/helpers';
 export * as utils from './lib/utils';
 export * as validation from './lib/validation';
 export * as onboarding from './lib/onboarding';

package/src/lib/validation.ts

@@ -2,7 +2,13 @@ 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,
+  IBatchCancelOrder,
+} from '../clients/types';
 import { UserError } from './errors';
 
 /**
@@ -77,6 +83,35 @@ export function validateCancelOrderMessage(
   return undefined;
 }
 
+/**
+ * @describe validateBatchCancelOrderMessage validates that orders to batch cancel have fields that would be
+ *  valid on-chain.
+ */
+export function validateBatchCancelOrderMessage(
+  subaccountNumber: number,
+  orders: IBatchCancelOrder,
+): UserError | undefined {
+  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.
@@ -84,12 +119,16 @@ export function validateCancelOrderMessage(
 export function validateTransferMessage(transfer: Transfer): UserError | undefined {
   if (!verifySubaccountNumber(transfer.sender!!.number || 0)) {
     return new UserError(
-      `senderSubaccountNumber: ${transfer.sender!!.number || 0} cannot be < 0 or > ${MAX_SUBACCOUNT_NUMBER}`,
+      `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}`,
+      `recipientSubaccountNumber: ${
+        transfer.recipient!!.number || 0
+      } cannot be < 0 or > ${MAX_SUBACCOUNT_NUMBER}`,
     );
   }
   if (transfer.assetId !== 0) {

package/src/types.ts

@@ -40,4 +40,5 @@ export interface Options {
 
 export enum ClobPairId {
   PERPETUAL_PAIR_BTC_USD = 0,
+  PERPETUAL_PAIR_ETH_USD = 1,
 }

package/tsconfig.json

@@ -6,7 +6,6 @@
     "examples",
     "scripts",
     "src",
-    "codegen.js",
     "node_modules/@dydxprotocol/v4-proto/**/**.ts"
   ],
   "compilerOptions": {

package/webpack.config.js

@@ -31,6 +31,7 @@ module.exports = {
       http: require.resolve('stream-http'),
       path: require.resolve('path-browserify'),
       crypto: require.resolve('crypto-browserify'),
+      util: require.resolve('util'),
     },
   },
   plugins: [

package/.telescope.json

@@ -1,15 +0,0 @@
-{
-  "protoDirs": ["./proto"],
-  "outPath": "./src/codegen",
-  "options": {
-    "aminoEncoding": {
-      "enabled": false
-    },
-    "lcdClients": {
-      "enabled": true
-    },
-    "rpcClients": {
-      "enabled": true
-    }
-  }
-}

package/src/codegen/helpers.ts

@@ -1,241 +0,0 @@
-/**
- * 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 Long from 'long';
-
-// @ts-ignore
-if (_m0.util.Long !== Long) {
-  _m0.util.Long = Long as any;
-
-  _m0.configure();
-}
-
-export { Long };
-
-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';
-})();
-
-const atob: (b64: string) => string =
-  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 btoa: (bin: string) => string =
-  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(''));
-}
-
-export interface AminoHeight {
-  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 === 'number') {
-    return input === 0 ? undefined : input;
-  }
-
-  if (Long.isLong(input)) {
-    return input.isZero() ? undefined : 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;
-}
-
-export function toDuration(duration: string): Duration {
-  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();
-}
-
-export function isSet(value: any): boolean {
-  return value !== null && value !== undefined;
-}
-
-export function isObject(value: any): boolean {
-  return typeof value === 'object' && value !== null;
-}
-
-export interface PageRequest {
-  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;
-}
-
-export interface Params {
-  params: PageRequestParams;
-}
-
-export const setPaginationParams = (options: Params, pagination?: PageRequest) => {
-  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;
-  }
-
-  return options;
-};
-
-type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
-
-export type DeepPartial<T> = T extends Builtin
-  ? 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>;
-
-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>;
-
-export interface Rpc {
-  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;
-}
-
-export function toTimestamp(date: Date): Timestamp {
-  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);
-}
-
-const fromJSON = (object: any): Timestamp => {
-  return {
-    seconds: isSet(object.seconds) ? Long.fromString(object.seconds) : Long.ZERO,
-    nanos: isSet(object.nanos) ? Number(object.nanos) : 0,
-  };
-};
-
-const timestampFromJSON = (object: any): Timestamp => {
-  return {
-    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') {
-    return toTimestamp(new Date(o));
-  } else {
-    return timestampFromJSON(o);
-  }
-}
-
-function numberToLong(number: number) {
-  return Long.fromNumber(number);
-}

package/src/codegen/index.ts

@@ -1,5 +0,0 @@
-/**
- * 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.
- */