Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.66 KB

ssx.ssx.md

File metadata and controls

40 lines (27 loc) · 1.66 KB

Home > @spruceid/ssx > SSX

SSX class

SSX: Self-sovereign anything.

A toolbox for user-controlled identity, credentials, storage and more.

Signature:

export declare class SSX 

Constructors

Constructor Modifiers Description
(constructor)(config) Constructs a new instance of the SSX class

Properties

Property Modifiers Type Description
address () => string | undefined Gets the address that is connected and signed in.
chainId () => number | undefined Get the chainId that the address is connected and signed in on.
connection? SSXConnected (Optional) Current connection of SSX
RPCProviders static typeof SSXRPCProviders Supported RPC Providers
session? SSXClientSession (Optional) The session representation (once signed in).

Methods

Method Modifiers Description
resolveEns(address, resolveEnsOpts) ENS data supported by SSX.
signIn() Request the user to sign in, and start the session.
signOut() Invalidates user's session.