SSX API Reference
Last updated
Last updated
| Class | Description |
|---|---|
| Enumeration | Description |
|---|---|
| Interface | Description |
|---|---|
| Variable | Description |
|---|---|
| Type Alias | Description |
|---|---|
SSX: Self-sovereign anything.
A toolbox for user-controlled identity, credentials, storage and more.
An intermediate SSX state: connected, but not signed-in.
Initializer for an SSXClientSession.
Enum of supported networks for Alchemy.
Enum of supported networks for Ankr.
Enum of supported networks for Etherscan.
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
Core config for SSX.
ENS options supported by SSX.
ENS data supported by SSX.
ENS options supported by SSX.
Interface for an extension to SSX.
SSX web3 configuration settings
Web3 provider configuration settings
Server endpoints configuration.
Type-Guard for SSXAnkrProvider.
Type-Guard for SSXCustomProvider.
Type-Guard for SSXPocketProvider.
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.
Generic provider settings.
Infura provider settings.
Infura provider project settings.
Pocket provider settings.
The ssx-powered server configuration settings
Supported provider types.
The URL of the server running ssx-server. Providing this field enables SIWE server communication
Representation of an active SSXSession.