@meshconnect/uwc-types 0.2.0

package/dist/signature.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=signature.js.map

package/dist/signature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signature.js","sourceRoot":"","sources":["../src/signature.ts"],"names":[],"mappings":""}

package/dist/transactions.d.ts

@@ -0,0 +1,109 @@
+/**
+ * EVM Transaction Types
+ */
+/**
+ * Gas configuration for EVM transactions
+ */
+export interface EVMGasConfig {
+    gasLimit?: number | null;
+    maxFeePerGas?: number | null;
+    maxPriorityFeePerGas?: number | null;
+}
+/**
+ * Request for native EVM token transfer (ETH, BNB, MATIC, etc.)
+ */
+export interface EVMNativeTransferRequest {
+    to: string;
+    amount: bigint;
+    from: string;
+    gasConfig?: EVMGasConfig;
+}
+/**
+ * Request for EVM smart contract interaction
+ */
+export interface EVMContractCallRequest {
+    contractAddress: string;
+    abi: any[];
+    functionName: string;
+    args: unknown[];
+    from: string;
+    value?: string;
+    gasConfig?: EVMGasConfig;
+}
+/**
+ * Single call in a batch transaction
+ */
+export interface EVMBatchCall {
+    to: string;
+    value: string;
+    data?: string;
+}
+/**
+ * Request for batch EVM transactions (EIP-5792)
+ */
+export interface EVMBatchTransactionRequest {
+    version: string;
+    from: string;
+    chainId: string;
+    atomicRequired: boolean;
+    calls: EVMBatchCall[];
+}
+/**
+ * EVM wallet capabilities
+ */
+export interface EVMCapabilities {
+    atomicBatch?: {
+        supported: boolean;
+    };
+    paymasterService?: {
+        supported: boolean;
+    };
+}
+/**
+ * Solana Transaction Types
+ */
+/**
+ * Request for native SOL transfer
+ */
+export interface SolanaNativeTransferRequest {
+    from: string;
+    to: string;
+    amount: bigint;
+    blockhash: string;
+}
+/**
+ * Configuration for Solana transactions (internal use)
+ */
+export interface SolanaTransactionConfig {
+    fromAddress: string;
+    toAddress: string;
+    amount: string | number;
+    blockhash: string;
+    tokenMint?: string;
+    tokenDecimals?: number;
+    tokenProgram?: string;
+    createATA?: boolean;
+}
+/**
+ * Common Transaction Types
+ */
+/**
+ * Result of a transaction
+ */
+export type TransactionResult = string;
+/**
+ * Result of a batch transaction
+ */
+export interface BatchTransactionResult {
+    id: string;
+    status: number;
+    atomic: boolean;
+    receipts: Array<{
+        transactionHash: string;
+    }>;
+}
+/**
+ * Generic transaction request that can be either EVM or Solana
+ */
+export type TransactionRequest = EVMNativeTransferRequest | EVMContractCallRequest | EVMBatchTransactionRequest | SolanaNativeTransferRequest;
+//# sourceMappingURL=transactions.d.ts.map

package/dist/transactions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactions.d.ts","sourceRoot":"","sources":["../src/transactions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,YAAY,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,eAAe,EAAE,MAAM,CAAA;IAEvB,GAAG,EAAE,GAAG,EAAE,CAAA;IACV,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,OAAO,EAAE,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,YAAY,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,cAAc,EAAE,OAAO,CAAA;IACvB,KAAK,EAAE,YAAY,EAAE,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,WAAW,CAAC,EAAE;QACZ,SAAS,EAAE,OAAO,CAAA;KACnB,CAAA;IACD,gBAAgB,CAAC,EAAE;QACjB,SAAS,EAAE,OAAO,CAAA;KACnB,CAAA;CACF;AAED;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;GAEG;AAEH;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAA;AAEtC;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,KAAK,CAAC;QACd,eAAe,EAAE,MAAM,CAAA;KACxB,CAAC,CAAA;CACH;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,wBAAwB,GACxB,sBAAsB,GACtB,0BAA0B,GAC1B,2BAA2B,CAAA"}

package/dist/transactions.js

@@ -0,0 +1,5 @@
+/**
+ * EVM Transaction Types
+ */
+export {};
+//# sourceMappingURL=transactions.js.map

package/dist/transactions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactions.js","sourceRoot":"","sources":["../src/transactions.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/dist/wallet-connect-connector.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Configuration for WalletConnect connector
+ */
+export interface WalletConnectConfig {
+    projectId?: string;
+    metadata?: {
+        name: string;
+        description: string;
+        url: string;
+        icons: string[];
+    };
+}
+//# sourceMappingURL=wallet-connect-connector.d.ts.map

package/dist/wallet-connect-connector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-connect-connector.d.ts","sourceRoot":"","sources":["../src/wallet-connect-connector.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,MAAM,CAAA;QACnB,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,EAAE,CAAA;KAChB,CAAA;CACF"}

package/dist/wallet-connect-connector.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=wallet-connect-connector.js.map

package/dist/wallet-connect-connector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-connect-connector.js","sourceRoot":"","sources":["../src/wallet-connect-connector.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@meshconnect/uwc-types",
+  "version": "0.2.0",
+  "description": "TypeScript types for Universal Wallet Connector",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {},
+  "devDependencies": {
+    "typescript": "^5.9.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "lint": "eslint src --ext .ts,.tsx",
+    "lint:fix": "eslint src --ext .ts,.tsx --fix",
+    "type-check": "tsc --noEmit"
+  }
+}

package/src/UWC-state.ts

@@ -0,0 +1,77 @@
+import type { NetworkId, Namespace } from './networks'
+import type { Session } from './session'
+
+export interface UniversalWalletConnectorState {
+  session: Session
+}
+
+export interface DetectedEIP6963WalletInfo {
+  uuid: string
+  name: string
+  icon: string
+  rdns: string
+}
+
+export interface DetectedSolanaWalletInfo {
+  uuid: string
+  name: string
+  features: string[]
+}
+
+export interface Eip155Metadata {
+  eip155Name: string
+  injectedId: string
+  supportsAddingNetworks: boolean
+  requiresUserApprovalOnNetworkSwitch: boolean
+  installed?: boolean
+  detectedWallet?: DetectedEIP6963WalletInfo
+}
+
+export interface SolanaMetadata {
+  walletStandardName?: string
+  injectedId?: string
+  ignoredInjectedIds?: string[]
+  installed?: boolean
+  detectedWallet?: DetectedSolanaWalletInfo
+}
+
+type NamespaceMetaDataMap = {
+  [K in Namespace]?: K extends 'eip155'
+    ? Eip155Metadata
+    : K extends 'solana'
+      ? SolanaMetadata
+      : undefined
+}
+
+export interface ExtensionInjectedProvider {
+  supportedNetworkIds: NetworkId[]
+  namespaceMetaData: Partial<NamespaceMetaDataMap>
+  requiresUserApprovalOnNamespaceSwitch: boolean
+}
+
+export interface IntegratedBrowserInjectedProvider
+  extends ExtensionInjectedProvider {
+  integratedBrowserDeeplink: string
+}
+
+export type DeeplinkType = 'universal' | 'native'
+
+export interface WalletConnectProvider {
+  supportedNetworkIds: NetworkId[]
+  deeplinks: {
+    universal: string
+    native: string
+    androidPreferredDeeplink?: DeeplinkType
+    iOSPreferredDeeplink?: DeeplinkType
+  }
+}
+
+export interface WalletMetadata {
+  id: string
+  name: string
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  metadata: Record<string, any>
+  extensionInjectedProvider?: ExtensionInjectedProvider
+  integratedBrowserInjectedProvider?: IntegratedBrowserInjectedProvider
+  walletConnectProvider?: WalletConnectProvider
+}

package/src/connection-mode.ts

@@ -0,0 +1 @@
+export type ConnectionMode = 'injected' | 'walletConnect'

package/src/connector.ts

@@ -0,0 +1,118 @@
+import type { Network, NetworkId, Namespace } from './networks'
+import type { AvailableAddress } from './session'
+import type {
+  DetectedEIP6963WalletInfo,
+  DetectedSolanaWalletInfo,
+  ExtensionInjectedProvider,
+  IntegratedBrowserInjectedProvider,
+  WalletConnectProvider
+} from './UWC-state'
+import type { TransactionRequest, TransactionResult } from './transactions'
+
+/**
+ * Result interface for connect operations
+ */
+export interface ConnectorResult {
+  networkId: NetworkId
+  address: string
+  availableAddresses: AvailableAddress[]
+}
+
+/**
+ * Result interface for network switch operations
+ */
+export interface SwitchNetworkResult {
+  networkId: NetworkId
+  address: string
+  availableAddresses?: AvailableAddress[]
+}
+
+/**
+ * Common interface for all wallet connectors
+ */
+export interface Connector {
+  /**
+   * Connect to a wallet on the specified network
+   * @param network The network to connect to
+   * @param args Additional arguments specific to the connector type
+   * @returns A promise that resolves to a ConnectorResult containing the network ID, wallet address, and available addresses
+   */
+
+  connect(
+    network: Network,
+    provider?:
+      | ExtensionInjectedProvider
+      | IntegratedBrowserInjectedProvider
+      | WalletConnectProvider
+  ): Promise<ConnectorResult>
+
+  /**
+   * Get the connection URI for the wallet, if applicable
+   * This is typically used for WalletConnect or similar protocols
+   * to allow the user to scan a QR code or open a link
+   * to initiate the connection.
+   * @return A string representing the connection URI, or undefined if not applicable
+   * @remarks This method is optional and may not be implemented by all connectors.
+   */
+  getConnectionURI?(): string
+
+  /**
+   * Disconnect from the wallet
+   * This method is optional and may not be implemented by all connectors.
+   * @returns A promise that resolves when the disconnection is complete
+   */
+  disconnect?(): Promise<void>
+
+  /**
+   * Switch to a different network
+   * @param network The network to switch to
+   * @param args Additional arguments specific to the connector type
+   * @returns A promise that resolves to a SwitchNetworkResult containing the network ID and new wallet address
+   */
+
+  switchNetwork(
+    network: Network,
+    provider?:
+      | ExtensionInjectedProvider
+      | IntegratedBrowserInjectedProvider
+      | WalletConnectProvider
+  ): Promise<SwitchNetworkResult>
+
+  /**
+   * Get available wallets for a specific namespace
+   * This method is optional and may not be implemented by all connectors.
+   * @param namespace The namespace to check for available wallets (e.g., 'eip155', 'solana')
+   * @returns A promise that resolves to an array of detected wallets, or undefined if not supported
+   */
+  getAvailableWallets?(
+    namespace: Namespace
+  ): Promise<DetectedEIP6963WalletInfo[] | DetectedSolanaWalletInfo[]>
+
+  /**
+   * Sign a message with the connected wallet
+   * @param message The message to sign
+   * @param provider The wallet provider (required for injected connector)
+   * @returns A promise that resolves to the signature
+   */
+  signMessage?(
+    message: string,
+    provider?:
+      | ExtensionInjectedProvider
+      | IntegratedBrowserInjectedProvider
+      | WalletConnectProvider
+  ): Promise<string>
+
+  /**
+   * Send a transaction with the connected wallet
+   * @param request The transaction request parameters
+   * @param provider The wallet provider (required for injected connector)
+   * @returns A promise that resolves to the transaction result
+   */
+  sendTransaction?(
+    request: TransactionRequest,
+    provider?:
+      | ExtensionInjectedProvider
+      | IntegratedBrowserInjectedProvider
+      | WalletConnectProvider
+  ): Promise<TransactionResult>
+}

package/src/errors.ts

@@ -0,0 +1,20 @@
+export type ErrorType = 'unknown' | 'rejected'
+
+export interface WalletError {
+  type: ErrorType
+  message: string
+}
+
+/**
+ * Custom error class that includes wallet error metadata
+ * This is thrown by the connectors when operations fail
+ */
+export class WalletConnectorError extends Error {
+  type: ErrorType
+
+  constructor(walletError: WalletError) {
+    super(walletError.message)
+    this.name = 'WalletConnectorError'
+    this.type = walletError.type
+  }
+}

package/src/index.ts

@@ -0,0 +1,12 @@
+export * from './networks'
+export * from './network-rpc'
+export * from './connection-mode'
+export * from './session'
+export * from './UWC-state'
+export * from './connector'
+export * from './providers'
+export * from './wallet-connect-connector'
+export * from './react-hooks'
+export * from './signature'
+export * from './transactions'
+export * from './errors'

package/src/network-rpc.ts

@@ -0,0 +1,6 @@
+import type { NetworkId } from './networks'
+
+/**
+ * Map of network IDs to their RPC URLs
+ */
+export type NetworkRpcMap = Partial<Record<NetworkId, string>>

package/src/networks.ts

@@ -0,0 +1,62 @@
+export type NetworkId =
+  | 'eip155:1'
+  | 'eip155:11155111'
+  | 'solana:devnet'
+  | 'eip155:56'
+  | 'eip155:137'
+  | 'eip155:43114'
+  | 'eip155:42161'
+  | 'eip155:10'
+  | 'eip155:8453'
+  | 'bip122:000000000019d6689c085ae165831e93'
+  | 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp'
+  | 'tron:0x2b6653dc'
+  | 'eip155:81457'
+  | 'bip122:1a91e3dace36e2be3bf030a65679fe82'
+  | 'xrpl:0'
+  | 'bip122:12a765e31ffd4059bada1e25190f6e98'
+
+export type NetworkType =
+  | 'evm'
+  | 'solana'
+  | 'bitcoin'
+  | 'tron'
+  | 'dogecoin'
+  | 'litecoin'
+  | 'ripple'
+
+export type Namespace = 'eip155' | 'solana' | 'bip122' | 'tron' | 'xrpl'
+
+export interface NativeCurrency {
+  name: string
+  symbol: string
+  decimals: number
+}
+
+export interface RpcUrls {
+  default: {
+    http: string[]
+  }
+}
+
+export interface BlockExplorer {
+  name: string
+  url: string
+  apiUrl?: string
+}
+
+export interface BlockExplorers {
+  default: BlockExplorer
+}
+
+export interface Network {
+  internalId: number
+  id: NetworkId
+  namespace: Namespace
+  name: string
+  logoUrl: string
+  nativeCurrency: NativeCurrency
+  rpcUrls?: RpcUrls
+  blockExplorers?: BlockExplorers
+  networkType: NetworkType
+}

package/src/providers.ts

@@ -0,0 +1,14 @@
+import type {
+  ExtensionInjectedProvider,
+  IntegratedBrowserInjectedProvider,
+  WalletConnectProvider
+} from './UWC-state'
+
+/**
+ * Union type of all supported provider types
+ * Used throughout the application to handle different wallet provider types
+ */
+export type SupportedProvider =
+  | ExtensionInjectedProvider
+  | IntegratedBrowserInjectedProvider
+  | WalletConnectProvider