@ritbit/v4-client-js 2.4.1 → 2.5.0

package/examples/noble_example.ts

@@ -1,107 +0,0 @@
-import { EncodeObject } from '@cosmjs/proto-signing';
-import Long from 'long';
-
-import { SubaccountInfo } from '../src';
-import { Network } from '../src/clients/constants';
-import LocalWallet from '../src/clients/modules/local-wallet';
-import { NobleClient } from '../src/clients/noble-client';
-import { ValidatorClient } from '../src/clients/validator-client';
-import { BECH32_PREFIX, NOBLE_BECH32_PREFIX } from '../src/lib/constants';
-import { sleep } from '../src/lib/utils';
-import { TEST_MNEMONIC } from './constants';
-
-async function test(): Promise<void> {
-  const dydxClient = await ValidatorClient.connect(Network.testnet().validatorConfig);
-
-  const dydxWallet = await LocalWallet.fromMnemonic(TEST_MNEMONIC, BECH32_PREFIX);
-  const nobleWallet = await LocalWallet.fromMnemonic(TEST_MNEMONIC, NOBLE_BECH32_PREFIX);
-
-  const client = new NobleClient('https://rpc.testnet.noble.strange.love', 'Noble example');
-  await client.connect(nobleWallet);
-
-  if (nobleWallet.address === undefined || dydxWallet.address === undefined) {
-    throw new Error('Wallet not found');
-  }
-
-  // IBC to noble
-
-  const ibcToNobleMsg: EncodeObject = {
-    typeUrl: '/ibc.applications.transfer.v1.MsgTransfer',
-    value: {
-      sourcePort: 'transfer',
-      sourceChannel: 'channel-0',
-      token: {
-        denom: 'ibc/8E27BA2D5493AF5636760E354E46004562C46AB7EC0CC4C1CA14E9E20E2545B5',
-        amount: '1000000',
-      },
-      sender: dydxWallet.address,
-      receiver: nobleWallet.address,
-      timeoutTimestamp: Long.fromNumber(Math.floor(Date.now() / 1000) * 1e9 + 10 * 60 * 1e9),
-    },
-  };
-
-  const msgs = [ibcToNobleMsg];
-  const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs));
-
-  await dydxClient.post.send(
-    SubaccountInfo.forLocalWallet(dydxWallet),
-    () => {
-      return encodeObjects;
-    },
-    false,
-    undefined,
-    undefined,
-  );
-
-  await sleep(30000);
-
-  try {
-    const coins = await client.getAccountBalances();
-    console.log('Balances');
-    console.log(JSON.stringify(coins));
-
-    // IBC from noble
-
-    const ibcFromNobleMsg: EncodeObject = {
-      typeUrl: '/ibc.applications.transfer.v1.MsgTransfer',
-      value: {
-        sourcePort: 'transfer',
-        sourceChannel: 'channel-21',
-        token: {
-          denom: 'uusdc',
-          amount: coins[0].amount,
-        },
-        sender: nobleWallet.address,
-        receiver: dydxWallet.address,
-        timeoutTimestamp: Long.fromNumber(Math.floor(Date.now() / 1000) * 1e9 + 10 * 60 * 1e9),
-      },
-    };
-    const fee = await client.simulateTransaction([ibcFromNobleMsg]);
-
-    ibcFromNobleMsg.value.token.amount = (
-      parseInt(ibcFromNobleMsg.value.token.amount, 10) -
-      Math.floor(parseInt(fee.amount[0].amount, 10) * 1.4)
-    ).toString();
-
-    await client.send([ibcFromNobleMsg]);
-  } catch (error) {
-    console.log(JSON.stringify(error.message));
-  }
-
-  await sleep(30000);
-
-  try {
-    const coin = await client.getAccountBalance('uusdc');
-    console.log('Balance');
-    console.log(JSON.stringify(coin));
-  } catch (error) {
-    console.log(JSON.stringify(error.message));
-  }
-}
-
-test()
-  .then(() => {})
-  .catch((error) => {
-    console.log(error.message);
-    console.log(error);
-  });

package/examples/optimal_node.ts

@@ -1,70 +0,0 @@
-import { TESTNET_CHAIN_ID } from '../src/clients/constants';
-import { NetworkOptimizer } from '../src/network_optimizer';
-
-async function testNodes(): Promise<void> {
-  // all valid endpoints
-  try {
-    const optimizer = new NetworkOptimizer();
-    const endpoints = [
-      'https://validator.v4testnet1.ritbit.trade',
-      'https://ritbit-testnet.nodefleet.org',
-      'https://ritbit-testnet-archive.allthatnode.com:26657/XZvMM41hESf8PJrEQiTzbCOMVyFca79R',
-    ];
-    const optimal = await optimizer.findOptimalNode(endpoints, TESTNET_CHAIN_ID);
-    console.log(optimal);
-  } catch (error) {
-    console.log(error.message);
-  }
-
-  // one invalid endpoint
-  try {
-    const optimizer = new NetworkOptimizer();
-    const endpoints = [
-      'https://validator.v4testnet1.ritbit.trade',
-      'https://ritbit-testnet.nodefleet.org',
-      'https://ritbit-testnet-archive.allthatnode.com:26657/XZvMM41hESf8PJrEQiTzbCOMVyFca79R',
-      'https://example.com',
-    ];
-    const optimal = await optimizer.findOptimalNode(endpoints, TESTNET_CHAIN_ID);
-    console.log(optimal);
-  } catch (error) {
-    console.log(error.message);
-  }
-
-  // all invalid endpoints
-
-  try {
-    const optimizer = new NetworkOptimizer();
-    const endpoints = ['https://example.com', 'https://example.org'];
-    const optimal = await optimizer.findOptimalNode(endpoints, TESTNET_CHAIN_ID);
-    console.log(optimal);
-  } catch (error) {
-    console.log(error.message);
-  }
-}
-
-async function testIndexers(): Promise<void> {
-  // all valid endpoints
-  try {
-    const optimizer = new NetworkOptimizer();
-    const endpoints = ['https://indexer.v4testnet2.ritbit.trade'];
-    const optimal = await optimizer.findOptimalIndexer(endpoints);
-    console.log(optimal);
-  } catch (error) {
-    console.log(error.message);
-  }
-
-  // all invalid endpoints
-
-  try {
-    const optimizer = new NetworkOptimizer();
-    const endpoints = ['https://example.com', 'https://example.org'];
-    const optimal = await optimizer.findOptimalIndexer(endpoints);
-    console.log(optimal);
-  } catch (error) {
-    console.log(error.message);
-  }
-}
-
-testNodes().catch(console.log);
-testIndexers().catch(console.log);

package/examples/permissioned_keys_example.ts

@@ -1,162 +0,0 @@
-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 {
-  createNewRandomChainWallet,
-  getAuthorizeNewTradingKeyArguments,
-  getAuthorizedTradingKeysMetadata,
-} from '../src/lib/trading-key-utils';
-import { TEST_MNEMONIC, TEST_MNEMONIC_2 } from './constants';
-
-async function test(): Promise<void> {
-  const wallet1 = await LocalWallet.fromMnemonic(TEST_MNEMONIC, BECH32_PREFIX);
-  const wallet2 = await LocalWallet.fromMnemonic(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; forChainAddress: string }> {
-  const wallet = await createNewRandomChainWallet();
-  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, forChainAddress: 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

@@ -1,130 +0,0 @@
-[
-  {
-    "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

@@ -1,68 +0,0 @@
-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 { TEST_MNEMONIC, MAX_CLIENT_ID } from './constants';
-
-async function test(): Promise<void> {
-  const wallet = await LocalWallet.fromMnemonic(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

@@ -1,80 +0,0 @@
-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 { 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(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

@@ -1,65 +0,0 @@
-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 { 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(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);
-  });