@ritbit/v4-client-js 1.3.17

package/examples/permissioned_keys_example.ts

@@ -0,0 +1,162 @@
+import Long from 'long';
+
+import { BECH32_PREFIX } from '../src';
+import { CompositeClient } from '../src/clients/composite-client';
+import {
+  Network,
+  OrderExecution,
+  OrderSide,
+  OrderTimeInForce,
+  OrderType,
+  SelectedGasDenom,
+} from '../src/clients/constants';
+import LocalWallet from '../src/clients/modules/local-wallet';
+import { SubaccountInfo } from '../src/clients/subaccount';
+import {
+  createNewRandomDydxWallet,
+  getAuthorizeNewTradingKeyArguments,
+  getAuthorizedTradingKeysMetadata,
+} from '../src/lib/trading-key-utils';
+import { DYDX_TEST_MNEMONIC, DYDX_TEST_MNEMONIC_2 } from './constants';
+
+async function test(): Promise<void> {
+  const wallet1 = await LocalWallet.fromMnemonic(DYDX_TEST_MNEMONIC, BECH32_PREFIX);
+  const wallet2 = await LocalWallet.fromMnemonic(DYDX_TEST_MNEMONIC_2, BECH32_PREFIX);
+
+  const network = Network.testnet();
+  const client = await CompositeClient.connect(network);
+  client.setSelectedGasDenom(SelectedGasDenom.NATIVE);
+
+  console.log('**Client**');
+  console.log(client);
+
+  const subaccount1 = SubaccountInfo.forLocalWallet(wallet1, 0);
+  const subaccount2 = SubaccountInfo.forLocalWallet(wallet2, 0);
+
+  // Change second wallet pubkey
+  // Add an authenticator to allow wallet2 to place orders
+  console.log('** Adding authenticator **');
+  // Record authenticator count before adding
+  const authsBefore = await client.getAuthenticators(wallet1.address!);
+  const beforeCount = authsBefore.accountAuthenticators.length;
+  console.log(`Authenticators before: ${beforeCount}`);
+
+  const apiTradingWalletInfo1 = await createApiTradingWallet(client, subaccount1);
+  const apiTradingWallet1 = await LocalWallet.fromPrivateKey(
+    apiTradingWalletInfo1.privteKeyHex,
+    BECH32_PREFIX,
+  );
+
+  console.log('** Waiting 3 seconds for txn to be confirmed **');
+  await new Promise((resolve) => setTimeout(resolve, 3000));
+
+  const authsAfter = await client.getAuthenticators(wallet1.address!);
+  const afterCount = authsAfter.accountAuthenticators.length;
+  console.log(`Authenticators after: ${afterCount}`);
+  if (afterCount !== beforeCount + 1) {
+    console.error('Authenticator count did not increment by 1.');
+    process.exit(1);
+  } else {
+    console.log('Authenticator count incremented by 1 as expected.');
+  }
+
+  const parsedAuths = getAuthorizedTradingKeysMetadata(authsAfter.accountAuthenticators);
+  const newAuthenticatorID = parsedAuths.find(
+    (a) => apiTradingWallet1.address != null && a.address === apiTradingWallet1.address,
+  )?.id;
+  if (newAuthenticatorID == null) {
+    console.error(
+      'Unable to locate the created authenticator. Address: ',
+      apiTradingWallet1.address,
+    );
+    throw new Error('Unable to locate the new authenticator');
+  }
+  console.log(`New authenticator ID: ${newAuthenticatorID}`);
+
+  // Placing order using subaccount2 for subaccount1 succeeds
+  console.log(
+    '** Placing order for subaccount1 with subaccount2 + authenticator, should succeed **',
+  );
+  await placeOrder(client, apiTradingWallet1, subaccount1.address, newAuthenticatorID);
+
+  // Placing order using subaccount2 for subaccount1 should fail
+  console.log('** Placing order for subaccount1 with subaccount3 + authenticator, should fail **');
+  await placeOrder(client, subaccount2.signingWallet, subaccount1.address, newAuthenticatorID);
+
+  // Remove authenticator
+  console.log('** Removing authenticator **');
+  await removeAuthenticator(client, subaccount1, newAuthenticatorID);
+
+  console.log('** Waiting 3 seconds for txn to be confirmed **');
+  await new Promise((resolve) => setTimeout(resolve, 3000));
+
+  // Placing an order using subaccount2 will now fail
+  console.log('** Placing order with removed authenticator should fail **');
+  await placeOrder(client, apiTradingWallet1, subaccount1.address, newAuthenticatorID);
+}
+
+async function removeAuthenticator(
+  client: CompositeClient,
+  subaccount: SubaccountInfo,
+  id: string,
+): Promise<void> {
+  await client.removeAuthenticator(subaccount, id);
+}
+
+async function createApiTradingWallet(
+  client: CompositeClient,
+  subaccount: SubaccountInfo,
+): Promise<{ privteKeyHex: string; forDydxAddress: string }> {
+  const wallet = await createNewRandomDydxWallet();
+  if (wallet == null) {
+    throw new Error("Couldn't create wallet");
+  }
+  const { data, type } = getAuthorizeNewTradingKeyArguments({
+    generatedWalletPubKey: wallet?.publicKey,
+  });
+  console.log('adding', wallet.address);
+  await client.addAuthenticator(subaccount, type, data);
+  return { privteKeyHex: wallet.privateKeyHex, forDydxAddress: subaccount.address };
+}
+
+async function placeOrder(
+  client: CompositeClient,
+  apiTradingWallet: LocalWallet,
+  forAccountAddress: string,
+  authenticatorId: string,
+): Promise<void> {
+  try {
+    const side = OrderSide.BUY;
+    const price = Number('10000');
+
+    const clientId = Math.floor(Math.random() * 10000);
+
+    const tx = await client.placeOrder(
+      SubaccountInfo.forPermissionedWallet(apiTradingWallet, forAccountAddress, 0, [
+        Long.fromString(authenticatorId),
+      ]),
+      'ETH-USD',
+      OrderType.MARKET,
+      side,
+      price,
+      0.01,
+      clientId,
+      OrderTimeInForce.IOC,
+      100,
+      OrderExecution.IOC,
+      false,
+      false,
+    );
+    console.log('**Order Tx**');
+    console.log(Buffer.from(tx.hash).toString('hex'));
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  } catch (error: any) {
+    console.log(error.message);
+  }
+}
+
+test()
+  .then(() => {})
+  .catch((error) => {
+    console.log(error.message);
+  });

package/examples/raw_orders.json

@@ -0,0 +1,130 @@
+[
+  {
+    "timeInForce": 0,
+    "reduceOnly": false,
+    "orderFlags": 64,
+    "side": 1,
+    "quantums": 10000000,
+    "subticks": 40000000000
+  },
+  {
+    "timeInForce": 2,
+    "reduceOnly": false,
+    "orderFlags": 64,
+    "side": 1,
+    "quantums": 10000000,
+    "subticks": 40000000000
+  },
+  {
+    "timeInForce": 0,
+    "reduceOnly": true,
+    "orderFlags": 64,
+    "side": 1,
+    "quantums": 10000000,
+    "subticks": 40000000000
+  },
+  {
+    "timeInForce": 2,
+    "reduceOnly": true,
+    "orderFlags": 64,
+    "side": 1,
+    "quantums": 10000000,
+    "subticks": 40000000000
+  },
+  {
+    "timeInForce": 1,
+    "reduceOnly": false,
+    "orderFlags": 0,
+    "side": 1,
+    "quantums": 10000000,
+    "subticks": 40000000000
+  },
+  {
+    "timeInForce": 1,
+    "reduceOnly": true,
+    "orderFlags": 0,
+    "side": 1,
+    "quantums": 10000000,
+    "subticks": 40000000000
+  },
+  {
+    "timeInForce": 3,
+    "reduceOnly": false,
+    "orderFlags": 0,
+    "side": 1,
+    "quantums": 10000000,
+    "subticks": 40000000000
+  },
+  {
+    "timeInForce": 3,
+    "reduceOnly": true,
+    "orderFlags": 0,
+    "side": 1,
+    "quantums": 10000000,
+    "subticks": 40000000000
+  },
+  {
+    "timeInForce": 0,
+    "reduceOnly": false,
+    "orderFlags": 64,
+    "side": 2,
+    "quantums": 10000000,
+    "subticks": 1000000000
+  },
+  {
+    "timeInForce": 2,
+    "reduceOnly": false,
+    "orderFlags": 64,
+    "side": 2,
+    "quantums": 10000000,
+    "subticks": 1000000000
+  },
+  {
+    "timeInForce": 0,
+    "reduceOnly": true,
+    "orderFlags": 64,
+    "side": 2,
+    "quantums": 10000000,
+    "subticks": 1000000000
+  },
+  {
+    "timeInForce": 2,
+    "reduceOnly": true,
+    "orderFlags": 64,
+    "side": 2,
+    "quantums": 10000000,
+    "subticks": 1000000000
+  },
+  {
+    "timeInForce": 1,
+    "reduceOnly": false,
+    "orderFlags": 0,
+    "side": 2,
+    "quantums": 10000000,
+    "subticks": 1000000000
+  },
+  {
+    "timeInForce": 1,
+    "reduceOnly": true,
+    "orderFlags": 0,
+    "side": 2,
+    "quantums": 10000000,
+    "subticks": 1000000000
+  },
+  {
+    "timeInForce": 3,
+    "reduceOnly": false,
+    "orderFlags": 0,
+    "side": 2,
+    "quantums": 10000000,
+    "subticks": 1000000000
+  },
+  {
+    "timeInForce": 3,
+    "reduceOnly": true,
+    "orderFlags": 0,
+    "side": 2,
+    "quantums": 10000000,
+    "subticks": 1000000000
+  }
+]

package/examples/short_term_order_cancel_example.ts

@@ -0,0 +1,68 @@
+import { BECH32_PREFIX, OrderFlags, Order_TimeInForce } from '../src';
+import { CompositeClient } 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';
+
+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);
+
+  const currentBlock = await client.validatorClient.get.latestBlockHeight();
+  const nextValidBlockHeight = currentBlock + 1;
+  // Note, you can change this to any number between `next_valid_block_height`
+  // to `next_valid_block_height + SHORT_BLOCK_WINDOW`
+  const goodTilBlock = nextValidBlockHeight + 10;
+  const shortTermOrderClientId = randomInt(MAX_CLIENT_ID);
+  try {
+    // place a short term order
+    const tx = await client.placeShortTermOrder(
+      subaccount,
+      'ETH-USD',
+      OrderSide.SELL,
+      40000,
+      0.01,
+      shortTermOrderClientId,
+      goodTilBlock,
+      Order_TimeInForce.TIME_IN_FORCE_UNSPECIFIED,
+      false,
+    );
+    console.log('**Short Term Order Tx**');
+    console.log(tx.hash);
+  } catch (error) {
+    console.log('**Short Term Order Failed**');
+    console.log(error.message);
+  }
+
+  await sleep(5000); // wait for placeOrder to complete
+
+  try {
+    // cancel the short term order
+    const tx = await client.cancelOrder(
+      subaccount,
+      shortTermOrderClientId,
+      OrderFlags.SHORT_TERM,
+      'ETH-USD',
+      goodTilBlock + 10,
+      0,
+    );
+    console.log('**Cancel Short Term Order Tx**');
+    console.log(tx);
+  } catch (error) {
+    console.log('**Cancel Short Term Order Failed**');
+    console.log(error.message);
+  }
+}
+
+test()
+  .then(() => {})
+  .catch((error) => {
+    console.log(error.message);
+  });

package/examples/short_term_order_composite_example.ts

@@ -0,0 +1,80 @@
+import { Order_TimeInForce } from '@ritbit/v4-proto/src/codegen/ritbit/clob/order';
+
+import { BECH32_PREFIX } from '../src';
+import { CompositeClient } from '../src/clients/composite-client';
+import { Network, OrderExecution, OrderSide } 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 } from './constants';
+import ordersParams from './human_readable_short_term_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 side = OrderSide[orderParams.side as keyof typeof OrderSide];
+      const price = orderParams.price ?? 1350;
+
+      const currentBlock = await client.validatorClient.get.latestBlockHeight();
+      const nextValidBlockHeight = currentBlock + 1;
+      // Note, you can change this to any number between `next_valid_block_height`
+      // to `next_valid_block_height + SHORT_BLOCK_WINDOW`
+      const goodTilBlock = nextValidBlockHeight + 10;
+
+      const timeInForce = orderExecutionToTimeInForce(orderParams.timeInForce);
+
+      // uint32
+      const clientId = randomInt(2 ** 32 - 1);
+
+      const tx = await client.placeShortTermOrder(
+        subaccount,
+        'ETH-USD',
+        side,
+        price,
+        0.01,
+        clientId,
+        goodTilBlock,
+        timeInForce,
+        false,
+      );
+      console.log('**Order Tx**');
+      console.log(tx.hash.toString());
+    } catch (error) {
+      console.log(error.message);
+    }
+
+    await sleep(5000); // wait for placeOrder to complete
+  }
+}
+
+function orderExecutionToTimeInForce(orderExecution: string): Order_TimeInForce {
+  switch (orderExecution) {
+    case OrderExecution.DEFAULT:
+      return Order_TimeInForce.TIME_IN_FORCE_UNSPECIFIED;
+    case OrderExecution.FOK:
+      return Order_TimeInForce.TIME_IN_FORCE_FILL_OR_KILL;
+    case OrderExecution.IOC:
+      return Order_TimeInForce.TIME_IN_FORCE_IOC;
+    case OrderExecution.POST_ONLY:
+      return Order_TimeInForce.TIME_IN_FORCE_POST_ONLY;
+    default:
+      throw new Error('Unrecognized order execution');
+  }
+}
+
+test()
+  .then(() => {})
+  .catch((error) => {
+    console.log(error.message);
+  });

package/examples/test.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/transfer_example_deposit.ts

@@ -0,0 +1,28 @@
+import Long from 'long';
+
+import { BECH32_PREFIX } from '../src';
+import { Network } from '../src/clients/constants';
+import LocalWallet from '../src/clients/modules/local-wallet';
+import { SubaccountInfo } from '../src/clients/subaccount';
+import { ValidatorClient } from '../src/clients/validator-client';
+import { DYDX_TEST_MNEMONIC } from './constants';
+
+async function test(): Promise<void> {
+  const wallet = await LocalWallet.fromMnemonic(DYDX_TEST_MNEMONIC, BECH32_PREFIX);
+  console.log(wallet);
+
+  const client = await ValidatorClient.connect(Network.testnet().validatorConfig);
+  console.log('**Client**');
+  console.log(client);
+
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
+  const tx = await client.post.deposit(subaccount, 0, new Long(10_000_000));
+  console.log('**Deposit Tx**');
+  console.log(tx);
+}
+
+test()
+  .then(() => {})
+  .catch((error) => {
+    console.log(error.message);
+  });

package/examples/transfer_example_send.ts

@@ -0,0 +1,60 @@
+import { EncodeObject } from '@cosmjs/proto-signing';
+import { Method } from '@cosmjs/tendermint-rpc';
+import Long from 'long';
+
+import { TEST_RECIPIENT_ADDRESS } from '../__tests__/helpers/constants';
+import { BECH32_PREFIX } from '../src';
+import { Network } from '../src/clients/constants';
+import LocalWallet from '../src/clients/modules/local-wallet';
+import { SubaccountInfo } from '../src/clients/subaccount';
+import { ValidatorClient } from '../src/clients/validator-client';
+import { DYDX_TEST_MNEMONIC } from './constants';
+
+async function test(): Promise<void> {
+  const wallet = await LocalWallet.fromMnemonic(DYDX_TEST_MNEMONIC, BECH32_PREFIX);
+  console.log(wallet);
+
+  const client = await ValidatorClient.connect(Network.testnet().validatorConfig);
+  console.log('**Client**');
+  console.log(client);
+
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
+
+  const amount = new Long(100_000_000);
+
+  const msgs: Promise<EncodeObject[]> = new Promise((resolve) => {
+    const msg = client.post.composer.composeMsgSendToken(
+      subaccount.address,
+      TEST_RECIPIENT_ADDRESS,
+      client.config.denoms.CHAINTOKEN_DENOM,
+      amount.toString(),
+    );
+
+    resolve([msg]);
+  });
+
+  const totalFee = await client.post.simulate(subaccount, () => msgs, undefined, undefined);
+  console.log('**Total Fee**');
+  console.log(totalFee);
+
+  const amountAfterFee = amount.sub(Long.fromString(totalFee.amount[0].amount));
+  console.log('**Amount after fee**');
+  console.log(amountAfterFee);
+
+  const tx = await client.post.sendToken(
+    subaccount,
+    TEST_RECIPIENT_ADDRESS,
+    client.config.denoms.CHAINTOKEN_DENOM,
+    amountAfterFee.toString(),
+    false,
+    Method.BroadcastTxCommit,
+  );
+  console.log('**Send**');
+  console.log(tx);
+}
+
+test()
+  .then(() => {})
+  .catch((error) => {
+    console.log(error.message);
+  });

package/examples/transfer_example_subaccount_transfer.ts

@@ -0,0 +1,29 @@
+import Long from 'long';
+
+import { BECH32_PREFIX } from '../src';
+import { Network } from '../src/clients/constants';
+import LocalWallet from '../src/clients/modules/local-wallet';
+import { SubaccountInfo } from '../src/clients/subaccount';
+import { ValidatorClient } from '../src/clients/validator-client';
+import { DYDX_TEST_MNEMONIC } from './constants';
+
+async function test(): Promise<void> {
+  const wallet = await LocalWallet.fromMnemonic(DYDX_TEST_MNEMONIC, BECH32_PREFIX);
+  console.log(wallet);
+
+  const client = await ValidatorClient.connect(Network.testnet().validatorConfig);
+  console.log('**Client**');
+  console.log(client);
+
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
+
+  const tx = await client.post.transfer(subaccount, subaccount.address, 1, 0, new Long(10_000_000));
+  console.log('**Transfer Tx**');
+  console.log(tx);
+}
+
+test()
+  .then(() => {})
+  .catch((error) => {
+    console.log(error.message);
+  });

package/examples/transfer_example_withdraw.ts

@@ -0,0 +1,31 @@
+import Long from 'long';
+
+import { BECH32_PREFIX } from '../src';
+import { Network } from '../src/clients/constants';
+import LocalWallet from '../src/clients/modules/local-wallet';
+import { SubaccountInfo } from '../src/clients/subaccount';
+import { ValidatorClient } from '../src/clients/validator-client';
+import { DYDX_TEST_MNEMONIC } from './constants';
+
+// TODO: Test after testnet deploy latest transfer contracts.
+
+async function test(): Promise<void> {
+  const wallet = await LocalWallet.fromMnemonic(DYDX_TEST_MNEMONIC, BECH32_PREFIX);
+  console.log(wallet);
+
+  const client = await ValidatorClient.connect(Network.testnet().validatorConfig);
+  console.log('**Client**');
+  console.log(client);
+
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
+
+  const tx = await client.post.withdraw(subaccount, 0, new Long(1_00_000_000));
+  console.log('**Withdraw Tx**');
+  console.log(tx);
+}
+
+test()
+  .then(() => {})
+  .catch((error) => {
+    console.log(error.message);
+  });