Merge branch 'main' into samtin0x/update-v2-docs

.github/CODEOWNERS

@@ -1,5 +1,6 @@
 v4-client-cpp/ @asnefedovv @dydxprotocol/eng
 v4-client-py/ @kaloureyes3 @dydxprotocol/eng
-v4-client-py-v2/ @samtin0x @therustmonk @piwonskp @dydxprotocol/eng
+v4-client-py-v2/ @dydxprotocol/engineering @dydxprotocol/nethermind
+v4-client-rs/ @dydxprotocol/engineering @dydxprotocol/nethermind
 
 * @dydxprotocol/eng

.github/workflows/commitlint.yml

@@ -2,7 +2,8 @@ name: "[v4-client-js] Conventional PR Title"
 on:
   pull_request:
     types: ['opened', 'edited', 'reopened', 'synchronize']
-
+    paths:
+      - 'v4-client-js/**'
 jobs:
   conventional-pr-title:
     runs-on: ubuntu-latest

v4-client-js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dydxprotocol/v4-client-js",
-  "version": "1.3.7",
+  "version": "1.3.11",
   "description": "General client library for the new dYdX system (v4 decentralized)",
   "main": "build/src/index.js",
   "scripts": {

v4-client-js/src/clients/composite-client.ts

@@ -1207,4 +1207,14 @@ export class CompositeClient {
 
     return this.send(wallet, () => msg, false, undefined, memo);
   }
+
+  async createMarketPermissionless(
+    subaccount: SubaccountInfo,
+    ticker: string,
+    broadcastMode?: BroadcastMode,
+    gasAdjustment?: number,
+    memo?: string,
+  ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
+    return this.validatorClient.post.createMarketPermissionless(ticker, subaccount, broadcastMode, gasAdjustment, memo);
+  }
 }

v4-client-js/src/clients/constants.ts

@@ -85,6 +85,9 @@ export const TYPE_URL_MSG_UPDATE_CLOB_PAIR = '/dydxprotocol.clob.MsgUpdateClobPa
 // x/delaymsg
 export const TYPE_URL_MSG_DELAY_MESSAGE = '/dydxprotocol.delaymsg.MsgDelayMessage';
 
+// x/listing
+export const TYPE_URL_MSG_CREATE_MARKET_PERMISSIONLESS = '/dydxprotocol.listing.MsgCreateMarketPermissionless';
+
 // x/perpetuals
 export const TYPE_URL_MSG_CREATE_PERPETUAL = '/dydxprotocol.perpetuals.MsgCreatePerpetual';
 
@@ -97,6 +100,9 @@ export const TYPE_URL_MSG_WITHDRAW_FROM_SUBACCOUNT =
   '/dydxprotocol.sending.MsgWithdrawFromSubaccount';
 export const TYPE_URL_MSG_DEPOSIT_TO_SUBACCOUNT = '/dydxprotocol.sending.MsgDepositToSubaccount';
 
+// x/affiliates
+export const TYPE_URL_MSG_REGISTER_AFFILIATE = '/dydxprotocol.affiliates.MsgRegisterAffiliate';
+
 // x/vault
 export const TYPE_URL_MSG_DEPOSIT_TO_MEGAVAULT = '/dydxprotocol.vault.MsgDepositToMegavault';
 export const TYPE_URL_MSG_WITHDRAW_FROM_MEGAVAULT = '/dydxprotocol.vault.MsgWithdrawFromMegavault';

v4-client-js/src/clients/helpers/request-helpers.ts

@@ -1,3 +1,6 @@
+import Long from "long";
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
 export function generateQueryPath(url: string, params: {}): string {
   const definedEntries = Object.entries(params).filter(
     ([_key, value]: [string, unknown]) => value !== undefined,
@@ -12,3 +15,57 @@ export function generateQueryPath(url: string, params: {}): string {
     .join('&');
   return `${url}?${paramsString}`;
 }
+
+export function parseToPrimitives<T>(x: T): T {
+  if (typeof x === 'number' || typeof x === 'string' || typeof x === 'boolean' || x === null) {
+    return x;
+  }
+
+  if (Array.isArray(x)) {
+    return x.map((item) => parseToPrimitives(item)) as T;
+  }
+
+  if (Long.isLong(x)) {
+    return x.toString() as T;
+  }
+
+  if (x instanceof Uint8Array) {
+    return bytesToBigInt(x).toString() as T;
+  }
+
+  if (x instanceof Date) {
+    return x.toString() as T;
+  }
+
+  if (typeof x === 'object') {
+    const parsedObj: { [key: string]: any } = {};
+    // eslint-disable-next-line no-restricted-syntax
+    for (const key in x) {
+      if (Object.prototype.hasOwnProperty.call(x, key)) {
+        parsedObj[key] = parseToPrimitives((x as any)[key]);
+      }
+    }
+    return parsedObj as T;
+  }
+
+  if (typeof x === 'bigint') {
+    return x.toString() as T;
+  }
+
+  throw new Error(`Unsupported data type: ${typeof x}`);
+}
+
+/**
+ * Converts a byte array (representing an arbitrary-size signed integer) into a bigint.
+ * @param u Array of bytes represented as a Uint8Array.
+ */
+function bytesToBigInt(u: Uint8Array): bigint {
+  if (u.length <= 1) {
+    return BigInt(0);
+  }
+  // eslint-disable-next-line no-bitwise
+  const negated: boolean = (u[0] & 1) === 1;
+  const hex: string = Buffer.from(u.slice(1)).toString('hex');
+  const abs: bigint = BigInt(`0x${hex}`);
+  return negated ? -abs : abs;
+}

v4-client-js/src/clients/lib/registry.ts

@@ -1,5 +1,6 @@
 import { GeneratedType, Registry } from '@cosmjs/proto-signing';
 import { defaultRegistryTypes } from '@cosmjs/stargate';
+import { MsgRegisterAffiliate } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/affiliates/tx';
 import {
   MsgPlaceOrder,
   MsgCancelOrder,
@@ -8,6 +9,7 @@ import {
   MsgBatchCancel,
 } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/tx';
 import { MsgDelayMessage } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/delaymsg/tx';
+import { MsgCreateMarketPermissionless } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/listing/tx';
 import { MsgCreatePerpetual } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/perpetuals/tx';
 import { MsgCreateOracleMarket } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/prices/tx';
 import {
@@ -34,6 +36,8 @@ import {
   TYPE_URL_BATCH_CANCEL,
   TYPE_URL_MSG_DEPOSIT_TO_MEGAVAULT,
   TYPE_URL_MSG_WITHDRAW_FROM_MEGAVAULT,
+  TYPE_URL_MSG_REGISTER_AFFILIATE,
+  TYPE_URL_MSG_CREATE_MARKET_PERMISSIONLESS,
 } from '../constants';
 
 export const registry: ReadonlyArray<[string, GeneratedType]> = [];
@@ -49,6 +53,9 @@ export function generateRegistry(): Registry {
     // delaymsg
     [TYPE_URL_MSG_DELAY_MESSAGE, MsgDelayMessage as GeneratedType],
 
+    // listing
+    [TYPE_URL_MSG_CREATE_MARKET_PERMISSIONLESS, MsgCreateMarketPermissionless as GeneratedType],
+
     // perpetuals
     [TYPE_URL_MSG_CREATE_PERPETUAL, MsgCreatePerpetual as GeneratedType],
 
@@ -58,11 +65,15 @@ export function generateRegistry(): Registry {
     // vaults
     [TYPE_URL_MSG_DEPOSIT_TO_MEGAVAULT, MsgDepositToMegavault as GeneratedType],
     [TYPE_URL_MSG_WITHDRAW_FROM_MEGAVAULT, MsgWithdrawFromMegavault as GeneratedType],
+
     // sending
     [TYPE_URL_MSG_CREATE_TRANSFER, MsgCreateTransfer as GeneratedType],
     [TYPE_URL_MSG_WITHDRAW_FROM_SUBACCOUNT, MsgWithdrawFromSubaccount as GeneratedType],
     [TYPE_URL_MSG_DEPOSIT_TO_SUBACCOUNT, MsgDepositToSubaccount as GeneratedType],
 
+    // affiliates
+    [TYPE_URL_MSG_REGISTER_AFFILIATE, MsgRegisterAffiliate as GeneratedType],
+
     // default types
     ...defaultRegistryTypes,
   ]);

v4-client-js/src/clients/modules/composer.ts

@@ -7,6 +7,7 @@ import {
   MsgDelegate,
   MsgUndelegate,
 } from '@dydxprotocol/v4-proto/src/codegen/cosmos/staking/v1beta1/tx';
+import { MsgRegisterAffiliate } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/affiliates/tx';
 import { ClobPair_Status } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/clob_pair';
 import {
   MsgBatchCancel,
@@ -47,8 +48,10 @@ import {
   TYPE_URL_MSG_UNDELEGATE,
   TYPE_URL_MSG_WITHDRAW_DELEGATOR_REWARD,
   TYPE_URL_BATCH_CANCEL,
+  TYPE_URL_MSG_REGISTER_AFFILIATE,
   TYPE_URL_MSG_DEPOSIT_TO_MEGAVAULT,
   TYPE_URL_MSG_WITHDRAW_FROM_MEGAVAULT,
+  TYPE_URL_MSG_CREATE_MARKET_PERMISSIONLESS,
 } from '../constants';
 import { DenomConfig } from '../types';
 import {
@@ -60,6 +63,7 @@ import {
   MsgPlaceOrder,
   MsgCancelOrder,
   SubaccountId,
+  MsgCreateMarketPermissionless,
   MsgCreateTransfer,
   Transfer,
   MsgDepositToSubaccount,
@@ -536,6 +540,41 @@ export class Composer {
     };
   }
 
+  // ------------ x/affiliates ------------
+  public composeMsgRegisterAffiliate(referee: string, affiliate: string): EncodeObject {
+    const msg: MsgRegisterAffiliate = {
+      referee,
+      affiliate,
+    };
+
+    return {
+      typeUrl: TYPE_URL_MSG_REGISTER_AFFILIATE,
+      value: msg,
+    };
+  }
+
+  // ------------ x/listing ------------
+  public composeMsgCreateMarketPermissionless(
+    address: string,
+    ticker: string,
+    subaccountNumber: number,
+  ): EncodeObject {
+    const subaccountId: SubaccountId = {
+      owner: address,
+      number: subaccountNumber,
+    };
+
+    const msg: MsgCreateMarketPermissionless = {
+      ticker,
+      subaccountId
+    };
+
+    return {
+      typeUrl: TYPE_URL_MSG_CREATE_MARKET_PERMISSIONLESS,
+      value: msg,
+    }
+  }
+
   // ------------ util ------------
   public validateGoodTilBlockAndTime(
     orderFlags: number,

v4-client-js/src/clients/modules/get.ts

@@ -17,6 +17,7 @@ import { bigIntToBytes } from '../../lib/helpers';
 import { PAGE_REQUEST } from '../constants';
 import { UnexpectedClientError } from '../lib/errors';
 import {
+  AffiliateModule,
   BridgeModule,
   ClobModule,
   DistributionModule,
@@ -559,6 +560,56 @@ export class Get {
     return VaultModule.QueryMegavaultWithdrawalInfoResponse.decode(data);
   }
 
+  async getAffiliateInfo(address: string): Promise<AffiliateModule.AffiliateInfoResponse> {
+    const requestData = Uint8Array.from(
+      AffiliateModule.AffiliateInfoRequest.encode({
+        address,
+      }).finish(),
+    );
+
+    const data = await this.sendQuery('/dydxprotocol.affiliates.Query/AffiliateInfo', requestData);
+
+    return AffiliateModule.AffiliateInfoResponse.decode(data);
+  }
+
+  async getReferredBy(address: string): Promise<AffiliateModule.ReferredByResponse> {
+    const requestData = Uint8Array.from(
+      AffiliateModule.ReferredByRequest.encode({
+        address,
+      }).finish(),
+    );
+
+    const data = await this.sendQuery('/dydxprotocol.affiliates.Query/ReferredBy', requestData);
+
+    return AffiliateModule.ReferredByResponse.decode(data);
+  }
+
+  async getAllAffiliateTiers(): Promise<AffiliateModule.AllAffiliateTiersResponse> {
+    const requestData = Uint8Array.from(
+      AffiliateModule.AllAffiliateTiersRequest.encode({}).finish(),
+    );
+
+    const data = await this.sendQuery(
+      '/dydxprotocol.affiliates.Query/AllAffiliateTiers',
+      requestData,
+    );
+
+    return AffiliateModule.AllAffiliateTiersResponse.decode(data);
+  }
+
+  async getAffiliateWhitelist(): Promise<AffiliateModule.AffiliateWhitelistResponse> {
+    const requestData = Uint8Array.from(
+      AffiliateModule.AffiliateWhitelistRequest.encode({}).finish(),
+    );
+
+    const data = await this.sendQuery(
+      '/dydxprotocol.affiliates.Query/AffiliateWhitelist',
+      requestData,
+    );
+
+    return AffiliateModule.AffiliateWhitelistResponse.decode(data);
+  }
+
   private async sendQuery(requestUrl: string, requestData: Uint8Array): Promise<Uint8Array> {
     // eslint-disable-next-line max-len
     const resp: QueryAbciResponse = await this.stargateQueryClient.queryAbci(