-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): add more documentation and fix others
- Loading branch information
1 parent
07efc8b
commit c89b429
Showing
30 changed files
with
858 additions
and
98 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
File renamed without changes.
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
21 changes: 21 additions & 0 deletions
21
AtalaPrismSDK/AtalaPrismSDK/Sources/AtalaPrismSDK.docc/BuildingBlocks.md
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# BuildingBlocks | ||
|
||
The building blocks are the core components of Atala PRISM and they are designed to work together seamlessly to provide a comprehensive identity management solution. | ||
|
||
## Overview | ||
|
||
Each building block serves a specific purpose, and together they provide a solid foundation for building decentralized identity applications. | ||
|
||
Let's take a closer look at each building block: | ||
|
||
- [Apollo](apollo.html): Apollo is a building block that provides a suite of cryptographic operations. This includes secure hash algorithms, digital signatures, and encryption, which are all essential for creating a secure and tamper-proof identity system. Apollo ensures that all data within the Atala PRISM system is securely encrypted and digitally signed, making it resistant to tampering and unauthorized access. | ||
- [Castor](castor.html): Castor is a building block that provides a suite of decentralized identifier (DID) operations in a user-controlled manner. DIDs are a key component of decentralized identity, as they provide a way to uniquely identify individuals and entities in a decentralized manner. Castor allows users to create, manage, and control their DIDs and associated cryptographic keys. | ||
- [Pollux](pollux.html): Pollux is a building block that provides a suite of credential operations in a privacy-preserving manner. Credentials are a way to prove claims about an individual or entity, and they are an important part of decentralized identity. Pollux allows users to create, manage, and share credentials in a privacy-preserving way, using zero-knowledge proofs to ensure that sensitive information is not revealed. | ||
- [Mercury](mercury.html): Mercury is a building block that provides a set of secure, standards-based communications protocols in a transport-agnostic and interoperable manner. Mercury allows different components of Atala PRISM to communicate with each other securely, using standard protocols such as HTTP, WebSocket, and MQTT. | ||
- [Pluto](pluto.html): Pluto is a building block that provides an interface for storage operations in a portable, storage-agnostic manner. Pluto allows data to be stored and retrieved in a way that is independent of the underlying storage technology, allowing Atala PRISM to work with a variety of storage solutions. | ||
|
||
Together, these building blocks provide a solid foundation for building decentralized identity applications that are secure, privacy-preserving, and interoperable. By using Atala PRISM, developers can focus on building innovative identity solutions without having to worry about the underlying infrastructure. | ||
|
||
## Prism Agent | ||
|
||
Prism Agent is a comprehensive library that brings together all the building blocks of the Prism platform - Apollo, Castor, Pluto, Mercury, and Pollux - to provide a seamless experience for developers working with decentralized identifiers (DIDs) on the Prism platform. |
13 changes: 13 additions & 0 deletions
13
AtalaPrismSDK/AtalaPrismSDK/Sources/AtalaPrismSDK.docc/ModularApproach.md
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 |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Modular Approach | ||
|
||
A modular approach is an essential part of the Atala PRISM architecture. It allows each building block to operate independently of each other, reducing indirect dependencies between components. To achieve this, Atala PRISM uses protocols-oriented programming, domain-oriented programming, and dependency injection. | ||
|
||
## Overview | ||
|
||
For example, Castor, which provides decentralized identifier (DID) operations, depends on the Apollo protocol for cryptographic operations. However, it doesn't depend on the Apollo implementation or module directly. Instead, it depends on the Domain module, which defines the Apollo protocol. This separation of concerns allows for better maintainability and flexibility of the Atala PRISM architecture. | ||
|
||
The Atala PRISM SDK provides implementations for each of the building blocks, but the architecture decision was made to allow developers to create their own implementations of a building block. This means that developers can customize and extend the functionality of the building blocks to suit their specific needs. | ||
|
||
For instance, Pluto is the storage module within the Atala PRISM SDK, and its implementation uses CoreData and Keychain to securely store data. However, if a developer wants to use their own implementation of Pluto, they can do so and still use the rest of the SDK. This approach allows developers to choose the storage solution that best suits their use case, without being tied to a specific implementation within the Atala PRISM SDK. | ||
|
||
Overall, the modular approach of Atala PRISM architecture provides developers with flexibility, extensibility, and maintainability, allowing them to create innovative decentralized identity solutions with ease. |
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
File renamed without changes.
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
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
Oops, something went wrong.