Class Challenges

constructor

• new Challenges(client: SignifyClient): Challenges

  Challenges

  Parameters

  • client: SignifyClient

  Returns Challenges

client

generate

• generate(strength?: number): Promise<Challenge>

  Generate a random challenge word list based on BIP39

  Parameters

  • strength: number = 128

    Integer representing the strength of the challenge. Typically 128 or 256

  Returns Promise<Challenge>

  A promise to the list of random words

  Async

respond

• respond(name: string, recipient: string, words: string[]): Promise<unknown>

  Respond to a challenge by signing a message with the list of words

  Parameters

  • name: string

    Name or alias of the identifier
  • recipient: string

    Prefix of the recipient of the response
  • words: string[]

    List of words to embed in the signed response

  Returns Promise<unknown>

  A promise to the result of the response

  Async

responded

• responded(source: string, said: string): Promise<Response>

  Mark challenge response as signed and accepted

  Parameters

  • source: string

    Prefix of the identifier that was challenged
  • said: string

    qb64 AID of exn message representing the signed response

  Returns Promise<Response>

  A promise to the result

verify

• verify(source: string, words: string[]): Promise<Operation<unknown>>

  Ask Agent to verify a given sender signed the provided words

  Parameters

  • source: string

    Prefix of the identifier that was challenged
  • words: string[]

    List of challenge words to check for

  Returns Promise<Operation<unknown>>

  A promise to the long running operation