@dydxprotocol/v4-client-js 1.0.14 → 1.0.16

package/src/clients/modules/composer.ts

@@ -1,9 +1,40 @@
-import { EncodeObject } from '@cosmjs/proto-signing';
+import { EncodeObject, Registry } from '@cosmjs/proto-signing';
+import {
+  MsgSubmitProposal,
+} from '@dydxprotocol/v4-proto/src/codegen/cosmos/gov/v1/tx';
+import {
+  ClobPair_Status,
+} from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/clob_pair';
+import {
+  MsgCreateClobPair,
+  MsgUpdateClobPair,
+} from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/tx';
+import { MsgDelayMessage } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/delaymsg/tx';
+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';
 import { Coin } from 'cosmjs-types/cosmos/base/v1beta1/coin';
+import { Any } from 'cosmjs-types/google/protobuf/any';
 import Long from 'long';
 import protobuf from 'protobufjs';
 
+import {
+  GOV_MODULE_ADDRESS,
+  DELAYMSG_MODULE_ADDRESS,
+  TYPE_URL_MSG_SEND,
+  TYPE_URL_MSG_SUBMIT_PROPOSAL,
+  TYPE_URL_MSG_PLACE_ORDER,
+  TYPE_URL_MSG_CANCEL_ORDER,
+  TYPE_URL_MSG_CREATE_CLOB_PAIR,
+  TYPE_URL_MSG_UPDATE_CLOB_PAIR,
+  TYPE_URL_MSG_DELAY_MESSAGE,
+  TYPE_URL_MSG_CREATE_PERPETUAL,
+  TYPE_URL_MSG_CREATE_ORACLE_MARKET,
+  TYPE_URL_MSG_CREATE_TRANSFER,
+  TYPE_URL_MSG_WITHDRAW_FROM_SUBACCOUNT,
+  TYPE_URL_MSG_DEPOSIT_TO_SUBACCOUNT,
+} from '../constants';
+import { DenomConfig } from '../types';
 import {
   OrderId,
   Order,
@@ -23,6 +54,8 @@ protobuf.util.Long = Long;
 protobuf.configure();
 
 export class Composer {
+
+  // ------------ x/clob ------------
   public composeMsgPlaceOrder(
     address: string,
     subaccountNumber: number,
@@ -70,7 +103,7 @@ export class Composer {
       order,
     };
     return {
-      typeUrl: '/dydxprotocol.clob.MsgPlaceOrder',
+      typeUrl: TYPE_URL_MSG_PLACE_ORDER,
       value: msg,
     };
   }
@@ -105,11 +138,68 @@ export class Composer {
     };
 
     return {
-      typeUrl: '/dydxprotocol.clob.MsgCancelOrder',
+      typeUrl: TYPE_URL_MSG_CANCEL_ORDER,
       value: msg,
     };
   }
 
+  public composeMsgCreateClobPair(
+    clobId: number,
+    perpetualId: number,
+    quantumConversionExponent: number,
+    stepBaseQuantums: Long,
+    subticksPerTick: number,
+  ): EncodeObject {
+    const msg: MsgCreateClobPair = {
+      // uses x/gov module account since creating the clob pair is a governance action.
+      authority: GOV_MODULE_ADDRESS,
+      clobPair: {
+        id: clobId,
+        perpetualClobMetadata: {
+          perpetualId,
+        },
+        quantumConversionExponent,
+        stepBaseQuantums,
+        subticksPerTick,
+        status: ClobPair_Status.STATUS_INITIALIZING,
+      },
+    };
+
+    return {
+      typeUrl: TYPE_URL_MSG_CREATE_CLOB_PAIR,
+      value: msg,
+    };
+  }
+
+  public composeMsgUpdateClobPair(
+    clobId: number,
+    perpetualId: number,
+    quantumConversionExponent: number,
+    stepBaseQuantums: Long,
+    subticksPerTick: number,
+  ): EncodeObject {
+    const msg: MsgUpdateClobPair = {
+      // uses x/delaymsg module account since updating the clob pair is a delayedmsg action.
+      authority: DELAYMSG_MODULE_ADDRESS,
+      clobPair: {
+        id: clobId,
+        perpetualClobMetadata: {
+          perpetualId,
+        },
+        quantumConversionExponent,
+        stepBaseQuantums,
+        subticksPerTick,
+        status: ClobPair_Status.STATUS_ACTIVE,
+      },
+    };
+
+    return {
+      typeUrl: TYPE_URL_MSG_UPDATE_CLOB_PAIR,
+      value: msg,
+    };
+  }
+
+  // ------------ x/sending ------------
   public composeMsgTransfer(
     address: string,
     subaccountNumber: number,
@@ -139,7 +229,7 @@ export class Composer {
     };
 
     return {
-      typeUrl: '/dydxprotocol.sending.MsgCreateTransfer',
+      typeUrl: TYPE_URL_MSG_CREATE_TRANSFER,
       value: msg,
     };
   }
@@ -163,7 +253,7 @@ export class Composer {
     };
 
     return {
-      typeUrl: '/dydxprotocol.sending.MsgDepositToSubaccount',
+      typeUrl: TYPE_URL_MSG_DEPOSIT_TO_SUBACCOUNT,
       value: msg,
     };
   }
@@ -188,11 +278,12 @@ export class Composer {
     };
 
     return {
-      typeUrl: '/dydxprotocol.sending.MsgWithdrawFromSubaccount',
+      typeUrl: TYPE_URL_MSG_WITHDRAW_FROM_SUBACCOUNT,
       value: msg,
     };
   }
 
+  // ------------ x/bank ------------
   public composeMsgSendToken(
     address: string,
     recipient: string,
@@ -211,11 +302,117 @@ export class Composer {
     };
 
     return {
-      typeUrl: '/cosmos.bank.v1beta1.MsgSend',
+      typeUrl: TYPE_URL_MSG_SEND,
+      value: msg,
+    };
+  }
+
+  // ------------ x/prices ------------
+  public composeMsgCreateOracleMarket(
+    marketId: number,
+    pair: string,
+    exponent: number,
+    minExchanges: number,
+    minPriceChangePpm: number,
+    exchangeConfigJson: string,
+  ): EncodeObject {
+    const msg: MsgCreateOracleMarket = {
+      // uses x/gov module account since creating the oracle market is a governance action.
+      authority: GOV_MODULE_ADDRESS,
+      params: {
+        id: marketId,
+        pair,
+        exponent,
+        minExchanges,
+        minPriceChangePpm,
+        exchangeConfigJson,
+      },
+    };
+
+    return {
+      typeUrl: TYPE_URL_MSG_CREATE_ORACLE_MARKET,
       value: msg,
     };
   }
 
+  // ------------ x/perpetuals ------------
+  public composeMsgCreatePerpetual(
+    perpetualId: number,
+    marketId: number,
+    ticker: string,
+    atomicResolution: number,
+    liquidityTier: number,
+  ): EncodeObject {
+    const msg: MsgCreatePerpetual = {
+      // uses x/gov module account since creating the perpetual is a governance action.
+      authority: GOV_MODULE_ADDRESS,
+      params: {
+        id: perpetualId,
+        marketId,
+        ticker,
+        atomicResolution,
+        defaultFundingPpm: 0, // default funding should be 0 to start.
+        liquidityTier,
+      },
+    };
+
+    return {
+      typeUrl: TYPE_URL_MSG_CREATE_PERPETUAL,
+      value: msg,
+    };
+  }
+
+  // ------------ x/delaymsg ------------
+  public composeMsgDelayMessage(
+    embeddedMsg: EncodeObject,
+    delayBlocks: number,
+  ): EncodeObject {
+    const msg: MsgDelayMessage = {
+      // all msgs sent to x/delay must be from x/gov module account.
+      authority: GOV_MODULE_ADDRESS,
+      msg: embeddedMsg,
+      delayBlocks,
+    };
+
+    return {
+      typeUrl: TYPE_URL_MSG_DELAY_MESSAGE,
+      value: msg,
+    };
+  }
+
+  // ------------ x/gov ------------
+  public composeMsgSubmitProposal(
+    title: string,
+    initialDepositAmount: number,
+    initialDepositDenomConfig: DenomConfig,
+    summary: string,
+    messages: EncodeObject[],
+    proposer: string,
+    metadata: string = '',
+    expedited: boolean = false,
+  ): EncodeObject {
+    const initialDeposit: Coin[] = [{
+      amount: initialDepositAmount.toString(),
+      denom: initialDepositDenomConfig.CHAINTOKEN_DENOM,
+    }];
+
+    const msg: MsgSubmitProposal = {
+      title,
+      initialDeposit,
+      summary,
+      messages,
+      proposer,
+      metadata,
+      expedited,
+    };
+
+    return {
+      typeUrl: TYPE_URL_MSG_SUBMIT_PROPOSAL,
+      value: msg,
+    };
+  }
+
+  // ------------ util ------------
   public validateGoodTilBlockAndTime(
     orderFlags: number,
     goodTilBlock: number,
@@ -227,4 +424,18 @@ export class Composer {
       throw new Error('goodTilBlockTime must be set if orderFlags is not 0');
     }
   }
+
+  public wrapMessageAsAny(registry: Registry, message: EncodeObject): Any {
+    return registry.encodeAsAny(message);
+  }
+
+  public wrapMessageArrAsAny(
+    registry: Registry,
+    messages: EncodeObject[],
+  ): Any[] {
+    const encodedMessages: Any[] = messages.map(
+      (message: EncodeObject) => this.wrapMessageAsAny(registry, message),
+    );
+    return encodedMessages;
+  }
 }

package/src/clients/modules/get.ts

@@ -19,8 +19,10 @@ import {
   BridgeModule,
   ClobModule,
   FeeTierModule,
+  GovV1Module,
   PerpetualsModule,
   PricesModule,
+  ProposalStatus,
   RewardsModule,
   StakingModule,
   StatsModule,
@@ -365,7 +367,7 @@ export class Get {
    */
   async getEquityTierLimitConfiguration(): Promise<
     ClobModule.QueryEquityTierLimitConfigurationResponse
-    > {
+  > {
     const requestData: Uint8Array = Uint8Array.from(
       ClobModule.QueryEquityTierLimitConfigurationRequest.encode({})
         .finish(),
@@ -470,9 +472,40 @@ export class Get {
     return StakingModule.QueryValidatorsResponse.decode(data);
   }
 
+  /**
+   * @description Get all gov proposals.
+   *
+   * @param proposalStatus Status of the proposal to filter by.
+   * @param voter Voter to filter by.
+   * @param depositor Depositor to filter by.
+   *
+   * @returns All gov proposals that match the filters above.
+   */
+  async getAllGovProposals(
+    proposalStatus: ProposalStatus = ProposalStatus.PROPOSAL_STATUS_VOTING_PERIOD,
+    voter: string = '',
+    depositor: string = '',
+  ): Promise<GovV1Module.QueryProposalsResponse> {
+    const requestData = Uint8Array.from(
+      GovV1Module.QueryProposalsRequest
+        .encode({
+          proposalStatus,
+          voter,
+          depositor,
+          pagination: PAGE_REQUEST,
+        })
+        .finish(),
+    );
+    const data: Uint8Array = await this.sendQuery(
+      '/cosmos.gov.v1.Query/Proposals',
+      requestData,
+    );
+    return GovV1Module.QueryProposalsResponse.decode(data);
+  }
+
   private async sendQuery(requestUrl: string, requestData: Uint8Array): Promise<Uint8Array> {
-    const resp: QueryAbciResponse = await
-    this.stargateQueryClient.queryAbci(requestUrl, requestData);
+    // eslint-disable-next-line max-len
+    const resp: QueryAbciResponse = await this.stargateQueryClient.queryAbci(requestUrl, requestData);
     return resp.value;
   }
 }

package/src/clients/modules/proto-includes.ts

@@ -1,15 +1,17 @@
+export * as GovV1Module from '@dydxprotocol/v4-proto/src/codegen/cosmos/gov/v1/query';
+export * as StatsModule from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/stats/query';
+
 export * as ClobModule from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/query';
 export * as PerpetualsModule from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/perpetuals/query';
 export * as PricesModule from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/prices/query';
-export * as SubaccountsModule
-from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/subaccounts/query';
+export * as SubaccountsModule from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/subaccounts/query';
 export * as FeeTierModule from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/feetiers/query';
-export * as StatsModule from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/stats/query';
 export * as RewardsModule from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/rewards/query';
 export * as StakingModule from '@dydxprotocol/v4-proto/src/codegen/cosmos/staking/v1beta1/query';
 export * as BridgeModule from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/bridge/query';
 
 export * from '@dydxprotocol/v4-proto/src/codegen/cosmos/base/abci/v1beta1/abci';
+export * from '@dydxprotocol/v4-proto/src/codegen/cosmos/gov/v1/gov';
 export * from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/order';
 export * from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/tx';
 export * from '@dydxprotocol/v4-proto/src/codegen/google/protobuf/any';

package/src/clients/native.ts

@@ -1112,7 +1112,7 @@ export async function withdrawToNobleIBC(payload: string): Promise<String> {
         ...parsedIbcPayload.msg,
         // Squid returns timeoutTimestamp as Long, but the signer expects BigInt
         timeoutTimestamp: parsedIbcPayload.msg.timeoutTimestamp
-          ? BigInt(Long.fromValue(json.msg.timeoutTimestamp).toString())
+          ? BigInt(Long.fromValue(parsedIbcPayload.msg.timeoutTimestamp).toString())
           : undefined,
       },
     };

package/src/clients/types.ts

@@ -96,6 +96,7 @@ export interface ComplianceResponse {
   restricted: boolean;
 }
 
+// ------------ Squid ------------ //
 export type SquidIBCPayload = {
   msgTypeUrl: '/ibc.applications.transfer.v1.MsgTransfer';
   msg: Partial<{
@@ -109,4 +110,29 @@ export type SquidIBCPayload = {
   }>;
 };
 
+// ------------ x/gov: Add New Market ------------ //
+export type GovAddNewMarketParams = {
+  // common
+  id: number;
+  ticker: string;
+
+  // x/prices
+  priceExponent: number;
+  minPriceChange: number;
+  minExchanges: number;
+  exchangeConfigJson: string;
+
+  // x/perpetuals
+  liquidityTier: number;
+  atomicResolution: number;
+
+  // x/clob
+  quantumConversionExponent: number;
+  stepBaseQuantums: Long;
+  subticksPerTick: number;
+
+  // x/delaymsg
+  delayBlocks: number;
+};
+
 export * from './modules/proto-includes';

package/src/lib/helpers.ts

@@ -65,7 +65,7 @@ export function encodeJson(
     if (value instanceof BigNumber) {
       return value.toString();
     }
-    if (value instanceof BigInt) {
+    if (typeof value === 'bigint') {
       return value.toString();
     }
     if (value instanceof Long) {

package/src/lib/utils.ts

@@ -43,3 +43,27 @@ export function clientIdFromString(
 export async function sleep(ms: number): Promise<void> {
   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: string): string {
+  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: 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.`;
+}