@dydxprotocol/v4-client-js 1.7.0 → 1.9.0

package/examples/native_examples.ts

@@ -15,6 +15,9 @@ import {
   withdraw,
   withdrawToIBC,
   wrappedError,
+  getMegavaultOwnerShares,
+  depositToMegavault,
+  withdrawFromMegavault,
 } from '../src/clients/native';
 import { DYDX_TEST_ADDRESS, DYDX_TEST_MNEMONIC } from './constants';
 
@@ -47,6 +50,19 @@ async function test(): Promise<void> {
     const userStats = await getUserStats(payload);
     console.log(userStats);
 
+    const balances1 = await getAccountBalances();
+    console.log(balances1);
+
+    const vaultOwnerShares = await getMegavaultOwnerShares(payload);
+    console.log(vaultOwnerShares);
+    
+    const depositResult = await depositToMegavault(0, 2);
+    console.log(depositResult);
+
+    const withdrawResult = await withdrawFromMegavault(0, 1, 0);
+    console.log(withdrawResult);
+
+
     const sendTokenPayload = {
       subaccountNumber: 0,
       amount: '10', // Dydx Token

package/package.json

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

package/src/clients/constants.ts

@@ -23,6 +23,7 @@ export const MAINNET_CHAIN_ID = 'dydx-mainnet-1';
 // ------------ API URLs ------------
 export enum IndexerApiHost {
   TESTNET = 'https://indexer.v4testnet.dydx.exchange/',
+  STAGING = 'https://indexer.v4staging.dydx.exchange/',
   LOCAL = 'http://localhost:3002',
   // For the deployment by DYDX token holders
   MAINNET = 'https://indexer.dydx.trade',
@@ -30,6 +31,7 @@ export enum IndexerApiHost {
 
 export enum IndexerWSHost {
   TESTNET = 'wss://dydx-testnet.imperator.co/v4/ws',
+  STAGING = 'wss://indexer.v4staging.dydx.exchange/v4/ws',
   LOCAL = 'ws://localhost:3003',
   // For the deployment by DYDX token holders
   MAINNET = 'wss://indexer.dydx.trade/v4/ws',
@@ -41,6 +43,7 @@ export enum FaucetApiHost {
 
 export enum ValidatorApiHost {
   TESTNET = 'https://test-dydx.kingnodes.com',
+  STAGING = 'https://validator.v4staging.dydx.exchange',
   LOCAL = 'http://localhost:26657',
   // For the deployment by DYDX token holders
   MAINNET = 'https://dydx-ops-rpc.kingnodes.com:443',
@@ -265,6 +268,24 @@ export class Network {
     return new Network('testnet', indexerConfig, validatorConfig);
   }
 
+  static staging(): Network {
+    const indexerConfig = new IndexerConfig(IndexerApiHost.STAGING, IndexerWSHost.STAGING);
+    const validatorConfig = new ValidatorConfig(
+      ValidatorApiHost.STAGING,
+      TESTNET_CHAIN_ID,
+      {
+        CHAINTOKEN_DENOM: 'adv4tnt',
+        USDC_DENOM: 'ibc/8E27BA2D5493AF5636760E354E46004562C46AB7EC0CC4C1CA14E9E20E2545B5',
+        USDC_GAS_DENOM: 'uusdc',
+        USDC_DECIMALS: 6,
+        CHAINTOKEN_DECIMALS: 18,
+      },
+      undefined,
+      'Client Example',
+    );
+    return new Network('staging', indexerConfig, validatorConfig);
+  }
+
   static local(): Network {
     const indexerConfig = new IndexerConfig(IndexerApiHost.LOCAL, IndexerWSHost.LOCAL);
     const validatorConfig = new ValidatorConfig(

package/src/clients/helpers/request-helpers.ts

@@ -1,3 +1,6 @@
+import Long from "long";
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
 export function generateQueryPath(url: string, params: {}): string {
   const definedEntries = Object.entries(params).filter(
     ([_key, value]: [string, unknown]) => value !== undefined,
@@ -12,3 +15,57 @@ export function generateQueryPath(url: string, params: {}): string {
     .join('&');
   return `${url}?${paramsString}`;
 }
+
+export function parseToPrimitives<T>(x: T): T {
+  if (typeof x === 'number' || typeof x === 'string' || typeof x === 'boolean' || x === null) {
+    return x;
+  }
+
+  if (Array.isArray(x)) {
+    return x.map((item) => parseToPrimitives(item)) as T;
+  }
+
+  if (Long.isLong(x)) {
+    return x.toString() as T;
+  }
+
+  if (x instanceof Uint8Array) {
+    return bytesToBigInt(x).toString() as T;
+  }
+
+  if (x instanceof Date) {
+    return x.toString() as T;
+  }
+
+  if (typeof x === 'object') {
+    const parsedObj: { [key: string]: any } = {};
+    // eslint-disable-next-line no-restricted-syntax
+    for (const key in x) {
+      if (Object.prototype.hasOwnProperty.call(x, key)) {
+        parsedObj[key] = parseToPrimitives((x as any)[key]);
+      }
+    }
+    return parsedObj as T;
+  }
+
+  if (typeof x === 'bigint') {
+    return x.toString() as T;
+  }
+
+  throw new Error(`Unsupported data type: ${typeof x}`);
+}
+
+/**
+ * Converts a byte array (representing an arbitrary-size signed integer) into a bigint.
+ * @param u Array of bytes represented as a Uint8Array.
+ */
+function bytesToBigInt(u: Uint8Array): bigint {
+  if (u.length <= 1) {
+    return BigInt(0);
+  }
+  // eslint-disable-next-line no-bitwise
+  const negated: boolean = (u[0] & 1) === 1;
+  const hex: string = Buffer.from(u.slice(1)).toString('hex');
+  const abs: bigint = BigInt(`0x${hex}`);
+  return negated ? -abs : abs;
+}

package/src/clients/native.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 /*
     Native app can call JS functions with primitives.
 */
@@ -30,6 +31,7 @@ import {
   SelectedGasDenom,
 } from './constants';
 import { FaucetClient } from './faucet-client';
+import { parseToPrimitives } from './helpers/request-helpers';
 import { Response } from './lib/axios';
 import LocalWallet from './modules/local-wallet';
 import { NobleClient } from './noble-client';
@@ -1352,3 +1354,90 @@ export async function setSelectedGasDenom(gasDenom: string): Promise<string> {
     return wrappedError(error);
   }
 }
+
+export async function getMegavaultOwnerShares(payload: string): Promise<string> {
+  try {
+    const client = globalThis.client;
+    if (client === undefined) {
+      throw new UserError('client is not connected. Call connectClient() first');
+    }
+    const json = JSON.parse(payload);
+    const address = json.address;
+    if (address === undefined) {
+      throw new UserError('address is not set');
+    }
+    const response =
+      await globalThis.client?.validatorClient.get.getMegavaultOwnerShares(address);
+    return encodeJson(parseToPrimitives(response));
+  } catch (e) {
+    return wrappedError(e);
+  }
+}
+
+export async function getMegavaultWithdrawalInfo(
+  sharesToWithdraw: bigint
+): Promise<string> {
+  try {
+    const client = globalThis.client;
+    if (client === undefined) {
+      throw new UserError('client is not connected. Call connectClient() first');
+    }
+    const response =
+      await globalThis.client?.validatorClient.get.getMegavaultWithdrawalInfo(sharesToWithdraw);
+      return encodeJson(parseToPrimitives(response));
+  } catch (e) {
+    return wrappedError(e);
+  }
+}
+
+export async function depositToMegavault(
+  subaccountNumber: number,
+  amountUsdc: number
+): Promise<string> {
+  try {
+    const client = globalThis.client;
+    if (client === undefined) {
+      throw new UserError('client is not connected. Call connectNetwork() first');
+    }
+    const wallet = globalThis.wallet;
+    if (wallet === undefined) {
+      throw new UserError('wallet is not set. Call connectWallet() first');
+    }
+    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
+    const tx = await client.depositToMegavault(
+      subaccount,
+      amountUsdc,
+      Method.BroadcastTxCommit,
+    );
+    return encodeJson(parseToPrimitives(tx));
+  } catch (error) {
+    return wrappedError(error);
+  }
+}
+
+export async function withdrawFromMegavault(
+  subaccountNumber: number,
+  shares: number,
+  minAmount: number,
+): Promise<string> {
+  try {
+    const client = globalThis.client;
+    if (client === undefined) {
+      throw new UserError('client is not connected. Call connectNetwork() first');
+    }
+    const wallet = globalThis.wallet;
+    if (wallet === undefined) {
+      throw new UserError('wallet is not set. Call connectWallet() first');
+    }
+    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
+    const tx = await client.withdrawFromMegavault(
+      subaccount,
+      shares,
+      minAmount,
+      Method.BroadcastTxCommit,
+    );
+    return encodeJson(parseToPrimitives(tx));
+  } catch (error) {
+    return wrappedError(error);
+  }
+}