Class ASPProfile

constructor

• new ASPProfile(
      keyType: KeyType,
      publicKey: Uint8Array,
      name?: string,
      description?: string,
      claims?: string[],
      color?: string,
      avatar_url?: string,
      email?: string,
      exp?: number,
      signature?: Uint8Array<ArrayBufferLike>,
  ): ASPProfile

  Ariadne Signature Profile (ASP)

  Parameters

  • keyType: KeyType

    Key type (ES256 or EdDSA)

  • publicKey: Uint8Array

    Profile public key (ANSI X9.62 uncompressed P-256 point)

  • name: string = ""

    Profile name

  • description: string = ""

    Profile description

  • claims: string[] = []

    Profile claims

  • color: string = ""

    Profile color

  • avatar_url: string = ""

    Profile Avatar URL

  • email: string = ""

    Profile Email

  • exp: number = 0

    Expire claim

  • Optionalsignature: Uint8Array<ArrayBufferLike>

    Profile signature (Optional. Needed for export only)

  Returns ASPProfile

avatar_url

claims

color

description

email

exp

keyType

name

publicKey

Optionalsignature

thumbprint

• get thumbprint(): string

  Profile thumbprint

  Returns string

generateActionRequest

• generateActionRequest(action: RequestAction, secretKey: SecretKey): string

  Generate action request to ASPE server

  Parameters

  • action: RequestAction
  • secretKey: SecretKey

  Returns string

getAvatarUrl

• getAvatarUrl(dicebearApiHostname?: string): string

  Get profile avatar URL

  Parameters

  • dicebearApiHostname: string = 'api.dicebear.com'

  Returns string

getHashedProof

• getHashedProof(domain?: string): Promise<string>

  Get hashed profile proof

  Parameters

  • domain: string = "keyoxide.org"

  Returns Promise<string>

getURI

• getURI(domain?: string): string

  Get profile ASPE URI (aka Direct proof)

  Parameters

  • domain: string = "keyoxide.org"

  Returns string

sign

• sign(secretKey: SecretKey): void

  Sign profile with secret key

  Parameters

  • secretKey: SecretKey

  Returns void

toBase64

• toBase64(): string

  Export profile as base64 (signature needed)

  Returns string

toJSON

• toJSON(): ASPProfilePayload

  Convert profile to JSON object

  Returns ASPProfilePayload

verify

• verify(): boolean

  Verify profile signature

  Returns boolean

StaticfromBase64

• fromBase64(base64: string): ASPProfile

  Import profile from base64

  Parameters

  • base64: string

  Returns ASPProfile