@dydxprotocol/v4-client-js 1.16.3 → 1.18.0

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

@@ -3,7 +3,7 @@ import {
   AccountData,
   DirectSecp256k1HdWallet,
   EncodeObject,
-  OfflineSigner,
+  OfflineDirectSigner,
 } from '@cosmjs/proto-signing';
 import { SigningStargateClient } from '@cosmjs/stargate';
 import Long from 'long';
@@ -22,9 +22,9 @@ export default class LocalWallet {
   address?: string;
   pubKey?: Secp256k1Pubkey;
   signer?: TransactionSigner;
-  offlineSigner?: OfflineSigner;
+  offlineSigner?: OfflineDirectSigner;
 
-  static async fromOfflineSigner(signer: OfflineSigner): Promise<LocalWallet> {
+  static async fromOfflineSigner(signer: OfflineDirectSigner): Promise<LocalWallet> {
     const wallet = new LocalWallet();
     await wallet.setSigner(signer);
     return wallet;
@@ -36,7 +36,7 @@ export default class LocalWallet {
     return wallet;
   }
 
-  async setSigner(signer: OfflineSigner): Promise<void> {
+  async setSigner(signer: OfflineDirectSigner): Promise<void> {
     this.offlineSigner = signer;
     const stargateClient = await SigningStargateClient.offline(signer, {
       registry: generateRegistry(),
@@ -46,7 +46,7 @@ export default class LocalWallet {
     this.accounts = [...accountData];
     this.address = firstAccount.address;
     this.pubKey = encodeSecp256k1Pubkey(firstAccount.pubkey);
-    this.signer = new TransactionSigner(this.address, stargateClient);
+    this.signer = new TransactionSigner(this.address, stargateClient, signer);
   }
 
   async setMnemonic(mnemonic: string, prefix?: string): Promise<void> {
@@ -60,6 +60,6 @@ export default class LocalWallet {
     fee?: StdFee,
     memo: string = '',
   ): Promise<Uint8Array> {
-    return this.signer!.signTransaction(messages, transactionOptions, fee, memo);
+    return this.signer!.signTransaction(messages, transactionOptions, fee, memo, this.pubKey);
   }
 }

package/src/clients/modules/post.ts

@@ -11,7 +11,7 @@ import _ from 'lodash';
 import Long from 'long';
 import protobuf from 'protobufjs';
 
-import { GAS_MULTIPLIER, SelectedGasDenom } from '../constants';
+import { AuthenticatorType, GAS_MULTIPLIER, SelectedGasDenom } from '../constants';
 import { UnexpectedClientError } from '../lib/errors';
 import { generateRegistry } from '../lib/registry';
 import { SubaccountInfo } from '../subaccount';
@@ -178,6 +178,7 @@ export class Post {
     broadcastMode?: BroadcastMode,
     account?: () => Promise<Account>,
     gasAdjustment: number = GAS_MULTIPLIER,
+    authenticators?: Long[],
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
     const msgsPromise = messaging();
     const accountPromise = account ? await account() : this.account(wallet.address!);
@@ -193,6 +194,7 @@ export class Post {
       memo ?? this.defaultClientMemo,
       broadcastMode ?? this.defaultBroadcastMode(msgs),
       gasAdjustment,
+      authenticators,
     );
   }
 
@@ -238,6 +240,7 @@ export class Post {
     gasPrice: GasPrice = this.getGasPrice(),
     memo?: string,
     gasAdjustment: number = GAS_MULTIPLIER,
+    authenticators?: Long[],
   ): Promise<Uint8Array> {
     // protocol expects timestamp nonce in UTC milliseconds, which is the unit returned by Date.now()
     const sequence = this.useTimestampNonce ? Date.now() : account.sequence;
@@ -260,6 +263,7 @@ export class Post {
       sequence,
       accountNumber: account.accountNumber,
       chainId: this.chainId,
+      authenticators,
     };
     // Generate signed transaction.
     return wallet.signTransaction(messages, txOptions, fee, memo);
@@ -297,6 +301,7 @@ export class Post {
     memo?: string,
     broadcastMode?: BroadcastMode,
     gasAdjustment: number = GAS_MULTIPLIER,
+    authenticators?: Long[],
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
     const signedTransaction = await this.signTransaction(
       wallet,
@@ -306,6 +311,7 @@ export class Post {
       gasPrice,
       memo,
       gasAdjustment,
+      authenticators,
     );
     return this.sendSignedTransaction(signedTransaction, broadcastMode);
   }
@@ -944,4 +950,41 @@ export class Post {
       gasAdjustment,
     );
   }
+
+  async addAuthenticator(
+    subaccount: SubaccountInfo,
+    authenticatorType: AuthenticatorType,
+    data: Uint8Array,
+  ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
+    const msg = this.composer.composeMsgAddAuthenticator(subaccount.address, authenticatorType, data);
+
+    return this.send(
+      subaccount.wallet,
+      () => Promise.resolve([msg]),
+      false,
+      undefined,
+      undefined,
+      Method.BroadcastTxSync,
+      undefined,
+      undefined,
+    );
+  }
+
+  async removeAuthenticator(
+    subaccount: SubaccountInfo,
+    id: Long,
+  ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
+    const msg = this.composer.composeMsgRemoveAuthenticator(subaccount.address, id);
+
+    return this.send(
+      subaccount.wallet,
+      () => Promise.resolve([msg]),
+      false,
+      undefined,
+      undefined,
+      Method.BroadcastTxSync,
+      undefined,
+      undefined,
+    );
+  }
 }

package/src/clients/modules/signer.ts

@@ -1,10 +1,15 @@
-import { EncodeObject } from '@cosmjs/proto-signing';
+import { Secp256k1Pubkey } from '@cosmjs/amino';
+import { fromBase64 } from '@cosmjs/encoding';
+import { Int53 } from '@cosmjs/math';
+import { EncodeObject, encodePubkey, makeAuthInfoBytes, makeSignDoc, OfflineDirectSigner } from '@cosmjs/proto-signing';
 import { SigningStargateClient, StdFee } from '@cosmjs/stargate';
-import { TxRaw } from 'cosmjs-types/cosmos/tx/v1beta1/tx';
+import { TxExtension } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/accountplus/tx';
+import { TxBody, TxRaw } from 'cosmjs-types/cosmos/tx/v1beta1/tx';
+import { Any } from 'cosmjs-types/google/protobuf/any';
 import Long from 'long';
 import protobuf from 'protobufjs';
 
-import { UserError } from '../lib/errors';
+import { generateRegistry } from '../lib/registry';
 import { TransactionOptions } from '../types';
 
 // Required for encoding and decoding queries that are of type Long.
@@ -17,10 +22,16 @@ protobuf.configure();
 export class TransactionSigner {
   readonly address: string;
   readonly stargateSigningClient: SigningStargateClient;
+  readonly offlineSigner: OfflineDirectSigner;
 
-  constructor(address: string, stargateSigningClient: SigningStargateClient) {
+  constructor(
+    address: string,
+    stargateSigningClient: SigningStargateClient,
+    offlineSigner: OfflineDirectSigner,
+  ) {
     this.address = address;
     this.stargateSigningClient = stargateSigningClient;
+    this.offlineSigner = offlineSigner;
   }
 
   /**
@@ -35,18 +46,73 @@ export class TransactionSigner {
     transactionOptions: TransactionOptions,
     fee?: StdFee,
     memo: string = '',
+    publicKey?: Secp256k1Pubkey,
   ): Promise<Uint8Array> {
-    // Verify there is either a fee or a path to getting the fee present.
-    if (fee === undefined) {
-      throw new UserError('fee cannot be undefined');
+    if (!fee) {
+      throw new Error('Fee cannot be undefined');
     }
 
-    // Sign, encode and return the transaction.
-    const rawTx: TxRaw = await this.stargateSigningClient.sign(this.address, messages, fee, memo, {
-      accountNumber: transactionOptions.accountNumber,
-      sequence: transactionOptions.sequence,
-      chainId: transactionOptions.chainId,
+    const registry = generateRegistry();
+
+    // Encode the messages
+    const encodedMessages = messages.map((msg) => registry.encodeAsAny(msg));
+
+    // Encode the TxExtension message
+    const txExtension = TxExtension.encode({
+      selectedAuthenticators: transactionOptions.authenticators ?? [],
+    }).finish();
+
+    // Create the non-critical extension message
+    const nonCriticalExtensionOptions: Any[] = [
+      Any.fromPartial({
+        typeUrl: '/dydxprotocol.accountplus.TxExtension',
+        value: txExtension,
+      }),
+    ];
+
+    // Construct the TxBody
+    const txBody: TxBody = TxBody.fromPartial({
+      messages: encodedMessages,
+      memo,
+      extensionOptions: [],
+      nonCriticalExtensionOptions,
     });
-    return Uint8Array.from(TxRaw.encode(rawTx).finish());
+
+    // Encode the TxBody
+    const txBodyBytes = TxBody.encode(txBody).finish();
+
+    if (!publicKey) {
+      throw new Error('Public key cannot be undefined');
+    }
+    const pubkey = encodePubkey(publicKey); // Use the public key of the signer
+
+    const gasLimit = Int53.fromString(String(fee.gas)).toNumber();
+    const authInfoBytes = makeAuthInfoBytes(
+      [{ pubkey, sequence: transactionOptions.sequence }],
+      fee.amount,
+      gasLimit,
+      undefined,
+      undefined,
+    );
+
+    // Create the SignDoc
+    const signDoc = makeSignDoc(
+      txBodyBytes,
+      authInfoBytes,
+      transactionOptions.chainId,
+      transactionOptions.accountNumber,
+    );
+
+    // Use OfflineSigner to sign the transaction
+    const signerAddress = this.address;
+    const { signed, signature } = await this.offlineSigner.signDirect(signerAddress, signDoc);
+
+    const txRaw = TxRaw.fromPartial({
+      bodyBytes: signed.bodyBytes,
+      authInfoBytes: signed.authInfoBytes,
+      signatures: [fromBase64(signature.signature)],
+    });
+
+    return Uint8Array.from(TxRaw.encode(txRaw).finish());
   }
 }

package/src/clients/modules/utility.ts

@@ -1,4 +1,9 @@
-import type { ComplianceResponse, HeightResponse, TimeResponse } from '../types';
+import type {
+  ComplianceResponse,
+  ComplianceV2Response,
+  HeightResponse,
+  TimeResponse,
+} from '../types';
 import RestClient from './rest';
 
 export default class UtilityClient extends RestClient {
@@ -29,4 +34,14 @@ export default class UtilityClient extends RestClient {
     const uri = '/v4/screen';
     return this.get(uri, { address });
   }
+
+  /**
+   * @description Screen an address to see if it is restricted
+   * @param {string} address evm or dydx address
+   * @returns {ComplianceResponse} whether the specified address is restricted
+   */
+  async complianceScreen(address: string): Promise<ComplianceV2Response> {
+    const uri = `/v4/compliance/screen/${address}`;
+    return this.get(uri);
+  }
 }

package/src/clients/types.ts

@@ -29,6 +29,7 @@ export interface PartialTransactionOptions {
 // Information for signing a transaction while offline.
 export interface TransactionOptions extends PartialTransactionOptions {
   sequence: number;
+  authenticators?: Long[];
 }
 
 // OrderFlags, just a number in proto, defined as enum for convenience
@@ -104,6 +105,30 @@ export interface HeightResponse {
 
 export interface ComplianceResponse {
   restricted: boolean;
+  reason?: string;
+}
+
+export enum ComplianceReason {
+  MANUAL = 'MANUAL',
+  US_GEO = 'US_GEO',
+  CA_GEO = 'CA_GEO',
+  GB_GEO = 'GB_GEO',
+  SANCTIONED_GEO = 'SANCTIONED_GEO',
+  COMPLIANCE_PROVIDER = 'COMPLIANCE_PROVIDER',
+}
+
+export enum ComplianceStatus {
+  COMPLIANT = 'COMPLIANT',
+  FIRST_STRIKE_CLOSE_ONLY = 'FIRST_STRIKE_CLOSE_ONLY',
+  FIRST_STRIKE = 'FIRST_STRIKE',
+  CLOSE_ONLY = 'CLOSE_ONLY',
+  BLOCKED = 'BLOCKED',
+}
+
+export interface ComplianceV2Response {
+  status: ComplianceStatus;
+  reason?: ComplianceReason;
+  updatedAt?: string;
 }
 
 // ------------ Squid ------------ //