SSX API Reference

Home > @spruceid/ssx

ssx package

Classes

Class	Description
SSX	SSX: Self-sovereign anything. A toolbox for user-controlled identity, credentials, storage and more.
SSXConnected	An intermediate SSX state: connected, but not signed-in.
SSXInit	Initializer for an SSXClientSession.

Enumerations

Enumeration	Description
SSXAlchemyProviderNetworks	Enum of supported networks for Alchemy.
SSXAnkrProviderNetworks	Enum of supported networks for Ankr.
SSXEtherscanProviderNetworks	Enum of supported networks for Etherscan.
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
SSXConfig	Core config for SSX.
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.
SSXProviders	SSX web3 configuration settings
SSXProviderWeb3	Web3 provider configuration settings
SSXServerRoutes	Server endpoints configuration.

Variables

Variable	Description
isSSXAlchemyProvider
isSSXAnkrProvider	Type-Guard for SSXAnkrProvider.
isSSXCloudflareProvider
isSSXCustomProvider	Type-Guard for SSXCustomProvider.
isSSXEtherscanProvider
isSSXInfuraProvider
isSSXPocketProvider	Type-Guard for SSXPocketProvider.

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.
SSXGenericProvider	Generic provider settings.
SSXInfuraProvider	Infura provider settings.
SSXInfuraProviderProjectSettings	Infura provider project settings.
SSXPocketProvider	Pocket provider settings.
SSXProviderServer	The ssx-powered server configuration settings
SSXRPCProvider	Supported provider types.
SSXServerHost	The URL of the server running ssx-server. Providing this field enables SIWE server communication
SSXSession	Representation of an active SSXSession.