ssxconnected

Home > @spruceid/ssx > SSXConnected

SSXConnected class

An intermediate SSX state: connected, but not signed-in.

Signature:

export declare class SSXConnected implements ISSXConnected 

Implements: ISSXConnected

Constructors

Constructor	Modifiers	Description
(constructor)(builder, config, extensions, provider)		Constructs a new instance of the SSXConnected class

Properties

Property	Modifiers	Type	Description
afterConnectHooksPromise		Promise<void>	Promise that is initialized on construction of this class to run the "afterConnect" methods of the extensions.
api?		AxiosInstance	(Optional) Axios instance.
builder		ssxSession.SSXSessionBuilder	Instance of SSXSessionBuilder
config		SSXClientConfig	SSXConfig object.
extensions		SSXExtension[]	Enabled extensions.
isExtensionEnabled		(namespace: string) => boolean	Verifies if extension is enabled.
provider		ethers.providers.Web3Provider	EthersJS provider.

Methods

Method	Modifiers	Description
afterSignIn(session)		Applies the "afterSignIn" methods of the extensions.
applyExtensions()		Applies the "afterConnect" methods and the delegated capabilities of the extensions.
signIn()		Requests the user to sign in. Generates the SIWE message for this session, requests the configured Signer to sign the message, calls the "afterSignIn" methods of the extensions.
signOut(session)		Requests the user to sign out.
ssxServerLogin(session)		Requests sign in from server and returns session.
ssxServerNonce(params)		Requests nonce from server.