@ritbit/v4-client-js 1.3.17

package/commitlint.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'subject-case': [0, 'never'],
+    'header-max-length': [2, 'always', 120],
+    'body-max-line-length': [0, 'always', 120],
+  },
+};

package/examples/account_endpoints.ts

@@ -0,0 +1,129 @@
+/**
+ * Simple JS example demostrating accessing subaccount data with Indexer REST endpoints
+ */
+
+import { Network } from '../src/clients/constants';
+import { IndexerClient } from '../src/clients/indexer-client';
+import { DYDX_TEST_ADDRESS } from './constants';
+
+async function test(): Promise<void> {
+  const client = new IndexerClient(Network.testnet().indexerConfig);
+  const address = DYDX_TEST_ADDRESS;
+
+  // Get subaccounts
+  try {
+    const response = await client.account.getSubaccounts(address);
+    console.log(response);
+    const subaccounts = response.subaccounts;
+    console.log(subaccounts);
+    const subaccount = subaccounts[0];
+    const subaccountNumber = subaccount.subaccountNumber;
+    console.log(subaccountNumber);
+  } catch (error) {
+    console.log(error.message);
+  }
+
+  // Get subaccount 0
+  try {
+    const response = await client.account.getSubaccount(address, 0);
+    console.log(response);
+    const subaccount = response.subaccount;
+    console.log(subaccount);
+    const subaccountNumber = subaccount.subaccountNumber;
+    console.log(subaccountNumber);
+  } catch (error) {
+    console.log(error.message);
+  }
+
+  // Get asset positions
+  try {
+    const response = await client.account.getSubaccountAssetPositions(address, 0);
+    console.log(response);
+    const positions = response.positions;
+    console.log(positions);
+    if (positions.length > 0) {
+      const positions0 = positions[0];
+      console.log(positions0);
+    }
+  } catch (error) {
+    console.log(error.message);
+  }
+
+  // Get perp positions
+  try {
+    const response = await client.account.getSubaccountPerpetualPositions(address, 0);
+    console.log(response);
+    const positions = response.positions;
+    console.log(positions);
+    if (positions.length > 0) {
+      const positions0 = positions[0];
+      console.log(positions0);
+    }
+  } catch (error) {
+    console.log(error.message);
+  }
+
+  // Get transfers
+  try {
+    const response = await client.account.getSubaccountTransfers(address, 0);
+    console.log(response);
+    const transfers = response.transfers;
+    console.log(transfers);
+    if (transfers.length > 0) {
+      const transfer0 = transfers[0];
+      console.log(transfer0);
+    }
+  } catch (error) {
+    console.log(error.message);
+  }
+
+  // Get orders
+  try {
+    const response = await client.account.getSubaccountOrders(address, 0);
+    console.log(response);
+    const orders = response;
+    console.log(orders);
+    if (orders.length > 0) {
+      const order0 = orders[0];
+      console.log(order0);
+      const order0Id = order0.id;
+      console.log(order0Id);
+    }
+  } catch (error) {
+    console.log(error.message);
+  }
+
+  // Get fills
+  try {
+    const response = await client.account.getSubaccountFills(address, 0);
+    console.log(response);
+    const fills = response.fills;
+    console.log(fills);
+    if (fills.length > 0) {
+      const fill0 = fills[0];
+      console.log(fill0);
+    }
+  } catch (error) {
+    console.log(error.message);
+  }
+
+  // Get historical pnl
+  try {
+    const response = await client.account.getSubaccountHistoricalPNLs(address, 0);
+    console.log(response);
+    const historicalPnl = response.historicalPnl;
+    console.log(historicalPnl);
+    if (historicalPnl.length > 0) {
+      const historicalPnl0 = historicalPnl[0];
+      console.log(historicalPnl0);
+    }
+  } catch (error) {
+    console.log(error.message);
+  }
+}
+
+test()
+  .then(() => {})
+  .catch((error) => {
+    console.log(error.message);
+  });

package/examples/batch_cancel_orders_example.ts

@@ -0,0 +1,130 @@
+import _ from 'lodash';
+
+import { BECH32_PREFIX, Order_TimeInForce } from '../src';
+import { CompositeClient, OrderBatchWithMarketId } from '../src/clients/composite-client';
+import { Network, OrderSide } from '../src/clients/constants';
+import LocalWallet from '../src/clients/modules/local-wallet';
+import { SubaccountInfo } from '../src/clients/subaccount';
+import { randomInt, sleep } from '../src/lib/utils';
+import { DYDX_TEST_MNEMONIC, MAX_CLIENT_ID } from './constants';
+
+type OrderInfo = {
+  marketId: string;
+  clientId: number;
+  side: OrderSide;
+  price: number;
+  size: number;
+};
+
+const generateShortTermOrdersInfo = (): OrderInfo[] => [
+  {
+    marketId: 'ETH-USD',
+    clientId: randomInt(MAX_CLIENT_ID),
+    side: OrderSide.SELL,
+    price: 4000,
+    size: 0.01,
+  },
+  {
+    marketId: 'ETH-USD',
+    clientId: randomInt(MAX_CLIENT_ID),
+    side: OrderSide.SELL,
+    price: 4200,
+    size: 0.02,
+  },
+  {
+    marketId: 'BTC-USD',
+    clientId: randomInt(MAX_CLIENT_ID),
+    side: OrderSide.BUY,
+    price: 40000,
+    size: 0.01,
+  },
+];
+
+const generateBatchCancelShortTermOrders = (ordersInfo: OrderInfo[]): OrderBatchWithMarketId[] => {
+  const ordersGroupedByMarketIds = _.groupBy(ordersInfo, (info) => info.marketId);
+  return Object.keys(ordersGroupedByMarketIds).map((marketId) => ({
+    marketId,
+    clientIds: ordersGroupedByMarketIds[marketId].map((info) => info.clientId),
+  }));
+};
+
+async function test(): Promise<void> {
+  try {
+    const wallet = await LocalWallet.fromMnemonic(DYDX_TEST_MNEMONIC, BECH32_PREFIX);
+    console.log('**Wallet**', wallet);
+
+    const network = Network.testnet();
+    const client = await CompositeClient.connect(network);
+    console.log('**Client**', client);
+
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
+    const currentBlock = await client.validatorClient.get.latestBlockHeight();
+    const goodTilBlock = currentBlock + 10;
+
+    const shortTermOrdersInfo = generateShortTermOrdersInfo();
+    await placeShortTermOrders(client, subaccount, shortTermOrdersInfo, goodTilBlock);
+    await sleep(5000);
+    await batchCancelOrders(client, subaccount, shortTermOrdersInfo, goodTilBlock);
+  } catch (error) {
+    console.error('**Test Failed**', error.message);
+  }
+}
+
+const placeShortTermOrders = async (
+  client: CompositeClient,
+  subaccount: SubaccountInfo,
+  shortTermOrdersInfo: OrderInfo[],
+  goodTilBlock: number,
+): Promise<void> => {
+  const orderPromises = shortTermOrdersInfo.map(async (order) => {
+    try {
+      const tx = await client.placeShortTermOrder(
+        subaccount,
+        order.marketId,
+        order.side,
+        order.price,
+        order.size,
+        order.clientId,
+        goodTilBlock,
+        Order_TimeInForce.TIME_IN_FORCE_UNSPECIFIED,
+        false,
+      );
+      console.log('**Short Term Order Tx**', tx.hash);
+    } catch (error) {
+      console.error(
+        `**Short Term Order Failed for Market ${order.marketId}, Client ID ${order.clientId}**`,
+        error.message,
+      );
+    }
+  });
+
+  // Wait for all order placements to complete
+  await Promise.all(orderPromises);
+};
+
+const batchCancelOrders = async (
+  client: CompositeClient,
+  subaccount: SubaccountInfo,
+  shortTermOrdersInfo: OrderInfo[],
+  goodTilBlock: number,
+): Promise<void> => {
+  const shortTermOrdersPayload = generateBatchCancelShortTermOrders(shortTermOrdersInfo);
+  try {
+    const tx = await client.batchCancelShortTermOrdersWithMarketId(
+      subaccount,
+      shortTermOrdersPayload,
+      goodTilBlock + 10,
+    );
+    console.log('**Batch Cancel Short Term Orders Tx**', tx);
+  } catch (error) {
+    console.error('**Batch Cancel Short Term Orders Failed**', error.message);
+  }
+};
+
+test()
+  .then(() => {
+    console.log('**Batch Cancel Test Completed Successfully**');
+  })
+  .catch((error) => {
+    console.error('**Batch Cancel Test Execution Error**', error.message);
+  });

package/examples/composite_example.ts

@@ -0,0 +1,65 @@
+import { BECH32_PREFIX } from '../src';
+import { CompositeClient } from '../src/clients/composite-client';
+import {
+  Network,
+  OrderExecution,
+  OrderSide,
+  OrderTimeInForce,
+  OrderType,
+} from '../src/clients/constants';
+import LocalWallet from '../src/clients/modules/local-wallet';
+import { SubaccountInfo } from '../src/clients/subaccount';
+import { randomInt } from '../src/lib/utils';
+import { DYDX_TEST_MNEMONIC, MAX_CLIENT_ID } from './constants';
+import ordersParams from './human_readable_orders.json';
+
+async function sleep(ms: number): Promise<void> {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+async function test(): Promise<void> {
+  const wallet = await LocalWallet.fromMnemonic(DYDX_TEST_MNEMONIC, BECH32_PREFIX);
+  console.log(wallet);
+  const network = Network.testnet();
+  const client = await CompositeClient.connect(network);
+  console.log('**Client**');
+  console.log(client);
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
+  for (const orderParams of ordersParams) {
+    try {
+      const type = OrderType[orderParams.type as keyof typeof OrderType];
+      const side = OrderSide[orderParams.side as keyof typeof OrderSide];
+      const timeInForceString = orderParams.timeInForce ?? 'GTT';
+      const timeInForce = OrderTimeInForce[timeInForceString as keyof typeof OrderTimeInForce];
+      const price = orderParams.price ?? 1350;
+      const timeInForceSeconds = timeInForce === OrderTimeInForce.GTT ? 60 : 0;
+      const postOnly = orderParams.postOnly ?? false;
+      const tx = await client.placeOrder(
+        subaccount,
+        'ETH-USD',
+        type,
+        side,
+        price,
+        0.01,
+        randomInt(MAX_CLIENT_ID),
+        timeInForce,
+        timeInForceSeconds,
+        OrderExecution.DEFAULT,
+        postOnly,
+        false,
+      );
+      console.log('**Order Tx**');
+      console.log(tx);
+    } catch (error) {
+      console.log(error.message);
+    }
+
+    await sleep(5000); // wait for placeOrder to complete
+  }
+}
+
+test()
+  .then(() => {})
+  .catch((error) => {
+    console.log(error.message);
+  });

package/examples/constants.ts

@@ -0,0 +1,42 @@
+import {
+  Order_Side,
+  Order_TimeInForce,
+} from '@ritbit/v4-proto/src/codegen/ritbit/clob/order';
+import Long from 'long';
+
+import { IPlaceOrder, OrderFlags } from '../src/clients/types';
+
+export const DYDX_TEST_ADDRESS = 'dydx14zzueazeh0hj67cghhf9jypslcf9sh2n5k6art';
+export const DYDX_TEST_PRIVATE_KEY =
+  'e92a6595c934c991d3b3e987ea9b3125bf61a076deab3a9cb519787b7b3e8d77';
+export const DYDX_TEST_MNEMONIC =
+  'mirror actor skill push coach wait confirm orchard lunch mobile athlete gossip awake miracle matter bus reopen team ladder lazy list timber render wait';
+export const DYDX_LOCAL_ADDRESS = 'dydx199tqg4wdlnu4qjlxchpd7seg454937hjrknju4';
+export const DYDX_LOCAL_MNEMONIC =
+  'merge panther lobster crazy road hollow amused security before critic about cliff exhibit cause coyote talent happy where lion river tobacco option coconut small';
+
+export const DYDX_TEST_MNEMONIC_2 = 'movie yard still copper exile wear brisk chest ride dizzy novel future menu finish radar lunar claim hub middle force turtle mouse frequent embark';
+
+// dydx1fxu2ndxwju2evh28js0cflkxn5wxzvlhw4gec5
+export const DYDX_TEST_MNEMONIC_3 = 'crane poverty boil edit response weasel quick almost fringe able upon benefit boil boat narrow innocent enter cradle tongue toward luggage awful mention column';
+
+export const MARKET_BTC_USD: string = 'BTC-USD';
+export const PERPETUAL_PAIR_BTC_USD: number = 0;
+
+const quantums: Long = new Long(1_000_000_000);
+const subticks: Long = new Long(1_000_000_000);
+
+export const MAX_CLIENT_ID = 2 ** 32 - 1;
+
+// PlaceOrder variables
+export const defaultOrder: IPlaceOrder = {
+  clientId: 0,
+  orderFlags: OrderFlags.SHORT_TERM,
+  clobPairId: PERPETUAL_PAIR_BTC_USD,
+  side: Order_Side.SIDE_BUY,
+  quantums,
+  subticks,
+  timeInForce: Order_TimeInForce.TIME_IN_FORCE_UNSPECIFIED,
+  reduceOnly: false,
+  clientMetadata: 0,
+};

package/examples/faucet_endpoint.ts

@@ -0,0 +1,24 @@
+/**
+ * Simple JS example demostrating filling subaccount with Faucet API
+ */
+
+import { FaucetApiHost } from '../src/clients/constants';
+import { FaucetClient } from '../src/clients/faucet-client';
+import { DYDX_TEST_ADDRESS } from './constants';
+
+async function test(): Promise<void> {
+  const client = new FaucetClient(FaucetApiHost.TESTNET);
+  const address = DYDX_TEST_ADDRESS;
+
+  // Use faucet to fill subaccount
+  const faucetResponse = await client?.fill(address, 0, 2000);
+  console.log(faucetResponse);
+  const status = faucetResponse.status;
+  console.log(status);
+}
+
+test()
+  .then(() => {})
+  .catch((error) => {
+    console.log(error.message);
+  });

package/examples/gov_add_new_market.json

@@ -0,0 +1,64 @@
+{
+  "title": "Add BONK-USD perpetual market",
+  "deposit": "10000000000000adv4tnt",
+  "summary": "Add the x/prices, x/perpetuals and x/clob parameters needed for a BONK-USD perpetual market. Create the market in INITIALIZING status and transition it to ACTIVE status after 5 blocks.",
+  "messages": [
+    {
+      "@type": "/ritbit.prices.MsgCreateOracleMarket",
+      "authority": "dydx10d07y265gmmuvt4z0w9aw880jnsr700jnmapky",
+      "params": {
+        "id": 34,
+        "pair": "BONK-USD",
+        "exponent": -14,
+        "minExchanges": 3,
+        "minPriceChangePpm": 4000,
+        "exchangeConfigJson": "{\"exchanges\":[{\"exchangeName\":\"Binance\",\"ticker\":\"BONKUSDT\",\"adjustByMarket\":\"USDT-USD\"},{\"exchangeName\":\"Bybit\",\"ticker\":\"BONKUSDT\",\"adjustByMarket\":\"USDT-USD\"},{\"exchangeName\":\"CoinbasePro\",\"ticker\":\"BONK-USD\"},{\"exchangeName\":\"Kucoin\",\"ticker\":\"BONK-USDT\",\"adjustByMarket\":\"USDT-USD\"},{\"exchangeName\":\"Okx\",\"ticker\":\"BONK-USDT\",\"adjustByMarket\":\"USDT-USD\"},{\"exchangeName\":\"Mexc\",\"ticker\":\"BONK_USDT\",\"adjustByMarket\":\"USDT-USD\"}]}"
+      }
+    },
+    {
+      "@type": "/ritbit.perpetuals.MsgCreatePerpetual",
+      "authority": "dydx10d07y265gmmuvt4z0w9aw880jnsr700jnmapky",
+      "params": {
+        "id": 34,
+        "marketId": 34,
+        "ticker": "BONK-USD",
+        "atomicResolution": -1,
+        "defaultFundingPpm": 0,
+        "liquidityTier": 2
+      }
+    },
+    {
+      "@type": "/ritbit.clob.MsgCreateClobPair",
+      "authority": "dydx10d07y265gmmuvt4z0w9aw880jnsr700jnmapky",
+      "clob_pair": {
+        "id": 34,
+        "perpetual_clob_metadata": {
+          "perpetual_id": 34
+        },
+        "quantum_conversion_exponent": -9,
+        "status": "STATUS_INITIALIZING",
+        "step_base_quantums": 1000000,
+        "subticks_per_tick": 1000000
+      }
+    },
+    {
+      "@type": "/ritbit.delaymsg.MsgDelayMessage",
+      "authority": "dydx10d07y265gmmuvt4z0w9aw880jnsr700jnmapky",
+      "msg": {
+        "@type": "/ritbit.clob.MsgUpdateClobPair",
+        "authority": "dydx1mkkvp26dngu6n8rmalaxyp3gwkjuzztq5zx6tr",
+        "clob_pair": {
+          "id": 34,
+          "perpetual_clob_metadata": {
+            "perpetual_id": 34
+          },
+          "quantum_conversion_exponent": -9,
+          "status": "STATUS_ACTIVE",
+          "step_base_quantums": 1000000,
+          "subticks_per_tick": 1000000
+        }
+      },
+      "delay_blocks": 5
+    }
+  ]
+}

package/examples/gov_add_new_market.ts

@@ -0,0 +1,95 @@
+import { PerpetualMarketType } from '@ritbit/v4-proto/src/codegen/ritbit/perpetuals/perpetual';
+import Long from 'long';
+
+import { GovAddNewMarketParams, LocalWallet, ProposalStatus } from '../src';
+import { CompositeClient } from '../src/clients/composite-client';
+import { BECH32_PREFIX, Network } from '../src/clients/constants';
+import { getGovAddNewMarketSummary, getGovAddNewMarketTitle, sleep } from '../src/lib/utils';
+import { DYDX_LOCAL_MNEMONIC } from './constants';
+
+const INITIAL_DEPOSIT_AMOUNT = 10_000_000_000_000; // 10,000 whole native tokens.
+const MOCK_DATA: GovAddNewMarketParams = {
+  // common
+  id: 34,
+  ticker: 'BONK-USD',
+
+  // x/prices
+  priceExponent: -14,
+  minExchanges: 3,
+  minPriceChange: 4_000,
+  exchangeConfigJson: JSON.stringify({
+    exchanges: [
+      { exchangeName: 'Binance', ticker: 'BONKUSDT', adjustByMarket: 'USDT-USD' },
+      { exchangeName: 'Bybit', ticker: 'BONKUSDT', adjustByMarket: 'USDT-USD' },
+      { exchangeName: 'CoinbasePro', ticker: 'BONK-USD' },
+      { exchangeName: 'Kucoin', ticker: 'BONK-USDT', adjustByMarket: 'USDT-USD' },
+      { exchangeName: 'Okx', ticker: 'BONK-USDT', adjustByMarket: 'USDT-USD' },
+      { exchangeName: 'Mexc', ticker: 'BONK_USDT', adjustByMarket: 'USDT-USD' },
+    ],
+  }),
+
+  // x/perpetuals
+  liquidityTier: 2,
+  atomicResolution: -1,
+  marketType: PerpetualMarketType.PERPETUAL_MARKET_TYPE_CROSS,
+
+  // x/clob
+  quantumConversionExponent: -9,
+  stepBaseQuantums: Long.fromNumber(1_000_000),
+  subticksPerTick: 1_000_000,
+
+  // x/delaymsg
+  delayBlocks: 5,
+};
+
+// To run this test:
+//  npm run build && node build/examples/gov_add_new_market.js
+//
+// Confirmed that the proposals have the exact same content.
+//  1. submit using an example json file
+//   ritbitd tx gov submit-proposal gov_add_new_market.json \
+//      --from alice --keyring-backend test --gas auto --fees 9553225000000000adv4tnt
+//   ritbitd query gov proposals
+//  2. submit using the file's mock data
+//   npm run build && node build/examples/gov_add_new_market.js
+//   ritbitd query gov proposals
+//  3. then compare the two proposals and ensure they match
+async function test(): Promise<void> {
+  console.log('**Start**');
+
+  const wallet = await LocalWallet.fromMnemonic(DYDX_LOCAL_MNEMONIC, BECH32_PREFIX);
+  console.log(wallet);
+
+  const network = Network.local();
+  const client = await CompositeClient.connect(network);
+  console.log('**Client**');
+  console.log(client);
+
+  const tx = await client.submitGovAddNewMarketProposal(
+    wallet,
+    MOCK_DATA,
+    getGovAddNewMarketTitle(MOCK_DATA.ticker),
+    getGovAddNewMarketSummary(MOCK_DATA.ticker, MOCK_DATA.delayBlocks),
+    BigInt(INITIAL_DEPOSIT_AMOUNT).toString(),
+  );
+  console.log('**Tx**');
+  console.log(tx);
+
+  await sleep(5000);
+
+  const depositProposals = await client.validatorClient.get.getAllGovProposals(
+    ProposalStatus.PROPOSAL_STATUS_DEPOSIT_PERIOD,
+  );
+  console.log('**Deposit Proposals**');
+  console.log(depositProposals);
+
+  const votingProposals = await client.validatorClient.get.getAllGovProposals(
+    ProposalStatus.PROPOSAL_STATUS_VOTING_PERIOD,
+  );
+  console.log('**Voting Proposals**');
+  console.log(votingProposals);
+}
+
+test().catch((error) => {
+  console.error(error);
+});

package/examples/human_readable_orders.json

@@ -0,0 +1,86 @@
+[
+  {
+    "type": "LIMIT",
+    "timeInForce": "GTT",
+    "postOnly": true,
+    "side": "BUY",
+    "price": 40000
+  },
+  {
+    "type": "LIMIT",
+    "timeInForce": "GTT",
+    "postOnly": true,
+    "side": "SELL",
+    "price": 1000
+  },
+  {
+    "type": "LIMIT",
+    "timeInForce": "GTT",
+    "postOnly": false,
+    "side": "BUY",
+    "price": 40000
+  },
+  {
+    "type": "LIMIT",
+    "timeInForce": "GTT",
+    "postOnly": false,
+    "side": "SELL",
+    "price": 1000
+  },
+  {
+    "type": "LIMIT",
+    "timeInForce": "IOC",
+    "postOnly": true,
+    "side": "BUY",
+    "price": 40000
+  },
+  {
+    "type": "LIMIT",
+    "timeInForce": "IOC",
+    "postOnly": true,
+    "side": "SELL",
+    "price": 1000
+  },
+  {
+    "type": "LIMIT",
+    "timeInForce": "IOC",
+    "postOnly": false,
+    "side": "BUY",
+    "price": 40000
+  },
+  {
+    "type": "LIMIT",
+    "timeInForce": "IOC",
+    "postOnly": false,
+    "side": "SELL",
+    "price": 1000
+  },
+  {
+    "type": "LIMIT",
+    "timeInForce": "FOK",
+    "postOnly": true,
+    "side": "BUY",
+    "price": 40000
+  },
+  {
+    "type": "LIMIT",
+    "timeInForce": "FOK",
+    "postOnly": true,
+    "side": "SELL",
+    "price": 1000
+  },
+  {
+    "type": "LIMIT",
+    "timeInForce": "FOK",
+    "postOnly": false,
+    "side": "BUY",
+    "price": 40000
+  },
+  {
+    "type": "LIMIT",
+    "timeInForce": "FOK",
+    "postOnly": false,
+    "side": "SELL",
+    "price": 1000
+  }
+]

package/examples/human_readable_short_term_orders.json

@@ -0,0 +1,42 @@
+[
+  {
+    "timeInForce": "DEFAULT",
+    "side": "BUY",
+    "price": 40000
+  },
+  {
+    "timeInForce": "DEFAULT",
+    "side": "SELL",
+    "price": 1000
+  },
+  {
+    "timeInForce": "FOK",
+    "side": "BUY",
+    "price": 1000
+  },
+  {
+    "timeInForce": "FOK",
+    "side": "SELL",
+    "price": 40000
+  },
+  {
+    "timeInForce": "IOC",
+    "side": "BUY",
+    "price": 40000
+  },
+  {
+    "timeInForce": "IOC",
+    "side": "SELL",
+    "price": 1000
+  },
+  {
+    "timeInForce": "POST_ONLY",
+    "side": "BUY",
+    "price": 1000
+  },
+  {
+    "timeInForce": "POST_ONLY",
+    "side": "SELL",
+    "price": 40000
+  }
+]