Class EnokiFlow

constructor

• new EnokiFlow(config): EnokiFlow

• Parameters

  • config: EnokiFlowConfig

  Returns EnokiFlow

$zkLoginSession

$zkLoginState

enokiClient

• get enokiClient(): EnokiClient

• Returns EnokiClient

createAuthorizationURL

• createAuthorizationURL(input): Promise<string>

• Parameters

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

    • clientId: string

    • OptionalextraParams?: Record<string, unknown>

    • Optionalnetwork?: "mainnet" | "testnet" | "devnet"

    • provider: AuthProvider

    • redirectUrl: string

  Returns Promise<string>

executeTransaction

• executeTransaction(__namedParameters): Promise<{
      digest: string;
  }>

• Parameters

  • __namedParameters: {
        bytes: string;
        client: SuiClient;
        digest: string;
        network?: "mainnet" | "testnet";
    }

    • bytes: string

    • client: SuiClient

    • digest: string

    • Optionalnetwork?: "mainnet" | "testnet"

  Returns Promise<{
      digest: string;
  }>

getKeypair

• getKeypair(__namedParameters?): Promise<EnokiKeypair>

• Parameters

  • __namedParameters: {
        network?: "mainnet" | "testnet";
    } = {}

    • Optionalnetwork?: "mainnet" | "testnet"

  Returns Promise<EnokiKeypair>

getProof

• getProof(__namedParameters?): Promise<CreateZkLoginZkpApiResponse>

• Parameters

  • __namedParameters: {
        network?: "mainnet" | "testnet";
    } = {}

    • Optionalnetwork?: "mainnet" | "testnet"

  Returns Promise<CreateZkLoginZkpApiResponse>

getSession

• getSession(): Promise<null | ZkLoginSession>

• Returns Promise<null | ZkLoginSession>

handleAuthCallback

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

• Parameters

  • hash: string = window.location.hash

  Returns Promise<null | string>

logout

• logout(): Promise<void>

• Returns Promise<void>

sponsorAndExecuteTransaction

• sponsorAndExecuteTransaction(__namedParameters): Promise<{
      digest: string;
  }>

• Parameters

  • __namedParameters: {
        client: SuiClient;
        network?: "mainnet" | "testnet";
        transaction: Transaction;
    }

    • client: SuiClient

    • Optionalnetwork?: "mainnet" | "testnet"

    • transaction: Transaction

  Returns Promise<{
      digest: string;
  }>

sponsorTransaction

• sponsorTransaction(__namedParameters): Promise<CreateSponsoredTransactionApiResponse>

• Parameters

  • __namedParameters: {
        client: SuiClient;
        network?: "mainnet" | "testnet";
        transaction: Transaction;
    }

    • client: SuiClient

    • Optionalnetwork?: "mainnet" | "testnet"

    • transaction: Transaction

  Returns Promise<CreateSponsoredTransactionApiResponse>