Description
The SDK has different key purposes (ISSUING_KEY, AUTHENTICATION_KEY) used for DID verification, but new contributors (especially those learning about Self-Sovereign Identity) may not understand:
- What are verification relationships? (authentication, assertionMethod, etc.)
- Why do we need different key purposes?
- When should each be used?
- How do they relate to DID documents?
Goal
Add inline documentation/comments to key files explaining:
- DID verification relationships and their purpose
- The relationship between
ISSUING_KEY and assertionMethod
- The relationship between
AUTHENTICATION_KEY and authentication
- Why this matters for SSI/Web3 identity flows
Files to Document
These files are referenced in key identity operations:
packages/lib/sdk/src/edge-agent/didFunctions/FindDIDSigningKeys.ts
packages/lib/sdk/src/pollux/utils/jwt/CreateJwt.ts
packages/lib/sdk/src/pollux/utils/jwt/CreateSDJWT.ts
Acceptance Criteria
Learning Resources to Reference
This would be great for someone learning about DIDs and SSI!
Description
The SDK has different key purposes (
ISSUING_KEY,AUTHENTICATION_KEY) used for DID verification, but new contributors (especially those learning about Self-Sovereign Identity) may not understand:Goal
Add inline documentation/comments to key files explaining:
ISSUING_KEYandassertionMethodAUTHENTICATION_KEYandauthenticationFiles to Document
These files are referenced in key identity operations:
packages/lib/sdk/src/edge-agent/didFunctions/FindDIDSigningKeys.tspackages/lib/sdk/src/pollux/utils/jwt/CreateJwt.tspackages/lib/sdk/src/pollux/utils/jwt/CreateSDJWT.tsAcceptance Criteria
Learning Resources to Reference
This would be great for someone learning about DIDs and SSI!