Sync sender address state before txns (MystenLabs#3621)

sdk/typescript/src/providers/json-rpc-provider.ts

@@ -21,6 +21,7 @@ import {
 } from '../types';
 
 const isNumber = (val: any): val is number => typeof val === 'number';
+const isAny = (_val: any): _val is any => true;
 
 export class JsonRpcProvider extends Provider {
   private client: JsonRpcClient;
@@ -245,4 +246,18 @@ export class JsonRpcProvider extends Provider {
       );
     }
   }
+
+  async syncAccountState(address: string): Promise<any> {
+    try {
+      return await this.client.requestWithType(
+        'sui_syncAccountState',
+        [address],
+        isAny,
+      );
+    } catch (err) {
+      throw new Error(
+        `Error sync account address for address: ${address} with error: ${err}`,
+      );
+    }
+  }
 }

sdk/typescript/src/providers/provider.ts

@@ -56,5 +56,6 @@ export abstract class Provider {
     pubkey: string
   ): Promise<TransactionResponse>;
 
+  abstract syncAccountState(address: string): Promise<any>
   // TODO: add more interface methods
 }

sdk/typescript/src/providers/void-provider.ts

@@ -53,6 +53,10 @@ export class VoidProvider extends Provider {
     throw this.newError('getRecentTransactions');
   }
 
+  async syncAccountState(_address: string): Promise<any> {
+    throw this.newError('syncAccountState');
+  }
+
   private newError(operation: string): Error {
     return new Error(`Please use a valid provider for ${operation}`);
   }

sdk/typescript/src/signers/signer-with-provider.ts

@@ -68,6 +68,15 @@ export abstract class SignerWithProvider implements Signer {
     );
   }
 
+  /**
+   * Trigger gateway to sync account state related to the address,
+   * based on the account state on validators.
+   */
+  async syncAccountState(): Promise<any> {
+    const address = await this.getAddress();
+    return await this.provider.syncAccountState(address);
+  }
+
   /**
    * Serialize and Sign a `TransferObject` transaction and submit to the Gateway for execution
    */

wallet/src/ui/app/redux/slices/sui-objects/Coin.ts

@@ -76,6 +76,7 @@ export class Coin {
         amount: bigint,
         recipient: SuiAddress
     ): Promise<TransactionResponse> {
+        await signer.syncAccountState();
         const coin = await Coin.selectCoin(signer, coins, amount);
         return await signer.transferObject({
             objectId: coin,
@@ -98,6 +99,7 @@ export class Coin {
         amount: bigint,
         recipient: SuiAddress
     ): Promise<TransactionResponse> {
+        await signer.syncAccountState();
         const coin = await Coin.prepareCoinWithEnoughBalance(
             signer,
             coins,
@@ -127,6 +129,7 @@ export class Coin {
         validator: SuiAddress
     ): Promise<TransactionResponse> {
         const coin = await Coin.selectCoin(signer, coins, amount);
+        await signer.syncAccountState();
         return await signer.executeMoveCall({
             packageObjectId: '0x2',
             module: 'sui_system',

wallet/src/ui/app/redux/slices/sui-objects/NFT.ts

@@ -16,6 +16,7 @@ export class ExampleNFT {
         description?: string,
         imageUrl?: string
     ): Promise<TransactionResponse> {
+        await signer.syncAccountState();
         return await signer.executeMoveCall({
             packageObjectId: '0x2',
             module: 'devnet_nft',
@@ -39,6 +40,7 @@ export class ExampleNFT {
         recipientID: string,
         transferCost: number
     ): Promise<TransactionResponse> {
+        await signer.syncAccountState();
         return await signer.transferObject({
             objectId: nftId,
             gasBudget: transferCost,