flexfintx / issuer-verifier-sdk Goto Github PK

We would want the following functions (basically all except for the holder routes)

issueNewCredential(...)
getIssuedCredentials(...)
verifySignedCredential(...)
verifySignedPresentation(...)
generatePresentationRequest(...)

The missing endpoints we need to discuss are

/presentationSubmission
/polling/:callbackId

Motivation
Flex-IVAPI is a REST based API, but some knowledge about verifiable credentials and verifiable presentations is required to be able to use it properly. It is not very intuitive or developer friendly.

We want to solve that issue by creating an easy to use SDK as a node module which can just be imported by our customers in their project, where they can call simple functions which will deal with the IVAPI REST API in the background.

Features
To get a base version up and running, we can mimic the API word for word with no custom modifications. That is, we just pass whatever we would regularly send as part of the JSON body in the POST request to the function call - and it just calls the API in the background.

Design
We should follow a Class based OOP approach this as most SDK's do. I envision the final usage of the SDK to be something like

const ivapiClient = new IvapiSdk(ivapi_api_url);

const signedCredential = await ivapiClient.issueNewCredential(unsigned_credential);

Currently the SDK supports filtering based on id and type. Should support filtering based on credentialId and credentialName as well

blocked by https://github.com/FlexFinTx/flex-ivapi/issues/8