@dydxprotocol/v4-client-js 1.0.28 → 1.1.1

package/examples/gov_add_new_market.ts

@@ -1,3 +1,4 @@
+import { PerpetualMarketType } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/perpetuals/perpetual';
 import Long from 'long';
 
 import { GovAddNewMarketParams, LocalWallet, ProposalStatus } from '../src';
@@ -30,6 +31,7 @@ const MOCK_DATA: GovAddNewMarketParams = {
   // x/perpetuals
   liquidityTier: 2,
   atomicResolution: -1,
+  marketType: PerpetualMarketType.PERPETUAL_MARKET_TYPE_CROSS,
 
   // x/clob
   quantumConversionExponent: -9,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dydxprotocol/v4-client-js",
-  "version": "1.0.28",
+  "version": "1.1.1",
   "description": "General client library for the new dYdX system (v4 decentralized)",
   "main": "build/src/index.js",
   "scripts": {
@@ -37,7 +37,7 @@
     "@cosmjs/stargate": "^0.32.1",
     "@cosmjs/tendermint-rpc": "^0.32.1",
     "@cosmjs/utils": "^0.32.1",
-    "@dydxprotocol/v4-proto": "4.0.0-dev.0",
+    "@dydxprotocol/v4-proto": "5.0.0-dev.0",
     "@osmonauts/lcd": "^0.6.0",
     "@scure/bip32": "^1.1.5",
     "@scure/bip39": "^1.1.1",

package/src/clients/composite-client.ts

@@ -1065,6 +1065,7 @@ export class CompositeClient {
         params.ticker,
         params.atomicResolution,
         params.liquidityTier,
+        params.marketType,
       );
 
       // x/clob.MsgCreateClobPair

package/src/clients/modules/composer.ts

@@ -10,6 +10,7 @@ import {
   MsgUpdateClobPair,
 } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/tx';
 import { MsgDelayMessage } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/delaymsg/tx';
+import { PerpetualMarketType } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/perpetuals/perpetual';
 import { MsgCreatePerpetual } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/perpetuals/tx';
 import { MsgCreateOracleMarket } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/prices/tx';
 import { MsgSend } from 'cosmjs-types/cosmos/bank/v1beta1/tx';
@@ -342,6 +343,7 @@ export class Composer {
     ticker: string,
     atomicResolution: number,
     liquidityTier: number,
+    marketType: PerpetualMarketType,
   ): EncodeObject {
     const msg: MsgCreatePerpetual = {
       // uses x/gov module account since creating the perpetual is a governance action.
@@ -353,6 +355,7 @@ export class Composer {
         atomicResolution,
         defaultFundingPpm: 0, // default funding should be 0 to start.
         liquidityTier,
+        marketType,
       },
     };
 

package/src/clients/modules/get.ts

@@ -13,6 +13,7 @@ import { Any } from 'cosmjs-types/google/protobuf/any';
 import Long from 'long';
 import protobuf from 'protobufjs';
 
+import { ByteArrayEncoding, encodeJson } from '../../lib/helpers';
 import { PAGE_REQUEST } from '../constants';
 import { UnexpectedClientError } from '../lib/errors';
 import {
@@ -504,7 +505,7 @@ export class Get {
     return GovV1Module.QueryProposalsResponse.decode(data);
   }
 
-  async GetWithdrawalAndTransferGatingStatus(
+  async getWithdrawalAndTransferGatingStatus(
   ): Promise<SubaccountsModule.QueryGetWithdrawalAndTransfersBlockedInfoResponse> {
     const requestData = Uint8Array.from(
       SubaccountsModule.QueryGetWithdrawalAndTransfersBlockedInfoRequest
@@ -536,7 +537,8 @@ export class Get {
       requestData,
     );
 
-    return RateLimitModule.QueryCapacityByDenomResponse.decode(data);
+    const decodedResponse = RateLimitModule.QueryCapacityByDenomResponse.decode(data);
+    return JSON.parse(encodeJson(decodedResponse, ByteArrayEncoding.BIGINT));
   }
 
   private async sendQuery(requestUrl: string, requestData: Uint8Array): Promise<Uint8Array> {

package/src/clients/native.ts

@@ -1184,3 +1184,23 @@ export async function cctpWithdraw(squidPayload: string): Promise<String> {
     return wrappedError(error);
   }
 }
+
+export async function getWithdrawalCapacityByDenom(denom: string): Promise<string> {
+  try {
+    const validatorClient = globalThis.client.validatorClient;
+    const result = await validatorClient.get.getWithdrawalCapacityByDenom(denom);
+    return encodeJson(result, ByteArrayEncoding.BIGINT);
+  } catch (e) {
+    return wrappedError(e);
+  }
+}
+
+export async function getWithdrawalAndTransferGatingStatus(): Promise<string> {
+  try {
+    const validatorClient = globalThis.client.validatorClient;
+    const result = await validatorClient.get.getWithdrawalAndTransferGatingStatus();
+    return encodeJson(result, ByteArrayEncoding.BIGINT);
+  } catch (e) {
+    return wrappedError(e);
+  }
+}

package/src/clients/types.ts

@@ -1,6 +1,7 @@
 import { Coin } from '@cosmjs/proto-signing';
 import { Method } from '@cosmjs/tendermint-rpc';
 import { Order_ConditionType, Order_Side, Order_TimeInForce } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/order';
+import { PerpetualMarketType } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/perpetuals/perpetual';
 import BigNumber from 'bignumber.js';
 import Long from 'long';
 
@@ -111,6 +112,7 @@ export type SquidIBCPayload = {
 };
 
 // ------------ x/gov: Add New Market ------------ //
+
 export type GovAddNewMarketParams = {
   // common
   id: number;
@@ -125,6 +127,7 @@ export type GovAddNewMarketParams = {
   // x/perpetuals
   liquidityTier: number;
   atomicResolution: number;
+  marketType: PerpetualMarketType;
 
   // x/clob
   quantumConversionExponent: number;

package/src/codegen/helpers.ts

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

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