Class WalletProviderServiceClient

constructor

• new WalletProviderServiceClient(
      config: ClientConfig,
  ): WalletProviderServiceClient

  Create new client that connects to the backend service

  Parameters

  • config: ClientConfig

    config containing information about backend service

  Returns WalletProviderServiceClient

apiVersion

walletProviderUrl

addEphemeralKey

• addEphemeralKey(
      __namedParameters: { authModule: AuthModule; payload: AddEphKeyRequest },
  ): Promise<AddEphKeyResponse[]>

  Parameters

  • __namedParameters: { authModule: AuthModule; payload: AddEphKeyRequest }

  Returns Promise<AddEphKeyResponse[]>

connect

• connect(
      slug: Slug,
      payload: RequestPayloadV1,
      authModule: AuthModule,
  ): Promise<string>

  Parameters

  • slug: Slug
  • payload: RequestPayloadV1
  • authModule: AuthModule

  Returns Promise<string>

connectV2

• connectV2(
      slug: Slug,
      payload: RequestPayloadV2,
      authModule: AuthModule,
  ): Promise<string>

  Parameters

  • slug: Slug
  • payload: RequestPayloadV2
  • authModule: AuthModule

  Returns Promise<string>

deletePolicy

• deletePolicy(
      __namedParameters: {
          authModule: AuthModule;
          payload: DeletePolicyRequest;
      },
  ): Promise<PolicyChangeResponse>

  Parameters

  • __namedParameters: { authModule: AuthModule; payload: DeletePolicyRequest }

  Returns Promise<PolicyChangeResponse>

deletePolicyWithUserSignatures

• deletePolicyWithUserSignatures(
      __namedParameters: {
          payload: DeletePolicyRequest;
          userSignatures: WpNonKeygenUserSignatures;
      },
  ): Promise<PolicyChangeResponse>

  Submit a V2 policy deletion with proofs collected from separate credential holders.

  Parameters

  • __namedParameters: { payload: DeletePolicyRequest; userSignatures: WpNonKeygenUserSignatures }

  Returns Promise<PolicyChangeResponse>

finishWithError

• finishWithError(
      connection: WebSocket,
      state: ProtocolState,
      error: any,
      source: string,
      reject: (error: Error) => void,
  ): void

  Common function to transition to finished state and reject the promise. Also handles closing the connection if it's not already closed/closing.

  Parameters

  • connection: WebSocket

    The WebSocket connection to close.

  • state: ProtocolState

    The current protocol state.

  • error: any

    The error to reject with.

  • source: string

    Where the error originated (for logging/clarity).

  • reject: (error: Error) => void

    The promise reject function to use.

  Returns void

getCredentialGrants

• getCredentialGrants(
      __namedParameters: { authModule: AuthModule; payload: GetPolicyRequest },
  ): Promise<GetCredentialGrantsResponse>

  Parameters

  • __namedParameters: { authModule: AuthModule; payload: GetPolicyRequest }

  Returns Promise<GetCredentialGrantsResponse>

getPolicyIntegrations

• getPolicyIntegrations(): Promise<IntegrationCatalogResponse>

  Returns the public catalog of available policy integrations.

  Returns Promise<IntegrationCatalogResponse>

getVersion

• getVersion(): ApiVersion

  Returns ApiVersion

registerPasskey

• registerPasskey(
      __namedParameters: {
          authModule: AuthModule;
          payload: RegisterPasskeyRequest;
      },
  ): Promise<RegisterPasskeyResponse>

  Parameters

  • __namedParameters: { authModule: AuthModule; payload: RegisterPasskeyRequest }

  Returns Promise<RegisterPasskeyResponse>

revokeEphemeralKey

• revokeEphemeralKey(
      __namedParameters: {
          authModule: AuthModule;
          payload: RevokeEphKeyRequest;
      },
  ): Promise<SimpleResponse>

  Parameters

  • __namedParameters: { authModule: AuthModule; payload: RevokeEphKeyRequest }

  Returns Promise<SimpleResponse>

startKeygen

• startKeygen(
      __namedParameters: { authModule: AuthModule; setups: KeygenSetupOpts[] },
  ): Promise<KeygenResponse[]>

  Parameters

  • __namedParameters: { authModule: AuthModule; setups: KeygenSetupOpts[] }

  Returns Promise<KeygenResponse[]>

startKeygenWithUserSignatures

• startKeygenWithUserSignatures(
      __namedParameters: {
          setups: KeygenSetupOpts[];
          userSignatures: WpKeygenUserSignatures;
      },
  ): Promise<KeygenResponse[]>

  Submit a V2 keygen request with proofs collected from separate credential holders.

  Parameters

  • __namedParameters: { setups: KeygenSetupOpts[]; userSignatures: WpKeygenUserSignatures }

  Returns Promise<KeygenResponse[]>

startKeyRefresh

• startKeyRefresh(
      __namedParameters: {
          authModule: AuthModule;
          payload: KeyRefreshRequest;
      },
  ): Promise<KeygenResponse>

  Parameters

  • __namedParameters: { authModule: AuthModule; payload: KeyRefreshRequest }

  Returns Promise<KeygenResponse>

startSigngen

• startSigngen(
      __namedParameters: { authModule: AuthModule; setup: SignSetupOpts },
  ): Promise<SignResponse[]>

  Parameters

  • __namedParameters: { authModule: AuthModule; setup: SignSetupOpts }

  Returns Promise<SignResponse[]>

startSigngenWithUserSignatures

• startSigngenWithUserSignatures(
      __namedParameters: {
          setup: SignSetupOpts;
          userSignatures: WpNonKeygenUserSignatures;
      },
  ): Promise<SignResponse[]>

  Submit a V2 sign request with proofs collected from separate credential holders.

  Parameters

  • __namedParameters: { setup: SignSetupOpts; userSignatures: WpNonKeygenUserSignatures }

  Returns Promise<SignResponse[]>

updatePolicy

• updatePolicy(
      __namedParameters: {
          authModule: AuthModule;
          payload: UpdatePolicyRequest;
      },
  ): Promise<PolicyChangeResponse>

  Parameters

  • __namedParameters: { authModule: AuthModule; payload: UpdatePolicyRequest }

  Returns Promise<PolicyChangeResponse>

updatePolicyWithUserSignatures

• updatePolicyWithUserSignatures(
      __namedParameters: {
          payload: UpdatePolicyRequest;
          userSignatures: WpNonKeygenUserSignatures;
      },
  ): Promise<PolicyChangeResponse>

  Submit a V2 policy update with proofs collected from separate credential holders.

  Parameters

  • __namedParameters: { payload: UpdatePolicyRequest; userSignatures: WpNonKeygenUserSignatures }

  Returns Promise<PolicyChangeResponse>