Interface IRelay

Hierarchy

IRelay

Index

Methods

fetchPKPs generateRegistrationOptions mintPKP pollRequestUntilTerminalState

Methods

fetchPKPs

fetchPKPs(body: string): Promise<IRelayFetchResponse>
Fetch PKPs associated with the given auth method

Returns
Response from the relay server
Parameters
- body: string
  
  Body of the request
Returns Promise<IRelayFetchResponse>
- Defined in packages/types/src/lib/interfaces.ts:1195

generateRegistrationOptions

generateRegistrationOptions(username?: string): Promise<any>
Generate options for registering a new credential to pass to the authenticator

Returns
Registration options for the browser to pass to the authenticator
Parameters
- Optional username: string
  
  Optional username to associate with the credential
Returns Promise<any>
- Defined in packages/types/src/lib/interfaces.ts:1203

mintPKP

mintPKP(body: string): Promise<IRelayMintResponse>
Mint a new PKP for the given auth method

Returns
Response from the relay server
Parameters
- body: string
  
  Body of the request
Returns Promise<IRelayMintResponse>
- Defined in packages/types/src/lib/interfaces.ts:1177

pollRequestUntilTerminalState

pollRequestUntilTerminalState(requestId: string): Promise<IRelayPollStatusResponse>
Poll the relay server for status of minting request

Returns
Response from the relay server
Parameters
- requestId: string
  
  Request ID to poll, likely the minting transaction hash
Returns Promise<IRelayPollStatusResponse>
- Defined in packages/types/src/lib/interfaces.ts:1185

Generated using TypeDoc