@tuwaio/satellite-connect-monorepo
SiweAuthContextType
Defined in: packages/satellite-siwe-next-auth/src/types.ts:129
SiweAuthContextType Interface for the SIWE authentication context state and actions.
Properties
data
data:
SIWESession|undefined
Defined in: packages/satellite-siwe-next-auth/src/types.ts:130
The authenticated SIWE data (address, chainId) if signed in.
enabled
enabled:
boolean
Defined in: packages/satellite-siwe-next-auth/src/types.ts:135
isLoading
isLoading:
boolean
Defined in: packages/satellite-siwe-next-auth/src/types.ts:133
True if the session status is loading.
isReadyToSign
isReadyToSign:
boolean
Defined in: packages/satellite-siwe-next-auth/src/types.ts:131
True if an EVM connector is connected and ready to sign.
isRejected
isRejected:
boolean
Defined in: packages/satellite-siwe-next-auth/src/types.ts:132
True if the last signing attempt was explicitly rejected by the user.
isSignedIn
isSignedIn:
boolean
Defined in: packages/satellite-siwe-next-auth/src/types.ts:134
True if the user has a valid NextAuth session.
signInWithSiwe()
signInWithSiwe: (
onSignIn?) =>Promise<void>
Defined in: packages/satellite-siwe-next-auth/src/types.ts:136
Initiates the SIWE sign-in flow.
Parameters
onSignIn?
(session?) => void
Returns
Promise<void>
signOutSiwe()
signOutSiwe: (
onSignOut?) =>Promise<void>
Defined in: packages/satellite-siwe-next-auth/src/types.ts:137
Terminates the NextAuth session.
Parameters
onSignOut?
() => void
Returns
Promise<void>