SSX Core API Reference
Last updated
Last updated
| Enumeration | Description |
|---|---|
| Interface | Description |
|---|---|
| Variable | Description |
|---|---|
| Type Alias | Description |
|---|---|
Enum of supported networks for Alchemy.
Enum of supported networks for Ankr.
Enum of supported networks for Etherscan.
Available SSX Log Types.
Enum of supported networks for Infura.
Enum of supported networks for Pocket.
Enum of supported EthersJS providers.
Interface to an intermediate SSX state: connected, but not signed-in.
Optional session configuration for the SIWE message.
Core config for SSX.
SSX web3 configuration settings
Configuration interface for cookies issued by ssx-server
ENS options supported by SSX.
ENS data supported by SSX.
ENS options supported by SSX.
Interface for an extension to SSX.
Allowed fields for an SSX Log.
Web3 provider configuration settings
Configuration interface for ssx-server
SSX web3 configuration settings.
Server endpoints configuration.
SSX Session Store configuration settings
Type-Guard for SSXAnkrProvider.
Type-Guard for SSXCustomProvider.
Type-Guard for SSXPocketProvider.
Registers a new event to the API.
Abstracts the fetch API to append correct headers, host and parse responses to JSON for POST requests.
Resolves ENS data supported by SSX.
Overrides for the session configuration.
Extra SIWE fields.
Alchemy provider settings.
Ankr provider settings.
Representation of an active SSXSession.
Cloudflare provider settings.
Custom provider settings.
Etherscan provider settings.
SSX Express Session Store Provider settings.
Generic provider settings.
Infura provider settings.
Infura provider project settings.
SSX Metrics Provider settings.
Pocket provider settings.
The ssx-powered server configuration settings
SSX Redis Session Store Provider settings.
Supported provider types.
The URL of the server running ssx-server. Providing this field enables SIWE server communication