@dydxprotocol/v4-client-js 1.1.13 → 1.1.15

package/src/clients/native.ts

@@ -2,9 +2,13 @@
     Native app can call JS functions with primitives.
 */
 
+import { Secp256k1, sha256 } from '@cosmjs/crypto';
 import { EncodeObject, coin as createCoin } from '@cosmjs/proto-signing';
 import { MsgTransferEncodeObject, accountFromAny } from '@cosmjs/stargate';
-import { Order_Side, Order_TimeInForce } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/order';
+import {
+  Order_Side,
+  Order_TimeInForce,
+} from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/order';
 import * as AuthModule from 'cosmjs-types/cosmos/auth/v1beta1/query';
 import Long from 'long';
 
@@ -15,7 +19,13 @@ import { deriveHDKeyFromEthereumSignature } from '../lib/onboarding';
 import { NetworkOptimizer } from '../network_optimizer';
 import { CompositeClient, MarketInfo } from './composite-client';
 import {
-  Network, OrderType, OrderSide, OrderTimeInForce, OrderExecution, IndexerConfig, ValidatorConfig,
+  Network,
+  OrderType,
+  OrderSide,
+  OrderTimeInForce,
+  OrderExecution,
+  IndexerConfig,
+  ValidatorConfig,
 } from './constants';
 import { FaucetClient } from './faucet-client';
 import { Response } from './lib/axios';
@@ -31,6 +41,11 @@ declare global {
   var faucetClient: FaucetClient | null;
   // eslint-disable-next-line vars-on-top, no-var
   var wallet: LocalWallet;
+  // eslint-disable-next-line vars-on-top, no-var
+  var hdKey: {
+    privateKey: Uint8Array | null;
+    publicKey: Uint8Array | null;
+  }
 
   // eslint-disable-next-line vars-on-top, no-var
   var nobleClient: NobleClient | undefined;
@@ -38,9 +53,7 @@ declare global {
   var nobleWallet: LocalWallet | undefined;
 }
 
-export async function connectClient(
-  network: Network,
-): Promise<string> {
+export async function connectClient(network: Network): Promise<string> {
   try {
     globalThis.client = await CompositeClient.connect(network);
     return encodeJson(network);
@@ -49,9 +62,7 @@ export async function connectClient(
   }
 }
 
-export async function connectNetwork(
-  paramsJSON: string,
-): Promise<string> {
+export async function connectNetwork(paramsJSON: string): Promise<string> {
   try {
     const params = JSON.parse(paramsJSON);
     const {
@@ -70,16 +81,20 @@ export async function connectNetwork(
       txnMemo,
     } = params;
 
-    if (indexerUrl === undefined ||
+    if (
+      indexerUrl === undefined ||
       websocketUrl === undefined ||
       validatorUrl === undefined ||
-      chainId === undefined) {
+      chainId === undefined
+    ) {
       throw new UserError('Missing required network params');
     }
-    if (USDC_DENOM === undefined ||
+    if (
+      USDC_DENOM === undefined ||
       USDC_DECIMALS === undefined ||
       CHAINTOKEN_DENOM === undefined ||
-      CHAINTOKEN_DECIMALS === undefined) {
+      CHAINTOKEN_DECIMALS === undefined
+    ) {
       throw new UserError('Missing required token params');
     }
     if (txnMemo === undefined) {
@@ -125,15 +140,10 @@ export async function connectNetwork(
   }
 }
 
-export async function connectWallet(
-  mnemonic: string,
-): Promise<string> {
+export async function connectWallet(mnemonic: string): Promise<string> {
   try {
     globalThis.wallet = await LocalWallet.fromMnemonic(mnemonic, BECH32_PREFIX);
-    globalThis.nobleWallet = await LocalWallet.fromMnemonic(
-      mnemonic,
-      NOBLE_BECH32_PREFIX,
-    );
+    globalThis.nobleWallet = await LocalWallet.fromMnemonic(mnemonic, NOBLE_BECH32_PREFIX);
 
     try {
       await globalThis.nobleClient?.connect(globalThis.nobleWallet);
@@ -148,10 +158,7 @@ export async function connectWallet(
   }
 }
 
-export async function connect(
-  network: Network,
-  mnemonic: string,
-): Promise<string> {
+export async function connect(network: Network, mnemonic: string): Promise<string> {
   try {
     await connectClient(network);
     return connectWallet(mnemonic);
@@ -162,8 +169,11 @@ export async function connect(
 
 export async function deriveMnemomicFromEthereumSignature(signature: string): Promise<string> {
   try {
-    const { mnemonic } = deriveHDKeyFromEthereumSignature(signature);
+    const { mnemonic, privateKey, publicKey } = deriveHDKeyFromEthereumSignature(signature);
     const wallet = await LocalWallet.fromMnemonic(mnemonic, BECH32_PREFIX);
+    hdKey = {
+      privateKey, publicKey
+    }
     const result = { mnemonic, address: wallet.address! };
     return new Promise((resolve) => {
       resolve(encodeJson(result));
@@ -218,8 +228,8 @@ export async function getEquityTiers(): Promise<string> {
     if (client === undefined) {
       throw new UserError('client is not connected. Call connectClient() first');
     }
-    const equityTiers = await globalThis.client?.validatorClient.get
-      .getEquityTierLimitConfiguration();
+    const equityTiers =
+      await globalThis.client?.validatorClient.get.getEquityTierLimitConfiguration();
     return encodeJson(equityTiers, ByteArrayEncoding.BIGINT);
   } catch (e) {
     return wrappedError(e);
@@ -239,9 +249,7 @@ export async function getPerpetualMarkets(): Promise<string> {
   }
 }
 
-export async function placeOrder(
-  payload: string,
-): Promise<string> {
+export async function placeOrder(payload: string): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -323,9 +331,7 @@ export function wrappedError(error: Error): string {
   return `{"error": ${text}}`;
 }
 
-export async function cancelOrder(
-  payload: string,
-): Promise<string> {
+export async function cancelOrder(payload: string): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -371,9 +377,7 @@ export async function cancelOrder(
   }
 }
 
-export async function deposit(
-  payload: string,
-): Promise<string> {
+export async function deposit(payload: string): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -395,19 +399,14 @@ export async function deposit(
     }
 
     const subaccount = new SubaccountInfo(wallet, subaccountNumber);
-    const tx = await client.depositToSubaccount(
-      subaccount,
-      amount,
-    );
+    const tx = await client.depositToSubaccount(subaccount, amount);
     return encodeJson(tx);
   } catch (error) {
     return wrappedError(error);
   }
 }
 
-export async function withdraw(
-  payload: string,
-): Promise<string> {
+export async function withdraw(payload: string): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -429,20 +428,14 @@ export async function withdraw(
     }
 
     const subaccount = new SubaccountInfo(wallet, subaccountNumber);
-    const tx = await client.withdrawFromSubaccount(
-      subaccount,
-      amount,
-      json.recipient,
-    );
+    const tx = await client.withdrawFromSubaccount(subaccount, amount, json.recipient);
     return encodeJson(tx);
   } catch (error) {
     return wrappedError(error);
   }
 }
 
-export async function faucet(
-  payload: string,
-): Promise<string> {
+export async function faucet(payload: string): Promise<string> {
   try {
     const faucetClient = globalThis.faucetClient;
     if (!faucetClient) {
@@ -491,7 +484,7 @@ export async function withdrawToIBC(
       throw new UserError('wallet is not set. Call connectWallet() first');
     }
 
-    const decode = (str: string):string => Buffer.from(str, 'base64').toString('binary');
+    const decode = (str: string): string => Buffer.from(str, 'base64').toString('binary');
     const decoded = decode(payload);
 
     const json: SquidIBCPayload = JSON.parse(decoded);
@@ -528,9 +521,7 @@ export async function withdrawToIBC(
   }
 }
 
-export async function transferNativeToken(
-  payload: string,
-): Promise<string> {
+export async function transferNativeToken(payload: string): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -547,11 +538,7 @@ export async function transferNativeToken(
       throw new UserError('amount is not set');
     }
 
-    const msg: EncodeObject = client.sendTokenMessage(
-      wallet,
-      amount,
-      json.recipient,
-    );
+    const msg: EncodeObject = client.sendTokenMessage(wallet, amount, json.recipient);
     const msgs = [msg];
     const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs));
 
@@ -582,8 +569,10 @@ export async function getAccountBalance(): Promise<String> {
     }
     const address = globalThis.wallet.address!;
 
-    const tx = await client.validatorClient.get
-      .getAccountBalance(address, client.validatorClient.config.denoms.USDC_DENOM);
+    const tx = await client.validatorClient.get.getAccountBalance(
+      address,
+      client.validatorClient.config.denoms.USDC_DENOM,
+    );
     return encodeJson(tx);
   } catch (error) {
     return wrappedError(error);
@@ -609,9 +598,7 @@ export async function getAccountBalances(): Promise<String> {
   }
 }
 
-export async function getUserStats(
-  payload: string,
-): Promise<String> {
+export async function getUserStats(payload: string): Promise<String> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -630,9 +617,7 @@ export async function getUserStats(
   }
 }
 
-export async function simulateDeposit(
-  payload: string,
-): Promise<string> {
+export async function simulateDeposit(payload: string): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -653,28 +638,20 @@ export async function simulateDeposit(
     }
 
     const subaccount = new SubaccountInfo(wallet, subaccountNumber);
-    const msg: EncodeObject = client.depositToSubaccountMessage(
-      subaccount,
-      amount,
-    );
+    const msg: EncodeObject = client.depositToSubaccountMessage(subaccount, amount);
     const msgs: EncodeObject[] = [msg];
     const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs));
 
-    const stdFee = await client.simulate(
-      globalThis.wallet,
-      () => {
-        return encodeObjects;
-      },
-    );
+    const stdFee = await client.simulate(globalThis.wallet, () => {
+      return encodeObjects;
+    });
     return JSON.stringify(stdFee);
   } catch (error) {
     return wrappedError(error);
   }
 }
 
-export async function simulateWithdraw(
-  payload: string,
-): Promise<string> {
+export async function simulateWithdraw(payload: string): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -703,21 +680,16 @@ export async function simulateWithdraw(
     const msgs: EncodeObject[] = [msg];
     const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs));
 
-    const stdFee = await client.simulate(
-      globalThis.wallet,
-      () => {
-        return encodeObjects;
-      },
-    );
+    const stdFee = await client.simulate(globalThis.wallet, () => {
+      return encodeObjects;
+    });
     return encodeJson(stdFee);
   } catch (error) {
     return wrappedError(error);
   }
 }
 
-export async function simulateTransferNativeToken(
-  payload: string,
-): Promise<string> {
+export async function simulateTransferNativeToken(payload: string): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -737,11 +709,7 @@ export async function simulateTransferNativeToken(
       throw new UserError('amount is not set');
     }
 
-    const msg: EncodeObject = client.sendTokenMessage(
-      wallet,
-      amount,
-      json.recipient,
-    );
+    const msg: EncodeObject = client.sendTokenMessage(wallet, amount, json.recipient);
     const msgs: EncodeObject[] = [msg];
     const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs));
 
@@ -800,11 +768,7 @@ export async function signRawPlaceOrder(
       );
       resolve([msg]);
     });
-    const signed = await client.sign(
-      wallet,
-      () => msgs,
-      true,
-    );
+    const signed = await client.sign(wallet, () => msgs, true);
     return Buffer.from(signed).toString('base64');
   } catch (error) {
     return wrappedError(error);
@@ -983,9 +947,7 @@ export async function getRewardsParams(): Promise<string> {
   }
 }
 
-export async function getDelegatorDelegations(
-  payload: string,
-): Promise<string> {
+export async function getDelegatorDelegations(payload: string): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -996,17 +958,15 @@ export async function getDelegatorDelegations(
     if (address === undefined) {
       throw new UserError('address is not set');
     }
-    const delegations = await globalThis
-      .client?.validatorClient.get.getDelegatorDelegations(address);
+    const delegations =
+      await globalThis.client?.validatorClient.get.getDelegatorDelegations(address);
     return encodeJson(delegations);
   } catch (e) {
     return wrappedError(e);
   }
 }
 
-export async function getDelegatorUnbondingDelegations(
-  payload: string,
-): Promise<string> {
+export async function getDelegatorUnbondingDelegations(payload: string): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -1017,17 +977,15 @@ export async function getDelegatorUnbondingDelegations(
     if (address === undefined) {
       throw new UserError('address is not set');
     }
-    const delegations = await globalThis
-      .client?.validatorClient.get.getDelegatorUnbondingDelegations(address);
+    const delegations =
+      await globalThis.client?.validatorClient.get.getDelegatorUnbondingDelegations(address);
     return encodeJson(delegations);
   } catch (e) {
     return wrappedError(e);
   }
 }
 
-export async function getMarketPrice(
-  payload: string,
-): Promise<string> {
+export async function getMarketPrice(payload: string): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -1049,9 +1007,7 @@ export async function getNobleBalance(): Promise<String> {
   try {
     const client = globalThis.nobleClient;
     if (client === undefined || !client.isConnected) {
-      throw new UserError(
-        'client is not connected.',
-      );
+      throw new UserError('client is not connected.');
     }
     const coin = await client.getAccountBalance('uusdc');
     return encodeJson(coin);
@@ -1064,9 +1020,7 @@ export async function sendNobleIBC(squidPayload: string): Promise<String> {
   try {
     const client = globalThis.nobleClient;
     if (client === undefined || !client.isConnected) {
-      throw new UserError(
-        'client is not connected.',
-      );
+      throw new UserError('client is not connected.');
     }
 
     const json: SquidIBCPayload = JSON.parse(squidPayload);
@@ -1084,13 +1038,12 @@ export async function sendNobleIBC(squidPayload: string): Promise<String> {
     const fee = await client.simulateTransaction([ibcMsg]);
 
     if (!ibcMsg.value.token) {
-      throw new UserError(
-        'Payload missing token field',
-      );
+      throw new UserError('Payload missing token field');
     }
 
     // take out fee from amount before sweeping
-    const amount = parseInt(ibcMsg.value.token.amount, 10) -
+    const amount =
+      parseInt(ibcMsg.value.token.amount, 10) -
       Math.floor(parseInt(fee.amount[0].amount, 10) * GAS_MULTIPLIER);
 
     if (amount <= 0) {
@@ -1119,7 +1072,7 @@ export async function withdrawToNobleIBC(payload: string): Promise<String> {
 
     const { subaccountNumber, amount, ibcPayload } = json ?? {};
 
-    const decode = (str: string):string => Buffer.from(str, 'base64').toString('binary');
+    const decode = (str: string): string => Buffer.from(str, 'base64').toString('binary');
     const decoded = decode(ibcPayload);
 
     const parsedIbcPayload: SquidIBCPayload = JSON.parse(decoded);
@@ -1139,11 +1092,7 @@ export async function withdrawToNobleIBC(payload: string): Promise<String> {
       },
     };
 
-    const tx = await client.send(
-      wallet,
-      () => Promise.resolve([msg, ibcMsg]),
-      false,
-    );
+    const tx = await client.send(wallet, () => Promise.resolve([msg, ibcMsg]), false);
 
     return encodeJson({
       txHash: `0x${Buffer.from(tx?.hash).toString('hex')}`,
@@ -1157,9 +1106,7 @@ export async function cctpWithdraw(squidPayload: string): Promise<String> {
   try {
     const client = globalThis.nobleClient;
     if (client === undefined || !client.isConnected) {
-      throw new UserError(
-        'client is not connected.',
-      );
+      throw new UserError('client is not connected.');
     }
 
     const json = JSON.parse(squidPayload);
@@ -1171,7 +1118,8 @@ export async function cctpWithdraw(squidPayload: string): Promise<String> {
     const fee = await client.simulateTransaction([ibcMsg]);
 
     // take out fee from amount before sweeping
-    const amount = parseInt(ibcMsg.value.amount, 10) -
+    const amount =
+      parseInt(ibcMsg.value.amount, 10) -
       Math.floor(parseInt(fee.amount[0].amount, 10) * GAS_MULTIPLIER);
 
     if (amount <= 0) {
@@ -1188,9 +1136,7 @@ export async function cctpWithdraw(squidPayload: string): Promise<String> {
   }
 }
 
-export async function getWithdrawalCapacityByDenom(
-  payload: string,
-): Promise<string> {
+export async function getWithdrawalCapacityByDenom(payload: string): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -1209,8 +1155,7 @@ export async function getWithdrawalCapacityByDenom(
   }
 }
 
-export async function getWithdrawalAndTransferGatingStatus(
-): Promise<string> {
+export async function getWithdrawalAndTransferGatingStatus(): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -1224,9 +1169,7 @@ export async function getWithdrawalAndTransferGatingStatus(
   }
 }
 
-export async function subaccountTransfer(
-  payload: string,
-): Promise<string> {
+export async function subaccountTransfer(payload: string): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -1269,3 +1212,39 @@ export async function subaccountTransfer(
     return wrappedError(error);
   }
 }
+
+export async function signCompliancePayload(payload: string): Promise<string> {
+  try {
+    const json = JSON.parse(payload);
+    const message = json.message;
+    if (message === undefined) {
+      throw new UserError('message is not set');
+    }
+    const action = json.action;
+    if (action === undefined) {
+      throw new UserError('action is not set');
+    }
+    const currentStatus = json.status;
+    if (currentStatus === undefined) {
+      throw new UserError('status is not set');
+    }
+    if (!hdKey?.privateKey || !hdKey?.publicKey) {
+      throw new Error('Missing hdKey');
+    }
+  
+    const timestampInSeconds = Math.floor(Date.now() / 1000);
+    const messageToSign: string = `${message}:${action}"${currentStatus ?? ''}:${timestampInSeconds}`;
+    const messageHash = sha256(Buffer.from(messageToSign));
+  
+    const signed = await Secp256k1.createSignature(messageHash, hdKey.privateKey);
+    const signedMessage = signed.toFixedLength();
+
+    return encodeJson({
+      signedMessage: Buffer.from(signedMessage).toString('base64'),
+      publicKey: Buffer.from(hdKey.publicKey).toString('base64'),
+      timestamp: timestampInSeconds,
+    });
+  } catch (error) {
+    return wrappedError(error);
+  }
+}

package/src/clients/noble-client.ts

@@ -99,11 +99,7 @@ export class NobleClient {
       throw new Error('NobleClient wallet not initialized');
     }
     // Get simulated response
-    const gasEstimate = await this.stargateClient.simulate(
-      this.wallet?.address,
-      messages,
-      memo,
-    );
+    const gasEstimate = await this.stargateClient.simulate(this.wallet?.address, messages, memo);
 
     // Calculate and return the fee
     return calculateFee(Math.floor(gasEstimate * GAS_MULTIPLIER), gasPrice);