@rango-dev/wallets-core 0.47.1-next.1 → 0.48.1-next.0

package/src/hub/provider/provider.test.ts

@@ -6,7 +6,11 @@ import { beforeEach, describe, expect, test, vi } from 'vitest';
 
 import { NamespaceBuilder } from '../../builders/namespace.js';
 import { ProviderBuilder } from '../../builders/provider.js';
-import { garbageWalletInfo } from '../../test-utils/fixtures.js';
+import {
+  garbageWalletDeepLink,
+  garbageWalletInfo,
+  garbageWalletMetaData,
+} from '../../test-utils/fixtures.js';
 import { createStore } from '../store/mod.js';
 
 import { Provider } from './provider.js';
@@ -46,9 +50,7 @@ describe('check providers', () => {
   });
 
   test('Initialize providers correctly', () => {
-    const provider = new Provider('garbage', namespacesMap, {
-      info: garbageWalletInfo,
-    });
+    const provider = new Provider('garbage', namespacesMap, garbageWalletInfo);
 
     const allNamespaces = provider.getAll();
 
@@ -56,48 +58,32 @@ describe('check providers', () => {
   });
 
   test('throw error if state() is called before store initialization', () => {
-    const provider = new Provider('garbage', namespacesMap, {
-      info: garbageWalletInfo,
-    });
+    const provider = new Provider('garbage', namespacesMap, garbageWalletInfo);
 
     expect(() => provider.state()).toThrowError();
   });
 
   test('should return wallet info via info() without store initialization', () => {
-    const provider = new Provider('garbage', namespacesMap, {
-      info: garbageWalletInfo,
-    });
+    const provider = new Provider('garbage', namespacesMap, garbageWalletInfo);
 
     expect(provider.info()).toBe(garbageWalletInfo);
   });
 
   test('should return wallet info via info() after store initialization', () => {
     const store = createStore();
-    const provider = new Provider(
-      'garbage',
-      namespacesMap,
-      {
-        info: garbageWalletInfo,
-      },
-      { store }
-    );
+    const provider = new Provider('garbage', namespacesMap, garbageWalletInfo, {
+      store,
+    });
 
-    expect(provider.info()).toBe(
-      store.getState().providers.list['garbage'].config.info
+    expect(provider.info()).toMatchObject(
+      store.getState().providers.list['garbage'].config
     );
   });
 
   test('access state correctly', () => {
-    const provider = new Provider(
-      'garbage',
-      namespacesMap,
-      {
-        info: garbageWalletInfo,
-      },
-      {
-        store: createStore(),
-      }
-    );
+    const provider = new Provider('garbage', namespacesMap, garbageWalletInfo, {
+      store: createStore(),
+    });
 
     const [getState, setState] = provider.state();
 
@@ -114,16 +100,9 @@ describe('check providers', () => {
   });
   test('update state properly', () => {
     const store = createStore();
-    const provider = new Provider(
-      'garbage',
-      namespacesMap,
-      {
-        info: garbageWalletInfo,
-      },
-      {
-        store,
-      }
-    );
+    const provider = new Provider('garbage', namespacesMap, garbageWalletInfo, {
+      store,
+    });
 
     const [getState, setState] = provider.state();
 
@@ -142,9 +121,7 @@ describe('check providers', () => {
     testNamespaces.set('evm', evm.build());
     testNamespaces.set('solana', solana.build());
 
-    const provider = new Provider('garbage', testNamespaces, {
-      info: garbageWalletInfo,
-    });
+    const provider = new Provider('garbage', testNamespaces, garbageWalletInfo);
 
     const result = await provider.get('solana')?.connect();
 
@@ -159,16 +136,19 @@ describe('check providers', () => {
 
   test('sets config properly', () => {
     const builder = new ProviderBuilder('garbage');
-    builder.config('info', garbageWalletInfo);
+    builder
+      .config('metadata', garbageWalletMetaData)
+      .config('deepLink', garbageWalletDeepLink);
     const provider = builder.build().store(store);
 
-    expect(provider.info()).toStrictEqual(garbageWalletInfo);
+    expect(provider.info()?.metadata).toStrictEqual(garbageWalletMetaData);
+    expect(provider.info()?.deepLink).toStrictEqual(garbageWalletDeepLink);
   });
 
   test('.init should works on Provider', () => {
     const builder = new ProviderBuilder('garbage').config(
-      'info',
-      garbageWalletInfo
+      'metadata',
+      garbageWalletMetaData
     );
     let count = 0;
     builder.init(() => {
@@ -184,8 +164,8 @@ describe('check providers', () => {
 
   test(".init shouldn't do anything when use hasn't set anything", () => {
     const builder = new ProviderBuilder('garbage').config(
-      'info',
-      garbageWalletInfo
+      'metadata',
+      garbageWalletMetaData
     );
     const provider = builder.build().store(store);
     expect(() => {
@@ -197,8 +177,8 @@ describe('check providers', () => {
 
   test('A provider can be found using its namespace', () => {
     const builder = new ProviderBuilder('garbage', { store }).config(
-      'info',
-      garbageWalletInfo
+      'metadata',
+      garbageWalletMetaData
     );
 
     const { evm, solana } = namespaces;
@@ -231,7 +211,7 @@ describe('check providers', () => {
 
     const builder = new ProviderBuilder('garbage', { store })
       .add('evm', evmNamespace)
-      .config('info', garbageWalletInfo);
+      .config('metadata', garbageWalletMetaData);
     const provider = builder.build();
 
     const [getState] = provider.state();

package/src/hub/provider/provider.ts

@@ -9,7 +9,7 @@ import type {
 } from './types.js';
 import type { FindProxiedNamespace } from '../../builders/mod.js';
 import type { AnyFunction, FunctionWithContext } from '../../types/actions.js';
-import type { ProviderConfig, Store } from '../store/mod.js';
+import type { ProviderConfig, ProviderInfo, Store } from '../store/mod.js';
 
 const VERSION = '1.0';
 
@@ -180,12 +180,14 @@ export class Provider {
    * provider.info();
    * ```
    */
-  public info(): ProviderConfig['info'] | undefined {
+  public info(): ProviderInfo | undefined {
     const store = this.#store;
     if (!store) {
-      return this.#configs.info;
+      return this.#configs;
     }
-    return store.getState().providers.list[this.id].config.info;
+    const config = store.getState().providers.list[this.id].config;
+
+    return { metadata: config.metadata, deepLink: config.deepLink };
   }
 
   /**

package/src/hub/provider/types.ts

@@ -13,7 +13,10 @@ export type Context = {
   state: () => [GetState, SetState];
 };
 
-export type State = Omit<LegacyState, 'reachable' | 'accounts' | 'network'>;
+export type State = Omit<
+  LegacyState,
+  'reachable' | 'accounts' | 'network' | 'derivationPath'
+>;
 export type SetState = <K extends keyof Pick<State, 'installed'>>(
   name: K,
   value: State[K]
@@ -43,3 +46,15 @@ export type RegisteredNamespaces<K extends keyof T, T> = Map<
 >;
 
 export type ProviderBuilderOptions = { store?: Store };
+export type GenerateDeepLink = (context: DeepLinkContext) => string;
+
+/**
+ * Deeplink parameters context.
+ *
+ * @param targetUrl - URL of the widget in the app to be opened in the in-app browser.
+ * @param appHost - Domain of the app where the widget has been implemented.
+ */
+export type DeepLinkContext = {
+  targetUrl: string;
+  appHost: string;
+};

package/src/hub/store/mod.ts

@@ -16,6 +16,10 @@ export type {
   NamespaceConnectedEvent,
   NamespaceSwitchedAccountEvent,
 } from './events.js';
-export type { ProviderInfo, ProviderConfig } from './providers.js';
+export type {
+  ProviderMetadata,
+  ProviderConfig,
+  ProviderInfo,
+} from './providers.js';
 export type { NamespaceConfig, NamespaceData } from './namespaces.js';
 export { createStore } from './store.js';

package/src/hub/store/providers.ts

@@ -1,5 +1,8 @@
 import type { Namespace } from '../../namespaces/common/types.js';
-import type { State as InternalProviderState } from '../provider/mod.js';
+import type {
+  GenerateDeepLink,
+  State as InternalProviderState,
+} from '../provider/mod.js';
 import type { BlockchainMeta, SignerFactory } from 'rango-types';
 import type { StateCreator } from 'zustand';
 
@@ -50,7 +53,7 @@ type SignersProperty = Property<
   }
 >;
 
-export type ProviderInfo = {
+export type ProviderMetadata = {
   name: string;
   icon: string;
   extensions: Partial<Record<Browsers, string>>;
@@ -63,9 +66,12 @@ export type ProviderInfo = {
 };
 
 export interface ProviderConfig {
-  info: ProviderInfo;
+  metadata: ProviderMetadata;
+  deepLink?: GenerateDeepLink;
 }
 
+export type ProviderInfo = ProviderConfig;
+
 interface ProviderData {
   installed: boolean;
 }

package/src/hub/store/store.test.ts

@@ -14,7 +14,7 @@ describe('checking store', () => {
   test('new providers can be added to store', () => {
     const id = 'sol-or-something';
     const info = {
-      info: {
+      metadata: {
         name: 'sol grabage wallet',
         icon: 'http://somewhere.world',
         extensions: {
@@ -31,18 +31,16 @@ describe('checking store', () => {
   });
   test('provider can be removed from store', () => {
     const id = 'sol-or-something';
-    const info = {
-      info: {
-        name: 'sol grabage wallet',
-        icon: 'http://somewhere.world',
-        extensions: {
-          homepage: 'http://somewhere.world',
-        },
+    const metadata = {
+      name: 'sol grabage wallet',
+      icon: 'http://somewhere.world',
+      extensions: {
+        homepage: 'http://somewhere.world',
       },
     };
 
     const { getState } = hubStore;
-    getState().providers.addProvider(id, info);
+    getState().providers.addProvider(id, { metadata });
     expect(getState().providers.list[id]).toBeDefined();
     expect(Object.keys(getState().providers.list).length).toBe(1);
     getState().providers.removeProvider(id);

package/src/legacy/types.ts

@@ -1,4 +1,5 @@
 import type { State as WalletState } from './wallet.js';
+import type { GenerateDeepLink } from '../mod.js';
 import type { Namespace } from '../namespaces/common/mod.js';
 import type { BlockchainMeta, SignerFactory } from 'rango-types';
 
@@ -123,7 +124,7 @@ export type WalletInfo = {
   showOnMobile?: boolean;
   isContractWallet?: boolean;
   mobileWallet?: boolean;
-
+  generateDeepLink?: GenerateDeepLink;
   needsDerivationPath?: NeedsDerivationPath;
   needsNamespace?: NeedsNamespace;
 };

package/src/mod.ts

@@ -1,12 +1,14 @@
 export type {
   Store,
   State,
-  ProviderInfo,
+  ProviderMetadata,
   CommonNamespaces,
   CommonNamespaceKeys,
   Subscriber,
   SubscriberCleanUp,
   Context,
+  GenerateDeepLink,
+  DeepLinkContext,
 } from './hub/mod.js';
 export {
   Hub,

package/src/test-utils/fixtures.ts

@@ -1,9 +1,15 @@
-import type { ProviderConfig } from '../hub/store/mod.js';
+import type { ProviderConfig, ProviderInfo } from '../hub/store/mod.js';
 
-export const garbageWalletInfo: ProviderConfig['info'] = {
+export const garbageWalletMetaData: ProviderConfig['metadata'] = {
   name: 'Garbage Wallet',
   icon: 'https://somewhereininternet.com/icon.svg',
   extensions: {
     homepage: 'https://app.rango.exchange',
   },
 };
+export const garbageWalletDeepLink: ProviderConfig['deepLink'] = () =>
+  'garbage link';
+export const garbageWalletInfo: ProviderInfo = {
+  metadata: garbageWalletMetaData,
+  deepLink: garbageWalletDeepLink,
+};