Haven1
  • Get started
    • 🧑‍🚀Welcome Havenauts!
    • 📄Haven1 Litepaper
    • 🧮H1 Tokenomics
  • Foundations of Haven1
    • 📐Architecture & network design
    • 🔐Network-level security
    • 📚Haven1 Core protocols
    • 💱Best in class liquidity
    • 👮Network Guardians: Firewall on Haven1
    • 🌉hBridge: Intro to Haven1 Bridge
  • Learn
    • 💵What does Haven1 solve?
    • 💡Haven1: Use Cases
    • 📚Understanding GoQuorum
    • 🔤Haven1 Blockchain basics
    • 🛂KYC policies on Haven1 blockchain
    • Security at Haven1
    • 🔓What is esH1?
    • ⚖️Dispute resolution mechanism
    • 🛣️Haven1 Roadmap
    • 🖥️Haven1 is EVM compatible
  • Products
    • 🔃hSwap - Spot DEX on Haven1
    • 📍hsETH on Haven1
    • Earn on Haven1
    • 🛡️2FA Wallet Shield
    • 🧊Haven1 block explorer
    • 🏛️Governance & veH1
    • 🆔hPassport - Key to Haven1
      • Advantages of having ID verification at a network level
      • Understanding the ID Verification Process
    • 💼Vesting esH1 - Converting esH1 to H1
    • 📍Staking H1 & esH1 - Earning rewards on your H1 holdings
      • Flexible Staking
      • Locked Staking
  • hPerpetuals - Perps DEX on Haven1
  • Haven1 Guides
    • 🔗Quick links
    • ✅Haven1 onboarding Guide
      • 🪪KYC Guide
      • Business KYC(KYB) Guide
    • Adding multiple wallets to a hPassport
    • 🌉Simple Bridging Guide on Haven1 network
    • 🏠Haven1 Portal - Your Gateway into Haven1
    • 🔑2FA Set up Guide
    • 🤑Haven1 Airdrop: Claim Process and Strategies
    • Claim Process Walkthrough on Team Finance
    • 📄Contract Addresses
  • Build
    • 📖Getting started
    • 🌐Haven1 Network information
    • 🍦Novel developer benefits on Haven1
    • 📑High level guide for secure deployment
    • ⚙️Detailed deployment Guide
    • 🧰Developer tools
      • 👛Haven1 Gnosis Safe wallet
      • 🛠️Haven1 SDK
        • 🔌@haven1/sdk-api-client
          • Class: Haven1SDK
          • Class: AuthModule
          • Class: SdkModule
        • ⛓️@haven1/blockchain-sdk
          • Contracts
        • 🧰@haven1/wagmi-sdk
          • Constant Module
            • Variable: haven1Devnet
            • Variable: haven1Testnet
            • Variable: H1
          • Contract Module
            • ProofOfIdentity
            • ProofOfIdentityV2
            • NativeAppFee
          • Utility Module
            • bigIntMax
            • formatBigint
            • bigintFromDecimals
          • Hook Module
            • useWatch
            • useBalance
            • useApproveERC20
            • useContractWrite
        • ⚛️@haven1/react-sdk
          • useHaven1SDK
          • useAuth
          • useIdentity
          • useNotifications
          • useOTP
          • useSignIn
        • 📜Use cases & Examples
          • Adding the Notification Component to Your React UI
          • Check Proof of Identity (POI) Status
      • Oracles on Haven1
      • Subgraph on Haven1
      • Haven1 block explorer
      • Web3 libraries and tools
    • Development frameworks
    • 🔐Using hPassport in Your dApps
      • Integrating hPassport into Your dApp
      • Implementing Identity Checks in Smart Contracts
        • Country codes
      • Sample Application - Country ID
      • Sample Application - Composable verification level
      • Sample Application - User type
      • Repository Information
    • ⛽Application fees
      • FeeContract.sol
      • Example FeeContract Interactions
      • Case Studies
    • 👷Builders grants program
  • Additional resources
    • 📚Haven1 terminology
  • Quick Links
    • Website
    • Twitter
    • Blog
    • Telegram
    • Customer Support
Powered by GitBook
On this page
  • Constructors
  • Methods
  1. Build
  2. Developer tools
  3. Haven1 SDK
  4. @haven1/sdk-api-client

Class: AuthModule

The AuthModule class provides methods for interacting with an authentication API. It allows clients to retrieve a nonce, verify a message signature, validate tokens, and sign out from the authenticati

PreviousClass: Haven1SDKNextClass: SdkModule

Last updated 4 months ago

Constructors

new AuthModule()

new AuthModule(config): AuthModule

Initializes the AuthModule instance.

Parameters

config

Config

An object containing the configuration for the authentication module. The authApiUrl field in the config is required to initialize the client.

Returns

AuthModule

Defined in

Methods

getClient()

getClient(): undefined | Client<paths, `${string}/${string}`>

Returns the OpenAPI client instance if it is initialized.

Returns

undefined | Client<paths, `${string}/${string}`>

The instance or undefined if not initialized.

Defined in


getNonce()

getNonce(): undefined | Promise<FetchResponse<{}, undefined | FetchOptions<{}>, `${string}/${string}`>>

Retrieves a nonce from the authentication API.

The nonce can be used for generating and signing authentication messages.

Returns

undefined | Promise<FetchResponse<{}, undefined | FetchOptions<{}>, `${string}/${string}`>>

A Promise that resolves with the server's response, or undefined if the client is not initialized.

Defined in


signOut()

signOut(): undefined | Promise<FetchResponse<{}, undefined | FetchOptions<{}>, `${string}/${string}`>>

Signs out the current session using the authentication API.

This function invalidates the authentication session on the backend.

Returns

undefined | Promise<FetchResponse<{}, undefined | FetchOptions<{}>, `${string}/${string}`>>

A Promise that resolves with the sign-out response, or undefined if the client is not initialized.

Defined in


validateToken()

validateToken(token): undefined | Promise<FetchResponse<{}, { params: { path: { token: string; }; }; }, `${string}/${string}`>>

Validates an authentication token using the authentication API.

Parameters

token

string = ''

The token to be validated. Defaults to an empty string if not provided.

Returns

undefined | Promise<FetchResponse<{}, { params: { path: { token: string; }; }; }, `${string}/${string}`>>

A Promise that resolves with the validation result, or undefined if the client is not initialized.

Defined in


verify()

verify(message, signature): undefined | Promise<FetchResponse<{}, { body: { message: string; signature: string; }; }, `${string}/${string}`>>

Verifies a given signature against a message using the authentication API.

Parameters

message

string

The original message to be verified.

signature

string

The signature to verify against the message.

Returns

undefined | Promise<FetchResponse<{}, { body: { message: string; signature: string; }; }, `${string}/${string}`>>

A Promise that resolves with the verification result, or undefined if the client is not initialized.

Defined in

🧰
🛠️
🔌
module/auth.ts:25
module/auth.ts:40
module/auth.ts:51
module/auth.ts:96
module/auth.ts:79
module/auth.ts:63