Links

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
Constructs a new instance of the SSXConnected class

Properties

Property
Modifiers
Type
Description
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
SSXConfig object.
Enabled extensions.
(namespace: string) => boolean
Verifies if extension is enabled.
provider
ethers.providers.Web3Provider
EthersJS provider.

Methods

Method
Modifiers
Description
Applies the "afterSignIn" methods of the extensions.
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.
Requests the user to sign out.
Requests sign in from server and returns session.
Requests nonce from server.