Skip to main content

SDJWT

@hyperledger/identus-sdk v7.0.0


@hyperledger/identus-sdk / overview / SDJWT

Class: SDJWT

Defined in: src/pollux/utils/jwt/SDJWT.ts:28

used to enable Modules to propagate the Context and have access to runTask

Extends

Constructors

Constructor

new SDJWT(): SDJWT

Returns

SDJWT

Inherited from

Runner.constructor

Methods

clone()

clone(): SDJWT

Defined in: src/pollux/utils/jwt/SDJWT.ts:29

Returns

SDJWT

Overrides

Runner.clone


createPresentationFor()

createPresentationFor<T>(options: { jws: string; presentationFrame?: PFrame<T>; privateKey: PrivateKey; }): Promise<string>

Defined in: src/pollux/utils/jwt/SDJWT.ts:97

Type Parameters

Type Parameter
T extends SdJwtVcPayload

Parameters

ParameterType
options{ jws: string; presentationFrame?: PFrame<T>; privateKey: PrivateKey; }
options.jwsstring
options.presentationFrame?PFrame<T>
options.privateKeyPrivateKey

Returns

Promise<string>


decode()

decode(jws: string): DecodedSDJwt

Defined in: src/pollux/utils/jwt/SDJWT.ts:33

Parameters

ParameterType
jwsstring

Returns

DecodedSDJwt


getPKConfig()

getPKConfig(publicKey: PublicKey): SDJWTVCConfig

Defined in: src/pollux/utils/jwt/SDJWT.ts:117

Parameters

ParameterType
publicKeyPublicKey

Returns

SDJWTVCConfig


getSKConfig()

getSKConfig(privateKey: PrivateKey): SDJWTVCConfig

Defined in: src/pollux/utils/jwt/SDJWT.ts:151

Parameters

ParameterType
privateKeyPrivateKey

Returns

SDJWTVCConfig


reveal()

reveal(disclosedPayload: Record<string, unknown>, disclosures: Disclosure<unknown>[]): Promise<unknown>

Defined in: src/pollux/utils/jwt/SDJWT.ts:106

Parameters

ParameterType
disclosedPayloadRecord<string, unknown>
disclosuresDisclosure<unknown>[]

Returns

Promise<unknown>


sign()

sign<E>(options: { disclosureFrame: DisclosureFrame<E>; issuerDID: DID; kid?: string; payload: E; privateKey?: PrivateKey; }): Promise<string>

Defined in: src/pollux/utils/jwt/SDJWT.ts:37

Type Parameters

Type Parameter
E extends SdJwtVcPayload

Parameters

ParameterType
options{ disclosureFrame: DisclosureFrame<E>; issuerDID: DID; kid?: string; payload: E; privateKey?: PrivateKey; }
options.disclosureFrameDisclosureFrame<E>
options.issuerDIDDID
options.kid?string
options.payloadE
options.privateKey?PrivateKey

Returns

Promise<string>


verify()

verify(options: { issuerDID: DID; jws: string; requiredClaimKeys?: string[]; requiredKeyBindings?: boolean; }): Promise<boolean>

Defined in: src/pollux/utils/jwt/SDJWT.ts:53

Parameters

ParameterType
options{ issuerDID: DID; jws: string; requiredClaimKeys?: string[]; requiredKeyBindings?: boolean; }
options.issuerDIDDID
options.jwsstring
options.requiredClaimKeys?string[]
options.requiredKeyBindings?boolean

Returns

Promise<boolean>


withContext()

withContext(ctx: Context): Runner

Defined in: src/utils/tasks.ts:103

Parameters

ParameterType
ctxContext

Returns

Runner

Inherited from

Runner.withContext