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

Document the TigerBeetle usage in Rafiki #498

Closed
2 of 8 tasks
AlexLakatos opened this issue Aug 23, 2022 · 4 comments · Fixed by #1224
Closed
2 of 8 tasks

Document the TigerBeetle usage in Rafiki #498

AlexLakatos opened this issue Aug 23, 2022 · 4 comments · Fixed by #1224
Assignees
Labels
type: documentation (archived) Improvements or additions to documentation
Milestone

Comments

@AlexLakatos
Copy link
Member

AlexLakatos commented Aug 23, 2022

  • What is TigerBeetle (from a non-developer perspective)?
  • Why are we using TB?
  • How are we using TB in Rafiki?
    • Document the Chart of Accounts
    • Document the flows that use TB
    • How do we upgrade TB in Rafiki?
    • Running a TB cluster & requirements
      • Describe the consensus, limitations, and strategies for designing your TB cluster.
@wilsonianb
Copy link
Contributor

What is TigerBeetle (from a non-developer perspective)?

https://github.com/coilhq/tigerbeetle
TigerBeetle is a financial accounting database designed for mission critical safety and performance to power the future of financial services.

Document the Chart of Accounts

https://github.com/interledger/rafiki/tree/main/packages/backend#design

How do we upgrade TB in Rafiki?

pnpm --filter backend add -P tigerbeetle-node
https://github.com/interledger/rafiki/blob/main/packages/backend/package.json#L89
https://www.npmjs.com/package/tigerbeetle-node

@sabineschaller
Copy link
Member

@wilsonianb

https://github.com/interledger/rafiki/tree/main/packages/backend#design

I think this needs a bit more explanation.

pnpm --filter backend add -P tigerbeetle-node

That's not all of it, at least right now.

@wilsonianb
Copy link
Contributor

  • What is TigerBeetle (from a non-developer perspective)?

https://github.com/interledger/rafiki/blob/main/docs/glossary.md#tigerbeetle

* [ ]  Why are we using TB?

TODO?

* [ ]  How are we using TB in Rafiki?
  
  * [x]  Document the Chart of Accounts
  * [ ]  Document the flows that use TB
  * [ ]  How do we upgrade TB in Rafiki?

I don't currently know the answer to this question 😅

  * [ ]  Running a TB cluster & requirements
    
    * [ ]  Describe the consensus, limitations, and strategies for designing your TB cluster.

I vote we defer to https://docs.tigerbeetle.com/

@sabineschaller
Copy link
Member

@wilsonianb If you promise to have another look at

I can take this.

@sabineschaller sabineschaller self-assigned this Mar 14, 2023
@github-project-automation github-project-automation bot moved this to Done in Rafiki Mar 16, 2023
@huijing huijing added the type: documentation (archived) Improvements or additions to documentation label Oct 30, 2023
@github-project-automation github-project-automation bot moved this to Backlog in Rafiki Oct 30, 2023
@sabineschaller sabineschaller moved this from Backlog to Done in Rafiki Feb 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation (archived) Improvements or additions to documentation
Projects
Archived in project
Status: Done
Status: Done
Development

Successfully merging a pull request may close this issue.

5 participants