Skip to main content

@atala/prism-wallet-sdk / Exports / Domain

Namespace: Domain

Table of contents​

Namespaces​

Enumerations​

Classes​

Interfaces​

Type Aliases​

Functions​

Type Aliases​

AnoncredsInputFieldFilter​

Ƭ AnoncredsInputFieldFilter: Object

Type declaration​

NameType
$gt?PredicateType
$gte?PredicateType
$lt?PredicateType
$lte?PredicateType
namestring
typestring

Defined in​

src/domain/models/VerifiableCredential.ts:111

AnoncredsPresentationClaims​

Ƭ AnoncredsPresentationClaims: Object

Type declaration​

NameType
attributes?Anoncreds.RequestedAttributes
predicates?Claims<AnonCreds>

Defined in​

src/domain/models/VerifiableCredential.ts:100

AnoncredsPresentationSubmission​

Ƭ AnoncredsPresentationSubmission: Anoncreds.PresentationType

Defined in​

src/domain/models/VerifiableCredential.ts:215

AttachmentData​

Ƭ AttachmentData: AttachmentJsonData | AttachmentLinkData | AttachmentBase64 | AttachmentJwsData | AttachmentJws | AttachmentHeader

Defined in​

src/domain/models/MessageAttachment.ts:32

AttributeType​

Ƭ AttributeType: string | number

Defined in​

src/domain/models/VerifiableCredential.ts:81

Claims​

Ƭ Claims<Type>: Type extends JWT ? { [name: string]: InputFieldFilter; } : { [name: string]: AnoncredsInputFieldFilter; }

Type parameters​

NameType
Typeextends CredentialType = JWT

Defined in​

src/domain/models/VerifiableCredential.ts:84

CredentialOfferJWTBasePayload​

Ƭ CredentialOfferJWTBasePayload: Object

Type declaration​

NameType
options{ challenge: string ; domain: string }
options.challengestring
options.domainstring

Defined in​

src/domain/buildingBlocks/Pollux.ts:16

CredentialOfferPayloads​

Ƭ CredentialOfferPayloads: Object

Type declaration​

NameType
AnonCredsAnoncreds.CredentialOfferType
Unknownunknown
prism/jwtCredentialOfferJWTBasePayload
vc+sd-jwtCredentialOfferJWTBasePayload
w3cunknown

Defined in​

src/domain/buildingBlocks/Pollux.ts:23

CredentialOfferTypes​

Ƭ CredentialOfferTypes: AnonCreds | JWT | SDJWT

Defined in​

src/domain/buildingBlocks/Pollux.ts:32

CredentialRequestTuple​

Ƭ CredentialRequestTuple<T1, T2>: [T1, T2]

Type parameters​

NameType
T1Anoncreds.CredentialRequestType
T2Anoncreds.CredentialRequestMetadataType

Defined in​

src/domain/buildingBlocks/Pollux.ts:9

DIDDocumentCoreProperty​

Ƭ DIDDocumentCoreProperty: Service | AlsoKnownAs | Controller | VerificationMethods | Services | Authentication | AssertionMethod | KeyAgreement | CapabilityInvocation | CapabilityDelegation

Defined in​

src/domain/models/DIDDocument.ts:99

DefinitionFormat​

Ƭ DefinitionFormat: Object

Type declaration​

NameType
jwt{ alg: string[] }
jwt.algstring[]

Defined in​

src/domain/models/VerifiableCredential.ts:151

DescriptorItem​

Ƭ DescriptorItem: Object

Type declaration​

NameType
formatDescriptorItemFormat
idstring
pathstring
path_nested?DescriptorItem

Defined in​

src/domain/models/VerifiableCredential.ts:198

ExportableKey​

Ƭ ExportableKey: All

ExportableKey defines the formats a crypographic key can be converted to Default is all

Defined in​

src/domain/models/keyManagement/exportable/ExportableKey.ts:11

src/domain/models/keyManagement/exportable/ExportableKey.ts:23

Hasher​

Ƭ Hasher: (data: string, alg: string) => Promise<Uint8Array>

Type declaration​

▸ (data, alg): Promise<Uint8Array>

Parameters​
NameType
datastring
algstring
Returns​

Promise<Uint8Array>

Defined in​

src/domain/models/VerifiableCredential.ts:373

InputConstraints​

Ƭ InputConstraints: Object

Type declaration​

NameType
fieldsInputField[]
limit_disclosureInputLimitDisclosure

Defined in​

src/domain/models/VerifiableCredential.ts:138

InputDescriptor​

Ƭ InputDescriptor: Object

Type declaration​

NameType
constraintsInputConstraints
format?DefinitionFormat
idstring
name?string
purpose?string

Defined in​

src/domain/models/VerifiableCredential.ts:143

InputField​

Ƭ InputField: Object

Type declaration​

NameType
filter?InputFieldFilter
id?string
name?string
optional?boolean
pathstring[]
purpose?string

Defined in​

src/domain/models/VerifiableCredential.ts:129

InputFieldFilter​

Ƭ InputFieldFilter: Object

Type declaration​

NameType
const?PredicateType[]
enum?PredicateType[]
pattern?string
typestring
value?PredicateType

Defined in​

src/domain/models/VerifiableCredential.ts:120

JWK​

Ƭ JWK: EC | OCT | OKP | RSA

JWK

Defined in​

src/domain/models/keyManagement/exportable/JWK.ts:10

src/domain/models/keyManagement/exportable/JWK.ts:16

JWTCredentialPayload​

Ƭ JWTCredentialPayload: Object

Type declaration​

NameType
aud?string
expnumber
issstring
jti?string
nbfnumber
revoked?boolean
substring
vcW3CVerifiableCredential

Defined in​

src/domain/models/VerifiableCredential.ts:335

JWTHeader​

Ƭ JWTHeader: Object

Index signature​

▪ [x: string]: any

Type declaration​

NameType
algstring
typ"JWT"

Defined in​

src/domain/models/VerifiableCredential.ts:377

JWTObject​

Ƭ JWTObject: Object

Type declaration​

NameType
datastring
headerJWTHeader
payloadJWTPayload
signaturestring

Defined in​

src/domain/models/VerifiableCredential.ts:385

JWTPayload​

Ƭ JWTPayload: JWTCredentialPayload | JWTPresentationPayload

Defined in​

src/domain/models/VerifiableCredential.ts:384

JWTPresentationClaims​

Ƭ JWTPresentationClaims: Object

Type declaration​

NameType
claimsClaims<JWT>
issuer?string
schema?string

Defined in​

src/domain/models/VerifiableCredential.ts:94

JWTPresentationPayload​

Ƭ JWTPresentationPayload: Object

Type declaration​

NameType
audstring
exp?number
iss?string
jti?string
nbf?number
noncestring
vpW3CVerifiablePresentation

Defined in​

src/domain/models/VerifiableCredential.ts:347

JWTPresentationSubmission​

Ƭ JWTPresentationSubmission: Object

Type declaration​

NameType
presentation_submission{ definition_id: string ; descriptor_map: DescriptorItem[] ; id: string }
presentation_submission.definition_idstring
presentation_submission.descriptor_mapDescriptorItem[]
presentation_submission.idstring
verifiablePresentationstring[]

Defined in​

src/domain/models/VerifiableCredential.ts:206

JsonString​

Ƭ JsonString: string

Defined in​

src/domain/models/index.ts:23

MnemonicWordList​

Ƭ MnemonicWordList: [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string]

Defined in​

src/domain/models/WordList.ts:1

PredicateType​

Ƭ PredicateType: string | number

Defined in​

src/domain/models/VerifiableCredential.ts:80

PresentationAnoncredsRequest​

Ƭ PresentationAnoncredsRequest: Anoncreds.PresentationRequestType

Defined in​

src/domain/models/VerifiableCredential.ts:157

PresentationClaims​

Ƭ PresentationClaims<Type>: Type extends JWT ? JWTPresentationClaims : AnoncredsPresentationClaims

Type parameters​

NameType
Typeextends CredentialType = JWT

Defined in​

src/domain/models/VerifiableCredential.ts:105

PresentationDefinitionData​

Ƭ PresentationDefinitionData: Object

Type declaration​

NameType
AnonCredsPresentationAnoncredsRequest
Unknownany
prism/jwtPresentationExchangeDefinitionRequest
vc+sd-jwtany
w3cany

Defined in​

src/domain/models/VerifiableCredential.ts:173

PresentationDefinitionRequest​

Ƭ PresentationDefinitionRequest<Type>: PresentationDefinitionData[Type]

Type parameters​

NameType
Typeextends CredentialType = JWT

Defined in​

src/domain/models/VerifiableCredential.ts:194

PresentationExchangeDefinitionRequest​

Ƭ PresentationExchangeDefinitionRequest: Object

Type declaration​

NameType
options{ challenge: string ; domain: string }
options.challengestring
options.domainstring
presentation_definition{ format?: DefinitionFormat ; id: string ; input_descriptors: InputDescriptor[] }
presentation_definition.format?DefinitionFormat
presentation_definition.idstring
presentation_definition.input_descriptorsInputDescriptor[]

Defined in​

src/domain/models/VerifiableCredential.ts:159

PresentationJWTOptions​

Ƭ PresentationJWTOptions: Object

Type declaration​

NameType
jwtAlg?string[]

Defined in​

src/domain/models/VerifiableCredential.ts:392

PresentationRequestOptions​

Ƭ PresentationRequestOptions: Object

Type declaration​

NameType
AnonCredsConstructorParameters<typeof AnoncredsPresentationOptions>["0"]
Unknownany
prism/jwtConstructorParameters<typeof JWTPresentationOptions>["0"]
w3cany

Defined in​

src/domain/models/VerifiableCredential.ts:396

PresentationSubmission​

Ƭ PresentationSubmission<Type>: PresentationSubmissionData[Type]

Type parameters​

NameType
Typeextends CredentialType = JWT

Defined in​

src/domain/models/VerifiableCredential.ts:228

PresentationSubmissionData​

Ƭ PresentationSubmissionData: Object

Type declaration​

NameType
AnonCredsAnoncredsPresentationSubmission
Unknownany
prism/jwtJWTPresentationSubmission
vc+sd-jwtany
w3cany

Defined in​

src/domain/models/VerifiableCredential.ts:219

ProcessedCredentialOfferPayloads​

Ƭ ProcessedCredentialOfferPayloads: Object

Type declaration​

NameType
AnonCredsCredentialRequestTuple
Unknownunknown
prism/jwtstring
vc+sd-jwtstring
w3cunknown

Defined in​

src/domain/buildingBlocks/Pollux.ts:37

Signer​

Ƭ Signer: (data: string | Uint8Array) => Promise<string>

Type declaration​

▸ (data): Promise<string>

Parameters​
NameType
datastring | Uint8Array
Returns​

Promise<string>

Defined in​

src/domain/models/VerifiableCredential.ts:374

Verifier​

Ƭ Verifier: (data: string, sig: string) => Promise<boolean>

Type declaration​

▸ (data, sig): Promise<boolean>

Parameters​
NameType
datastring
sigstring
Returns​

Promise<boolean>

Defined in​

src/domain/models/VerifiableCredential.ts:375

W3CVerifiableCredential​

Ƭ W3CVerifiableCredential: Object

Type declaration​

NameType
@context[credential]
credentialSchema?{ id: string ; type: string }
credentialSchema.idstring
credentialSchema.typestring
credentialStatus?JWTRevocationStatus | unknown
credentialSubjectRecord<string, any>
evidence?{ id: string ; type: string }
evidence.idstring
evidence.typestring
expirationDate?string
issuanceDatestring
issued?string
issuerstring
refreshService?{ id: string ; type: string }
refreshService.idstring
refreshService.typestring
termsOfUse?{ id: string ; type: string }
termsOfUse.idstring
termsOfUse.typestring
type[credential]
validFrom?{ id: string ; type: string }
validFrom.idstring
validFrom.typestring
validUntil?{ id: string ; type: string }
validUntil.idstring
validUntil.typestring

Defined in​

src/domain/models/VerifiableCredential.ts:232

W3CVerifiablePresentation​

Ƭ W3CVerifiablePresentation: Object

Type declaration​

NameType
@context[credential]
proof?W3CVerifiablePresentationProof
type[presentation]
verifiableCredentialstring[]

Defined in​

src/domain/models/VerifiableCredential.ts:358

W3CVerifiablePresentationProof​

Ƭ W3CVerifiablePresentationProof: Object

Type declaration​

NameType
challengestring
domainstring

Defined in​

src/domain/models/VerifiableCredential.ts:369

Functions​

curveToAlg​

▸ curveToAlg(curve): JWT_ALG

Parameters​

NameType
curvestring

Returns​

JWT_ALG

Defined in​

src/domain/models/keyManagement/Key.ts:119

getKeyCurveByNameAndIndex​

▸ getKeyCurveByNameAndIndex(name, index?): KeyCurve

Parameters​

NameType
namestring
index?number

Returns​

KeyCurve

Defined in​

src/domain/models/keyManagement/Key.ts:128

getProtosUsage​

▸ getProtosUsage(usage): KeyUsage

Parameters​

NameType
usageUsage

Returns​

KeyUsage

Defined in​

src/domain/models/keyManagement/Key.ts:24

getUsage​

▸ getUsage(protosUsage): Usage

Parameters​

NameType
protosUsageKeyUsage

Returns​

Usage

Defined in​

src/domain/models/keyManagement/Key.ts:73

getUsageId​

▸ getUsageId(index): string

Parameters​

NameType
indexUsage

Returns​

string

Defined in​

src/domain/models/keyManagement/Key.ts:52