Links

SSX API Reference

ssx package

Classes

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

Enumerations

Enumeration
Description
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 RPC providers
Selection and configuration of the storage module.
Supported storage types.

Interfaces

Interface
Description
Optional session configuration for the SIWE message.
SSXConfig
Core config for SSX.
Interface for an extension to SSX.
SSX web3 configuration settings
Web3 provider configuration settings
Storage_2
A Storage module.

Type Aliases

Type Alias
Description
Overrides for the session configuration.
The URL of the server running ssx-server. Providing this field enables SIWE server communication
Alchemy provider settings
Ankr provider settings
Cloudflare provider settings
Custom provider settings
Etherscan provider settings
Infura provider settings
Infura provider project settings
Pocket provider settings
The ssx-powered server configuration settings
Representation of an active SSXSession.