Skip to content

Commit

Permalink
update name
Browse files Browse the repository at this point in the history
  • Loading branch information
apratt3377 committed Nov 13, 2024
1 parent 2f61288 commit 016ee36
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Onyx SSI SDK
Kinexys SSI SDK
Copyright 2023 J.P. Morgan Chase & Co.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### NOTE - All hackathon submissions for the Digital Identity Hackathon (Sept 12 - Oct 8) need to be sent to the hackathon organizer, Encode club. PRs will not be considered as offical submissions for the Digital Identity hackathon.

# Onyx SSI SDK
# Kinexys SSI SDK

Create SSI Ecosystems following W3C Standards for [Verifiable Credentials](https://www.w3.org/TR/vc-data-model/) and [DIDs](https://www.w3.org/TR/did-core/)

Expand All @@ -18,7 +18,7 @@ Create SSI Ecosystems following W3C Standards for [Verifiable Credentials](https
### Installation

``` shell
npm install @jpmorganchase/onyx-ssi-sdk
npm install @jpmorganchase/Kinexys-ssi-sdk
```

### Build
Expand All @@ -42,17 +42,17 @@ npx hardhat test
```

## Navigating the SDK
* [DID Management](https://github.com/jpmorganchase/onyx-ssi-sdk/tree/main/src/services/common/did): Create, Resolve, Update, and Delete the 2 supported DID Methods (did:key and did:ethr)
* [Credential Schema Management](https://github.com/jpmorganchase/onyx-ssi-sdk/tree/main/src/services/common/schemas): Example of 4 Credential Types and their schemas as well as helper methods for Schema Management
* [JWT Signatures](https://github.com/jpmorganchase/onyx-ssi-sdk/tree/main/src/services/common/signatures): Sign Verifiable Credentials as JWTs
* [Issuer](https://github.com/jpmorganchase/onyx-ssi-sdk/tree/main/src/services/issuer): All functionality required to be a Credential Issuer
* [Holder](https://github.com/jpmorganchase/onyx-ssi-sdk/tree/main/src/services/holder): All functionality required to be a Credential Holder
* [Verifier](https://github.com/jpmorganchase/onyx-ssi-sdk/tree/main/src/services/verifier): All functionality to perform basic Credential verification
* [KeyUtils](https://github.com/jpmorganchase/onyx-ssi-sdk/blob/main/src/utils/KeyUtils.ts): Helper functions for SDK supported keys
* [DID Management](https://github.com/jpmorganchase/Kinexys-ssi-sdk/tree/main/src/services/common/did): Create, Resolve, Update, and Delete the 2 supported DID Methods (did:key and did:ethr)
* [Credential Schema Management](https://github.com/jpmorganchase/Kinexys-ssi-sdk/tree/main/src/services/common/schemas): Example of 4 Credential Types and their schemas as well as helper methods for Schema Management
* [JWT Signatures](https://github.com/jpmorganchase/Kinexys-ssi-sdk/tree/main/src/services/common/signatures): Sign Verifiable Credentials as JWTs
* [Issuer](https://github.com/jpmorganchase/Kinexys-ssi-sdk/tree/main/src/services/issuer): All functionality required to be a Credential Issuer
* [Holder](https://github.com/jpmorganchase/Kinexys-ssi-sdk/tree/main/src/services/holder): All functionality required to be a Credential Holder
* [Verifier](https://github.com/jpmorganchase/Kinexys-ssi-sdk/tree/main/src/services/verifier): All functionality to perform basic Credential verification
* [KeyUtils](https://github.com/jpmorganchase/Kinexys-ssi-sdk/blob/main/src/utils/KeyUtils.ts): Helper functions for SDK supported keys

## Full SSI Ecosystem Example

For examples of how to use the SDK, check out our [onyx-ssi-sdk-examples repo](https://github.com/jpmorganchase/onyx-ssi-sdk-examples)
For examples of how to use the SDK, check out our [Kinexys-ssi-sdk-examples repo](https://github.com/jpmorganchase/Kinexys-ssi-sdk-examples)

Below code shows the VC Creation, VP Presentation and Verification of W3C Credential/Presentation.

Expand Down Expand Up @@ -145,8 +145,8 @@ As part of the hackathon we are offering 5 challenges to help improve our SDK.
To participate in these challenges please fork this repo, implement your changes, and submit your branch to Encode. We are not accepting PRs on this repo through the duration of the hackathon.
* [DIDs](https://github.com/jpmorganchase/onyx-ssi-sdk/blob/dids-hackathon/src/services/common/did/DIDS.md): Add support for a new DID method or support the Universal Resolver
* [JSON-LD Credentials](https://github.com/jpmorganchase/onyx-ssi-sdk/blob/jsonld-hackathon/src/services/common/schemas/JSONLD.md): Provide support for JSON-LD Credentials
* [Revocation](https://github.com/jpmorganchase/onyx-ssi-sdk/blob/revocation-hackathon/src/services/common/revocation/README.md): Implement a new Credential Revocation scheme
* [SD-JWT](https://github.com/jpmorganchase/onyx-ssi-sdk/blob/sdjwt-hackathon/src/services/common/signatures/SDJWT.md): Implement the emerging SD-JWT spec for selective disclosure
* [Communication](https://github.com/jpmorganchase/onyx-ssi-sdk/blob/oidc-hackathon/src/services/communication/oidc/README.md): Implement support for OIDC, DIDComm or Presentation Exchange
* [DIDs](https://github.com/jpmorganchase/Kinexys-ssi-sdk/blob/dids-hackathon/src/services/common/did/DIDS.md): Add support for a new DID method or support the Universal Resolver
* [JSON-LD Credentials](https://github.com/jpmorganchase/Kinexys-ssi-sdk/blob/jsonld-hackathon/src/services/common/schemas/JSONLD.md): Provide support for JSON-LD Credentials
* [Revocation](https://github.com/jpmorganchase/Kinexys-ssi-sdk/blob/revocation-hackathon/src/services/common/revocation/README.md): Implement a new Credential Revocation scheme
* [SD-JWT](https://github.com/jpmorganchase/Kinexys-ssi-sdk/blob/sdjwt-hackathon/src/services/common/signatures/SDJWT.md): Implement the emerging SD-JWT spec for selective disclosure
* [Communication](https://github.com/jpmorganchase/Kinexys-ssi-sdk/blob/oidc-hackathon/src/services/communication/oidc/README.md): Implement support for OIDC, DIDComm or Presentation Exchange
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jpmorganchase/onyx-ssi-sdk",
"name": "@jpmorganchase/Kinexys-ssi-sdk",
"version": "0.0.1",
"description": "SSI SDK for Onyx W3C Verifiable Credentials",
"description": "SSI SDK for Kinexys W3C Verifiable Credentials",
"license": "Apache-2.0",
"source": "src/index.ts",
"types": "./lib/cjs/types/index.d.ts",
Expand All @@ -26,7 +26,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/jpmorganchase/onyx-ssi-sdk"
"url": "https://github.com/jpmorganchase/Kinexys-ssi-sdk"
},
"scripts": {
"clean": "rm -rf ./lib",
Expand Down
2 changes: 1 addition & 1 deletion src/services/common/schemas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Please make sure that the Verifier code can access the URI location of the schem

### Future Improvements

Currently schema definitions are defined in the definitions folder of the SDK. Depending on use case needs, the Onyx SDK will provide options for registering schemas publicly (either on chain or in a hosted location).
Currently schema definitions are defined in the definitions folder of the SDK. Depending on use case needs, the Kinexys SDK will provide options for registering schemas publicly (either on chain or in a hosted location).

The current JSON Schema used is [draft-07](https://json-schema.org/specification-links.html#draft-7) and the SDK uses [`jsonschema`](https://github.com/tdegrunt/jsonschema) to validate these schemas. The W3C is working on a new [spec](https://www.w3.org/TR/vc-json-schema/) for Credential Schemas. Once this is finalized, this SDK will provide support for that spec as the default.

Expand Down
4 changes: 2 additions & 2 deletions src/services/issuer/credential.ts
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,9 @@ export async function createAndSignCredentialJWT(
}

/**
* This method deactivates an Onyx Verifiable Credential
* This method deactivates an Kinexys Verifiable Credential
*
* Onyx revocable credentials require the VC to have a DID registered on the DIDRegistry.
* Kinexys revocable credentials require the VC to have a DID registered on the DIDRegistry.
* Revocation involves the Issuer deactivating this DID to revoke the Credential
*
* @param vcDID the DID of the Verifiable Credential to be revoked
Expand Down
2 changes: 1 addition & 1 deletion src/services/verifier/verification.ts
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ export function verifyIssuanceDate(vc: VerifiableCredential): boolean {


/**
* Verify the revocation status of an Onyx revocable Verifiable Credential
* Verify the revocation status of an Kinexys revocable Verifiable Credential
*
* True if VC not revoked, false if revoked
*
Expand Down

0 comments on commit 016ee36

Please sign in to comment.