issxconnected

Home > @spruceid/ssx > ISSXConnected

ISSXConnected interface

Interface to an intermediate SSX state: connected, but not signed-in.

Signature:

export declare interface ISSXConnected 

Properties

Property	Modifiers	Type	Description
afterConnectHooksPromise		Promise<void>	Promise that is initialized on construction to run the "afterConnect" methods of extensions.
afterSignIn		(session: SSXClientSession) => Promise<void>	Method to apply the "afterSignIn" methods of the extensions.
api?		AxiosInstance	(Optional) Axios instance.
applyExtensions		() => Promise<void>	Method to apply the "afterConnect" methods and the delegated capabilities of the extensions.
builder		ssxSession.SSXSessionBuilder	Instance of SSXSessionBuilder.
config		SSXClientConfig	SSXConfig object.
extensions		SSXExtension[]	List of enabled extensions.
isExtensionEnabled		(namespace: string) => boolean	Method to verify if extension is enabled.
provider		ethers.providers.Web3Provider	Web3 provider.
signIn		() => Promise<SSXClientSession>	Method to request the user to sign in.
signOut		(session: SSXClientSession) => Promise<void>	Method to request the user to sign out.
ssxServerLogin		(session: SSXClientSession) => Promise<any>	Method to request sign in from server and return session.
ssxServerNonce		(params: Record<string, any>) => Promise<string>	Method to request nonce from server.