fix: add timestamp nonce adjustment config (#342)

Author: tyleroooo

v4-client-js/src/clients/constants.ts

@@ -117,8 +117,8 @@ export const TYPE_URL_MSG_WITHDRAW_DELEGATOR_REWARD =
   '/cosmos.distribution.v1beta1.MsgWithdrawDelegatorReward';
 
 // x/accountplus
-export const TYPE_URL_MSG_ADD_AUTHENTICATOR = '/dydxprotocol.accountplus.MsgAddAuthenticator'
-export const TYPE_URL_MSG_REMOVE_AUTHENTICATOR = '/dydxprotocol.accountplus.MsgRemoveAuthenticator'
+export const TYPE_URL_MSG_ADD_AUTHENTICATOR = '/dydxprotocol.accountplus.MsgAddAuthenticator';
+export const TYPE_URL_MSG_REMOVE_AUTHENTICATOR = '/dydxprotocol.accountplus.MsgRemoveAuthenticator';
 
 // ------------ Chain Constants ------------
 // The following are same across different networks / deployments.
@@ -257,6 +257,7 @@ export class ValidatorConfig {
   public broadcastOptions?: BroadcastOptions;
   public defaultClientMemo?: string;
   public useTimestampNonce?: boolean;
+  public timestampNonceOffsetMs?: number;
 
   constructor(
     restEndpoint: string,
@@ -265,6 +266,7 @@ export class ValidatorConfig {
     broadcastOptions?: BroadcastOptions,
     defaultClientMemo?: string,
     useTimestampNonce?: boolean,
+    timestampNonceOffsetMs?: number,
   ) {
     this.restEndpoint = restEndpoint?.endsWith('/') ? restEndpoint.slice(0, -1) : restEndpoint;
     this.chainId = chainId;
@@ -273,6 +275,7 @@ export class ValidatorConfig {
     this.broadcastOptions = broadcastOptions;
     this.defaultClientMemo = defaultClientMemo;
     this.useTimestampNonce = useTimestampNonce;
+    this.timestampNonceOffsetMs = timestampNonceOffsetMs;
   }
 }
 

v4-client-js/src/clients/modules/post.ts

@@ -56,6 +56,7 @@ export class Post {
   public readonly defaultDydxGasPrice: GasPrice;
 
   public useTimestampNonce: boolean = false;
+  public timestampNonceOffsetMs: number = 0;
   private accountNumberCache: Map<string, Account> = new Map();
 
   constructor(
@@ -64,6 +65,7 @@ export class Post {
     denoms: DenomConfig,
     defaultClientMemo?: string,
     useTimestampNonce?: boolean,
+    timestampNonceOffsetMs?: number,
   ) {
     this.get = get;
     this.chainId = chainId;
@@ -81,7 +83,10 @@ export class Post {
           : denoms.CHAINTOKEN_DENOM
       }`,
     );
-    if (useTimestampNonce === true) this.useTimestampNonce = useTimestampNonce;
+    if (useTimestampNonce === true) {
+      this.useTimestampNonce = useTimestampNonce;
+      this.timestampNonceOffsetMs = timestampNonceOffsetMs ?? this.timestampNonceOffsetMs;
+    }
   }
 
   /**
@@ -243,7 +248,9 @@ export class Post {
     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;
+    const sequence = this.useTimestampNonce
+      ? Date.now() + this.timestampNonceOffsetMs
+      : account.sequence;
     // Simulate transaction if no fee is specified.
     const fee: StdFee = zeroFee
       ? {
@@ -956,7 +963,11 @@ export class Post {
     authenticatorType: AuthenticatorType,
     data: Uint8Array,
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
-    const msg = this.composer.composeMsgAddAuthenticator(subaccount.address, authenticatorType, data);
+    const msg = this.composer.composeMsgAddAuthenticator(
+      subaccount.address,
+      authenticatorType,
+      data,
+    );
 
     return this.send(
       subaccount.wallet,

v4-client-js/src/clients/validator-client.ts

@@ -69,7 +69,6 @@ export class ValidatorClient {
     this._post.setSelectedGasDenom(gasDenom);
   }
 
-
   /**
    * @description populate account number cache in the Post module for performance.
    */
@@ -98,6 +97,7 @@ export class ValidatorClient {
       this.config.denoms,
       this.config.defaultClientMemo,
       this.config.useTimestampNonce,
+      this.config.timestampNonceOffsetMs,
     );
   }
 }

v4-client-js/src/lib/utils.ts

@@ -60,3 +60,17 @@ export function getGovAddNewMarketTitle(ticker: string): string {
 export function getGovAddNewMarketSummary(ticker: string, delayBlocks: number): string {
   return `Add the x/prices, x/perpetuals and x/clob parameters needed for a ${ticker} perpetual market. Create the market in INITIALIZING status and transition it to ACTIVE status after ${delayBlocks} blocks.`;
 }
+
+export function calculateClockOffsetFromFetchDateHeader(
+  clientRequestStartTime: number,
+  serverReportedTime: number,
+  clientRequestEndTime: number,
+): number {
+  // use midpoint, so assume that time for request reach server === time for response to reach us
+  const estimatedLocalTimeAtServerArrival = (clientRequestStartTime + clientRequestEndTime) / 2;
+
+  // we need an offset such that estimatedLocalTimeAtServerArrival + offset = serverReportedTime
+  const offset = serverReportedTime - estimatedLocalTimeAtServerArrival;
+
+  return offset;
+}