@hub3js/core 0.58.2-next.0

package/src/namespaces/sui/types.ts

@@ -0,0 +1,25 @@
+import type { Accounts } from '../../types/accounts.js';
+import type {
+  AutoImplementedActionsByRecommended,
+  CommonActions,
+} from '../common/types.js';
+import type {
+  StandardConnectFeature,
+  StandardEventsFeature,
+  SuiFeatures,
+  WalletWithFeatures,
+} from '@mysten/wallet-standard';
+
+export interface SuiActions
+  extends AutoImplementedActionsByRecommended, CommonActions {
+  connect: () => Promise<Accounts>;
+  canEagerConnect: () => Promise<boolean>;
+}
+
+export type ProviderAPI = WalletWithFeatures<
+  StandardConnectFeature & StandardEventsFeature & SuiFeatures
+>;
+
+export interface ChangeAccountSubscriberParams {
+  name: string;
+}

package/src/namespaces/sui/utils.ts

@@ -0,0 +1,56 @@
+import type {
+  StandardConnectFeature,
+  StandardEventsFeature,
+  SuiFeatures,
+  WalletWithFeatures,
+} from '@mysten/wallet-standard';
+
+import { getWallets, SUI_MAINNET_CHAIN } from '@mysten/wallet-standard';
+import { AccountId } from 'caip';
+
+import { CAIP_NAMESPACE, CAIP_SUI_CHAIN_ID } from './constants.js';
+
+// TODO: StandardFetures doesn't work, so we should add each feature separately
+type SuiWalletStandard = WalletWithFeatures<
+  StandardConnectFeature & StandardEventsFeature & SuiFeatures
+>;
+
+/**
+ * @param name each wallet has a name in WalletStandard. you should pass that value
+ */
+export function getInstance(name: string): SuiWalletStandard | undefined {
+  const wallet = getWallets()
+    .get()
+    .find(
+      (wallet) =>
+        wallet.name === name && wallet.chains.includes(SUI_MAINNET_CHAIN),
+    );
+
+  return wallet as SuiWalletStandard;
+}
+
+/**
+ * @param name each wallet has a name in WalletStandard. you should pass that value
+ */
+export function getInstanceOrThrow(name: string): SuiWalletStandard {
+  const wallet = getInstance(name);
+
+  if (!wallet) {
+    throw new Error(
+      "We couldn't find the Sui instance on your wallet. It may be fixed by refreshing the page.",
+    );
+  }
+
+  return wallet;
+}
+export function formatAccountsToCAIP(accounts: readonly { address: string }[]) {
+  return accounts.map((account) => {
+    return AccountId.format({
+      address: account.address,
+      chainId: {
+        namespace: CAIP_NAMESPACE,
+        reference: CAIP_SUI_CHAIN_ID,
+      },
+    });
+  });
+}

package/src/namespaces/tron/actions.ts

@@ -0,0 +1,3 @@
+import { recommended as commonRecommended } from '../common/actions.js';
+
+export const recommended = [...commonRecommended];

package/src/namespaces/tron/after.ts

@@ -0,0 +1,3 @@
+import { recommended as commonRecommended } from '../common/after.js';
+
+export const recommended = [...commonRecommended];

package/src/namespaces/tron/and.ts

@@ -0,0 +1,5 @@
+import { connectAndUpdateStateForSingleNetwork } from '../common/mod.js';
+
+export const recommended = [
+  ['connect', connectAndUpdateStateForSingleNetwork] as const,
+];

package/src/namespaces/tron/before.ts

@@ -0,0 +1,3 @@
+import { recommended as commonRecommended } from '../common/before.js';
+
+export const recommended = [...commonRecommended];

package/src/namespaces/tron/builders.ts

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

package/src/namespaces/tron/constants.ts

@@ -0,0 +1,8 @@
+/*
+ * TODO: I couldn't found tron in caip
+ * @see https://namespaces.chainagnostic.org/
+ */
+
+// if the value needs to be change make sure you will update mapCaipNamespaceToLegacyNetworkName as well
+export const CAIP_NAMESPACE = 'tron';
+export const CAIP_TRON_CHAIN_ID = 'tron';

package/src/namespaces/tron/mod.ts

@@ -0,0 +1,8 @@
+export * as actions from './actions.js';
+export * as after from './after.js';
+export * as and from './and.js';
+export * as before from './before.js';
+export * as builders from './builders.js';
+export * as utils from './utils.js';
+export type { ProviderAPI, TronActions } from './types.js';
+export { CAIP_NAMESPACE, CAIP_TRON_CHAIN_ID } from './constants.js';

package/src/namespaces/tron/types.ts

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

package/src/namespaces/tron/utils.ts

@@ -0,0 +1,18 @@
+import type { CaipAccount } from '../common/mod.js';
+
+import { AccountId } from 'caip';
+
+import { CAIP_NAMESPACE, CAIP_TRON_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_TRON_CHAIN_ID,
+        },
+      }) as CaipAccount,
+  );
+}

package/src/namespaces/utxo/actions.ts

@@ -0,0 +1,3 @@
+import { recommended as commonRecommended } from '../common/actions.js';
+
+export const recommended = [...commonRecommended];

package/src/namespaces/utxo/after.ts

@@ -0,0 +1,3 @@
+import { recommended as commonRecommended } from '../common/after.js';
+
+export const recommended = [...commonRecommended];

package/src/namespaces/utxo/and.ts

@@ -0,0 +1,5 @@
+import { connectAndUpdateStateForSingleNetwork } from '../common/mod.js';
+
+export const recommended = [
+  ['connect', connectAndUpdateStateForSingleNetwork] as const,
+];

package/src/namespaces/utxo/before.ts

@@ -0,0 +1,3 @@
+import { recommended as commonRecommended } from '../common/before.js';
+
+export const recommended = [...commonRecommended];

package/src/namespaces/utxo/builders.ts

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

package/src/namespaces/utxo/constants.ts

@@ -0,0 +1,2 @@
+export const CAIP_NAMESPACE = 'bip122';
+export const CAIP_BITCOIN_CHAIN_ID = '000000000019d6689c085ae165831e93';

package/src/namespaces/utxo/mod.ts

@@ -0,0 +1,8 @@
+export * as actions from './actions.js';
+export * as after from './after.js';
+export * as and from './and.js';
+export * as before from './before.js';
+export * as builders from './builders.js';
+export * as utils from './utils.js';
+export type { ProviderAPI, UtxoActions } from './types.js';
+export { CAIP_NAMESPACE, CAIP_BITCOIN_CHAIN_ID } from './constants.js';

package/src/namespaces/utxo/types.ts

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

package/src/namespaces/utxo/utils.ts

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

package/src/namespaces/xrpl/builders.ts

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

package/src/namespaces/xrpl/constants.ts

@@ -0,0 +1,7 @@
+/*
+ * @see https://namespaces.chainagnostic.org/xrpl/README
+ */
+
+// if the value neeeds to be change make sure you will update mapCaipNamespaceToLegacyNetworkName as well
+export const CAIP_NAMESPACE = 'xrpl';
+export const CAIP_XRPL_CHAIN_ID = 'mainnet';

package/src/namespaces/xrpl/mod.ts

@@ -0,0 +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';

package/src/namespaces/xrpl/types.ts

@@ -0,0 +1,16 @@
+import type { Accounts } from '../common/mod.js';
+import type {
+  AutoImplementedActionsByRecommended,
+  CommonActions,
+} from '../common/types.js';
+import type { AccountLinesTrustline } from 'xrpl';
+
+export interface XRPLActions
+  extends AutoImplementedActionsByRecommended, CommonActions {
+  connect: () => Promise<Accounts>;
+  canEagerConnect: () => Promise<boolean>;
+  accountLines: (
+    account: string,
+    options?: { peer?: string },
+  ) => Promise<AccountLinesTrustline[]>;
+}

package/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): CaipAccount {
+  return AccountId.format({
+    address,
+    chainId: {
+      namespace: CAIP_NAMESPACE,
+      reference: CAIP_XRPL_CHAIN_ID,
+    },
+  }) as CaipAccount;
+}

package/src/test-utils/fixtures.ts

@@ -0,0 +1,13 @@
+import type { ProviderConfig, ProviderInfo } from '../hub/store/mod.js';
+
+export const garbageWalletMetaData: ProviderConfig['metadata'] = {
+  name: 'Garbage Wallet',
+  icon: 'https://somewhereininternet.com/icon.svg',
+  extensions: {
+    homepage: 'https://app.rango.exchange',
+  },
+};
+
+export const garbageWalletInfo: ProviderInfo = {
+  metadata: garbageWalletMetaData,
+};

package/src/types/accounts.ts

@@ -0,0 +1,12 @@
+type CaipNamespace = string;
+type CaipChainId = string;
+type CaipAccountAddress = string;
+
+export type CaipAccount =
+  `${CaipNamespace}:${CaipChainId}:${CaipAccountAddress}`;
+
+export type Accounts = CaipAccount[];
+export type AccountsWithActiveChain = {
+  accounts: Accounts;
+  network: string;
+};

package/src/types/actions.ts

@@ -0,0 +1,13 @@
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type AnyFunction = (...args: any[]) => any;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type AnyPromiseFunction = (...args: any[]) => Promise<any>;
+
+export type AndFunction<
+  T extends Record<string, AnyPromiseFunction>,
+  K extends keyof T,
+> = (result: Awaited<ReturnType<T[K]>>) => Awaited<ReturnType<T[K]>>;
+
+export type FunctionWithContext<T, C> = T extends (...args: infer P) => infer R
+  ? (context: C, ...args: P) => R
+  : never;

package/src/types/mod.ts

@@ -0,0 +1 @@
+export type { AnyFunction, FunctionWithContext } from './actions.js';

package/src/types/utils.ts

@@ -0,0 +1,7 @@
+/**
+ * @see https://x.com/mattpocockuk/status/1622730173446557697
+ */
+export type Prettify<T> = {
+  [K in keyof T]: T[K];
+  // todo: should use this comment after configuring rango rules eslint: eslint-disable-next-line @typescript-eslint/ban-types
+} & {};

package/src/utils/mod.ts

@@ -0,0 +1,8 @@
+/*
+ * It is not a good idea to re-export all of CAIP because if they have a breaking change, we will break as well.
+ * It would be better to create an abstraction over them and export our own interface to ensure it is under our control.
+ */
+export * as CAIP from 'caip';
+
+export { generateStoreId } from '../hub/helpers.js';
+export * from './versions.js';

package/src/utils/versions.test.ts

@@ -0,0 +1,24 @@
+import { describe, expect, test } from 'vitest';
+
+import { defineVersions, pickVersion } from './versions.js';
+
+describe('Picking versions should work correctly', () => {
+  test("Error on picking a version doesn't exist", () => {
+    const versions = defineVersions().build();
+    // const versions: Versions = [['1.0.0', {}]];
+    expect(() => pickVersion(versions, '1.0.0')).toThrowError();
+  });
+
+  test('Pick the correct version if it exist', () => {
+    const versions = defineVersions()
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      .version('0.0.0', {} as any)
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      .version('1.0.0', {} as any)
+      .build();
+
+    const target = pickVersion(versions, '1.0.0');
+    expect(target).toBeDefined();
+    expect(target[0]).toBe('1.0.0');
+  });
+});

package/src/utils/versions.ts

@@ -0,0 +1,64 @@
+import type { Provider } from '../hub/mod.js';
+import type { LegacyProviderInterface } from '../legacy/mod.js';
+
+type LegacyVersioned = ['0.0.0', LegacyProviderInterface];
+type HubVersioned = ['1.0.0', Provider];
+type AvailableVersionedProviders = LegacyVersioned | HubVersioned;
+export type VersionedProviders = AvailableVersionedProviders[];
+export type VersionInterface<T extends AvailableVersionedProviders[]> = T[1];
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type SemVer<T extends [string, any]> = T extends [infer U, any] ? U : never;
+type MatchVersion<T extends VersionedProviders, Version> = Extract<
+  T[number],
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [Version, any]
+>;
+
+export function pickVersion<
+  L extends VersionedProviders,
+  V extends SemVer<VersionedProviders[number]>,
+>(list: L, targetVersion: V): MatchVersion<L, V> {
+  if (!targetVersion) {
+    throw new Error(`You should provide a valid semver, e.g 1.0.0.`);
+  }
+
+  const target = list.find(([version]) => version === targetVersion);
+
+  if (!target) {
+    throw new Error(
+      `You target version hasn't been found. Available versions: ${Object.keys(
+        list,
+      ).join(', ')}`,
+    );
+  }
+  return target as MatchVersion<L, V>;
+}
+
+interface DefineVersionsApi {
+  version: <T extends SemVer<VersionedProviders[number]>>(
+    semver: T,
+    value: VersionInterface<MatchVersion<VersionedProviders, T>>,
+  ) => DefineVersionsApi;
+  build: () => VersionedProviders;
+}
+
+export function defineVersions(): DefineVersionsApi {
+  const versions: VersionedProviders = [];
+  const api: DefineVersionsApi = {
+    version: (semver, value) => {
+      versions.push([semver, value]);
+      return api;
+    },
+    build: () => {
+      return versions;
+    },
+  };
+  return api;
+}
+
+export function legacyProviderImportsToVersionsInterface(
+  provider: LegacyProviderInterface,
+): VersionedProviders {
+  return defineVersions().version('0.0.0', provider).build();
+}

package/store/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@hub3js/core/store",
+  "type": "module",
+  "main": "../dist/hub/store/mod.js",
+  "module": "../dist/hub/store/mod.js",
+  "types": "../dist/hub/store/mod.d.ts",
+  "sideEffects": false
+}