SSX Core API Reference

Home > @spruceid/ssx-core

ssx-core package

Enumerations

Enumeration	Description
SSXAlchemyProviderNetworks	Enum of supported networks for Alchemy.
SSXAnkrProviderNetworks	Enum of supported networks for Ankr.
SSXEtherscanProviderNetworks	Enum of supported networks for Etherscan.
SSXEventLogTypes	Available SSX Log Types.
SSXInfuraProviderNetworks	Enum of supported networks for Infura.
SSXPocketProviderNetworks	Enum of supported networks for Pocket.
SSXRPCProviders	Enum of supported EthersJS providers.

Interfaces

Interface	Description
ISSXConnected	Interface to an intermediate SSX state: connected, but not signed-in.
SiweConfig	Optional session configuration for the SIWE message.
SSXClientConfig	Core config for SSX.
SSXClientProviders	SSX web3 configuration settings
SSXCookieOptions	Configuration interface for cookies issued by ssx-server
SSXEnsConfig	ENS options supported by SSX.
SSXEnsData	ENS data supported by SSX.
SSXEnsResolveOptions	ENS options supported by SSX.
SSXExtension	Interface for an extension to SSX.
SSXLogFields	Allowed fields for an SSX Log.
SSXProviderWeb3	Web3 provider configuration settings
SSXServerConfig	Configuration interface for ssx-server
SSXServerProviders	SSX web3 configuration settings.
SSXServerRoutes	Server endpoints configuration.
SSXSessionStoreConfig	SSX Session Store configuration settings

Variables

Variable	Description
getProvider
isSSXAlchemyProvider
isSSXAnkrProvider	Type-Guard for SSXAnkrProvider.
isSSXCloudflareProvider
isSSXCustomProvider	Type-Guard for SSXCustomProvider.
isSSXEtherscanProvider
isSSXInfuraProvider
isSSXPocketProvider	Type-Guard for SSXPocketProvider.
ssxLog	Registers a new event to the API.
ssxPost	Abstracts the fetch API to append correct headers, host and parse responses to JSON for POST requests.
ssxResolveEns	Resolves ENS data supported by SSX.

Type Aliases

Type Alias	Description
ConfigOverrides	Overrides for the session configuration.
ExtraFields	Extra SIWE fields.
SSXAlchemyProvider	Alchemy provider settings.
SSXAnkrProvider	Ankr provider settings.
SSXClientSession	Representation of an active SSXSession.
SSXCloudflareProvider	Cloudflare provider settings.
SSXCustomProvider	Custom provider settings.
SSXEtherscanProvider	Etherscan provider settings.
SSXExpressSessionStoreProvider	SSX Express Session Store Provider settings.
SSXGenericProvider	Generic provider settings.
SSXInfuraProvider	Infura provider settings.
SSXInfuraProviderProjectSettings	Infura provider project settings.
SSXMetricsProvider	SSX Metrics Provider settings.
SSXPocketProvider	Pocket provider settings.
SSXProviderServer	The ssx-powered server configuration settings
SSXRedisSessionStoreProvider	SSX Redis Session Store Provider settings.
SSXRPCProvider	Supported provider types.
SSXServerHost	The URL of the server running ssx-server. Providing this field enables SIWE server communication