Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

minor fixes to the main readme #750

Merged
merged 1 commit into from
Feb 9, 2024
Merged

minor fixes to the main readme #750

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ https://dm3.readthedocs.io/en/doc-latest/

## Principles

- **Decentral**: An dm3 client must be realizable as a real decentral application and the messages must also be stored in a decentral way.
- **Open**: All parts of dm3 are open source and the protocol is permissionless. Everyone should be able to write an dm3 client.
- **Decentral**: A dm3 client must be realizable as a real decentral application and the messages must also be stored in a decentral way.
- **Open**: All parts of dm3 are open source and the protocol is permissionless. Everyone should be able to write a dm3 client.
- **Secure**: All messages are end-to-end encrypted and the encryption keys are only under the control of the user.

## Terminology

- **Ethereum Account Key**: The private key linked to an [Externally Owned Account](https://ethereum.org/en/whitepaper/#ethereum-accounts).
- **Message Encryption Key Pair**: The key pair used to encrypt/decrypt messages.
- **Signing Key Pair**: The key pair used to sign/verify messages.
- **Storage Encryption Key**: Synchronous key to encrypt the user storage. `keccak256(personalSignWithEthAccount(salt))`
- **Storage Encryption Key**: Symmetric key to encrypt the user storage. `keccak256(personalSignWithEthAccount(salt))`
- **Delivery Service**: The service that buffers messages until they are delivered.
- **Registry**: A decentral service (e.g. ENS) mapping Ethereum accounts to profile registry entry URLs (e.g. using text records).
- **Profile Registry Entry**: A resource containing properties linked to an Ethereum account that is using dm3. E.g. public keys, the delivery service URL and spam filter configuration.
Expand Down Expand Up @@ -57,7 +57,7 @@ The delivery service profile needs to be transformed into a data URI before it c
const profileJsonDataUri = createJsonDataUri(deliveryServiceProfileA);
```

The data URI of the profile must be published on-chain as ENS `network.dm3.deliveryService` text record on the delivery service ENS domain.
The data URI of the profile must be published on-chain as ENS `network.dm3.deliveryService` text record on the delivery service's ENS domain.

### Creating and Publishing User Profiles

Expand Down
Loading