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>

executeTransaction

• executeTransaction(
      __namedParameters: {
          bytes: string;
          client: SuiClient;
          digest: string;
          network?: "mainnet" | "testnet";
      },
  ): Promise<{ digest: string }>

• Parameters

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

  Returns Promise<{ digest: string }>

getKeypair

• getKeypair(
      __namedParameters?: { network?: "mainnet" | "testnet" },
  ): Promise<EnokiKeypair>

• Parameters

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

  Returns Promise<EnokiKeypair>

getProof

• getProof(
      __namedParameters?: { network?: "mainnet" | "testnet" },
  ): Promise<CreateZkLoginZkpApiResponse>

• Parameters

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

  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>

sponsorAndExecuteTransaction

• sponsorAndExecuteTransaction(
      __namedParameters: {
          client: SuiClient;
          network?: "mainnet" | "testnet";
          transaction: Transaction;
      },
  ): Promise<{ digest: string }>

• Parameters

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

  Returns Promise<{ digest: string }>

sponsorTransaction

• sponsorTransaction(
      __namedParameters: {
          client: SuiClient;
          network?: "mainnet" | "testnet";
          transaction: Transaction;
      },
  ): Promise<CreateSponsoredTransactionApiResponse>

• Parameters

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

  Returns Promise<CreateSponsoredTransactionApiResponse>