@hyperledger/identus-edge-agent-sdk / Exports / Domain

Namespace: Domain

Table of contents

References

• KeyRestoration
• Startable

Namespaces

• AgentError
• ApolloError
• Backup
• CastorError
• CommonError
• ExportableKey
• ImportableKey
• JWK
• JWT
• MercuryError
• Message
• PEM
• Pluto
• PlutoError
• Pollux
• PolluxError
• Protocols
• StorableKey

Enumerations

• AttachmentFormats
• CredentialStatusType
• CredentialType
• Curve
• DescriptorItemFormat
• InputLimitDisclosure
• JWTProofPurpose
• JWTProofType
• JWTRevocationStatusPurpose
• JWTVerifiableCredentialProperties
• JWTVerifiablePresentationProperties
• JWT_ALG
• KeyProperties
• KeyTypes
• KeyUsage
• MessageDirection
• RevocationType
• SDJWTVerifiableCredentialProperties
• Usage
• W3CVerifiableCredentialContext
• W3CVerifiableCredentialType

Classes

• AlsoKnownAs
• AnoncredsPresentationOptions
• ApiError
• ApiResponse
• AssertionMethod
• AttachmentDescriptor
• Authentication
• CapabilityDelegation
• CapabilityInvocation
• Controller
• Credential
• CredentialMetadata
• DID
• DIDDocument
• DIDPair
• DIDResolver
• DIDUrl
• DerivableKey
• JWTPresentationOptions
• Key
• KeyAgreement
• KeyPair
• LinkSecret
• Message
• PresentationDefinitionRequestType
• PresentationOptions
• PrismDID
• PrivateKey
• PublicKey
• SDJWPresentationOptions
• Service
• ServiceEndpoint
• Services
• SignableKey
• VerifiableKey
• VerificationMethod
• VerificationMethods

Interfaces

• Api
• Apollo
• AttachmentBase64
• AttachmentHeader
• AttachmentJws
• AttachmentJwsData
• AttachmentLinkData
• Castor
• CredentialIssueOptions
• CredentialRequestOptions
• CredentialSubject
• JWTRevocationStatus
• JWTStatusListResponse
• KeyCurve
• Mediator
• Mercury
• Pluto
• Pollux
• ProvableCredential
• PublicKeyJWK
• Seed
• SeedWords
• Signature
• StorableCredential
• StorableKey
• VerifiableCredentialTypeContainer
• W3CVerifiableCredentialData

Type Aliases

• AnoncredsInputFieldFilter
• AnoncredsPresentationClaims
• AnoncredsPresentationSubmission
• AttachmentData
• AttachmentJsonData
• AttributeType
• Claims
• CredentialOfferJWTBasePayload
• CredentialOfferPayloads
• CredentialOfferTypes
• CredentialRequestTuple
• DIDDocumentCoreProperty
• DefinitionFormat
• DescriptorItem
• ExportableKey
• Hasher
• HttpMethod
• InputConstraints
• InputDescriptor
• InputField
• InputFieldFilter
• JWK
• JWTCredentialPayload
• JWTHeader
• JWTObject
• JWTPayload
• JWTPresentationClaims
• JWTPresentationPayload
• JWTPresentationSubmission
• JsonString
• MnemonicWordList
• PredicateType
• PresentationAnoncredsRequest
• PresentationClaims
• PresentationDefinitionData
• PresentationDefinitionRequest
• PresentationExchangeDefinitionRequest
• PresentationJWTOptions
• PresentationRequestOptions
• PresentationSubmission
• PresentationSubmissionData
• ProcessedCredentialOfferPayloads
• SDJWTPresentationClaims
• SDJWTPresentationExchangeSubmission
• SDJWTPresentationSubmission
• Signer
• Verifier
• W3CVerifiableCredential
• W3CVerifiablePresentation
• W3CVerifiablePresentationProof

Functions

• curveToAlg
• getKeyCurveByNameAndIndex
• getProtosUsage
• getUsage
• getUsageFromId
• getUsageId

References

KeyRestoration

Re-exports KeyRestoration

---

Startable

Re-exports Startable

Type Aliases

AnoncredsInputFieldFilter

Ƭ AnoncredsInputFieldFilter: Object

Type declaration

Name	Type
$gt?	PredicateType
$gte?	PredicateType
$lt?	PredicateType
$lte?	PredicateType
name	string
type	string

Defined in

src/domain/models/VerifiableCredential.ts:114

---

AnoncredsPresentationClaims

Ƭ AnoncredsPresentationClaims: Object

Type declaration

Name	Type
attributes?	Anoncreds.RequestedAttributes
predicates?	Claims<AnonCreds>

Defined in

src/domain/models/VerifiableCredential.ts:103

---

AnoncredsPresentationSubmission

Ƭ AnoncredsPresentationSubmission: Anoncreds.PresentationType

Defined in

src/domain/models/VerifiableCredential.ts:230

---

AttachmentData

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

Defined in

src/domain/models/MessageAttachment.ts:34

---

AttachmentJsonData

Ƭ AttachmentJsonData: { json: any } | { data: any }

Defined in

src/domain/models/MessageAttachment.ts:28

---

AttributeType

Ƭ AttributeType: string | number

Defined in

src/domain/models/VerifiableCredential.ts:82

---

Claims

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

Type parameters

Name	Type
Type	extends CredentialType = JWT

Defined in

src/domain/models/VerifiableCredential.ts:85

---

CredentialOfferJWTBasePayload

Ƭ CredentialOfferJWTBasePayload: Object

Type declaration

Name	Type
options	{ challenge: string ; domain: string }
options.challenge	string
options.domain	string

Defined in

src/domain/buildingBlocks/Pollux.ts:16

---

CredentialOfferPayloads

Ƭ CredentialOfferPayloads: Object

Type declaration

Name	Type
AnonCreds	Anoncreds.CredentialOfferType
Unknown	unknown
prism/jwt	CredentialOfferJWTBasePayload
vc+sd-jwt	CredentialOfferJWTBasePayload
w3c	unknown

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

Name	Type
T1	Anoncreds.CredentialRequestType
T2	Anoncreds.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

Name	Type
jwt?	{ alg: string[] }
jwt.alg	string[]
sdjwt?	{ alg: string[] }
sdjwt.alg	string[]

Defined in

src/domain/models/VerifiableCredential.ts:154

---

DescriptorItem

Ƭ DescriptorItem: Object

Type declaration

Name	Type
format	DescriptorItemFormat
id	string
path	string
path_nested?	DescriptorItem

Defined in

src/domain/models/VerifiableCredential.ts:197

---

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:12

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

---

Hasher

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

Type declaration

▸ (data, alg): Promise<Uint8Array>

Parameters

Name	Type
data	string
alg	string

Returns

Promise<Uint8Array>

Defined in

src/domain/models/VerifiableCredential.ts:388

---

HttpMethod

Ƭ HttpMethod: "DELETE" | "GET" | "POST" | "PUT"

Defined in

src/domain/models/Api.ts:1

---

InputConstraints

Ƭ InputConstraints: Object

Type declaration

Name	Type
fields	InputField[]
limit_disclosure	InputLimitDisclosure

Defined in

src/domain/models/VerifiableCredential.ts:141

---

InputDescriptor

Ƭ InputDescriptor: Object

Type declaration

Name	Type
constraints	InputConstraints
format?	DefinitionFormat
id	string
name?	string
purpose?	string

Defined in

src/domain/models/VerifiableCredential.ts:146

---

InputField

Ƭ InputField: Object

Type declaration

Name	Type
filter?	InputFieldFilter
id?	string
name?	string
optional?	boolean
path	string[]
purpose?	string

Defined in

src/domain/models/VerifiableCredential.ts:132

---

InputFieldFilter

Ƭ InputFieldFilter: Object

Type declaration

Name	Type
const?	PredicateType[]
enum?	PredicateType[]
pattern?	string
type	string
value?	PredicateType

Defined in

src/domain/models/VerifiableCredential.ts:123

---

JWK

Ƭ JWK: EC | OCT | OKP | RSA

JWK

Defined in

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

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

---

JWTCredentialPayload

Ƭ JWTCredentialPayload: Object

Type declaration

Name	Type
aud?	string
exp	number
iss	string
jti?	string
nbf	number
revoked?	boolean
sub	string
vc	W3CVerifiableCredential

Defined in

src/domain/models/VerifiableCredential.ts:350

---

JWTHeader

Ƭ JWTHeader: Object

Index signature

▪ [x: string]: any

Type declaration

Name	Type
alg	string
typ	"JWT"

Defined in

src/domain/models/VerifiableCredential.ts:392

---

JWTObject

Ƭ JWTObject: Object

Type declaration

Name	Type
data	string
header	JWTHeader
payload	JWTPayload
signature	string

Defined in

src/domain/models/VerifiableCredential.ts:400

---

JWTPayload

Ƭ JWTPayload: JWTCredentialPayload | JWTPresentationPayload

Defined in

src/domain/models/VerifiableCredential.ts:399

---

JWTPresentationClaims

Ƭ JWTPresentationClaims: Object

Type declaration

Name	Type
claims	Claims<JWT>
issuer?	string
schema?	string

Defined in

src/domain/models/VerifiableCredential.ts:90

---

JWTPresentationPayload

Ƭ JWTPresentationPayload: Object

Type declaration

Name	Type
aud?	string
exp?	number
iss?	string
jti?	string
nbf?	number
nonce?	string
vp	W3CVerifiablePresentation

Defined in

src/domain/models/VerifiableCredential.ts:362

---

JWTPresentationSubmission

Ƭ JWTPresentationSubmission: Object

Type declaration

Name	Type
presentation_submission	{ definition_id: string ; descriptor_map: DescriptorItem[] ; id: string }
presentation_submission.definition_id	string
presentation_submission.descriptor_map	DescriptorItem[]
presentation_submission.id	string
verifiablePresentation	string[]

Defined in

src/domain/models/VerifiableCredential.ts:205

---

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:81

---

PresentationAnoncredsRequest

Ƭ PresentationAnoncredsRequest: Anoncreds.PresentationRequestType

Defined in

src/domain/models/VerifiableCredential.ts:163

---

PresentationClaims

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

Type parameters

Name	Type
Type	extends CredentialType = JWT

Defined in

src/domain/models/VerifiableCredential.ts:108

---

PresentationDefinitionData

Ƭ PresentationDefinitionData: Object

Type declaration

Name	Type
AnonCreds	PresentationAnoncredsRequest
Unknown	any
prism/jwt	PresentationExchangeDefinitionRequest
vc+sd-jwt	PresentationExchangeDefinitionRequest
w3c	any

Defined in

src/domain/models/VerifiableCredential.ts:174

---

PresentationDefinitionRequest

Ƭ PresentationDefinitionRequest<Type>: PresentationDefinitionData[Type]

Type parameters

Name	Type
Type	extends CredentialType = JWT

Defined in

src/domain/models/VerifiableCredential.ts:193

---

PresentationExchangeDefinitionRequest

Ƭ PresentationExchangeDefinitionRequest: Object

Type declaration

Name	Type
presentation_definition	{ format?: DefinitionFormat ; id: string ; input_descriptors: InputDescriptor[] }
presentation_definition.format?	DefinitionFormat
presentation_definition.id	string
presentation_definition.input_descriptors	InputDescriptor[]

Defined in

src/domain/models/VerifiableCredential.ts:165

---

PresentationJWTOptions

Ƭ PresentationJWTOptions: Object

Type declaration

Name	Type
jwtAlg?	string[]

Defined in

src/domain/models/VerifiableCredential.ts:407

---

PresentationRequestOptions

Ƭ PresentationRequestOptions: Object

Type declaration

Name	Type
AnonCreds	ConstructorParameters<typeof AnoncredsPresentationOptions>["0"]
Unknown	any
prism/jwt	ConstructorParameters<typeof JWTPresentationOptions>["0"]
vc+sd-jwt	ConstructorParameters<typeof SDJWPresentationOptions>["0"]
w3c	any

Defined in

src/domain/models/VerifiableCredential.ts:411

---

PresentationSubmission

Ƭ PresentationSubmission<Type>: PresentationSubmissionData[Type]

Type parameters

Name	Type
Type	extends CredentialType = JWT

Defined in

src/domain/models/VerifiableCredential.ts:243

---

PresentationSubmissionData

Ƭ PresentationSubmissionData: Object

Type declaration

Name	Type
AnonCreds	AnoncredsPresentationSubmission
Unknown	any
prism/jwt	JWTPresentationSubmission
vc+sd-jwt	JWTPresentationSubmission
w3c	any

Defined in

src/domain/models/VerifiableCredential.ts:234

---

ProcessedCredentialOfferPayloads

Ƭ ProcessedCredentialOfferPayloads: Object

Type declaration

Name	Type
AnonCreds	CredentialRequestTuple
Unknown	unknown
prism/jwt	string
vc+sd-jwt	string
w3c	unknown

Defined in

src/domain/buildingBlocks/Pollux.ts:37

---

SDJWTPresentationClaims

Ƭ SDJWTPresentationClaims: Object

Type declaration

Name	Type
claims	Claims<SDJWT>
issuer?	string
schema?	string

Defined in

src/domain/models/VerifiableCredential.ts:96

---

SDJWTPresentationExchangeSubmission

Ƭ SDJWTPresentationExchangeSubmission: Object

Type declaration

Name	Type
presentation_submission	{ definition_id: string ; descriptor_map: DescriptorItem[] ; id: string }
presentation_submission.definition_id	string
presentation_submission.descriptor_map	DescriptorItem[]
presentation_submission.id	string
verifiablePresentation	string[]

Defined in

src/domain/models/VerifiableCredential.ts:214

---

SDJWTPresentationSubmission

Ƭ SDJWTPresentationSubmission: Object

Type declaration

Name	Type
disclosures	any[]
payload	string
protected	string
signature	string

Defined in

src/domain/models/VerifiableCredential.ts:223

---

Signer

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

Type declaration

▸ (data): Promise<string>

Parameters

Name	Type
data	string | Uint8Array

Returns

Promise<string>

Defined in

src/domain/models/VerifiableCredential.ts:389

---

Verifier

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

Type declaration

▸ (data, sig): Promise<boolean>

Parameters

Name	Type
data	string
sig	string

Returns

Promise<boolean>

Defined in

src/domain/models/VerifiableCredential.ts:390

---

W3CVerifiableCredential

Ƭ W3CVerifiableCredential: Object

Type declaration

Name	Type
@context	[credential]
credentialSchema?	{ id: string ; type: string }
credentialSchema.id	string
credentialSchema.type	string
credentialStatus?	JWTRevocationStatus | unknown
credentialSubject	Record<string, any>
evidence?	{ id: string ; type: string }
evidence.id	string
evidence.type	string
expirationDate?	string
issuanceDate	string
issued?	string
issuer	string
refreshService?	{ id: string ; type: string }
refreshService.id	string
refreshService.type	string
termsOfUse?	{ id: string ; type: string }
termsOfUse.id	string
termsOfUse.type	string
type	[credential]
validFrom?	{ id: string ; type: string }
validFrom.id	string
validFrom.type	string
validUntil?	{ id: string ; type: string }
validUntil.id	string
validUntil.type	string

Defined in

src/domain/models/VerifiableCredential.ts:247

---

W3CVerifiablePresentation

Ƭ W3CVerifiablePresentation: Object

Type declaration

Name	Type
@context	[credential]
proof?	W3CVerifiablePresentationProof
type	[presentation]
verifiableCredential	string[]

Defined in

src/domain/models/VerifiableCredential.ts:373

---

W3CVerifiablePresentationProof

Ƭ W3CVerifiablePresentationProof: Object

Type declaration

Name	Type
challenge	string
domain	string

Defined in

src/domain/models/VerifiableCredential.ts:384

Functions

curveToAlg

▸ curveToAlg(curve): JWT_ALG

Parameters

Name	Type
curve	string

Returns

JWT_ALG

Defined in

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

---

getKeyCurveByNameAndIndex

▸ getKeyCurveByNameAndIndex(name, index?): KeyCurve

Parameters

Name	Type
name	string
index?	number

Returns

KeyCurve

Defined in

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

---

getProtosUsage

▸ getProtosUsage(usage): KeyUsage

Parameters

Name	Type
usage	Usage

Returns

KeyUsage

Defined in

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

---

getUsage

▸ getUsage(protosUsage): Usage

Parameters

Name	Type
protosUsage	KeyUsage

Returns

Usage

Defined in

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

---

getUsageFromId

▸ getUsageFromId(id): Object

Return usage from a verification method id

Parameters

Name	Type
id	string

Returns

Object

Name	Type
index	number
usage	Usage

Defined in

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

---

getUsageId

▸ getUsageId(keyUsage, index?): string

create an identifier for keys within a DID Document should be unique within the Document

Parameters

Name	Type	Default value	Description
keyUsage	Usage	undefined	maps to a prefix word
index	number	0	occurrence of this keyUsage

Returns

string

Defined in

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