feat: integrating gemwallet

Author: yeager-eren

queue-manager/rango-preset/src/actions/createTransaction.ts

@@ -1,6 +1,7 @@
 import type { SwapQueueContext, SwapStorage } from '../types';
 import type { ExecuterActions } from '@rango-dev/queue-manager-core';
-import type { CreateTransactionRequest } from 'rango-sdk';
+
+import { type CreateTransactionRequest, TransactionType } from 'rango-sdk';
 
 import { warn } from '@rango-dev/logging-core';
 
@@ -71,7 +72,12 @@ export async function createTransaction(
       }
 
       setStorage({ ...getStorage(), swapDetails: swap });
-      schedule(SwapActionTypes.EXECUTE_TRANSACTION);
+
+      if (transaction?.blockChain === TransactionType.XRPL) {
+        schedule(SwapActionTypes.EXECUTE_XRPL_TRANSACTION);
+      } else {
+        schedule(SwapActionTypes.EXECUTE_TRANSACTION);
+      }
       next();
     } catch (error: unknown) {
       swap.status = 'failed';

queue-manager/rango-preset/src/actions/executeXrplTransaction/executeXrplTransaction.ts

@@ -0,0 +1,124 @@
+import type {
+  SwapActionTypes,
+  SwapQueueContext,
+  SwapStorage,
+} from '../../types';
+import type { ExecuterActions } from '@rango-dev/queue-manager-core';
+
+import {
+  type GenericSigner,
+  isXrplTransaction,
+  type XrplTransaction,
+  type XrplTrustSetTransactionData,
+} from 'rango-types';
+
+import {
+  getCurrentStep,
+  getCurrentStepTx,
+  handleSuccessfulSign,
+  handlRejectedSign,
+  isApprovalCurrentStepTx,
+} from '../../helpers';
+import { getCurrentAddressOf, getRelatedWallet } from '../../shared';
+import { checkEnvironmentBeforeExecuteTransaction } from '../common/checkEnvironmentBeforeExecuteTransaction';
+import {
+  onNextStateError,
+  onNextStateOk,
+  produceNextStateForTransaction,
+} from '../common/produceNextStateForTransaction';
+import { requestBlockQueue } from '../common/utils';
+
+import { isIssuedCurrencyAmount } from './helpers';
+
+export async function executeXrplTransaction(
+  actions: ExecuterActions<SwapStorage, SwapActionTypes, SwapQueueContext>
+): Promise<void> {
+  const checkResult = await checkEnvironmentBeforeExecuteTransaction(actions);
+  if (checkResult.err) {
+    requestBlockQueue(actions, checkResult.val);
+
+    return;
+  }
+
+  const { failed, getStorage, context } = actions;
+  const { meta, getSigners } = context;
+
+  const swap = getStorage().swapDetails;
+  const currentStep = getCurrentStep(swap)!;
+  const isApproval = isApprovalCurrentStepTx(currentStep);
+  const onFinish = () => {
+    // TODO resetClaimedBy is undefined here
+    if (actions.context.resetClaimedBy) {
+      actions.context.resetClaimedBy();
+    }
+  };
+
+  /*
+   * Checking the current transaction state to determine the next step.
+   * It will either be Err, indicating process should stop, or Ok, indicating process should continu.
+   */
+  const nextStateResult = produceNextStateForTransaction(actions);
+
+  if (nextStateResult.err) {
+    onNextStateError(actions, nextStateResult.val);
+    failed();
+    onFinish();
+    return;
+  }
+
+  // On sucess, we should update Swap object and also call notifier
+  onNextStateOk(actions, nextStateResult.val);
+
+  // when we are producing next step, it will check to tx shouldn't be null. So ! here is safe.
+  const tx = getCurrentStepTx(currentStep)!;
+
+  if (!isXrplTransaction(tx)) {
+    throw new Error('TODO: NEEDS TO FAILED AND THROW A MESSAGE USING HOOKS');
+  }
+
+  const sourceWallet = getRelatedWallet(swap, currentStep);
+  const walletAddress = getCurrentAddressOf(swap, currentStep);
+
+  const chainId = meta.blockchains?.[tx.blockChain]?.chainId;
+  const walletSigners = await getSigners(sourceWallet.walletType);
+
+  if (tx.data.TransactionType !== 'Payment') {
+    throw new Error('TODO: SHOULD FAILED Q correctly.');
+  }
+
+  const transactionQueue: XrplTransaction[] = [tx];
+  if (isIssuedCurrencyAmount(tx.data.Amount)) {
+    const trustlineTx: XrplTrustSetTransactionData = {
+      TransactionType: 'TrustSet',
+      Account: tx.data.Account,
+      LimitAmount: {
+        currency: tx.data.Amount.currency,
+        issuer: tx.data.Amount.issuer,
+        value: tx.data.Amount.value,
+      },
+    };
+    transactionQueue.unshift({
+      ...tx,
+      data: trustlineTx,
+    });
+  }
+
+  const signer: GenericSigner<XrplTransaction> = walletSigners.getSigner(
+    tx.type
+  );
+
+  // TODO: Check failuire scenario
+  for (const transaction of transactionQueue) {
+    await signer
+      .signAndSendTx(transaction, walletAddress, chainId)
+      .then(
+        handleSuccessfulSign(actions, {
+          isApproval,
+        }),
+        handlRejectedSign(actions)
+      )
+      .finally(() => {
+        onFinish();
+      });
+  }
+}

queue-manager/rango-preset/src/actions/executeXrplTransaction/helpers.ts

@@ -0,0 +1,13 @@
+import type { XrplTransactionDataIssuedCurrencyAmount } from 'rango-types';
+
+export function isIssuedCurrencyAmount(
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  amount: any
+): amount is XrplTransactionDataIssuedCurrencyAmount {
+  return (
+    typeof amount === 'object' &&
+    typeof amount.currency === 'string' &&
+    typeof amount.issuer === 'string' &&
+    typeof amount.value === 'string'
+  );
+}

queue-manager/rango-preset/src/actions/executeXrplTransaction/index.ts

@@ -0,0 +1 @@
+export { executeXrplTransaction } from './executeXrplTransaction.js';

queue-manager/rango-preset/src/actions/scheduleNextStep.ts

@@ -1,6 +1,7 @@
 import type { SwapQueueContext, SwapStorage } from '../types';
 import type { ExecuterActions } from '@rango-dev/queue-manager-core';
-import type { PendingSwapStep } from 'rango-types';
+
+import { type PendingSwapStep, TransactionType } from 'rango-types';
 
 import {
   getCurrentStep,
@@ -37,7 +38,11 @@ export function scheduleNextStep({
 
   if (!!currentStep && !isFailed) {
     if (isTxAlreadyCreated(swap, currentStep)) {
-      schedule(SwapActionTypes.EXECUTE_TRANSACTION);
+      if (currentStep.fromBlockchain === TransactionType.XRPL) {
+        schedule(SwapActionTypes.EXECUTE_XRPL_TRANSACTION);
+      } else {
+        schedule(SwapActionTypes.EXECUTE_TRANSACTION);
+      }
       return next();
     }
 

queue-manager/rango-preset/src/helpers.ts

@@ -171,6 +171,7 @@ export const getCurrentStepTx = (
     tronTransaction,
     tonTransaction,
     suiTransaction,
+    xrplTransaction,
   } = currentStep;
   return (
     evmTransaction ||
@@ -183,7 +184,8 @@ export const getCurrentStepTx = (
     tronApprovalTransaction ||
     tronTransaction ||
     tonTransaction ||
-    suiTransaction
+    suiTransaction ||
+    xrplTransaction
   );
 };
 
@@ -207,6 +209,7 @@ export const setCurrentStepTx = (
   currentStep.tronTransaction = null;
   currentStep.tonTransaction = null;
   currentStep.suiTransaction = null;
+  currentStep.xrplTransaction = null;
 
   const txType = transaction.type;
   switch (txType) {
@@ -746,6 +749,7 @@ export const isTxAlreadyCreated = (
     swap.wallets[step.solanaTransaction?.blockChain || ''] ||
     swap.wallets[step.tonTransaction?.blockChain || ''] ||
     swap.wallets[step.suiTransaction?.blockChain || ''] ||
+    swap.wallets[step.xrplTransaction?.blockChain || ''] ||
     step.transferTransaction?.fromWalletAddress ||
     null;
 

queue-manager/rango-preset/src/queueDef.ts

@@ -1,14 +1,17 @@
-import { BlockReason, SwapActionTypes, SwapQueueDef } from './types';
+import type { SwapQueueDef } from './types';
+
 import { checkStatus } from './actions/checkStatus';
 import { createTransaction } from './actions/createTransaction';
 import { executeTransaction } from './actions/executeTransaction';
+import { executeXrplTransaction } from './actions/executeXrplTransaction';
 import { scheduleNextStep } from './actions/scheduleNextStep';
 import { start } from './actions/start';
 import {
   onBlockForChangeNetwork,
   onBlockForConnectWallet,
   onDependsOnOtherQueues,
 } from './helpers';
+import { BlockReason, SwapActionTypes } from './types';
 
 /**
  *
@@ -24,10 +27,12 @@ export const swapQueueDef: SwapQueueDef = {
     [SwapActionTypes.SCHEDULE_NEXT_STEP]: scheduleNextStep,
     [SwapActionTypes.CREATE_TRANSACTION]: createTransaction,
     [SwapActionTypes.EXECUTE_TRANSACTION]: executeTransaction,
+    [SwapActionTypes.EXECUTE_XRPL_TRANSACTION]: executeXrplTransaction,
     [SwapActionTypes.CHECK_TRANSACTION_STATUS]: checkStatus,
   },
   run: [SwapActionTypes.START],
   whenTaskBlocked: (event, meta) => {
+    console.log({ event });
     if (event.reason.reason === BlockReason.WAIT_FOR_CONNECT_WALLET) {
       onBlockForConnectWallet(event, meta);
     } else if (event.reason.reason === BlockReason.WAIT_FOR_NETWORK_CHANGE) {

queue-manager/rango-preset/src/shared.ts

@@ -118,6 +118,7 @@ export const getCurrentNamespaceOf = (
   const solanaNetwork = step.solanaTransaction?.blockChain;
   const tonNetwork = step.tonTransaction?.blockChain;
   const suiNetwork = step.suiTransaction?.blockChain;
+  const xrplNetwork = step.xrplTransaction?.blockChain;
 
   if (evmNetwork) {
     return {
@@ -154,6 +155,11 @@ export const getCurrentNamespaceOf = (
       namespace: 'Sui',
       network: suiNetwork,
     };
+  } else if (xrplNetwork) {
+    return {
+      namespace: 'XRPL',
+      network: xrplNetwork,
+    };
   } else if (!!step.transferTransaction) {
     const transferAddress = step.transferTransaction.fromWalletAddress;
     if (!transferAddress) {
@@ -232,6 +238,7 @@ export const getCurrentWalletTypeAndAddress = (
     swap.wallets[step.solanaTransaction?.blockChain || ''] ||
     swap.wallets[step.tonTransaction?.blockChain || ''] ||
     swap.wallets[step.suiTransaction?.blockChain || ''] ||
+    swap.wallets[step.xrplTransaction?.blockChain || ''] ||
     (step.transferTransaction?.fromWalletAddress
       ? { address: step.transferTransaction?.fromWalletAddress }
       : null) ||
@@ -268,6 +275,13 @@ export function getRelatedWallet(
   const wallet = walletKV?.v || null;
 
   const walletType = wallet?.walletType;
+
+  console.log({
+    walletType,
+    wallet,
+    blockchain,
+    walletKV,
+  });
   if (wallet === null) {
     throw PrettyError.AssertionFailed(
       `Wallet for source ${blockchain} not passed: walletType: ${walletType}`
@@ -284,8 +298,10 @@ export function getRelatedWalletOrNull(
     return null;
   }
   try {
+    console.log('checking...');
     return getRelatedWallet(swap, currentStep);
-  } catch {
+  } catch (e) {
+    console.log({ e });
     return null;
   }
 }

queue-manager/rango-preset/src/types.ts

@@ -42,6 +42,7 @@ export enum SwapActionTypes {
   SCHEDULE_NEXT_STEP = 'SCHEDULE_NEXT_STEP',
   CREATE_TRANSACTION = 'CREATE_TRANSACTION',
   EXECUTE_TRANSACTION = 'EXECUTE_TRANSACTION',
+  EXECUTE_XRPL_TRANSACTION = 'EXECUTE_XRPL_TRANSACTION',
   CHECK_TRANSACTION_STATUS = 'CHECK_TRANSACTION_STATUS',
 }
 

wallets/core/namespaces/xrpl/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@rango-dev/wallets-core/namespaces/xrpl",
+  "type": "module",
+  "main": "../../dist/namespaces/xrpl/mod.js",
+  "module": "../../dist/namespaces/xrpl/mod.js",
+  "types": "../../dist/namespaces/xrpl/mod.d.ts",
+  "sideEffects": false
+}