Skip to content

Commit

Permalink
docs: smaller adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
Kammerlo committed Mar 4, 2025
1 parent 77e0595 commit 025ce6c
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Reeve, also known as Ledger on the Blockchain (LOB), empowers organizations to s
## Project Overview
The LOB platform is designed to integrate traditional accounting systems with blockchain technology, ensuring transparency, immutability, and enhanced security for financial records. By leveraging the Cardano blockchain, the platform offers a decentralized approach to financial data management, facilitating trust and efficiency in accounting processes.

Learn more about Reeve: [Reeve - Ledger on the Blockchain](https://www.cardanofoundation.org/blog/boosting-transparency-on-chain-financial-report)
### Key Features
- **Streamlined Audits:** Simplifies the audit process by providing a single source of truth for financial information
- **Strengthened Accountability:** Creates an immutable and transparent record of all financial activities, holding accountable for their actions and decisions
Expand Down
15 changes: 12 additions & 3 deletions docs/dataflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ Since it is a complex system, we will break it down into smaller parts and demon
The ERP extraction flow is triggered by the frontend.
It is used to extract transaction for a specific period of time from the ERP system.
These data will be stored in the database.
![erp-extraction-flow.png](images/erp-extraction-flow.png)

<p align="center">
<img src="images/erp-extraction-flow.png" height="800">
</p>

### Blockchain Publishing
The blockchain publishing is the job which runs periodically within the `blockchain_publisher` module.
Expand All @@ -16,9 +19,15 @@ Beforehand the `application_core` needs to approve reports and/or transactions a
#### Dispatching of Reports
Reports can be a balance sheet, income statement, or any other financial report.
The data of a report fits in one transaction, such that transaction chaining is not needed.
![report-dispatching.png](images/report-dispatching.png)

<p align="center">
<img src="images/report-dispatching.png" height="800">
</p>

### Dispatching of Transactions
Since it can be an arbitrary number of transactions, the transactions are dispatched in batches.
The `blockchain_publisher` module will dispatch the transactions in batches, such that the Blocksize of the blockchain is used efficiently.
![transaction-dispatching.png](images/transaction-dispatching.png)

<p align="center">
<img src="images/transaction-dispatching.png" height="800">
</p>
2 changes: 1 addition & 1 deletion docs/onChainFormat.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The type is an identifier for the specific transaction type. From this type more
}
```

Currently we are using the following types:
Currently we are supporting the following types:
- `INDIVIDUAL_TRANSACTIONS`
- `REPORT`

Expand Down

0 comments on commit 025ce6c

Please sign in to comment.