@dydxprotocol/v4-client-js 1.0.4 → 1.0.6

package/examples/noble_example.ts

@@ -0,0 +1,118 @@
+import { EncodeObject } from '@cosmjs/proto-signing';
+import Long from 'long';
+
+import { Network } from '../src/clients/constants';
+import LocalWallet from '../src/clients/modules/local-wallet';
+import { NobleClient } from '../src/clients/noble-client';
+import { ValidatorClient } from '../src/clients/validator-client';
+import { BECH32_PREFIX, NOBLE_BECH32_PREFIX } from '../src/lib/constants';
+import { sleep } from '../src/lib/utils';
+import { DYDX_TEST_MNEMONIC } from './constants';
+
+async function test(): Promise<void> {
+  const dydxClient = await ValidatorClient.connect(
+    Network.testnet().validatorConfig,
+  );
+
+  const dydxWallet = await LocalWallet.fromMnemonic(
+    DYDX_TEST_MNEMONIC,
+    BECH32_PREFIX,
+  );
+  const nobleWallet = await LocalWallet.fromMnemonic(
+    DYDX_TEST_MNEMONIC,
+    NOBLE_BECH32_PREFIX,
+  );
+
+  const client = new NobleClient('https://rpc.testnet.noble.strange.love');
+  await client.connect(nobleWallet);
+
+  if (nobleWallet.address === undefined || dydxWallet.address === undefined) {
+    throw new Error('Wallet not found');
+  }
+
+  // IBC to noble
+
+  const ibcToNobleMsg: EncodeObject = {
+    typeUrl: '/ibc.applications.transfer.v1.MsgTransfer',
+    value: {
+      sourcePort: 'transfer',
+      sourceChannel: 'channel-0',
+      token: {
+        denom:
+          'ibc/8E27BA2D5493AF5636760E354E46004562C46AB7EC0CC4C1CA14E9E20E2545B5',
+        amount: '1000000',
+      },
+      sender: dydxWallet.address,
+      receiver: nobleWallet.address,
+      timeoutTimestamp: Long.fromNumber(
+        Math.floor(Date.now() / 1000) * 1e9 + 10 * 60 * 1e9,
+      ),
+    },
+  };
+
+  const msgs = [ibcToNobleMsg];
+  const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs),
+  );
+
+  await dydxClient.post.send(
+    dydxWallet,
+    () => {
+      return encodeObjects;
+    },
+    false,
+    undefined,
+    undefined,
+  );
+
+  await sleep(30000);
+
+  try {
+    const coins = await client.getAccountBalances();
+    console.log('Balances');
+    console.log(JSON.stringify(coins));
+
+    // IBC from noble
+
+    const ibcFromNobleMsg: EncodeObject = {
+      typeUrl: '/ibc.applications.transfer.v1.MsgTransfer',
+      value: {
+        sourcePort: 'transfer',
+        sourceChannel: 'channel-21',
+        token: {
+          denom: 'uusdc',
+          amount: coins[0].amount,
+        },
+        sender: nobleWallet.address,
+        receiver: dydxWallet.address,
+        timeoutTimestamp: Long.fromNumber(
+          Math.floor(Date.now() / 1000) * 1e9 + 10 * 60 * 1e9,
+        ),
+      },
+    };
+    const fee = await client.simulateTransaction([ibcFromNobleMsg]);
+
+    ibcFromNobleMsg.value.token.amount = (parseInt(ibcFromNobleMsg.value.token.amount, 10) -
+      Math.floor(parseInt(fee.amount[0].amount, 10) * 1.4)).toString();
+
+    await client.send([ibcFromNobleMsg]);
+  } catch (error) {
+    console.log(JSON.stringify(error.message));
+  }
+
+  await sleep(30000);
+
+  try {
+    const coin = await client.getAccountBalance('uusdc');
+    console.log('Balance');
+    console.log(JSON.stringify(coin));
+  } catch (error) {
+    console.log(JSON.stringify(error.message));
+  }
+}
+
+test()
+  .then(() => {})
+  .catch((error) => {
+    console.log(error.message);
+    console.log(error);
+  });

package/package.json

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

package/src/clients/modules/local-wallet.ts

@@ -28,6 +28,7 @@ export default class LocalWallet {
     address?: string;
     pubKey?: Secp256k1Pubkey;
     signer?: TransactionSigner;
+    offlineSigner?: OfflineSigner;
 
     static async fromOfflineSigner(signer:OfflineSigner): Promise<LocalWallet> {
       const wallet = new LocalWallet();
@@ -42,6 +43,7 @@ export default class LocalWallet {
     }
 
     async setSigner(signer: OfflineSigner): Promise<void> {
+      this.offlineSigner = signer;
       const stargateClient = await SigningStargateClient.offline(
         signer,
         {

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 } from '../lib/constants';
+import { BECH32_PREFIX, GAS_MULTIPLIER, NOBLE_BECH32_PREFIX } from '../lib/constants';
 import { UserError } from '../lib/errors';
 import { ByteArrayEncoding, encodeJson } from '../lib/helpers';
 import { deriveHDKeyFromEthereumSignature } from '../lib/onboarding';
@@ -19,6 +19,7 @@ import {
 } from './constants';
 import { FaucetClient } from './faucet-client';
 import LocalWallet from './modules/local-wallet';
+import { NobleClient } from './noble-client';
 import { SubaccountInfo } from './subaccount';
 import { OrderFlags } from './types';
 
@@ -29,6 +30,9 @@ 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 nobleClient: NobleClient | undefined;
 }
 
 export async function connectClient(
@@ -53,6 +57,7 @@ export async function connectNetwork(
       validatorUrl,
       chainId,
       faucetUrl,
+      nobleValidatorUrl,
       USDC_DENOM,
       USDC_DECIMALS,
       USDC_GAS_DENOM,
@@ -90,6 +95,7 @@ export async function connectNetwork(
     } else {
       globalThis.faucetClient = null;
     }
+    globalThis.nobleClient = new NobleClient(nobleValidatorUrl);
     return encodeJson(config);
   } catch (e) {
     return wrappedError(e);
@@ -101,6 +107,12 @@ export async function connectWallet(
 ): Promise<string> {
   try {
     globalThis.wallet = await LocalWallet.fromMnemonic(mnemonic, BECH32_PREFIX);
+    const nobleWallet = await LocalWallet.fromMnemonic(
+      mnemonic,
+      NOBLE_BECH32_PREFIX,
+    );
+    await globalThis.nobleClient?.connect(nobleWallet);
+
     const address = globalThis.wallet.address!;
     return encodeJson({ address });
   } catch (e) {
@@ -988,3 +1000,54 @@ export async function getMarketPrice(
     return wrappedError(e);
   }
 }
+
+export async function getNobleBalance(): Promise<String> {
+  try {
+    const client = globalThis.nobleClient;
+    if (client === undefined || !client.isConnected) {
+      throw new UserError(
+        'client is not connected.',
+      );
+    }
+    const coin = await client.getAccountBalance('uusdc');
+    return encodeJson(coin);
+  } catch (error) {
+    return wrappedError(error);
+  }
+}
+
+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.',
+      );
+    }
+
+    const decode = (str: string): string => Buffer.from(str, 'base64').toString('binary');
+    const decoded = decode(squidPayload);
+
+    const json = JSON.parse(decoded);
+
+    const ibcMsg: EncodeObject = {
+      typeUrl: json.msgTypeUrl, // '/ibc.applications.transfer.v1.MsgTransfer',
+      value: json.msg,
+    };
+    const fee = await client.simulateTransaction([ibcMsg]);
+
+    // take out fee from amount before sweeping
+    const amount = parseInt(ibcMsg.value.token.amount, 10) -
+      Math.floor(parseInt(fee.amount[0].amount, 10) * GAS_MULTIPLIER);
+
+    if (amount <= 0) {
+      throw new UserError('noble balance does not cover fees');
+    }
+
+    ibcMsg.value.token.amount = amount.toString();
+    const tx = await client.send([ibcMsg]);
+    return encodeJson(tx);
+  } catch (error) {
+    return wrappedError(error);
+  }
+}

package/src/clients/noble-client.ts

@@ -0,0 +1,99 @@
+import { EncodeObject, Registry, Coin } from '@cosmjs/proto-signing';
+import {
+  calculateFee,
+  DeliverTxResponse,
+  GasPrice,
+  StdFee,
+  defaultRegistryTypes,
+  SigningStargateClient,
+} from '@cosmjs/stargate';
+
+import { GAS_MULTIPLIER } from './constants';
+import LocalWallet from './modules/local-wallet';
+
+export class NobleClient {
+  private wallet?: LocalWallet;
+  private restEndpoint: string;
+  private stargateClient?: SigningStargateClient;
+
+  constructor(restEndpoint: string) {
+    this.restEndpoint = restEndpoint;
+  }
+
+  get isConnected(): boolean {
+    return Boolean(this.stargateClient);
+  }
+
+  async connect(
+    wallet: LocalWallet,
+  ): Promise<void> {
+    if (wallet?.offlineSigner === undefined) {
+      throw new Error('Wallet signer not found');
+    }
+    this.wallet = wallet;
+    this.stargateClient = await SigningStargateClient.connectWithSigner(
+      this.restEndpoint,
+      wallet.offlineSigner,
+      { registry: new Registry(defaultRegistryTypes) },
+    );
+  }
+
+  getAccountBalances(): Promise<readonly Coin[]> {
+    if (!this.stargateClient || this.wallet?.address === undefined) {
+      throw new Error('stargateClient not initialized');
+    }
+    return this.stargateClient.getAllBalances(this.wallet.address);
+  }
+
+  getAccountBalance(denom: string): Promise<Coin> {
+    if (!this.stargateClient || this.wallet?.address === undefined) {
+      throw new Error('stargateClient not initialized');
+    }
+    return this.stargateClient.getBalance(this.wallet.address, denom);
+  }
+
+  async send(
+    messages: EncodeObject[],
+    gasPrice: GasPrice = GasPrice.fromString('0.025uusdc'),
+    memo?: string,
+  ): Promise<DeliverTxResponse> {
+    if (!this.stargateClient) {
+      throw new Error('NobleClient stargateClient not initialized');
+    }
+    if (this.wallet?.address === undefined) {
+      throw new Error('NobleClient wallet not initialized');
+    }
+    // Simulate to get the gas estimate
+    const fee = await this.simulateTransaction(messages, gasPrice, memo);
+
+    // Sign and broadcast the transaction
+    return this.stargateClient.signAndBroadcast(
+      this.wallet.address,
+      messages,
+      fee,
+      memo ?? '',
+    );
+  }
+
+  async simulateTransaction(
+    messages: readonly EncodeObject[],
+    gasPrice: GasPrice = GasPrice.fromString('0.025uusdc'),
+    memo?: string,
+  ): Promise<StdFee> {
+    if (!this.stargateClient) {
+      throw new Error('NobleClient stargateClient not initialized');
+    }
+    if (this.wallet?.address === undefined) {
+      throw new Error('NobleClient wallet not initialized');
+    }
+    // Get simulated response
+    const gasEstimate = await this.stargateClient.simulate(
+      this.wallet?.address,
+      messages,
+      memo,
+    );
+
+    // Calculate and return the fee
+    return calculateFee(Math.floor(gasEstimate * GAS_MULTIPLIER), gasPrice);
+  }
+}

package/src/index.ts

@@ -9,6 +9,7 @@ export * as onboarding from './lib/onboarding';
 export { default as LocalWallet } from './clients/modules/local-wallet';
 export { SubaccountInfo as SubaccountClient } from './clients/subaccount';
 export { CompositeClient } from './clients/composite-client';
+export { NobleClient } from './clients/noble-client';
 export { IndexerClient } from './clients/indexer-client';
 export { ValidatorClient } from './clients/validator-client';
 export { FaucetClient } from './clients/faucet-client';

package/src/lib/constants.ts

@@ -2,6 +2,7 @@ import { StdFee } from '@cosmjs/stargate';
 
 // Bech32 Prefix
 export const BECH32_PREFIX = 'dydx';
+export const NOBLE_BECH32_PREFIX = 'noble';
 
 // Broadcast Defaults
 export const BROADCAST_POLL_INTERVAL_MS: number = 300;