@dydxprotocol/v4-client-js 0.30.0 → 0.31.0

package/examples/native_examples.ts

@@ -8,7 +8,9 @@ import {
   getAccountBalances,
   getUserStats,
   simulateDeposit,
+  simulateTransferNativeToken,
   simulateWithdraw,
+  transferNativeToken,
   withdraw,
   withdrawToIBC,
   wrappedError,
@@ -20,13 +22,24 @@ async function test(): Promise<void> {
     const wallet = await connectWallet(DYDX_TEST_MNEMONIC);
     console.log(wallet);
 
-    const address = await connect(Environment.staging, DYDX_TEST_MNEMONIC);
+    const address = await connect(Environment.testnet, DYDX_TEST_MNEMONIC);
     console.log(address);
 
     const payload = `{ "address": "${DYDX_TEST_ADDRESS}" }`;
     const userStats = await getUserStats(payload);
     console.log(userStats);
 
+    const sendTokenPayload = {
+      subaccountNumber: 0,
+      amount: 10,   // Dydx Token
+      recipient: 'dydx15ndn9c895f8ntck25qughtuck9spv2d9svw5qx',
+    };
+    const fees = await simulateTransferNativeToken(JSON.stringify(sendTokenPayload));
+    console.log(fees);
+
+    let tx = await transferNativeToken(JSON.stringify(sendTokenPayload));
+    console.log(tx);
+
     let balances = await getAccountBalances();
     console.log(balances);
 
@@ -41,7 +54,7 @@ async function test(): Promise<void> {
       subaccountNumber: 0,
       amount: 20,
     };
-    let tx = await withdraw(JSON.stringify(withdrawlPayload));
+    tx = await withdraw(JSON.stringify(withdrawlPayload));
     console.log(tx);
 
     balances = await getAccountBalances();

package/examples/transfer_example_send.ts

@@ -66,6 +66,7 @@ async function test(): Promise<void> {
     TEST_RECIPIENT_ADDRESS,
     DYDX_DENOM,
     amountAfterFee,
+    false,
     Method.BroadcastTxCommit,
   );
   console.log('**Send**');

package/examples/transfer_example_withdraw_other.ts

@@ -57,6 +57,7 @@ async function test(): Promise<void> {
     0,
     amountAfterFee,
     TEST_RECIPIENT_ADDRESS,
+    false,
     Method.BroadcastTxCommit,
   );
   console.log('**Withdraw and Send**');

package/package.json

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

package/scripts/ios_build_pack.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+npm run webpack
+cp __native__/__ios__/v4-native-client.js ~/native-ios-v4/dydx/dydxPresenters/dydxPresenters/_Features

package/scripts/publish-if-not-exists.sh

@@ -12,7 +12,7 @@ if [ $? -eq 0 ]; then
 	git config --global user.name "github_actions"
 
 	# Get version and tag
-	git tag v4-client-js ${VERSION}
+	git tag v4-client-js@${VERSION}
 	git push --tags
 
 	npm publish

package/src/clients/composite-client.ts

@@ -6,6 +6,7 @@ import protobuf from 'protobufjs';
 
 import { OrderFlags } from '../types';
 import {
+  DYDX_DENOM,
   GAS_PRICE,
   Network, OrderExecution, OrderSide, OrderTimeInForce, OrderType,
 } from './constants';
@@ -541,6 +542,32 @@ export class CompositeClient {
     );
   }
 
+  /**
+     * @description Create message to send dydx token from subaccount to wallet
+     * with human readable input.
+     *
+     * @param subaccount The subaccount to withdraw from
+     * @param amount The amount to withdraw
+     * @param recipient The recipient address
+     *
+     * @throws UnexpectedClientError if a malformed response is returned with no GRPC error
+     * at any point.
+     * @returns The message
+     */
+  sendTokenMessage(
+    subaccount: Subaccount,
+    amount: number,
+    recipient: string,
+  ): EncodeObject {
+    const quantums: Long = Long.fromNumber(amount * (10 ** 6));
+    return this.validatorClient.post.composer.composeMsgSendToken(
+      subaccount.address,
+      recipient,
+      DYDX_DENOM,
+      quantums,
+    );
+  }
+
   async signPlaceOrder(
     subaccount: Subaccount,
     marketId: string,

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

@@ -148,6 +148,8 @@ export function calculateOrderFlags(type: OrderType, timeInForce?: OrderTimeInFo
 export function calculateClientMetadata(orderType: OrderType): number {
   switch (orderType) {
     case OrderType.MARKET:
+    case OrderType.STOP_MARKET:
+    case OrderType.TAKE_PROFIT_MARKET:
       return 1;
 
     default:

package/src/clients/modules/post.ts

@@ -441,6 +441,7 @@ export class Post {
       assetId: number,
       quantums: Long,
       recipient?: string,
+      zeroFee: boolean = true,
       broadcastMode?: BroadcastMode,
     ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
       const msgs: Promise<EncodeObject[]> = new Promise((resolve) => {
@@ -453,7 +454,7 @@ export class Post {
         );
         resolve([msg]);
       });
-      return this.send(subaccount.wallet, () => msgs, true, undefined, undefined, broadcastMode);
+      return this.send(subaccount.wallet, () => msgs, zeroFee, undefined, undefined, broadcastMode);
     }
 
     async sendToken(
@@ -461,6 +462,7 @@ export class Post {
       recipient: string,
       coinDenom: string,
       quantums: Long,
+      zeroFee: boolean = true,
       broadcastMode?: BroadcastMode,
     ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
       const msgs: Promise<EncodeObject[]> = new Promise((resolve) => {
@@ -475,7 +477,7 @@ export class Post {
       return this.send(
         subaccount.wallet,
         () => msgs,
-        false,
+        zeroFee,
         coinDenom === DYDX_DENOM ? GAS_PRICE_DYDX_DENOM : GAS_PRICE,
         undefined,
         broadcastMode,

package/src/clients/native.ts

@@ -8,7 +8,7 @@ import { Order_Side, Order_TimeInForce } from '@dydxprotocol/dydxjs/src/codegen/
 import * as AuthModule from 'cosmjs-types/cosmos/auth/v1beta1/query';
 import Long from 'long';
 
-import { BECH32_PREFIX, USDC_DENOM } from '../lib/constants';
+import { BECH32_PREFIX, GAS_PRICE_DYDX_DENOM, USDC_DENOM } from '../lib/constants';
 import { UserError } from '../lib/errors';
 import { encodeJson } from '../lib/helpers';
 import { deriveHDKeyFromEthereumSignature } from '../lib/onboarding';
@@ -360,6 +360,7 @@ export async function withdraw(
     const tx = await client.withdrawFromSubaccount(
       subaccount,
       amount,
+      json.recipient,
     );
     return encodeJson(tx);
   } catch (error) {
@@ -444,6 +445,53 @@ export async function withdrawToIBC(
   }
 }
 
+export async function transferNativeToken(
+  payload: string,
+): Promise<string> {
+  try {
+    const client = globalThis.client;
+    if (client === undefined) {
+      throw new UserError('client is not connected. Call connectClient() first');
+    }
+    const wallet = globalThis.wallet;
+    if (wallet === undefined) {
+      throw new UserError('wallet is not set. Call connectWallet() first');
+    }
+
+    const json = JSON.parse(payload);
+    const subaccountNumber = json.subaccountNumber;
+    if (subaccountNumber === undefined) {
+      throw new UserError('subaccountNumber is not set');
+    }
+    const amount = json.amount;
+    if (amount === undefined) {
+      throw new UserError('amount is not set');
+    }
+
+    const subaccount = new Subaccount(wallet, subaccountNumber);
+    const msg: EncodeObject = client.sendTokenMessage(
+      subaccount,
+      amount,
+      json.recipient,
+    );
+    const msgs = [msg];
+    const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs));
+
+    const tx = await client.send(
+      wallet,
+      () => {
+        return encodeObjects;
+      },
+      false,
+      GAS_PRICE_DYDX_DENOM,
+      undefined,
+    );
+    return encodeJson(tx);
+  } catch (error) {
+    return wrappedError(error);
+  }
+}
+
 export async function getAccountBalance(): Promise<String> {
   try {
     const client = globalThis.client;
@@ -567,6 +615,7 @@ export async function simulateWithdraw(
     const msg: EncodeObject = client.withdrawFromSubaccountMessage(
       subaccount,
       amount,
+      json.recipient,
     );
     const msgs: EncodeObject[] = [msg];
     const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs));
@@ -579,6 +628,53 @@ export async function simulateWithdraw(
   }
 }
 
+export async function simulateTransferNativeToken(
+  payload: string,
+): Promise<string> {
+  try {
+    const client = globalThis.client;
+    if (client === undefined) {
+      throw new UserError('client is not connected. Call connectClient() first');
+    }
+    const wallet = globalThis.wallet;
+    if (wallet === undefined) {
+      throw new UserError('wallet is not set. Call connectWallet() first');
+    }
+    const json = JSON.parse(payload);
+    const subaccountNumber = json.subaccountNumber;
+    if (subaccountNumber === undefined) {
+      throw new UserError('subaccountNumber is not set');
+    }
+    const recipient = json.recipient;
+    if (recipient === undefined) {
+      throw new UserError('recipient is not set');
+    }
+    const amount = json.amount;
+    if (amount === undefined) {
+      throw new UserError('amount is not set');
+    }
+
+    const subaccount = new Subaccount(wallet, subaccountNumber);
+    const msg: EncodeObject = client.sendTokenMessage(
+      subaccount,
+      amount,
+      json.recipient,
+    );
+    const msgs: EncodeObject[] = [msg];
+    const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs));
+    const stdFee = await client.simulate(
+      globalThis.wallet,
+      () => {
+        return encodeObjects;
+      },
+      GAS_PRICE_DYDX_DENOM,
+    );
+    return encodeJson(stdFee);
+  } catch (error) {
+    return wrappedError(error);
+  }
+}
+
 export async function signRawPlaceOrder(
   subaccountNumber: number,
   clientId: number,