Feat/rf 2840 migrating tonconnect to hub

wallets/core/namespaces/ton/package.json

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

wallets/core/package.json

@@ -58,6 +58,10 @@
     "./namespaces/xrpl": {
       "types": "./dist/namespaces/xrpl/mod.d.ts",
       "default": "./dist/namespaces/xrpl/mod.js"
+    },
+    "./namespaces/ton": {
+      "types": "./dist/namespaces/ton/mod.d.ts",
+      "default": "./dist/namespaces/ton/mod.js"
     }
   },
   "files": [
@@ -66,7 +70,7 @@
     "legacy"
   ],
   "scripts": {
-    "build": "node ../../scripts/build/command.mjs --path wallets/core --inputs src/mod.ts,src/utils/mod.ts,src/legacy/mod.ts,src/hub/store/mod.ts,src/namespaces/evm/mod.ts,src/namespaces/solana/mod.ts,src/namespaces/cosmos/mod.ts,src/namespaces/utxo/mod.ts,src/namespaces/sui/mod.ts,src/namespaces/tron/mod.ts,src/namespaces/starknet/mod.ts,src/namespaces/xrpl/mod.ts,src/namespaces/common/mod.ts",
+    "build": "node ../../scripts/build/command.mjs --path wallets/core --inputs src/mod.ts,src/utils/mod.ts,src/legacy/mod.ts,src/hub/store/mod.ts,src/namespaces/evm/mod.ts,src/namespaces/solana/mod.ts,src/namespaces/cosmos/mod.ts,src/namespaces/utxo/mod.ts,src/namespaces/sui/mod.ts,src/namespaces/tron/mod.ts,src/namespaces/starknet/mod.ts,src/namespaces/xrpl/mod.ts,src/namespaces/common/mod.ts,src/namespaces/ton/mod.ts",
     "ts-check": "tsc --declaration --emitDeclarationOnly -p ./tsconfig.json",
     "clean": "rimraf dist",
     "format": "prettier --write '{.,src}/**/*.{ts,tsx}'",

wallets/core/src/hub/hub.ts

@@ -14,6 +14,15 @@ type RunAllResult = {
   namespaces: unknown[];
 };
 
+type RunAllArgs = {
+  [providerId: string]: {
+    provider?: unknown;
+    namespaces?: {
+      [namespaceId: string]: unknown;
+    };
+  };
+};
+
 interface HubOptions {
   store?: Store;
 }
@@ -25,16 +34,16 @@ export class Hub {
     this.#options = options ?? {};
   }
 
-  init() {
-    this.runAll('init');
+  init(args?: RunAllArgs) {
+    this.runAll('init', args);
   }
 
   /*
    * Running a specific action (e.g. init) on all namespaces and providers one by one.
    *
    *  TODO: Some of methods may accepts args, with this implementation we only limit to those one without any argument.
    */
-  runAll(action: string): RunAllResult[] {
+  runAll(action: string, args?: RunAllArgs): RunAllResult[] {
     const output: RunAllResult[] = [];
 
     // run action on all providers eagerConnect, disconnect
@@ -52,7 +61,10 @@ export class Hub {
       if (typeof providerMethod === 'function') {
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore-next-line
-        providerOutput.provider = providerMethod.call(provider);
+        providerOutput.provider = providerMethod.call(
+          provider,
+          args?.[provider.id]?.provider
+        );
       }
 
       // Namespace instances can have their own `action` as well. we will call them as well.
@@ -62,7 +74,9 @@ export class Hub {
         // @ts-ignore-next-line
         const namespaceMethod = namespace[action];
         if (typeof namespaceMethod === 'function') {
-          const result = namespaceMethod();
+          const result = namespaceMethod(
+            args?.[provider.id]?.namespaces?.[namespace.namespaceId]
+          );
           providerOutput.namespaces.push(result);
         }
       }

wallets/core/src/hub/provider/provider.ts

@@ -68,14 +68,14 @@ export class Provider {
    * provider.init()
    * ```
    */
-  public init(): void {
+  public init(args?: unknown): void {
     if (this.#initiated) {
       return;
     }
 
     const definedInitByUser = this.#extendInternalActions.init;
     if (definedInitByUser) {
-      definedInitByUser(this.#context());
+      definedInitByUser(this.#context(), args);
     }
 
     this.#initiated = true;

wallets/core/src/hub/provider/types.ts

@@ -6,6 +6,7 @@ import type { EvmActions } from '../../namespaces/evm/mod.js';
 import type { SolanaActions } from '../../namespaces/solana/mod.js';
 import type { StarknetActions } from '../../namespaces/starknet/types.js';
 import type { SuiActions } from '../../namespaces/sui/mod.js';
+import type { TonActions } from '../../namespaces/ton/types.js';
 import type { TronActions } from '../../namespaces/tron/types.js';
 import type { UtxoActions } from '../../namespaces/utxo/mod.js';
 import type { XRPLActions } from '../../namespaces/xrpl/mod.js';
@@ -38,6 +39,7 @@ export interface CommonNamespaces {
   tron: TronActions;
   starknet: StarknetActions;
   xrpl: XRPLActions;
+  ton: TonActions;
 }
 
 export type CommonNamespaceKeys = Prettify<keyof CommonNamespaces>;

wallets/core/src/namespaces/ton/builders.ts

@@ -0,0 +1,15 @@
+import type { TonActions } from './types.js';
+
+import { ActionBuilder } from '../../builders/action.js';
+import { intoConnectionFinished } from '../common/after.js';
+import { connectAndUpdateStateForSingleNetwork } from '../common/and.js';
+import { intoConnecting } from '../common/before.js';
+
+export const connect = () =>
+  new ActionBuilder<TonActions, 'connect'>('connect')
+    .and(connectAndUpdateStateForSingleNetwork)
+    .before(intoConnecting)
+    .after(intoConnectionFinished);
+
+export const canEagerConnect = () =>
+  new ActionBuilder<TonActions, 'canEagerConnect'>('canEagerConnect');

wallets/core/src/namespaces/ton/constants.ts

@@ -0,0 +1,2 @@
+export const CAIP_NAMESPACE = 'tvm';
+export const CAIP_TON_CHAIN_ID = '-239';

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

@@ -0,0 +1,5 @@
+export * as utils from './utils.js';
+export * as builders from './builders.js';
+
+export type { ProviderAPI, TonActions } from './types.js';
+export { CAIP_NAMESPACE, CAIP_TON_CHAIN_ID } from './constants.js';

wallets/core/src/namespaces/ton/types.ts

@@ -0,0 +1,15 @@
+import type { Accounts } from '../../types/accounts.js';
+import type {
+  AutoImplementedActionsByRecommended,
+  CommonActions,
+} from '../common/types.js';
+
+export interface TonActions
+  extends AutoImplementedActionsByRecommended,
+    CommonActions {
+  connect: () => Promise<Accounts>;
+  canEagerConnect: () => Promise<boolean>;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type ProviderAPI = Record<string, any>;

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

@@ -0,0 +1,18 @@
+import type { CaipAccount } from '../../types/accounts.js';
+
+import { AccountId } from 'caip';
+
+import { CAIP_NAMESPACE, CAIP_TON_CHAIN_ID } from './constants.js';
+
+export function formatAccountsToCAIP(accounts: string[]) {
+  return accounts.map(
+    (account) =>
+      AccountId.format({
+        address: account.toString(),
+        chainId: {
+          namespace: CAIP_NAMESPACE,
+          reference: CAIP_TON_CHAIN_ID,
+        },
+      }) as CaipAccount
+  );
+}

wallets/provider-all/src/index.ts

@@ -30,7 +30,7 @@ import { versions as solflare } from '@rango-dev/provider-solflare';
 import { versions as taho } from '@rango-dev/provider-taho';
 import { versions as tokenPocket } from '@rango-dev/provider-tokenpocket';
 import { versions as tomo } from '@rango-dev/provider-tomo';
-import * as tonconnect from '@rango-dev/provider-tonconnect';
+import { versions as tonconnect } from '@rango-dev/provider-tonconnect';
 import * as trezor from '@rango-dev/provider-trezor';
 import { versions as tronLink } from '@rango-dev/provider-tron-link';
 import { versions as trustwallet } from '@rango-dev/provider-trustwallet';
@@ -84,23 +84,12 @@ export const allProviders = (
     }
   }
 
-  if (
-    !isWalletExcluded(providers, {
-      type: WalletTypes.TON_CONNECT,
-      name: 'tonconnect',
-    })
-  ) {
-    if (!!options?.tonConnect?.manifestUrl) {
-      tonconnect.init(options.tonConnect);
-    }
-  }
-
   return [
     lazyProvider(legacyProviderImportsToVersionsInterface(safe)),
     lazyProvider(legacyProviderImportsToVersionsInterface(defaultInjected)),
     metamask,
     lazyProvider(legacyProviderImportsToVersionsInterface(walletconnect2)),
-    lazyProvider(legacyProviderImportsToVersionsInterface(tonconnect)),
+    tonconnect,
     keplr,
     phantom,
     ready,

wallets/provider-tonconnect/package.json

@@ -3,21 +3,18 @@
   "version": "0.20.1-next.1",
   "license": "MIT",
   "type": "module",
-  "source": "./src/index.ts",
-  "main": "./dist/index.js",
+  "source": "./src/mod.ts",
+  "main": "./dist/mod.js",
   "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
-    }
+    ".": "./dist/mod.js"
   },
-  "typings": "dist/index.d.ts",
+  "typings": "dist/mod.d.ts",
   "files": [
     "dist",
     "src"
   ],
   "scripts": {
-    "build": "node ../../scripts/build/command.mjs --path wallets/provider-tonconnect",
+    "build": "node ../../scripts/build/command.mjs --path wallets/provider-tonconnect --inputs src/mod.ts",
     "ts-check": "tsc --declaration --emitDeclarationOnly -p ./tsconfig.json",
     "clean": "rimraf dist",
     "format": "prettier --write '{.,src}/**/*.{ts,tsx}'",
@@ -33,4 +30,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

wallets/provider-tonconnect/readme.md

@@ -1,3 +1,29 @@
 # @rango-dev/provider-tonconnect
+TonConnect Wallet integration for hub.  
+[Homepage](https://ton.org/) | [Docs](https://docs.ton.org/ecosystem/ton-connect/overview)
 
-TonConnect
+More about implementation status can be found [here](../readme.md).
+
+## Implementation notes/limitations
+
+#### ⚠️ Initialization
+You should provide TonConnect configs in configs.walletOptions[WalletTypes.TON_CONNECT] (which equals configs.walletOptions.tonconnect)
+
+### Feature
+
+#### ❌ Switch Account
+
+Ton wallets don't emit account change events: https://github.com/ton-blockchain/ton-connect/blob/main/wallet-guidelines.md
+
+#### ⚠️ Disconnect
+
+Some Ton wallets like **Tonkeeper** don't emit disconnect events
+
+#### ⚠️ Init
+
+We set **'installed'** to `true` on initialization even if we can't initialize the TonConnect instance.
+Instead, we throw an error when the user tries to connect and we haven't initialized the TonConnect instance.
+
+---
+
+More wallet information can be found in [readme.md](../readme.md).

wallets/provider-tonconnect/src/actions/ton.ts

@@ -0,0 +1,56 @@
+import type { Context, FunctionWithContext } from '@rango-dev/wallets-core';
+import type { TonConnectUI } from '@tonconnect/ui';
+
+import { actions as commonActions } from '@rango-dev/wallets-core/namespaces/common';
+import {
+  type TonActions,
+  type ProviderAPI as TonProviderAPI,
+  utils,
+} from '@rango-dev/wallets-core/namespaces/ton';
+
+import { tonConnect, waitForConnection } from '../utils.js';
+
+export function connect(
+  getInstance: () => TonConnectUI
+): FunctionWithContext<TonActions['connect'], Context> {
+  return async () => {
+    const tonInstance = getInstance();
+    const connectionRestored = await tonInstance.connectionRestored;
+    const { toUserFriendlyAddress } = tonConnect.getModule();
+    let userFriendlyAddress: string;
+
+    if (connectionRestored && tonInstance.account?.address) {
+      userFriendlyAddress = toUserFriendlyAddress(tonInstance.account.address);
+    } else {
+      await tonInstance.openModal();
+      const result = await waitForConnection(tonInstance);
+      userFriendlyAddress = toUserFriendlyAddress(result);
+    }
+
+    return utils.formatAccountsToCAIP([userFriendlyAddress]);
+  };
+}
+
+export function disconnect(
+  getInstance: () => TonProviderAPI
+): FunctionWithContext<TonActions['disconnect'], Context> {
+  return async (context) => {
+    const tonInstance = getInstance();
+    if (tonInstance.connected) {
+      await tonInstance.disconnect();
+    }
+    commonActions.disconnect(context);
+  };
+}
+
+export function canEagerConnect(
+  getInstance: () => TonProviderAPI
+): FunctionWithContext<TonActions['canEagerConnect'], Context> {
+  return async () => {
+    const tonConnectUI = getInstance() as TonConnectUI;
+    const connectionRestored = await tonConnectUI.connectionRestored;
+    return connectionRestored;
+  };
+}
+
+export const tonActions = { connect, disconnect, canEagerConnect };

wallets/provider-tonconnect/src/constants.ts

@@ -0,0 +1,38 @@
+import type { ProviderMetadata } from '@rango-dev/wallets-core';
+
+import { WalletTypes } from '@rango-dev/wallets-shared';
+import { type BlockchainMeta, tonBlockchain } from 'rango-types';
+
+import getSigners from './signer.js';
+import { getInstanceOrThrow } from './utils.js';
+
+export const WALLET_ID = WalletTypes.TON_CONNECT;
+
+export const metadata: ProviderMetadata = {
+  name: 'TON Connect',
+  icon: 'https://raw.githubusercontent.com/rango-exchange/assets/7fb19ed5d5019b4d6a41ce91b39cde64f86af4c6/wallets/tonconnect/icon.svg',
+  extensions: {},
+  properties: [
+    {
+      name: 'namespaces',
+      value: {
+        selection: 'single',
+        data: [
+          {
+            label: 'Ton',
+            value: 'Ton',
+            id: 'TON',
+            getSupportedChains: (allBlockchains: BlockchainMeta[]) =>
+              tonBlockchain(allBlockchains),
+          },
+        ],
+      },
+    },
+    {
+      name: 'signers',
+      value: {
+        getSigners: async () => getSigners(getInstanceOrThrow()),
+      },
+    },
+  ],
+};