SSX Serverless API Reference

Home > @spruceid/ssx-serverless

ssx-serverless 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 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
SSXEnsData
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.
SSXSessionCRUDConfig	Type definition for CRUD session functions
SSXSessionData

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
SSXAlchemyProvider	Alchemy provider settings.
SSXAnkrProvider	Ankr provider settings.
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.
SSXRPCProvider	Supported provider types.