Class EnokiFlow

constructor

• new EnokiFlow(config: EnokiFlowConfig): EnokiFlow

  Parameters

  • config: EnokiFlowConfig

  Returns EnokiFlow

$zkLoginSession

$zkLoginState

enokiClient

• get enokiClient(): EnokiClient

  Returns EnokiClient

createAuthorizationURL

• createAuthorizationURL(
      input: {
          clientId: string;
          extraParams?: Record<string, unknown>;
          network?: "mainnet" | "testnet" | "devnet";
          provider: AuthProvider;
          redirectUrl: string;
      },
  ): Promise<string>

  Parameters

  • input: {
        clientId: string;
        extraParams?: Record<string, unknown>;
        network?: "mainnet" | "testnet" | "devnet";
        provider: AuthProvider;
        redirectUrl: string;
    }

  Returns Promise<string>

getKeypair

• getKeypair(
      __namedParameters?: { network?: EnokiNetwork },
  ): Promise<EnokiKeypair>

  Parameters

  • __namedParameters: { network?: EnokiNetwork } = {}

  Returns Promise<EnokiKeypair>

getProof

• getProof(
      __namedParameters?: { network?: EnokiNetwork },
  ): Promise<CreateZkLoginZkpApiResponse>

  Parameters

  • __namedParameters: { network?: EnokiNetwork } = {}

  Returns Promise<CreateZkLoginZkpApiResponse>

getSession

• getSession(): Promise<null | ZkLoginSession>

  Returns Promise<null | ZkLoginSession>

handleAuthCallback

• handleAuthCallback(hash?: string): Promise<null | string>

  Parameters

  • hash: string = window.location.hash

  Returns Promise<null | string>

logout

• logout(): Promise<void>

  Returns Promise<void>