@ritbit/v4-client-js 2.4.1 → 2.5.0

package/__tests__/clients/composite-client.test.ts

@@ -1,140 +0,0 @@
-import { Authenticator, AuthenticatorType, Network } from '../../src';
-import { CompositeClient } from '../../src/clients/composite-client'
-
-describe('CompositeClient', () => {
-  describe('validateAuthenticators', () => {
-    const network = Network.staging();
-
-    it('Validates top level AnyOf authenticators', async () => {
-      const client = await CompositeClient.connect(network);
-      const auth: Authenticator = {
-        type: AuthenticatorType.ANY_OF,
-        config: [
-          { type: AuthenticatorType.SIGNATURE_VERIFICATION, config: "" },
-          { type: AuthenticatorType.SIGNATURE_VERIFICATION, config: "" },
-        ],
-      }
-      expect(client.validateAuthenticator(auth)).toEqual(true);
-    });
-
-    it('Fails top level AnyOf authenticators with non-signature nested authenticator', async () => {
-      const client = await CompositeClient.connect(network);
-      const auth: Authenticator = {
-        type: AuthenticatorType.ANY_OF,
-        config: [
-          { type: AuthenticatorType.SIGNATURE_VERIFICATION, config: "" },
-          { type: AuthenticatorType.MESSAGE_FILTER, config: "" },
-        ],
-      }
-      expect(client.validateAuthenticator(auth)).toEqual(false);
-    });
-
-    it('Validates top level AllOf authenticators', async () => {
-      const client = await CompositeClient.connect(network);
-      const auth: Authenticator = {
-        type: AuthenticatorType.ALL_OF,
-        config: [
-          { type: AuthenticatorType.SIGNATURE_VERIFICATION, config: "" },
-          { type: AuthenticatorType.MESSAGE_FILTER, config: "" },
-        ],
-      }
-      expect(client.validateAuthenticator(auth)).toEqual(true);
-    });
-
-    it('Fails top level AllOf authenticators, without signature verification', async () => {
-      const client = await CompositeClient.connect(network);
-      const auth: Authenticator = {
-        type: AuthenticatorType.ALL_OF,
-        config: [
-          { type: AuthenticatorType.MESSAGE_FILTER, config: "" },
-          { type: AuthenticatorType.MESSAGE_FILTER, config: "" },
-        ],
-      }
-      expect(client.validateAuthenticator(auth)).toEqual(false);
-    });
-
-    it('Validates nested anyOf authenticators', async () => {
-      const client = await CompositeClient.connect(network);
-      const nestedAnyOf =  {
-        type: AuthenticatorType.ANY_OF,
-        config: [
-          { type: AuthenticatorType.MESSAGE_FILTER, config: "" },
-          { type: AuthenticatorType.MESSAGE_FILTER, config: "" },
-        ]
-      }
-      const signatureVerification = {
-        type: AuthenticatorType.SIGNATURE_VERIFICATION,
-        config: ""
-      }
-
-      const auth: Authenticator = {
-        type: AuthenticatorType.ALL_OF,
-        config: [signatureVerification, nestedAnyOf],
-      };
-      expect(client.validateAuthenticator(auth)).toEqual(true);
-    });
-
-    it('Validates nested allOf authenticators', async () => {
-      const client = await CompositeClient.connect(network);
-      const nestedAllOf =  {
-        type: AuthenticatorType.ALL_OF,
-        config: [
-          { type: AuthenticatorType.SIGNATURE_VERIFICATION, config: "" },
-          { type: AuthenticatorType.SIGNATURE_VERIFICATION, config: "" },
-        ]
-      }
-      const messageVerification = {
-        type: AuthenticatorType.MESSAGE_FILTER,
-        config: ""
-      }
-
-      const auth: Authenticator = {
-        type: AuthenticatorType.ALL_OF,
-        config: [messageVerification, nestedAllOf],
-      };
-      expect(client.validateAuthenticator(auth)).toEqual(true);
-    });
-
-    it('Fails nested anyOf signatureVerification authenticators', async () => {
-      const client = await CompositeClient.connect(network);
-      const nestedAnyOf =  {
-        type: AuthenticatorType.ANY_OF,
-        config: [
-          { type: AuthenticatorType.MESSAGE_FILTER, config: "" },
-          { type: AuthenticatorType.SIGNATURE_VERIFICATION, config: "" },
-        ]
-      }
-      const messageVerification = {
-        type: AuthenticatorType.MESSAGE_FILTER,
-        config: ""
-      }
-
-      const auth: Authenticator = {
-        type: AuthenticatorType.ALL_OF,
-        config: [messageVerification, nestedAnyOf],
-      };
-      expect(client.validateAuthenticator(auth)).toEqual(false);
-    });
-
-    it('Fails nested anyOf authenticators', async () => {
-      const client = await CompositeClient.connect(network);
-      const nestedAnyOf =  {
-        type: AuthenticatorType.ANY_OF,
-        config: [
-          { type: AuthenticatorType.MESSAGE_FILTER, config: "" },
-          { type: AuthenticatorType.SIGNATURE_VERIFICATION, config: "" },
-        ]
-      }
-      const messageVerification = {
-        type: AuthenticatorType.MESSAGE_FILTER,
-        config: ""
-      }
-
-      const auth: Authenticator = {
-        type: AuthenticatorType.ANY_OF,
-        config: [messageVerification, nestedAnyOf],
-      };
-      expect(client.validateAuthenticator(auth)).toEqual(false);
-    });
-  });
-});

package/__tests__/helpers/baseClients.ts

@@ -1,23 +0,0 @@
-/* eslint-disable @typescript-eslint/no-empty-function */
-export class BaseTendermintClient {
-  async block(): Promise<void> {}
-  async broadcastTxSync(): Promise<void> {}
-  async broadcastTxAsync(): Promise<void> {}
-  async txSearchAll(): Promise<void> {}
-}
-
-export class BaseQueryClient {
-  tx = {
-    async simulate(): Promise<void> {},
-  };
-
-  async queryUnverified(): Promise<void> {}
-}
-
-export class BaseStargateSigningClient {
-  async sign(): Promise<void> {}
-}
-
-export class BaseWallet {
-  async getAccounts(): Promise<void> {}
-}

package/__tests__/helpers/constants.ts

@@ -1,131 +0,0 @@
-import Long from 'long';
-
-import { generateRandomClientId } from '../../src/lib/utils';
-import {
-  ClobPairId,
-  TransactionOptions,
-  ICancelOrder,
-  Transfer,
-  MsgTransfer,
-  OrderFlags,
-  IPlaceOrder,
-  Order_Side,
-  Order_TimeInForce,
-  IBatchCancelOrder,
-} from '../../src/types';
-
-export const TEST_ADDRESS: string = 'dydx1vl9h9nkmau4e9v7tm30wekespu3d2qhd9404wa';
-export const TEST_RECIPIENT_ADDRESS: string = 'dydx1slanxj8x9ntk9knwa6cvfv2tzlsq5gk3dshml0';
-export const TEST_CHAIN_ID: string = 'ritbit';
-export const TEST_HOST: string = 'http://localhost:26657';
-
-export const defaultTransactionOptions: TransactionOptions = {
-  accountNumber: 1,
-  sequence: 10,
-  chainId: TEST_CHAIN_ID,
-};
-
-// PlaceOrder variables
-export const defaultOrder: IPlaceOrder = {
-  clientId: 0,
-  orderFlags: OrderFlags.SHORT_TERM,
-  clobPairId: ClobPairId.PERPETUAL_PAIR_BTC_USD,
-  side: Order_Side.SIDE_BUY,
-  quantums: Long.fromNumber(10),
-  subticks: Long.fromNumber(100),
-  goodTilBlock: 10000,
-  timeInForce: Order_TimeInForce.TIME_IN_FORCE_UNSPECIFIED,
-  reduceOnly: false,
-  clientMetadata: 0,
-  // New optional fields
-  twapParameters: undefined,
-  builderCodeParameters: undefined,
-  orderRouterAddress: undefined,
-};
-
-// PlaceOrder with TWAP parameters for testing
-export const twapOrder: IPlaceOrder = {
-  ...defaultOrder,
-  clientId: 1,
-  twapParameters: {
-    duration: 3600, // 1 hour
-    interval: 300,  // 5 minutes
-    priceTolerance: 50000, // 5% in ppm
-  },
-};
-
-// PlaceOrder with builder code parameters for testing
-export const builderOrder: IPlaceOrder = {
-  ...defaultOrder,
-  clientId: 2,
-  builderCodeParameters: {
-    builderAddress: 'dydx1test_builder_address',
-    feePpm: 1000, // 0.1% fee
-  }
-};
-
-export const orderRouterOrder: IPlaceOrder = {
-  ...defaultOrder,
-  clientId: 2,
-  orderRouterAddress: 'dydx1test_router_address',
-};
-
-// CancelOrder variables
-export const defaultCancelOrder: ICancelOrder = {
-  clientId: generateRandomClientId(),
-  orderFlags: OrderFlags.SHORT_TERM,
-  clobPairId: ClobPairId.PERPETUAL_PAIR_BTC_USD,
-  goodTilBlock: 4250,
-};
-
-// BatchCancelOrder variables
-export const defaultBatchCancelOrder: IBatchCancelOrder = {
-  shortTermOrders: [
-    {
-      clobPairId: ClobPairId.PERPETUAL_PAIR_BTC_USD,
-      clientIds: [generateRandomClientId(), generateRandomClientId()],
-    },
-  ],
-  goodTilBlock: 4250,
-};
-
-// Transfer variables
-export const defaultTransfer: MsgTransfer = {
-  sender: {
-    owner: TEST_ADDRESS,
-    number: 0,
-  },
-  recipient: {
-    owner: 'dydx14063jves4u9zhm7eja5ltf3t8zspxd92qnk23t',
-    number: 0,
-  },
-  assetId: 0,
-  amount: Long.fromNumber(1000),
-};
-
-// ------ Onboarding Constants ------ //
-// Base Signature Result
-export const SIGNATURE_RESULT =
-  '0xf2006b4fc0afa08a6048b40d3d67e437ac2e20e6bacf3f947f9b33aa2756d204287f5fb2155bec067d879a25d7ddac791826cf28e2786919065e19848020f1531b';
-
-// Derived privateKeyBytes from Base Signature Result
-export const ENTROPY_FROM_SIGNATURE_RESULT: Uint8Array = new Uint8Array([
-  247, 183, 226, 106, 76, 125, 241, 35, 149, 75, 103, 180, 165, 243, 80, 128, 34, 20, 238, 201, 131,
-  180, 61, 76, 223, 179, 37, 211, 144, 197, 171, 251,
-]);
-
-// Derived HDKey privateKey from Base Signature Result
-export const PRIVATE_KEY_FROM_SIGNATURE_RESULT: Uint8Array = new Uint8Array([
-  14, 92, 178, 198, 64, 65, 27, 153, 11, 45, 118, 194, 71, 194, 10, 140, 145, 40, 203, 107, 231,
-  191, 138, 220, 168, 104, 28, 69, 58, 193, 203, 213,
-]);
-
-// Derived HDKey publicKey from Base Signature Result
-export const PUBLIC_KEY_FROM_SIGNATURE_RESULT: Uint8Array = new Uint8Array([
-  2, 204, 94, 45, 7, 83, 196, 55, 195, 107, 10, 35, 169, 32, 24, 37, 193, 196, 34, 210, 84, 26, 107,
-  89, 119, 240, 211, 63, 187, 34, 162, 197, 36,
-]);
-
-// Derived HDKey mnemonic from Base Signature Result
-export const MNEMONIC_FROM_SIGNATURE_RESULT =
-  'waste sample once ocean tenant mushroom festival hollow regret convince stage able candy jazz champion isolate diary group under entry decorate glare quiz job';

package/__tests__/lib/helpers.test.ts

@@ -1,55 +0,0 @@
-/// <reference types="jest" />
-
-import { PartialTransactionOptions, TransactionOptions } from '../../src';
-import { DEFAULT_SEQUENCE } from '../../src/lib/constants';
-import { convertPartialTransactionOptionsToFull, stripHexPrefix } from '../../src/lib/helpers';
-import { defaultTransactionOptions } from '../helpers/constants';
-import { calculateSubticks, calculateQuantums } from '../../src/clients/helpers/chain-helpers';
-import Long from 'long';
-
-describe('helpers', () => {
-  describe('calculateSubticks', () => {
-    it('correctly handles decimals', () => {
-      expect(calculateSubticks(8.45, -7, -9, 1000000)).toEqual(new Long(845_000_000));
-    });
-  });
-
-  describe('calculateQuantums', () => {
-    it('correctly handles decimals', () => {
-      expect(calculateQuantums(0.0003, -10, 1000000)).toEqual(new Long(3_000_000));
-    });
-  });
-  
-  describe('convertPartialTransactionOptionsToFull', () =>
-    it.each([
-      [
-        'partial transactionOptions',
-        {
-          accountNumber: defaultTransactionOptions.accountNumber,
-          chainId: defaultTransactionOptions.chainId,
-        },
-        { ...defaultTransactionOptions, sequence: DEFAULT_SEQUENCE },
-      ],
-      ['undefined transactionOptions', undefined, undefined],
-    ])(
-      'convertPartialTransactionOptionsToFull: %s',
-      (
-        _name: string,
-        partialTransactionOptions: PartialTransactionOptions | undefined,
-        expectedResult: TransactionOptions | undefined,
-      ) => {
-        const transactionOptions: TransactionOptions | void =
-          convertPartialTransactionOptionsToFull(partialTransactionOptions);
-        expect(expectedResult).toEqual(transactionOptions);
-      },
-    ));
-
-  describe('stripHexPrefix', () => {
-    it('strips 0x prefix', () => {
-      expect(stripHexPrefix('0x123')).toEqual('123');
-    });
-    it('returns input if no prefix', () => {
-      expect(stripHexPrefix('10x23')).toEqual('10x23');
-    });
-  });
-});

package/__tests__/lib/util.test.ts

@@ -1,77 +0,0 @@
-import { MAX_UINT_32 } from '../../src/lib/constants';
-import { randomInt, generateRandomClientId, clientIdFromString } from '../../src/lib/utils';
-
-describe('lib/util', () => {
-  describe('randomInt', () => {
-    it('random values', () => {
-      const maxValue: number = 9999;
-      let lastValue: number = 0;
-      for (let i = 0; i < 100; i++) {
-        const value: number = randomInt(maxValue);
-
-        // Within the expected bounds.
-        expect(value).toBeGreaterThanOrEqual(0);
-        expect(value).toBeLessThanOrEqual(maxValue);
-
-        // No collision.
-        expect(value).not.toEqual(lastValue);
-        lastValue = value;
-      }
-    });
-
-    it('zero', () => {
-      expect(randomInt(0)).toEqual(0);
-    });
-  });
-
-  describe('generateRandomClientId', () => {
-    it('random values', () => {
-      let lastValue: number = 0;
-      for (let i = 0; i < 100; i++) {
-        const value: number = generateRandomClientId();
-
-        // Within the expected bounds.
-        expect(value).toBeGreaterThanOrEqual(0);
-        expect(value).toBeLessThanOrEqual(MAX_UINT_32);
-
-        // No collision.
-        expect(value).not.toEqual(lastValue);
-        lastValue = value;
-      }
-    });
-  });
-
-  describe('clientIdFromString', () => {
-    it('hard-coded', () => {
-      expect(clientIdFromString('test')).toEqual(2151040146);
-    });
-
-    it('random values', () => {
-      let lastValue: number = 0;
-      let lastInput: number = 0;
-      for (let i = 0; i < 1000; i++) {
-        // Prevent input collision.
-        let input: number = randomInt(MAX_UINT_32);
-        if (input === lastInput) {
-          input += 1;
-        }
-
-        const value: number = clientIdFromString(`${input}`);
-        const valueAgain: number = clientIdFromString(`${input}`);
-
-        // Deterministic.
-        expect(value).toEqual(valueAgain);
-
-        // Within the expected bounds.
-        expect(value).toBeGreaterThanOrEqual(0);
-        expect(value).toBeLessThanOrEqual(MAX_UINT_32);
-
-        // No collision.
-        expect(value).not.toEqual(lastValue);
-        expect(value).not.toEqual(input);
-        lastValue = value;
-        lastInput = input;
-      }
-    });
-  });
-});