Skip to content

Commit

Permalink
render readme code blocks with json5
Browse files Browse the repository at this point in the history
  • Loading branch information
mxfactorial committed Sep 30, 2023
1 parent ec88edd commit 59bbb26
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ systemaccounting optimizes the flow of capital by expediting the discovery of ec

**q.** i dont find any words in here used by the media. what is this?
**a.** encryption solves access risk. replication solves single point of failure and inconsistency risk. neither of these solutions are relevant to modeling currency as an electric current. this payment application solves contemporary economic issues by replacing "monetary" policy with a natural physical law. first, currency is modeled as a lightweight, dual positive-negative structured time-series between creditors and debitors respectively. encryption and replication are secondary:
```json
```json5
{
"item": "bottled water",
"price": "1.000",
Expand Down Expand Up @@ -72,7 +72,7 @@ systemaccounting optimizes the flow of capital by expediting the discovery of ec
1. a `JacobWebb` systemaccount is created when the owner transfers `1,000` from their "Chase" account to the united states treasury account
1. `JacobWebb` visits the `GroceryStore` and brings a single `bottled water` priced at `1.000` (3 digit decimals used) to the cashier
1. the `GroceryStore` cashier authors a single entry list of `transaction_items` to be transacted. the `GroceryStore` account is set as the **creditor** (+) and the `JacobWebb` account is set as as **debitor** (-):
```json
```json5
[
{ // authored by GroceryStore cashier
"item": "bottled water",
Expand All @@ -86,7 +86,7 @@ systemaccounting optimizes the flow of capital by expediting the discovery of ec
]
```
1. the `GroceryStore` cashier first sends the `transaction_items` list to the `rule` service (see [detailed request & response](https://github.com/systemaccounting/mxfactorial/tree/develop/services/rule#request)) to check for any transaction automation rules that apply to the proposed transaction (taxes, approvals, etc) and receives a response with a creditor-approved state sales tax added to the `transaction_items` list:
```json
```json5
[
{
"item": "bottled water",
Expand All @@ -109,7 +109,7 @@ systemaccounting optimizes the flow of capital by expediting the discovery of ec
]
```
1. the `GroceryStore` cashier then sends the rule-applied transaction request to the `request-create` service (see [detailed request & response](https://github.com/systemaccounting/mxfactorial/tree/develop/services/request-create#request)) to 1) create a transaction request and 2) add an approval for the `GroceryStore` creditor:
```json
```json5
[ // added to database by request-create service
{
"item": "bottled water",
Expand All @@ -132,7 +132,7 @@ systemaccounting optimizes the flow of capital by expediting the discovery of ec
]
```
1. the `JacobWebb` customer receives a notification and sends their approval to the `request-approve` service (see [detailed request & response](https://github.com/systemaccounting/mxfactorial/tree/develop/services/request-approve#request))
```json
```json5
[
{
"item": "bottled water",
Expand Down
2 changes: 1 addition & 1 deletion scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ creates go mocks from list of interfaces inside `mock` subdirectory using [gomoc

1. set `.pkgs.lambdapg.mocked_interfaces` property under package or service in `project.yaml` to map of go package import paths and desired list of interfaces:

```json
```json5
"mocked_interfaces": {
"github.com/systemaccounting/mxfactorial/pkg/lambdapg": [
"Connector",
Expand Down
4 changes: 2 additions & 2 deletions services/request-approve/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

the `JacobWebb` customer approves all `transaction_items` in the `transaction` by sending the following `id` to the request-approve service:

```json
```json5
// graphql variable
{
"id": "3",
Expand All @@ -29,7 +29,7 @@ the `request-approve` service returns a `transaction` object with an `equilibriu

all account balances referenced in `transaction_items` are changed when a `transaction` has an `equilibrium_time` value

```json
```json5
{
"data": {
"approveRequest": {
Expand Down
4 changes: 2 additions & 2 deletions services/request-create/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

the `GroceryStore` cashier sends a `transaction_item` list to the request-create service:

```json
```json5
// graphql variable
{
"transaction_items": [
Expand Down Expand Up @@ -52,7 +52,7 @@ the `request-create` service:
1. creates the `transaction` request IF 0 missing `transaction_items` found
1. returns a `transaction` object with approvals **pending** from the debitor

```json
```json5
{
"data": {
"createRequest": {
Expand Down
4 changes: 2 additions & 2 deletions services/rule/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
1. the `JacobWebb` customer brings a single `bottled water` item priced at `1.000` to the `GroceryStore` cashier
1. the `GroceryStore` cashier sends the following `transaction_item` list to the rule service to apply rules required by a transaction between the `debitor` and `creditor` accounts:

```json
```json5
// graphql variable
[
{
Expand All @@ -35,7 +35,7 @@ the rule service returns a `transaction` object with `transaction_items` listing
1. rule added `transaction_items` and `approvals`
1. the initial `bottled water` transaction_item

```json
```json5
{
"auth_account": null,
"transaction": {
Expand Down

0 comments on commit 59bbb26

Please sign in to comment.