Module: "attestations"

Index

Enumerations

IdentifierType

Interfaces

AttestationsStatus

Functions

Object literals

AttestationBase

Functions

base64ToHex

▸ base64ToHex(base64String: string): string

Defined in packages/sdk/base/src/attestations.ts:36

Parameters:

Name	Type
`base64String`	string

Returns: string

extractAttestationCodeFromMessage

▸ extractAttestationCodeFromMessage(message: string): null | string

Defined in packages/sdk/base/src/attestations.ts:53

Parameters:

Name	Type
`message`	string

Returns: null | string

getIdentifierPrefix

▸ getIdentifierPrefix(type: IdentifierType): string

Defined in packages/sdk/base/src/attestations.ts:13

Parameters:

Name	Type
`type`	IdentifierType

Returns: string

hashIdentifier

▸ hashIdentifier(sha3: function, identifier: string, type: IdentifierType, salt?: undefined | string): string

Defined in packages/sdk/base/src/attestations.ts:22

Parameters:

▪ sha3: function

▸ (a: string): string | null

Parameters:

Name	Type
`a`	string

▪ identifier: string

▪ type: IdentifierType

▪Optional salt: undefined | string

Returns: string

isAccountConsideredVerified

▸ isAccountConsideredVerified(stats: AttestationStat | undefined, numAttestationsRequired: number, attestationThreshold: number): AttestationsStatus

Defined in packages/sdk/base/src/attestations.ts:88

Returns true if an AttestationStat is considered verified using the given factors, or defaults if factors are ommited.

Parameters:

Name	Type	Default	Description
`stats`	AttestationStat \| undefined	-	AttestationStat of the account's attestation identitifer, retrievable via lookupIdentitfiers
`numAttestationsRequired`	number	DEFAULT_NUM_ATTESTATIONS_REQUIRED	Optional number of attestations required. Will default to hardcoded value if absent.
`attestationThreshold`	number	DEFAULT_ATTESTATION_THRESHOLD	Optional threshold for fraction attestations completed. Will default to hardcoded value if absent.