-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
# [6.1.0](v6.0.1...v6.1.0) (2024-09-12) ### Bug Fixes * bitstring improvement and test coverage ([#270](#270)) ([dce65b5](dce65b5)) * external build update for new generated code ([#264](#264)) ([460102a](460102a)) * main branchname in semantic release config ([#279](#279)) ([a6a72ff](a6a72ff)) * make mediator updateable in the nextjs demo ([#262](#262)) ([99df3c0](99df3c0)) * nextjs demo safeBody ([#263](#263)) ([0d09ea7](0d09ea7)) * noble-ciphers dependency ([#284](#284)) ([fabcc2c](fabcc2c)) * package dependencies found by mixmix ([#273](#273)) ([#275](#275)) ([82a50d3](82a50d3)) * rollup is not a optionalDependency, and is not included in our m… ([#269](#269)) ([9ea9d42](9ea9d42)) * update code-owners ([#281](#281)) ([b8409af](b8409af)) ### Features * Connectionless presentation ([#272](#272)) ([d43ec60](d43ec60)) * decoupling JWT from Pollux and adding KID header to JWTs ([#271](#271)) ([8a1ed3f](8a1ed3f)) * errors introducing error codes and refactoring Apollo errors ([#265](#265)) ([f99c565](f99c565))
- Loading branch information
1 parent
4715781
commit d8d84e6
Showing
296 changed files
with
2,536 additions
and
1,797 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
|
|
||
| # Identus TypeScript SDK | ||
|
|
||
| [](https://coveralls.io/github/input-output-hk/atala-prism-wallet-sdk-ts?branch=master) | ||
| [](https://coveralls.io/github/hyperledger/identus-edge-agent-sdk-ts?branch=master) | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -11,18 +11,19 @@ verifiable data and digital identity. Built on Cardano, as a distributed ledger, | |
| it offers core infrastructure for issuing DIDs (Decentralized identifiers) and | ||
| verifiable credentials, alongside tools and frameworks to help expand your ecosystem. | ||
| The complete platform is separated into multiple repositories: | ||
|
|
||
| * [Cloud Agent](https://github.com/hyperledger/identus-cloud-agent) - Repo that contains the Cloud Agent that provides self-sovereign identity services to build products and solutions. | ||
| * [Mediator](https://github.com/input-output-hk/atala-prism-mediator) - Repo for the DIDComm V2 Mediator. | ||
| * [Edge Agent SDK TS](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts) - Repo for the Typescript version of the SDK. | ||
| * [Edge Agent SDK Swift](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift) - Repo for the Swift version of the SDK. | ||
| * [Edge Agent SDK KMP](https://github.com/input-output-hk/atala-prism-wallet-sdk-kmm) - Repo for the Kotlin Multi-Platform version of the SDK. | ||
| * | ||
| * [Mediator](https://github.com/input-output-hk/identus-prism-mediator) - Repo for the DIDComm V2 Mediator. | ||
| * [Edge Agent SDK TS](https://github.com/hyperledger/identus-edge-agent-sdk-ts) - Repo for the Typescript version of the SDK. | ||
|
|
||
| We also have edge agents for other platforms: | ||
| * [Edge Agent SDK Swift](https://github.com/hyperledger/identus-edge-agent-sdk-swift) - Repo for the Swift version of the SDK. | ||
| * [Edge Agent SDK KMP](https://github.com/hyperledger/identus-edge-agent-sdk-kmp) - Repo for the Kotlin Multi-Platform version of the SDK. | ||
|
|
||
| ## SDK Overview | ||
|
|
||
| - Apollo: Provides a suite of necessary cryptographic operations. | ||
| - Castor: Provides a suite of operations to create, manage and resolve decentralized identifiers. | ||
| - Pollux: Provides a suite of operations for handling [verifiable credentials](https://github.com/input-output-hk/atala-prism-docs/blob/master/documentation/docs/concepts/glossary.md#verifiable-credentials). | ||
| - Pollux: Provides a suite of operations for handling [verifiable credentials](https://github.com/hyperledger/identus-docs/blob/master/documentation/docs/concepts/glossary.md#verifiable-credentials). | ||
| - Mercury: Provides a suite of operations for handling DIDComm V2 messages. | ||
| - Pluto: Provides an interface for storage operations in a portable, storage-agnostic manner. | ||
| - Agent: A component using all other building blocks, provides basic edge agent capabilities, including implementing DIDComm V2 protocols. | ||
|
|
@@ -35,7 +36,7 @@ This repository includes a browser and a Node.js demo application, and also a st | |
| You can install and use this library in browsers and nodejs. | ||
|
|
||
| ```bash | ||
| npm i @atala/prism-wallet-sdk --save | ||
| npm i @hyperledger/identus-edge-agent-sdk --save | ||
| ``` | ||
|
|
||
| or with yarn | ||
|
|
@@ -55,10 +56,10 @@ This repository contains compiles typescript code and some rust dependencies for | |
|
|
||
| Clone the repository | ||
| ``` | ||
| git clone [email protected]:input-output-hk/atala-prism-wallet-sdk-ts.git --recruse-submodules | ||
| git clone [email protected]:hyperledger/identus-edge-agent-sdk-ts.git --recruse-submodules | ||
| ``` | ||
|
|
||
| To be able to run the demos, we have to build `prism-wallet-sdk`. | ||
| To be able to run the demos, we have to build `identus-edge-agent-sdk-ts`. | ||
| From the repository root run: | ||
|
|
||
| ```bash | ||
|
|
@@ -88,13 +89,14 @@ Browser NextJS | |
| ```bash | ||
| cd demos/next | ||
| npm i | ||
| npm run build # becuase Error: ENOENT: no such file or directory, open '/.../atala-prism-wallet-sdk-ts/demos/next/.next/BUILD_ID'] | ||
| npm run build # becuase Error: ENOENT: no such file or directory, open '/.../identus-edge-agent-sdk-ts/demos/next/.next/BUILD_ID'] | ||
| npm run start | ||
| ``` | ||
|
|
||
| ### Implementing storage for the SDK | ||
| This SDK exposes Pluto, a storage interface that should be implemented by the user, in the most appropriate way for a particular use case. | ||
|
|
||
| We don't provide a default implementation out of the box at the moment, but we do provide a couple of demo implementations that can be used to get started with demos and testing. | ||
| This SDK exposes Pluto, which manages data schemas, migrations for you, but requires a Pluto.Store which needs to be implemented by the user, as this is particular to your use case. | ||
|
|
||
| Provided demo implementations are intentionally oversimplified and **should not** be used in production. | ||
|
|
||
| Example community implementations: | ||
| - [atala-community-projects/pluto-encrypted](https://github.com/atala-community-projects/pluto-encrypted): InMemory, IndexDB, LevelDB, as well as a test-suite to help you build your own. | ||
Oops, something went wrong.
d8d84e6There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
JUnit