@wagmi/solid 0.0.0-alpha → 0.0.1

package/dist/types/version.d.ts

@@ -0,0 +1,2 @@
+export declare const version = "0.0.1";
+//# sourceMappingURL=version.d.ts.map

package/dist/types/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAA"}

package/package.json

@@ -1,8 +1,96 @@
 {
-	"name": "@wagmi/solid",
-	"version": "0.0.0-alpha",
-	"license": "MIT",
-	"publishConfig": {
-		"access": "public"
-	}
-}
+  "name": "@wagmi/solid",
+  "description": "Solid Primitives for Ethereum",
+  "version": "0.0.1",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wevm/wagmi.git",
+    "directory": "packages/solid"
+  },
+  "files": [
+    "dist/**",
+    "!dist/**/*.tsbuildinfo",
+    "src/**/*.ts",
+    "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
+    "/actions",
+    "/chains",
+    "/connectors",
+    "/query"
+  ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "./dist/esm/exports/index.js",
+  "types": "./dist/types/exports/index.d.ts",
+  "typings": "./dist/types/exports/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/exports/index.d.ts",
+      "default": "./dist/esm/exports/index.js"
+    },
+    "./actions": {
+      "types": "./dist/types/exports/actions.d.ts",
+      "default": "./dist/esm/exports/actions.js"
+    },
+    "./chains": {
+      "types": "./dist/types/exports/chains.d.ts",
+      "default": "./dist/esm/exports/chains.js"
+    },
+    "./connectors": {
+      "types": "./dist/types/exports/connectors.d.ts",
+      "default": "./dist/esm/exports/connectors.js"
+    },
+    "./query": {
+      "types": "./dist/types/exports/query.d.ts",
+      "default": "./dist/esm/exports/query.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "actions": [
+        "./dist/types/exports/actions.d.ts"
+      ],
+      "chains": [
+        "./dist/types/exports/chains.d.ts"
+      ],
+      "connectors": [
+        "./dist/types/exports/connectors.d.ts"
+      ],
+      "query": [
+        "./dist/types/exports/query.d.ts"
+      ]
+    }
+  },
+  "peerDependencies": {
+    "@tanstack/solid-query": ">=5.0.0",
+    "solid-js": "1.x",
+    "typescript": ">=5.7.3",
+    "viem": "2.x"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@wagmi/connectors": "7.1.6",
+    "@wagmi/core": "3.3.2"
+  },
+  "contributors": [
+    "awkweb.eth <t@wevm.dev>",
+    "jxom.eth <j@wevm.dev>"
+  ],
+  "funding": "https://github.com/sponsors/wevm",
+  "keywords": [
+    "wagmi",
+    "solid",
+    "primitives",
+    "eth",
+    "ethereum",
+    "dapps",
+    "wallet",
+    "web3"
+  ]
+}

package/query/package.json

@@ -0,0 +1,5 @@
+{
+  "type": "module",
+  "types": "../dist/types/exports/query.d.ts",
+  "main": "../dist/esm/exports/query.js"
+}

package/src/context.ts

@@ -0,0 +1,43 @@
+import type { ResolvedRegister, State } from '@wagmi/core'
+import {
+  createComponent,
+  createContext,
+  mergeProps,
+  type ParentProps,
+} from 'solid-js'
+import { Hydrate } from './hydrate.js'
+
+export const WagmiContext = createContext<
+  ResolvedRegister['config'] | undefined
+>(undefined)
+
+export type WagmiProviderProps = {
+  config: ResolvedRegister['config']
+  initialState?: State | undefined
+  reconnectOnMount?: boolean | undefined
+}
+
+export function WagmiProvider(parameters: ParentProps<WagmiProviderProps>) {
+  const props = mergeProps({ reconnectOnMount: true }, parameters)
+  return createComponent(Hydrate, {
+    get config() {
+      return props.config
+    },
+    get initialState() {
+      return props.initialState
+    },
+    get reconnectOnMount() {
+      return props.reconnectOnMount
+    },
+    get children() {
+      return createComponent(WagmiContext.Provider, {
+        get value() {
+          return props.config
+        },
+        get children() {
+          return props.children
+        },
+      })
+    },
+  })
+}

package/src/errors/base.ts

@@ -0,0 +1,14 @@
+import { BaseError as CoreError } from '@wagmi/core'
+
+import { getVersion } from '../utils/getVersion.js'
+
+export type BaseErrorType = BaseError & { name: 'WagmiError' }
+export class BaseError extends CoreError {
+  override name = 'WagmiError'
+  override get docsBaseUrl() {
+    return 'https://wagmi.sh/solid' // TODO: add solid docs
+  }
+  override get version() {
+    return getVersion()
+  }
+}

package/src/errors/context.ts

@@ -0,0 +1,13 @@
+import { BaseError } from './base.js'
+
+export type WagmiProviderNotFoundErrorType = WagmiProviderNotFoundError & {
+  name: 'WagmiProviderNotFoundError'
+}
+export class WagmiProviderNotFoundError extends BaseError {
+  override name = 'WagmiProviderNotFoundError'
+  constructor() {
+    super('`useConfig` must be used within `WagmiProvider`.', {
+      docsPath: '/api/WagmiProvider',
+    })
+  }
+}

package/src/exports/actions.ts

@@ -0,0 +1,7 @@
+////////////////////////////////////////////////////////////////////////////////
+// @wagmi/core/actions
+////////////////////////////////////////////////////////////////////////////////
+
+// biome-ignore lint/performance/noBarrelFile: entrypoint module
+// biome-ignore lint/performance/noReExportAll: entrypoint module
+export * from '@wagmi/core/actions'

package/src/exports/chains.ts

@@ -0,0 +1,7 @@
+////////////////////////////////////////////////////////////////////////////////
+// viem/chains
+////////////////////////////////////////////////////////////////////////////////
+
+// biome-ignore lint/performance/noBarrelFile: entrypoint module
+// biome-ignore lint/performance/noReExportAll: entrypoint module
+export * from 'viem/chains'

package/src/exports/connectors.ts

@@ -0,0 +1,7 @@
+////////////////////////////////////////////////////////////////////////////////
+// @wagmi/connectors
+////////////////////////////////////////////////////////////////////////////////
+
+// biome-ignore lint/performance/noBarrelFile: entrypoint module
+// biome-ignore lint/performance/noReExportAll: entrypoint module
+export * from '@wagmi/connectors'

package/src/exports/index.ts

@@ -0,0 +1,134 @@
+////////////////////////////////////////////////////////////////////////////////
+// Context
+////////////////////////////////////////////////////////////////////////////////
+
+// biome-ignore lint/performance/noBarrelFile: entrypoint module
+export {
+  WagmiContext,
+  WagmiProvider,
+  type WagmiProviderProps,
+} from '../context.js'
+
+////////////////////////////////////////////////////////////////////////////////
+// Errors
+////////////////////////////////////////////////////////////////////////////////
+
+export { BaseError, type BaseErrorType } from '../errors/base.js'
+
+export {
+  WagmiProviderNotFoundError,
+  type WagmiProviderNotFoundErrorType,
+} from '../errors/context.js'
+
+////////////////////////////////////////////////////////////////////////////////
+// Primitives
+////////////////////////////////////////////////////////////////////////////////
+
+export { useBalance } from '../primitives/useBalance.js'
+
+export { useBlockNumber } from '../primitives/useBlockNumber.js'
+
+export { useChainId } from '../primitives/useChainId.js'
+
+export { useChains } from '../primitives/useChains.js'
+
+export { useClient } from '../primitives/useClient.js'
+
+export { useConfig } from '../primitives/useConfig.js'
+
+export { useConnect } from '../primitives/useConnect.js'
+
+export { useConnection } from '../primitives/useConnection.js'
+
+export { useConnectionEffect } from '../primitives/useConnectionEffect.js'
+
+export { useConnections } from '../primitives/useConnections.js'
+
+export { useConnectorClient } from '../primitives/useConnectorClient.js'
+
+export { useConnectors } from '../primitives/useConnectors.js'
+
+export { useDisconnect } from '../primitives/useDisconnect.js'
+
+export { useReconnect } from '../primitives/useReconnect.js'
+
+export { useSwitchChain } from '../primitives/useSwitchChain.js'
+
+export { useSwitchConnection } from '../primitives/useSwitchConnection.js'
+
+export { useWatchBlockNumber } from '../primitives/useWatchBlockNumber.js'
+
+////////////////////////////////////////////////////////////////////////////////
+// Hydrate
+////////////////////////////////////////////////////////////////////////////////
+
+export {
+  Hydrate,
+  type HydrateProps,
+} from '../hydrate.js'
+
+////////////////////////////////////////////////////////////////////////////////
+// @wagmi/core
+////////////////////////////////////////////////////////////////////////////////
+
+export {
+  ChainNotConfiguredError,
+  // Errors
+  type ChainNotConfiguredErrorType,
+  type Config,
+  // Config
+  type Connection,
+  type Connector,
+  ConnectorAccountNotFoundError,
+  type ConnectorAccountNotFoundErrorType,
+  ConnectorAlreadyConnectedError,
+  type ConnectorAlreadyConnectedErrorType,
+  ConnectorChainMismatchError,
+  type ConnectorChainMismatchErrorType,
+  // Connector
+  type ConnectorEventMap,
+  ConnectorNotFoundError,
+  type ConnectorNotFoundErrorType,
+  ConnectorUnavailableReconnectingError,
+  type ConnectorUnavailableReconnectingErrorType,
+  type CreateConfigParameters,
+  type CreateConnectorFn,
+  // Storage
+  type CreateStorageParameters,
+  // Utilities
+  cookieStorage,
+  cookieToInitialState,
+  createConfig,
+  createConnector,
+  createStorage,
+  // Transports
+  custom,
+  deepEqual,
+  deserialize,
+  fallback,
+  http,
+  injected,
+  mock,
+  noopStorage,
+  type PartializedState,
+  ProviderNotFoundError,
+  type ProviderNotFoundErrorType,
+  parseCookie,
+  // Types
+  type Register,
+  type ResolvedRegister,
+  type State,
+  type Storage,
+  SwitchChainNotSupportedError,
+  type SwitchChainNotSupportedErrorType,
+  serialize,
+  type Transport,
+  unstable_connector,
+  webSocket,
+} from '@wagmi/core'
+
+////////////////////////////////////////////////////////////////////////////////
+// Version
+////////////////////////////////////////////////////////////////////////////////
+
+export { version } from '../version.js'

package/src/exports/query.ts

@@ -0,0 +1,19 @@
+////////////////////////////////////////////////////////////////////////////////
+// @wagmi/core/query
+////////////////////////////////////////////////////////////////////////////////
+
+// biome-ignore lint/performance/noBarrelFile: entrypoint module
+// biome-ignore lint/performance/noReExportAll: entrypoint module
+export * from '@wagmi/core/query'
+
+export {
+  type SolidInfiniteQueryParameters,
+  type SolidMutationParameters,
+  type SolidQueryParameters,
+  type UseInfiniteQueryReturnType,
+  type UseMutationReturnType,
+  type UseQueryReturnType,
+  useInfiniteQuery,
+  useMutation,
+  useQuery,
+} from '../utils/query.js'

package/src/hydrate.ts

@@ -0,0 +1,27 @@
+import { hydrate, type ResolvedRegister, type State } from '@wagmi/core'
+import { mergeProps, onMount, type ParentProps } from 'solid-js'
+
+export type HydrateProps = {
+  config: ResolvedRegister['config']
+  initialState?: State | undefined
+  reconnectOnMount?: boolean | undefined
+}
+
+export function Hydrate(parameters: ParentProps<HydrateProps>) {
+  const props = mergeProps({ reconnectOnMount: true }, parameters)
+
+  const { onMount: hydrateOnMount } = hydrate(props.config, {
+    initialState: props.initialState,
+    reconnectOnMount: props.reconnectOnMount,
+  })
+
+  // Hydrate for non-SSR
+  if (!props.config._internal.ssr) hydrateOnMount()
+
+  onMount(() => {
+    if (!props.config._internal.ssr) return
+    hydrateOnMount()
+  })
+
+  return props.children
+}

package/src/primitives/useBalance.ts

@@ -0,0 +1,46 @@
+import type { Config, GetBalanceErrorType, ResolvedRegister } from '@wagmi/core'
+import type { Compute, ConfigParameter } from '@wagmi/core/internal'
+import {
+  type GetBalanceData,
+  type GetBalanceOptions,
+  getBalanceQueryOptions,
+} from '@wagmi/core/query'
+import { type Accessor, createMemo } from 'solid-js'
+import { type UseQueryReturnType, useQuery } from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+/** https://wagmi.sh/solid/api/primitives/useBalance */
+export function useBalance<
+  config extends Config = ResolvedRegister['config'],
+  selectData = GetBalanceData,
+>(
+  parameters: useBalance.Parameters<config, selectData> = () => ({}),
+): useBalance.ReturnType<selectData> {
+  const config = useConfig(parameters)
+  const chainId = useChainId(() => ({ config: config() }))
+  const options = createMemo(() =>
+    getBalanceQueryOptions(config(), {
+      ...parameters(),
+      chainId: parameters().chainId ?? chainId(),
+    }),
+  )
+  return useQuery(options)
+}
+
+export namespace useBalance {
+  export type Parameters<
+    config extends Config = Config,
+    selectData = GetBalanceData,
+  > = Accessor<SolidParameters<config, selectData>>
+
+  export type ReturnType<selectData = GetBalanceData> = UseQueryReturnType<
+    selectData,
+    GetBalanceErrorType
+  >
+
+  export type SolidParameters<
+    config extends Config = Config,
+    selectData = GetBalanceData,
+  > = Compute<GetBalanceOptions<config, selectData> & ConfigParameter<config>>
+}

package/src/primitives/useBlockNumber.ts

@@ -0,0 +1,99 @@
+import { useQueryClient } from '@tanstack/solid-query'
+import type {
+  Config,
+  GetBlockNumberErrorType,
+  ResolvedRegister,
+} from '@wagmi/core'
+import type {
+  Compute,
+  ConfigParameter,
+  UnionCompute,
+  UnionStrictOmit,
+} from '@wagmi/core/internal'
+import {
+  type GetBlockNumberData,
+  type GetBlockNumberOptions,
+  getBlockNumberQueryOptions,
+} from '@wagmi/core/query'
+import { type Accessor, createMemo } from 'solid-js'
+import { type UseQueryReturnType, useQuery } from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+import { useWatchBlockNumber } from './useWatchBlockNumber.js'
+
+/** https://wagmi.sh/solid/api/hooks/useBlockNumber */
+export function useBlockNumber<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends
+    config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetBlockNumberData,
+>(
+  parameters: useBlockNumber.Parameters<
+    config,
+    chainId,
+    selectData
+  > = () => ({}),
+): useBlockNumber.ReturnType<selectData> {
+  const config = useConfig(parameters)
+  const chainId = useChainId(() => ({ config: config() }))
+  const options = createMemo(() =>
+    getBlockNumberQueryOptions(config(), {
+      ...parameters(),
+      chainId: parameters().chainId ?? chainId(),
+    }),
+  )
+  const queryClient = useQueryClient()
+  const watchBlockNumberArgs = createMemo(() => {
+    // Assign to variable to help type narrowing
+    const { watch } = parameters()
+    return {
+      ...({
+        config: config(),
+        chainId: parameters().chainId ?? chainId(),
+        ...(typeof watch === 'object' ? watch : {}),
+      } as useWatchBlockNumber.SolidParameters),
+      enabled:
+        (parameters().query?.enabled ?? true) &&
+        (typeof watch === 'object' ? watch.enabled : watch),
+      onBlockNumber(blockNumber) {
+        queryClient.setQueryData(options().queryKey, blockNumber)
+      },
+    } satisfies useWatchBlockNumber.SolidParameters
+  })
+  useWatchBlockNumber(watchBlockNumberArgs)
+  return useQuery(options)
+}
+
+export namespace useBlockNumber {
+  export type Parameters<
+    config extends Config = Config,
+    chainId extends
+      config['chains'][number]['id'] = config['chains'][number]['id'],
+    selectData = GetBlockNumberData,
+  > = Accessor<SolidParameters<config, chainId, selectData>>
+
+  export type ReturnType<selectData = GetBlockNumberData> = UseQueryReturnType<
+    selectData,
+    GetBlockNumberErrorType
+  >
+
+  export type SolidParameters<
+    config extends Config = Config,
+    chainId extends
+      config['chains'][number]['id'] = config['chains'][number]['id'],
+    selectData = GetBlockNumberData,
+  > = Compute<
+    GetBlockNumberOptions<config, chainId, selectData> &
+      ConfigParameter<config> & {
+        watch?:
+          | boolean
+          | UnionCompute<
+              UnionStrictOmit<
+                useWatchBlockNumber.SolidParameters<config, chainId>,
+                'chainId' | 'config' | 'onBlockNumber' | 'onError'
+              >
+            >
+          | undefined
+      }
+  >
+}

package/src/primitives/useChainId.ts

@@ -0,0 +1,42 @@
+import {
+  type Config,
+  type GetChainIdReturnType,
+  getChainId,
+  type ResolvedRegister,
+  watchChainId,
+} from '@wagmi/core'
+import type { ConfigParameter } from '@wagmi/core/internal'
+import { type Accessor, createEffect, createSignal, onCleanup } from 'solid-js'
+import { useConfig } from './useConfig.js'
+
+/** https://wagmi.sh/solid/api/hooks/useChainId */
+export function useChainId<config extends Config = ResolvedRegister['config']>(
+  parameters: useChainId.Parameters<config> = () => ({}),
+): useChainId.ReturnType<config> {
+  const config = useConfig(parameters)
+  const [chainId, setChainId] = createSignal(getChainId(config()))
+  createEffect(() => {
+    const _config = config()
+    setChainId(() => getChainId(_config))
+    const unsubscribe = watchChainId(_config, {
+      onChange(data) {
+        setChainId(() => data)
+      },
+    })
+    onCleanup(() => unsubscribe())
+  })
+  return chainId
+}
+
+export namespace useChainId {
+  export type Parameters<config extends Config = Config> = Accessor<
+    SolidParameters<config>
+  >
+  export type ReturnType<config extends Config = Config> = Accessor<
+    SolidReturnType<config>
+  >
+  export type SolidParameters<config extends Config = Config> =
+    ConfigParameter<config>
+  export type SolidReturnType<config extends Config = Config> =
+    GetChainIdReturnType<config>
+}

package/src/primitives/useChains.ts

@@ -0,0 +1,42 @@
+import {
+  type Config,
+  type GetChainsReturnType,
+  getChains,
+  type ResolvedRegister,
+} from '@wagmi/core'
+import type { ConfigParameter } from '@wagmi/core/internal'
+import { watchChains } from '@wagmi/core/internal'
+import { type Accessor, createEffect, createSignal, onCleanup } from 'solid-js'
+import { useConfig } from './useConfig.js'
+
+/** https://wagmi.sh/solid/api/primitives/useChains */
+export function useChains<config extends Config = ResolvedRegister['config']>(
+  parameters: useChains.Parameters<config> = () => ({}),
+): useChains.ReturnType<config> {
+  const config = useConfig(parameters)
+  const [chains, setChains] = createSignal<GetChainsReturnType<config>>(
+    getChains(config()),
+  )
+  createEffect(() => {
+    const unsubscribe = watchChains(config(), {
+      onChange(data) {
+        setChains(() => data)
+      },
+    })
+    onCleanup(() => unsubscribe())
+  })
+  return chains
+}
+
+export namespace useChains {
+  export type Parameters<config extends Config = Config> = Accessor<
+    ConfigParameter<config>
+  >
+  export type ReturnType<config extends Config = Config> = Accessor<
+    GetChainsReturnType<config>
+  >
+  export type SolidParameters<config extends Config = Config> =
+    ConfigParameter<config>
+  export type SolidReturnType<config extends Config = Config> =
+    GetChainsReturnType<config>
+}