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.

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

fix: Update image paths in design documentation #1878

Merged
merged 1 commit into from
Feb 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion designdocs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ There are three core data models in Frequency and each corresponds to a pallet.
- The metadata and payload or payload reference that a user sends that matches a particular schema.
- What and when a message is sent

![Basic Data Model drawio](https://github.com/LibertyDSNP/DesignDocs/blob/main/img/BasicDataModel.drawio.png?raw=true)
![Basic Data Model drawio](../docs/images/BasicDataModel.drawio.png?raw=true)

## Frequency Glossary

Expand Down
6 changes: 3 additions & 3 deletions designdocs/message_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ that will allow us to store these messages on chain.
Storing messages on chain using **BlockNumber** and **SchemaId** as main and secondary keys
using [StorageDoubleMap](https://paritytech.github.io/substrate/master/frame_support/storage/trait.StorageDoubleMap.html) data structure provided in Substrate.

![Data-Page-3 drawio](https://github.com/LibertyDSNP/DesignDocs/blob/main/img/main_storage_type.png?raw=true)
![Data-Page-3 drawio](../docs/images/main_storage_type.png?raw=true)


### Main Storage types
Expand Down Expand Up @@ -125,12 +125,12 @@ any messages, to eliminate unnecessary DB reads. We can use a BitArray per Schem
we would need to store this indexing data off-chain, and we can create jobs to create or update
it periodically.

![Data-OnChainAnnouncements drawio](https://github.com/LibertyDSNP/DesignDocs/blob/main/img/message_storage_bitvector.png?raw=true)
![Data-OnChainAnnouncements drawio](../docs/images/message_storage_bitvector.png?raw=true)
## Alternatives and Rationale
Storing messages on chain using a map of `schemaId` and `staring` index to a sequential fixed sized
bucket.

![Data-Page-2 drawio](https://github.com/LibertyDSNP/DesignDocs/blob/main/img/message_storage_alternative.png?raw=true)
![Data-Page-2 drawio](../docs/images/message_storage_alternative.png?raw=true)

### Main Storage types
- **Messages**
Expand Down
Binary file added docs/images/BasicDataModel.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/main_storage_type.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/message_storage_alternative.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/message_storage_bitvector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.