SSX Server API Reference

Home > @spruceid/ssx-server

ssx-server package

Classes

Class	Description
SSXServer	SSX-Server is a server-side library made to work with the SSX client libraries. SSX-Server is the base class that takes in a configuration object and works with various middleware libraries to add authentication and metrics to your server.

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
SSXCookieOptions	Configuration interface for cookies issued by ssx-server
SSXEnsData	ENS data supported by SSX.
SSXEnsResolveOptions	ENS options supported by SSX.
SSXLogFields	Allowed fields for an SSX Log.
SSXServerConfig	Configuration interface for ssx-server
SSXServerProviders	SSX web3 configuration settings.
SSXServerRoutes	Server endpoints configuration.
SSXSessionStoreConfig	SSX Session Store configuration settings

Variables

Variable	Description
isSSXAlchemyProvider
isSSXAnkrProvider	Type-Guard for SSXAnkrProvider.
isSSXCloudflareProvider
isSSXCustomProvider	Type-Guard for SSXCustomProvider.
isSSXEtherscanProvider
isSSXInfuraProvider
isSSXPocketProvider	Type-Guard for SSXPocketProvider.
SSXAuthenticated	This middleware function can be used to protect an Express route with SSX authentication. It will check for ssx.verified and if it is set, the route will be allowed to proceed. If it is not set, the route will redirect or return a 401 Unauthorized response, based on the value of the redirect property.
SSXExpressMiddleware	This middleware function has two key functions: 1. It provides 3 endpoints for the client to hit: /ssx-nonce, /ssx-login, and /ssx-logout. These endpoints are used to authenticate the SIWE message and issue sessions. 2. It provides a middleware function that can be used to authenticate session. The middleware then exposes the authenticated session's data via the req.ssx property.
SSXHttpMiddleware	This middleware function does the following: 1. Checks for a ssx-session cookie and if it exists, it will manage and set the session on the request object. 2. Adds a ssx field to the request object with SSX authentication information in the object. 3. It adds a nonce, login, and logout route to the server This function returns another function that can take an event listen as a parameter and calls it with the updated request object if none of the ssx routes are hit.

Type Aliases

Type Alias	Description
SSXAlchemyProvider	Alchemy provider settings.
SSXAnkrProvider	Ankr provider settings.
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.
SSXRedisSessionStoreProvider	SSX Redis Session Store Provider settings.
SSXRPCProvider	Supported provider types.