rafiki icon indicating copy to clipboard operation
rafiki copied to clipboard

Document the TigerBeetle usage in Rafiki

Open AlexLakatos opened this issue 3 years ago • 1 comments

  • [ ] 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.

AlexLakatos avatar Aug 23 '22 10:08 AlexLakatos

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

wilsonianb avatar Aug 25 '22 13:08 wilsonianb

@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.

sabineschaller avatar Feb 14 '23 09:02 sabineschaller

  • [x] 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
  • https://github.com/interledger/rafiki/pull/1191
  * [ ]  How do we upgrade TB in Rafiki?

I don't currently know the answer to this question :sweat_smile:

  • https://github.com/interledger/rafiki/pull/1181
  * [ ]  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/

wilsonianb avatar Mar 12 '23 18:03 wilsonianb

@wilsonianb If you promise to have another look at

  • #1181

I can take this.

sabineschaller avatar Mar 13 '23 12:03 sabineschaller