@dydxprotocol/v4-client-js 0.38.6 → 0.39.0

package/examples/transfer_example_withdraw.ts

@@ -1,7 +1,7 @@
 import Long from 'long';
 
 import { BECH32_PREFIX } from '../src';
-import { STAGING_CHAIN_ID, Network, ValidatorConfig } from '../src/clients/constants';
+import { Network } from '../src/clients/constants';
 import LocalWallet from '../src/clients/modules/local-wallet';
 import { Subaccount } from '../src/clients/subaccount';
 import { ValidatorClient } from '../src/clients/validator-client';
@@ -13,11 +13,7 @@ async function test(): Promise<void> {
   const wallet = await LocalWallet.fromMnemonic(DYDX_TEST_MNEMONIC, BECH32_PREFIX);
   console.log(wallet);
 
-  const config = new ValidatorConfig(
-    Network.staging().validatorConfig.restEndpoint,
-    STAGING_CHAIN_ID,
-  );
-  const client = await ValidatorClient.connect(config);
+  const client = await ValidatorClient.connect(Network.staging().validatorConfig);
   console.log('**Client**');
   console.log(client);
 

package/examples/transfer_example_withdraw_other.ts

@@ -4,7 +4,7 @@ import Long from 'long';
 
 import { TEST_RECIPIENT_ADDRESS } from '../__tests__/helpers/constants';
 import { BECH32_PREFIX } from '../src';
-import { STAGING_CHAIN_ID, Network, ValidatorConfig } from '../src/clients/constants';
+import { Network } from '../src/clients/constants';
 import LocalWallet from '../src/clients/modules/local-wallet';
 import { Subaccount } from '../src/clients/subaccount';
 import { ValidatorClient } from '../src/clients/validator-client';
@@ -16,11 +16,7 @@ async function test(): Promise<void> {
   const wallet = await LocalWallet.fromMnemonic(DYDX_TEST_MNEMONIC, BECH32_PREFIX);
   console.log(wallet);
 
-  const config = new ValidatorConfig(
-    Network.staging().validatorConfig.restEndpoint,
-    STAGING_CHAIN_ID,
-  );
-  const client = await ValidatorClient.connect(config);
+  const client = await ValidatorClient.connect(Network.staging().validatorConfig);
   console.log('**Client**');
   console.log(client);
 

package/examples/validator_post_example.ts

@@ -2,7 +2,7 @@ import Long from 'long';
 import protobuf from 'protobufjs';
 
 import { BECH32_PREFIX } from '../src';
-import { STAGING_CHAIN_ID, Network, ValidatorConfig } from '../src/clients/constants';
+import { Network } from '../src/clients/constants';
 import LocalWallet from '../src/clients/modules/local-wallet';
 import { Subaccount } from '../src/clients/subaccount';
 import { IPlaceOrder } from '../src/clients/types';
@@ -32,11 +32,8 @@ async function sleep(ms: number): Promise<void> {
 async function test(): Promise<void> {
   const wallet = await LocalWallet.fromMnemonic(DYDX_TEST_MNEMONIC, BECH32_PREFIX);
   console.log(wallet);
-  const config = new ValidatorConfig(
-    Network.staging().validatorConfig.restEndpoint,
-    STAGING_CHAIN_ID,
-  );
-  const client = await ValidatorClient.connect(config);
+
+  const client = await ValidatorClient.connect(Network.staging().validatorConfig);
   console.log('**Client**');
   console.log(client);
 

package/package.json

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

package/src/clients/composite-client.ts

@@ -10,8 +10,6 @@ import protobuf from 'protobufjs';
 import { isStatefulOrder, verifyOrderFlags } from '../lib/validation';
 import { OrderFlags } from '../types';
 import {
-  DYDX_DENOM,
-  GAS_PRICE,
   Network,
   OrderExecution,
   OrderSide,
@@ -103,7 +101,7 @@ export class CompositeClient {
     wallet: LocalWallet,
     messaging: () => Promise<EncodeObject[]>,
     zeroFee: boolean,
-    gasPrice: GasPrice = GAS_PRICE,
+    gasPrice?: GasPrice,
     memo?: string,
     account?: () => Promise<Account>,
   ): Promise<Uint8Array> {
@@ -129,7 +127,7 @@ export class CompositeClient {
     wallet: LocalWallet,
     messaging: () => Promise<EncodeObject[]>,
     zeroFee: boolean,
-    gasPrice: GasPrice = GAS_PRICE,
+    gasPrice?: GasPrice,
     memo?: string,
     account?: () => Promise<Account>,
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
@@ -175,7 +173,7 @@ export class CompositeClient {
   async simulate(
     wallet: LocalWallet,
     messaging: () => Promise<EncodeObject[]>,
-    gasPrice: GasPrice = GAS_PRICE,
+    gasPrice?: GasPrice,
     memo?: string,
     account?: () => Promise<Account>,
   ): Promise<StdFee> {
@@ -825,7 +823,7 @@ export class CompositeClient {
   }
 
   /**
-     * @description Create message to send dydx token from subaccount to wallet
+     * @description Create message to send chain token from subaccount to wallet
      * with human readable input.
      *
      * @param subaccount The subaccount to withdraw from
@@ -841,11 +839,15 @@ export class CompositeClient {
     amount: number,
     recipient: string,
   ): EncodeObject {
+    const chainTokenDenom = this._validatorClient?.config.denoms.CHAINTOKEN_DENOM;
+    if (chainTokenDenom === undefined) {
+      throw new Error('Chain token denom not set in validator config');
+    }
     const quantums: Long = Long.fromNumber(amount * (10 ** 6));
     return this.validatorClient.post.composer.composeMsgSendToken(
       subaccount.address,
       recipient,
-      DYDX_DENOM,
+      chainTokenDenom,
       quantums,
     );
   }

package/src/clients/constants.ts

@@ -1,7 +1,7 @@
 import { PageRequest } from '@dydxprotocol/v4-proto/src/codegen/cosmos/base/query/v1beta1/pagination';
 import Long from 'long';
 
-import { BroadcastOptions } from './types';
+import { BroadcastOptions, DenomConfig } from './types';
 
 export * from '../lib/constants';
 
@@ -150,11 +150,13 @@ export class IndexerConfig {
 export class ValidatorConfig {
   public restEndpoint: string;
   public chainId: string;
+  public denoms: DenomConfig;
   public broadcastOptions?: BroadcastOptions;
 
   constructor(
     restEndpoint: string,
     chainId: string,
+    denoms: DenomConfig,
     broadcastOptions?: BroadcastOptions,
   ) {
     if ((restEndpoint?.endsWith('/'))) {
@@ -162,6 +164,7 @@ export class ValidatorConfig {
     }
     this.restEndpoint = restEndpoint;
     this.chainId = chainId;
+    this.denoms = denoms;
     this.broadcastOptions = broadcastOptions;
   }
 }
@@ -178,7 +181,12 @@ export class Network {
       IndexerApiHost.DEV,
       IndexerWSHost.DEV,
     );
-    const validatorConfig = new ValidatorConfig(ValidatorApiHost.DEV, DEV_CHAIN_ID);
+    const validatorConfig = new ValidatorConfig(ValidatorApiHost.DEV, DEV_CHAIN_ID,
+      {
+        CHAINTOKEN_DENOM: 'adv4tnt',
+        USDC_DENOM: 'ibc/8E27BA2D5493AF5636760E354E46004562C46AB7EC0CC4C1CA14E9E20E2545B5',
+        USDC_GAS_DENOM: 'uusdc',
+      });
     return new Network('dev', indexerConfig, validatorConfig);
   }
 
@@ -187,7 +195,12 @@ export class Network {
       IndexerApiHost.STAGING,
       IndexerWSHost.STAGING,
     );
-    const validatorConfig = new ValidatorConfig(ValidatorApiHost.STAGING, STAGING_CHAIN_ID);
+    const validatorConfig = new ValidatorConfig(ValidatorApiHost.STAGING, STAGING_CHAIN_ID,
+      {
+        CHAINTOKEN_DENOM: 'adv4tnt',
+        USDC_DENOM: 'ibc/8E27BA2D5493AF5636760E354E46004562C46AB7EC0CC4C1CA14E9E20E2545B5',
+        USDC_GAS_DENOM: 'uusdc',
+      });
     return new Network('staging', indexerConfig, validatorConfig);
   }
 
@@ -196,7 +209,12 @@ export class Network {
       IndexerApiHost.TESTNET,
       IndexerWSHost.TESTNET,
     );
-    const validatorConfig = new ValidatorConfig(ValidatorApiHost.TESTNET, TESTNET_CHAIN_ID);
+    const validatorConfig = new ValidatorConfig(ValidatorApiHost.TESTNET, TESTNET_CHAIN_ID,
+      {
+        CHAINTOKEN_DENOM: 'adv4tnt',
+        USDC_DENOM: 'ibc/8E27BA2D5493AF5636760E354E46004562C46AB7EC0CC4C1CA14E9E20E2545B5',
+        USDC_GAS_DENOM: 'uusdc',
+      });
     return new Network('testnet', indexerConfig, validatorConfig);
   }
 

package/src/clients/modules/composer.ts

@@ -4,7 +4,6 @@ import { Coin } from 'cosmjs-types/cosmos/base/v1beta1/coin';
 import Long from 'long';
 import protobuf from 'protobufjs';
 
-import { USDC_DENOM, DYDX_DENOM } from '../../lib/constants';
 import {
   OrderId,
   Order,
@@ -200,10 +199,6 @@ export class Composer {
     coinDenom: string,
     quantums: Long,
   ): EncodeObject {
-    if (coinDenom !== USDC_DENOM && coinDenom !== DYDX_DENOM) {
-      throw new Error('Unsupported coinDenom');
-    }
-
     const coin: Coin = {
       denom: coinDenom,
       amount: quantums.toString(),

package/src/clients/modules/post.ts

@@ -22,10 +22,7 @@ import _ from 'lodash';
 import Long from 'long';
 import protobuf from 'protobufjs';
 
-import { DYDX_DENOM, GAS_PRICE_DYDX_DENOM, USDC_DENOM } from '../../lib/constants';
-import {
-  GAS_MULTIPLIER, GAS_PRICE,
-} from '../constants';
+import { GAS_MULTIPLIER } from '../constants';
 import { UnexpectedClientError } from '../lib/errors';
 import { generateRegistry } from '../lib/registry';
 import { Subaccount } from '../subaccount';
@@ -35,6 +32,7 @@ import {
   TransactionOptions,
   IPlaceOrder,
   ICancelOrder,
+  DenomConfig,
 } from '../types';
 import { Composer } from './composer';
 import { Get } from './get';
@@ -55,17 +53,27 @@ export class Post {
     private readonly registry: Registry;
     private readonly chainId: string;
     public readonly get: Get;
+    public readonly denoms: DenomConfig;
+
+    private readonly defaultGasPrice: GasPrice;
+    private readonly defaultDydxGasPrice: GasPrice;
 
     private accountNumberCache: Map<string, Account> = new Map();
 
     constructor(
       get: Get,
       chainId: string,
+      denoms: DenomConfig,
     ) {
       this.get = get;
       this.chainId = chainId;
       this.registry = generateRegistry();
       this.composer = new Composer();
+      this.denoms = denoms;
+      this.defaultGasPrice = GasPrice
+        .fromString(`0.025${denoms.USDC_GAS_DENOM !== undefined ? denoms.USDC_GAS_DENOM : denoms.USDC_DENOM}`);
+      this.defaultDydxGasPrice = GasPrice
+        .fromString(`25000000000${denoms.CHAINTOKEN_GAS_DENOM !== undefined ? denoms.CHAINTOKEN_GAS_DENOM : denoms.CHAINTOKEN_DENOM}`);
     }
 
     /**
@@ -79,7 +87,7 @@ export class Post {
     async simulate(
       wallet: LocalWallet,
       messaging: () => Promise<EncodeObject[]>,
-      gasPrice: GasPrice = GAS_PRICE,
+      gasPrice: GasPrice = this.defaultGasPrice,
       memo?: string,
       account?: () => Promise<Account>,
     ): Promise<StdFee> {
@@ -109,7 +117,7 @@ export class Post {
       wallet: LocalWallet,
       messaging: () => Promise<EncodeObject[]>,
       zeroFee: boolean,
-      gasPrice: GasPrice = GAS_PRICE,
+      gasPrice: GasPrice = this.defaultGasPrice,
       memo?: string,
       account?: () => Promise<Account>,
     ): Promise<Uint8Array> {
@@ -132,7 +140,7 @@ export class Post {
       wallet: LocalWallet,
       messaging: () => Promise<EncodeObject[]>,
       zeroFee: boolean,
-      gasPrice: GasPrice = GAS_PRICE,
+      gasPrice: GasPrice = this.defaultGasPrice,
       memo?: string,
       broadcastMode?: BroadcastMode,
       account?: () => Promise<Account>,
@@ -184,7 +192,7 @@ export class Post {
       messages: EncodeObject[],
       account: Account,
       zeroFee: boolean,
-      gasPrice: GasPrice = GAS_PRICE,
+      gasPrice: GasPrice = this.defaultGasPrice,
       memo?: string,
     ): Promise<Uint8Array> {
       // Simulate transaction if no fee is specified.
@@ -240,7 +248,7 @@ export class Post {
       account: Account,
       messages: EncodeObject[],
       zeroFee: boolean,
-      gasPrice: GasPrice = GAS_PRICE,
+      gasPrice: GasPrice = this.defaultGasPrice,
       memo?: string,
       broadcastMode?: BroadcastMode,
     ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
@@ -283,7 +291,7 @@ export class Post {
       pubKey: Secp256k1Pubkey,
       sequence: number,
       messages: readonly EncodeObject[],
-      gasPrice: GasPrice = GAS_PRICE,
+      gasPrice: GasPrice = this.defaultGasPrice,
       memo?: string,
     ): Promise<StdFee> {
       // Get simulated response.
@@ -320,7 +328,7 @@ export class Post {
         if (coin.denom === 'uusdc') {
           return {
             amount: coin.amount,
-            denom: USDC_DENOM,
+            denom: this.denoms.USDC_DENOM,
           };
         }
         return coin;
@@ -542,6 +550,10 @@ export class Post {
       zeroFee: boolean = true,
       broadcastMode?: BroadcastMode,
     ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
+      if (coinDenom !== this.denoms.CHAINTOKEN_DENOM && coinDenom !== this.denoms.USDC_DENOM) {
+        throw new Error('Unsupported coinDenom');
+      }
+
       const msgs: Promise<EncodeObject[]> = new Promise((resolve) => {
         const msg = this.composer.composeMsgSendToken(
           subaccount.address,
@@ -555,7 +567,9 @@ export class Post {
         subaccount.wallet,
         () => msgs,
         zeroFee,
-        coinDenom === DYDX_DENOM ? GAS_PRICE_DYDX_DENOM : GAS_PRICE,
+        coinDenom === this.denoms.CHAINTOKEN_DENOM
+          ? this.defaultDydxGasPrice
+          : this.defaultGasPrice,
         undefined,
         broadcastMode,
       );

package/src/clients/native.ts

@@ -8,7 +8,7 @@ import { Order_Side, Order_TimeInForce } from '@dydxprotocol/v4-proto/src/codege
 import * as AuthModule from 'cosmjs-types/cosmos/auth/v1beta1/query';
 import Long from 'long';
 
-import { BECH32_PREFIX, GAS_PRICE_DYDX_DENOM, USDC_DENOM } from '../lib/constants';
+import { BECH32_PREFIX } from '../lib/constants';
 import { UserError } from '../lib/errors';
 import { encodeJson } from '../lib/helpers';
 import { deriveHDKeyFromEthereumSignature } from '../lib/onboarding';
@@ -68,10 +68,19 @@ export async function connectNetwork(
   indexerUrl: string,
   indexerSocketUrl: string,
   faucetUrl?: string,
+  usdcDenom?: string,
+  usdcGasDenom?: string,
+  chainTokenDenom?: string,
+  chainTokenGasDenom?: string,
 ): Promise<string> {
   try {
     const indexerConfig = new IndexerConfig(indexerUrl, indexerSocketUrl);
-    const validatorConfig = new ValidatorConfig(validatorUrl, chainId);
+    const validatorConfig = new ValidatorConfig(validatorUrl, chainId, {
+      USDC_DENOM: usdcDenom ?? 'ibc/8E27BA2D5493AF5636760E354E46004562C46AB7EC0CC4C1CA14E9E20E2545B5',
+      CHAINTOKEN_DENOM: chainTokenDenom ?? 'adv4tnt',
+      USDC_GAS_DENOM: usdcGasDenom ?? 'uusdc',
+      CHAINTOKEN_GAS_DENOM: chainTokenGasDenom,
+    });
     const config = new Network('native', indexerConfig, validatorConfig);
     globalThis.client = await CompositeClient.connect(config);
     if (faucetUrl !== undefined) {
@@ -488,8 +497,6 @@ export async function transferNativeToken(
         return encodeObjects;
       },
       false,
-      GAS_PRICE_DYDX_DENOM,
-      undefined,
     );
     return encodeJson(tx);
   } catch (error) {
@@ -509,7 +516,8 @@ export async function getAccountBalance(): Promise<String> {
     }
     const address = globalThis.wallet.address!;
 
-    const tx = await client.validatorClient.get.getAccountBalance(address, USDC_DENOM);
+    const tx = await client.validatorClient.get
+      .getAccountBalance(address, client.validatorClient.config.denoms.USDC_DENOM);
     return encodeJson(tx);
   } catch (error) {
     return wrappedError(error);
@@ -681,7 +689,6 @@ export async function simulateTransferNativeToken(
       () => {
         return encodeObjects;
       },
-      GAS_PRICE_DYDX_DENOM,
     );
     return encodeJson(stdFee);
   } catch (error) {

package/src/clients/types.ts

@@ -61,6 +61,14 @@ export interface BroadcastOptions {
   broadcastTimeoutMs: number;
 }
 
+export interface DenomConfig {
+  USDC_DENOM: string;
+  CHAINTOKEN_DENOM: string;
+
+  USDC_GAS_DENOM?: string;
+  CHAINTOKEN_GAS_DENOM?: string;
+}
+
 // Specify when a broadcast should return:
 // 1. Immediately
 // 2. Once the transaction is added to the memPool

package/src/clients/validator-client.ts

@@ -69,6 +69,6 @@ export class ValidatorClient {
       setupTxExtension,
     );
     this._get = new Get(tendermintClient, queryClient);
-    this._post = new Post(this._get!, this.config.chainId);
+    this._post = new Post(this._get!, this.config.chainId, this.config.denoms);
   }
 }

package/src/lib/constants.ts

@@ -1,4 +1,4 @@
-import { GasPrice, StdFee } from '@cosmjs/stargate';
+import { StdFee } from '@cosmjs/stargate';
 
 // Bech32 Prefix
 export const BECH32_PREFIX = 'dydx';
@@ -10,16 +10,8 @@ export const BROADCAST_TIMEOUT_MS: number = 8_000;
 // API Defaults
 export const API_TIMEOUT_DEFAULT_MS: number = 5_000;
 
-// Default placeholder USDC denom (same as protocol).
-// Precomputed USDC IBC denom.
-export const USDC_DENOM = 'ibc/8E27BA2D5493AF5636760E354E46004562C46AB7EC0CC4C1CA14E9E20E2545B5';
-export const DYDX_DENOM = 'dv4tnt';
-
 // Gas
 export const GAS_MULTIPLIER: number = 1.4;
-// TODO(TRCL-2550): Replace 'uusdc' with IBC denom.
-export const GAS_PRICE: GasPrice = GasPrice.fromString('0.025uusdc');
-export const GAS_PRICE_DYDX_DENOM: GasPrice = GasPrice.fromString('0.025dv4tnt');
 
 export const ZERO_FEE: StdFee = {
   amount: [],

package/src/network_optimizer.ts

@@ -25,7 +25,10 @@ export class NetworkOptimizer {
   ): Promise<ValidatorClient[]> {
     return (await Promise.all(
       endpointUrls.map((endpointUrl) => ValidatorClient.connect(
-        new ValidatorConfig(endpointUrl, chainId))
+        new ValidatorConfig(endpointUrl, chainId, {
+          CHAINTOKEN_DENOM: '',
+          USDC_DENOM: '',
+        }))
         .catch((_) => undefined),
       ),
     )).filter(isTruthy);