Should await for requestSwitchToChain

[mthinh]

SDK Affected

AppKit

Context
I want to selectChain before doing any transaction, when calling selectChain with switchChain = true, we call requestSwitchToChain without waiting for it to be done. This lead to making transaction failed

Should await for requestSwitchToChain and move launchConnectedWallet before calling switch

Reproducible code
In appkit_modal_impl.dart, selectChain method

if (!hasChainAlready) {
  requestSwitchToChain(chainInfo);
  // Should launch connected wallet first 
// Then call requestSwitchToChain
  final hasSwitchMethod = _currentSession!.hasSwitchMethod();
  if (hasSwitchMethod) {
    launchConnectedWallet();
  }
} else {
  await _setLocalEthChain(chainInfo.chainId, logEvent: logEvent);
}

[linear]

APKTN-475 Should await for requestSwitchToChain

[quetool]

Hello @mthinh! Can you explain a bit more what you are trying to do and share a reproducible code of your own (not appkit's)

[quetool]

Or, if this is an issue, share steps to reproduce

[mthinh]

hi @quetool , i want to make transaction on specific chain, so before requesting for transactions, i want to switch to desired chain.
The issue is we dont wait for requestToSwitchChain => so the request transaction code run right way => throwing Unsupported chain

Future<String> requestTransaction({
    required Chain chain,
    required EthereumTransaction transaction,
  }) async {
    // Chain is our BE chain data
    final targetChain = ReownAppKitModalNetworkInfo(
      name: chain.name,
      chainId: chain.chainId,
      currency: chain.nativeToken?.symbol,
      rpcUrl: chain.rpcUrl,
      explorerUrl: chain.explorerUrl,
    );
r 
    await _appkitModal.selectChain(
        targetChain,
       switchChain: true,
      );

    final transactionId = await _appkitModal.request(
      topic: _appkitModal.session?.topic,
      chainId: chain.chainId,
      request: SessionRequestParams(
        method: 'eth_sendTransaction',
        params: [
          transaction.copyWith(data: transaction.data ?? '').toJson(),
        ],
      ),
    );
    if (transactionId is! String) {
      throw Exception('Failed to send transaction ${transactionId.toString()}');
    }
    return transactionId;
  }

[mthinh]

inside selectChain

@override
  Future<void> selectChain(
    ReownAppKitModalNetworkInfo? chainInfo, {
    bool switchChain = false,
    bool logEvent = true,
  }) async {
    _checkInitialized();

    if (chainInfo?.chainId == _selectedChainID) {
      return;
    }

    // If the chain is null, disconnect and stop.
    if (chainInfo == null) {
      await disconnect();
      return;
    }

    _chainBalance = null;

    try {
      final formattedBalance = CoreUtils.formatChainBalance(_chainBalance);
      balanceNotifier.value = '$formattedBalance ${chainInfo.currency}';

      final hasValidSession = _isConnected && _currentSession != null;
      if (switchChain && hasValidSession && _selectedChainID != null) {
        final namespace = NamespaceUtils.getNamespaceFromChain(
          chainInfo.chainId,
        );
        final approvedChains = _currentSession!.getApprovedChains(
          namespace: namespace,
        );
        final hasChainAlready = (approvedChains ?? []).contains(
          chainInfo.chainId,
        );
        if (!hasChainAlready) {
          // This method is not await, so requestTransation is called right 
          // away before chain is switched
          requestSwitchToChain(chainInfo);
          final hasSwitchMethod = _currentSession!.hasSwitchMethod();
          if (hasSwitchMethod) {
            launchConnectedWallet();
          }
        } else {
          await _setLocalEthChain(chainInfo.chainId, logEvent: logEvent);
        }
      } else {
        final namespace = NamespaceUtils.getNamespaceFromChain(
          chainInfo.chainId,
        );
        final approvedChains = _currentSession!.getApprovedChains(
          namespace: namespace,
        );
        final isApproved = (approvedChains ?? []).contains(
          chainInfo.chainId,
        );
        if (isApproved) {
          await _setLocalEthChain(chainInfo.chainId, logEvent: logEvent);
        } else {
          throw ReownAppKitModalException(
            'Chain is not approved, try switch to it',
          );
        }
      }
    } on JsonRpcError catch (e) {
      onModalError.broadcast(ModalError(e.message ?? 'An error occurred'));
    } on ReownAppKitModalException catch (e) {
      onModalError.broadcast(ModalError(e.message));
    } catch (e) {
      onModalError.broadcast(ModalError('An error occurred'));
    }
  }

[quetool]

Hello @mthinh! Sorry for the late response! Can you please try

await _appkitModal.requestSwitchToChain(targetChain);

instad of

await _appkitModal.selectChain(
        targetChain,
       switchChain: true,
      );

I tried this and worked for me:

return TextButton(
      onPressed: () async {
        // Chain is our BE chain data
        final targetChain = ReownAppKitModalNetworkInfo(
          name: 'Base',
          chainId: 'eip155:8453',
          currency: 'ETH',
          rpcUrl: 'https://mainnet.base.org',
          explorerUrl: 'https://basescan.org',
        );

        await widget.appKitModal.requestSwitchToChain(targetChain);

        print('selectChain finish');
        final bytes = utf8.encode('testSignData');
        final encoded = bytesToHex(bytes, include0x: true);
        final transactionId = await widget.appKitModal.request(
          topic: widget.appKitModal.session?.topic,
          chainId: widget.appKitModal.selectedChain!.chainId,
          request: SessionRequestParams(
            method: 'personal_sign',
            params: [
              encoded,
              widget.appKitModal.session!.getAddress('eip155'),
            ],
          ),
        );
        if (transactionId is! String) {
          throw Exception(
              'Failed to send transaction ${transactionId.toString()}');
        }
        print(transactionId);
      },
      child: Text('Test'),
    );

requestSwitchToChain will automatically call requestAddChain if the chain has to be added to the wallet

[quetool]

Hello @mthinh , is this still an issue?