Feat/integrate gem wallet

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

@@ -36,6 +36,8 @@ export function scheduleNextStep({
     (step: PendingSwapStep) => step.status === 'failed'
   );
 
+  console.log('what the heck is happening here');
+
   if (!!currentStep && !isFailed) {
     if (isTxAlreadyCreated(swap, currentStep)) {
       if (currentStep.fromBlockchain === TransactionType.XRPL) {

wallets/core/src/namespaces/xrpl/mod.ts

@@ -1,4 +1,5 @@
 export * as builders from './builders.js';
 export type { XRPLActions } from './types.js';
 
+export * as utils from './utils.js';
 export { CAIP_XRPL_CHAIN_ID, CAIP_NAMESPACE } from './constants.js';

wallets/core/src/namespaces/xrpl/utils.ts

@@ -0,0 +1,15 @@
+import type { CaipAccount } from '../common/mod.js';
+
+import { AccountId } from 'caip';
+
+import { CAIP_NAMESPACE, CAIP_XRPL_CHAIN_ID } from './constants.js';
+
+export function formatAddressToCAIP(address: string): string {
+  return AccountId.format({
+    address,
+    chainId: {
+      namespace: CAIP_NAMESPACE,
+      reference: CAIP_XRPL_CHAIN_ID,
+    },
+  }) as CaipAccount;
+}

wallets/provider-all/package.json

@@ -32,6 +32,7 @@
     "@rango-dev/provider-enkrypt": "^0.58.1-next.2",
     "@rango-dev/provider-exodus": "^0.59.1-next.2",
     "@rango-dev/provider-keplr": "^0.58.1-next.2",
+    "@rango-dev/provider-gemwallet": "^0.1.0",
     "@rango-dev/provider-leap-cosmos": "^0.58.1-next.2",
     "@rango-dev/provider-ledger": "^0.29.1-next.2",
     "@rango-dev/provider-math-wallet": "^0.59.1-next.2",
@@ -62,4 +63,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

wallets/provider-all/src/index.ts

@@ -14,6 +14,7 @@ import { versions as cosmostation } from '@rango-dev/provider-cosmostation';
 import * as defaultInjected from '@rango-dev/provider-default';
 import { versions as enkrypt } from '@rango-dev/provider-enkrypt';
 import { versions as exodus } from '@rango-dev/provider-exodus';
+import { versions as gemwallet } from '@rango-dev/provider-gemwallet';
 import { versions as keplr } from '@rango-dev/provider-keplr';
 import { versions as leap } from '@rango-dev/provider-leap-cosmos';
 import { versions as ledger } from '@rango-dev/provider-ledger';
@@ -130,5 +131,6 @@ export const allProviders = (
     solflare,
     slush,
     unisat,
+    gemwallet,
   ];
 };

wallets/provider-gemwallet/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@rango-dev/provider-gemwallet",
+  "version": "0.1.0",
+  "license": "MIT",
+  "type": "module",
+  "source": "./src/mod.ts",
+  "main": "./dist/mod.js",
+  "exports": {
+    ".": "./dist/mod.js"
+  },
+  "typings": "dist/mod.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "build": "node ../../scripts/build/command.mjs --path wallets/provider-gemwallet --inputs src/mod.ts",
+    "ts-check": "tsc --declaration --emitDeclarationOnly -p ./tsconfig.json",
+    "clean": "rimraf dist",
+    "format": "prettier --write '{.,src}/**/*.{ts,tsx}'",
+    "lint": "eslint \"**/*.{ts,tsx}\""
+  },
+  "dependencies": {
+    "@rango-dev/wallets-shared": "0.58.1-next.2",
+    "@gemwallet/api": "^3.8.0",
+    "xrpl": "^4.2.0",
+    "rango-types": "^0.1.95"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

wallets/provider-gemwallet/readme.md

@@ -0,0 +1,18 @@
+# GemWallet Provider
+GemWallet integration for hub.
+[Homepage](https://gemwallet.app/) | [Docs](https://gemwallet.app/docs/user-guide/introduction)
+
+More about implementation status can be found [here](../readme.md).
+
+## Implementation notes/limitation
+
+### Feature
+
+#### ⚠️ Auto Connect
+
+It doesn't have the feature to silently connect to wallet, it shows a popup and a loading for a few seconds.
+
+
+---
+
+More wallet information can be found in [readme.md](../readme.md).

wallets/provider-gemwallet/src/constants.ts

@@ -0,0 +1,40 @@
+import type { ProviderMetadata } from '@rango-dev/wallets-core';
+import type { BlockchainMeta } from 'rango-types';
+
+import { xrplBlockchain } from 'rango-types';
+
+import getSigners from './signer.js';
+
+export const XRPL_PUBLIC_SERVER = 'wss://xrplcluster.com/';
+export const WALLET_ID = 'gemwallet';
+
+export const info: ProviderMetadata = {
+  name: 'GemWallet',
+  icon: 'https://raw.githubusercontent.com/rango-exchange/assets/main/wallets/gemwallet/icon.svg',
+  extensions: {
+    chrome:
+      'https://chromewebstore.google.com/detail/gemwallet/egebedonbdapoieedfcfkofloclfghab',
+    homepage: 'https://gemwallet.app/',
+  },
+  properties: [
+    {
+      name: 'namespaces',
+      value: {
+        selection: 'multiple',
+        data: [
+          {
+            label: 'XRPL',
+            value: 'XRPL',
+            id: 'XRPL',
+            getSupportedChains: (allBlockchains: BlockchainMeta[]) =>
+              xrplBlockchain(allBlockchains),
+          },
+        ],
+      },
+    },
+    {
+      name: 'signers',
+      value: { getSigners: async () => getSigners() },
+    },
+  ],
+};

wallets/provider-gemwallet/src/mod.ts

@@ -0,0 +1,8 @@
+import { defineVersions } from '@rango-dev/wallets-core/utils';
+
+import { buildProvider } from './provider.js';
+
+const versions = () =>
+  defineVersions().version('1.0.0', buildProvider()).build();
+
+export { versions };

wallets/provider-gemwallet/src/namespaces/xrpl/helpers.ts

@@ -0,0 +1,88 @@
+import type {
+  Memo,
+  SendPaymentRequest,
+  SetTrustlineRequest,
+} from '@gemwallet/api';
+import type {
+  XrplPaymentTransactionData,
+  XrplTransactionDataIssuedCurrencyAmount,
+  XrplTransactionDataMPTAmount,
+  XrplTrustSetTransactionData,
+} from 'rango-types/mainApi';
+
+function isIssuedCurrencyAmount(
+  amount: XrplPaymentTransactionData['Amount']
+): amount is XrplTransactionDataIssuedCurrencyAmount {
+  return (
+    typeof amount === 'object' &&
+    // @ts-expect-error it never throw an runtime error, since we are checking it should be an object first
+    typeof amount.currency === 'string' &&
+    // @ts-expect-error it never throw an runtime error, since we are checking it should be an object first
+    typeof amount.issuer === 'string' &&
+    typeof amount.value === 'string'
+  );
+}
+
+function isMPTokenAmount(
+  amount: XrplPaymentTransactionData['Amount']
+): amount is XrplTransactionDataMPTAmount {
+  return (
+    typeof amount === 'object' &&
+    // @ts-expect-error it never throw an runtime error, since we are checking it should be an object first
+    typeof amount.mpt_issuance_id === 'string' &&
+    typeof amount.value === 'string'
+  );
+}
+
+function fromPaymentTransactionMemoToGemWalletMemo(
+  memos: XrplPaymentTransactionData['Memos']
+): Memo[] {
+  if (!memos) {
+    return [];
+  }
+
+  return memos.map((memo) => {
+    return {
+      memo: {
+        memoType: memo.Memo.MemoType,
+        memoData: memo.Memo.MemoData,
+        memoFormat: memo.Memo.MemoFormat,
+      },
+    };
+  });
+}
+
+export function fromTrustSetTransactionDataToGemWalletRequest(
+  data: XrplTrustSetTransactionData
+): SetTrustlineRequest {
+  return {
+    limitAmount: data.LimitAmount,
+    memos: fromPaymentTransactionMemoToGemWalletMemo(data.Memos),
+    flags: data.Flags,
+  };
+}
+
+export function fromPaymentTransactionDataToGemWalletRequest(
+  data: XrplPaymentTransactionData
+): SendPaymentRequest {
+  let amount: SendPaymentRequest['amount'];
+  if (isMPTokenAmount(data.Amount)) {
+    throw new Error("Current implemented signer doesn't have support for MPT");
+  } else if (isIssuedCurrencyAmount(data.Amount)) {
+    amount = data.Amount;
+  } else if (typeof data.Amount === 'string') {
+    amount = data.Amount;
+  } else {
+    throw new Error(
+      "There is an unexpected type for Amount. current signer doesn't have support for that."
+    );
+  }
+
+  return {
+    amount,
+    destination: data.Destination,
+    destinationTag: data.DestinationTag,
+    memos: fromPaymentTransactionMemoToGemWalletMemo(data.Memos),
+    flags: data.Flags,
+  };
+}

wallets/provider-gemwallet/src/namespaces/xrpl/hooks.ts

@@ -0,0 +1,35 @@
+import type { XRPLActions } from '@rango-dev/wallets-core/namespaces/xrpl';
+
+import { on } from '@gemwallet/api';
+import { ChangeAccountSubscriberBuilder } from '@rango-dev/wallets-core/namespaces/common';
+import { utils } from '@rango-dev/wallets-core/namespaces/xrpl';
+
+type WalletChangedEventPayload = {
+  wallet: {
+    publicAddress: string;
+  };
+};
+
+export function changeAccountSubscriberBuilder() {
+  // `true` instead of ProviderAPI is just a workaround. we don't need to have instance here.
+  return new ChangeAccountSubscriberBuilder<
+    WalletChangedEventPayload,
+    true,
+    XRPLActions
+  >()
+    .getInstance(() => true)
+    .format(async (_, payload) => [
+      utils.formatAddressToCAIP(payload.wallet.publicAddress),
+    ])
+    .addEventListener((_, callback) => {
+      on('walletChanged', callback);
+    })
+    .removeEventListener((_instance, _callback) => {
+      /*
+       * TODO: gem wallet doesn't have support for unsubscribing.
+       * Making a variable and keep the callback refrence then here make it `undefined` is a quick fix
+       * but it makes new bugs, where if two subscribers added at once, we will loose the track of the first one and it will be staled.
+       */
+    })
+    .build();
+}

wallets/provider-gemwallet/src/namespaces/xrpl/mod.ts

@@ -0,0 +1,2 @@
+export { namespace } from './namespace.js';
+export { Signer } from './singer.js';

wallets/provider-gemwallet/src/namespaces/xrpl/namespace.ts

@@ -0,0 +1,75 @@
+import type { XRPLActions } from '@rango-dev/wallets-core/namespaces/xrpl';
+
+import { getAddress } from '@gemwallet/api';
+import { ActionBuilder, NamespaceBuilder } from '@rango-dev/wallets-core';
+import { builders, utils } from '@rango-dev/wallets-core/namespaces/xrpl';
+import { Client } from 'xrpl';
+
+import { WALLET_ID, XRPL_PUBLIC_SERVER } from '../../constants.js';
+import { checkInstallationOnLoad } from '../../utils.js';
+
+import { changeAccountSubscriberBuilder } from './hooks.js';
+
+const [changeAccountSubscriber, changeAccountCleanup] =
+  changeAccountSubscriberBuilder();
+
+const connect = builders
+  .connect()
+  .action(async function () {
+    const response = await getAddress();
+    if (!response.result?.address) {
+      throw new Error(`Couldn't access to your wallet address.`);
+    }
+
+    return [utils.formatAddressToCAIP(response.result.address)];
+  })
+  .before(changeAccountSubscriber)
+  .or(changeAccountCleanup)
+  .build();
+
+const canEagerConnect = new ActionBuilder<XRPLActions, 'canEagerConnect'>(
+  'canEagerConnect'
+)
+  .action(async () => {
+    const isInstalled = await checkInstallationOnLoad();
+    if (!isInstalled) {
+      throw new Error(
+        'Trying to eagerly connect to your EVM wallet, but seems its instance is not available.'
+      );
+    }
+
+    try {
+      const response = await getAddress();
+      const address = response.result?.address;
+
+      return !!address;
+    } catch {
+      return false;
+    }
+  })
+  .build();
+
+const accountLines = new ActionBuilder<XRPLActions, 'accountLines'>(
+  'accountLines'
+)
+  .action(async (_, account, options) => {
+    const client = new Client(XRPL_PUBLIC_SERVER);
+    await client.connect();
+
+    const response = await client.request({
+      command: 'account_lines',
+      ledger_index: 'current',
+      account: account,
+      peer: options?.peer,
+    });
+
+    await client.disconnect();
+    return response.result.lines;
+  })
+  .build();
+
+export const namespace = new NamespaceBuilder<XRPLActions>('XRPL', WALLET_ID)
+  .action(connect)
+  .action(canEagerConnect)
+  .action(accountLines)
+  .build();