tigerbeetle-node 0.8.0 → 0.8.1

package/README.md

@@ -20,40 +20,6 @@ or
 npm install tigerbeetle-node
 ```
 
-**Development**
-
-Follow these steps to get up and running when cloning the repo:
-```shell
-git clone --recurse-submodules https://github.com/coilhq/tigerbeetle-node.git
-cd tigerbeetle-node/
-yarn install --immutable
-```
-
-Build locally using `yarn`:
-```shell
-# Run the following from this directory:
-yarn && yarn build
-```
- 
-* **Please note: `yarn clean` will remove Zig and NodeAPI C headers, which mean you need to run:**
-```shell
-./scripts/postinstall.sh #Install Zig and NodeJS C Headers
-```
-
-***Yarn - Run Test***
-Ensure TigerBeetle (`init` & `start`) is running on the port configured in `test.ts`, then run:
-```shell
-./tigerbeetle init --cluster=1 --replica=0 --directory=.
-./tigerbeetle start --cluster=1 --replica=0 --directory=. --addresses=3001
-yarn test
-```
-
-***Yarn - Run Benchmark***
-Run the benchmark (The `benchmark` will automatically start TigerBeetle on port `3001` _(single replica)_:
-```shell
-yarn benchmark
-```
-
 ## Usage
 A client needs to be configured with a `cluster_id` and `replica_addresses`. 
 This instantiates the client where memory is allocated to internally buffer events to be sent. 
@@ -121,7 +87,7 @@ The creation of an account can be linked to the successful creation of another b
   flags |= CreateAccountFlags.debits_must_not_exceed_credits
 ```
 
-### Account lookup
+### Account Lookup
 
 The `id` of the account is used for lookups. Only matched accounts are returned.
 ```js
@@ -145,7 +111,7 @@ The `id` of the account is used for lookups. Only matched accounts are returned.
    */
 ```
 
-### Creating a transfer
+### Creating a Transfer
 
 This creates a journal entry between two accounts.
 ```js
@@ -191,7 +157,7 @@ Transfers within a batch may also be linked (see [linked events](#linked-events)
   flags |= TransferFlags.pending
 ```
 
-### Post a Pending transfer (2-phase)
+### Post a Pending Transfer (2-Phase)
 
 With `flags = post_pending_transfer`, TigerBeetle will accept the transfer. TigerBeetle will atomically rollback the changes to `debits_pending` and `credits_pending` of the appropriate accounts and apply them to the `debits_posted` and `credits_posted` balances.
 ```js
@@ -204,7 +170,7 @@ const post = {
 const errors = await client.createTransfers([post])
 ```
 
-### Linked events
+### Linked Events
 
 When the `linked` flag is specified for the `createAccount`, `createTransfer`, `commitTransfer` event, it links an event with the next event in the batch, to create a chain of events, of arbitrary length, which all succeed or fail together. The tail of a chain is denoted by the first event without this flag. The last event in a batch may therefore never have the `linked` flag set as this would leave a chain open-ended. Multiple chains or individual events may coexist within a batch to succeed or fail independently. Events within a chain are executed within order, or are rolled back on error, so that the effect of each event in the chain is visible to the next, and so that the chain is either visible or invisible as a unit to subsequent events after the chain. The event that was the first to break the chain will have a unique error result. Other events in the chain will have their error result set to `linked_event_failed`.
 
@@ -248,3 +214,37 @@ const errors = await client.createTransfers(batch)
  * ]
  */
 ```
+
+### Development
+
+Follow these steps to get up and running when cloning the repo:
+```shell
+git clone --recurse-submodules https://github.com/coilhq/tigerbeetle-node.git
+cd tigerbeetle-node/
+yarn install --immutable
+```
+
+Build locally using `yarn`:
+```shell
+# Run the following from this directory:
+yarn && yarn build
+```
+
+* **Please note: `yarn clean` will remove Zig and NodeAPI C headers, which mean you need to run:**
+```shell
+./scripts/postinstall.sh #Install Zig and NodeJS C Headers
+```
+
+***Yarn - Run Test***
+Ensure TigerBeetle (`init` & `start`) is running on the port configured in `test.ts`, then run:
+```shell
+./tigerbeetle init --cluster=1 --replica=0 --directory=.
+./tigerbeetle start --cluster=1 --replica=0 --directory=. --addresses=3001
+yarn test
+```
+
+***Yarn - Run Benchmark***
+Run the benchmark (The `benchmark` will automatically start TigerBeetle on port `3001` _(single replica)_:
+```shell
+yarn benchmark
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tigerbeetle-node",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "TigerBeetle Node.js client",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

package/scripts/download_node_headers.sh

@@ -12,7 +12,9 @@ HEADERS_TARBALL=./build/`basename "$HEADERS_URL"`
 # Download, making sure we download to the same output document, without wget adding "-1" etc. if the file was previously partially downloaded:
 echo "Downloading $HEADERS_URL..."
 if command -v wget &> /dev/null; then
-    wget --quiet --show-progress --output-document=$HEADERS_TARBALL $HEADERS_URL
+    # -4 forces `wget` to connect to ipv4 addresses, as ipv6 fails to resolve on certain distros.
+    # Only A records (for ipv4) are used in DNS:
+    wget -4 --quiet --show-progress --output-document=$HEADERS_TARBALL $HEADERS_URL
 else
     curl --silent --progress-bar --output $HEADERS_TARBALL $HEADERS_URL
 fi

package/src/node.zig

@@ -691,7 +691,7 @@ fn on_result(user_data: u128, operation: Operation, results: Client.Error![]cons
 
     if (results) |value| {
         const napi_results = switch (operation) {
-            .reserved, .init, .register => {
+            .reserved, .root, .register => {
                 translate.throw(env, "Reserved operation.") catch return;
             },
             .create_accounts => encode_napi_results_array(

package/src/tigerbeetle/scripts/benchmark.bat

@@ -1,46 +1,46 @@
-@echo off
-setlocal enabledelayedexpansion
-
-if "%~1" equ ":main" (
-    shift /1
-    goto main
-)
-
-cmd /d /c "%~f0" :main %*
-set ZIG_RESULT=%ERRORLEVEL%
-taskkill /F /IM tigerbeetle.exe >nul
-
-if !ZIG_RESULT! equ 0 (
-    del /f benchmark.log
-) else (
-    echo.
-    echo Error running benchmark, here are more details
-    type benchmark.log
-)
-
-echo.
-exit /b
-
-:main
-zig\zig.exe build -Drelease-safe
-move zig-out\bin\tigerbeetle.exe . >nul
-
-for /l %%i in (0, 1, 0) do (
-    echo Initializing replica %%i
-    set ZIG_FILE=.\cluster_0000000000_replica_00%%i.tigerbeetle
-    if exist "!ZIG_FILE!" DEL /F "!ZIG_FILE!"
-    .\tigerbeetle.exe init --directory=. --cluster=0 --replica=%%i > benchmark.log 2>&1
-)
-
-for /l %%i in (0, 1, 0) do (
-    echo Starting replica %%i
-    start /B "tigerbeetle_%%i" .\tigerbeetle.exe start --directory=. --cluster=0 --addresses=3001 --replica=%%i > benchmark.log 2>&1
-)
-
-rem Wait for replicas to start, listen and connect:
-timeout /t 2
-
-echo.
-echo Benchmarking...
-zig\zig.exe run -OReleaseSafe src\benchmark.zig
-exit /b %errorlevel%
+@echo off
+setlocal enabledelayedexpansion
+
+if "%~1" equ ":main" (
+    shift /1
+    goto main
+)
+
+cmd /d /c "%~f0" :main %*
+set ZIG_RESULT=%ERRORLEVEL%
+taskkill /F /IM tigerbeetle.exe >nul
+
+if !ZIG_RESULT! equ 0 (
+    del /f benchmark.log
+) else (
+    echo.
+    echo Error running benchmark, here are more details
+    type benchmark.log
+)
+
+echo.
+exit /b
+
+:main
+zig\zig.exe build -Drelease-safe
+move zig-out\bin\tigerbeetle.exe . >nul
+
+for /l %%i in (0, 1, 0) do (
+    echo Initializing replica %%i
+    set ZIG_FILE=.\cluster_0000000000_replica_00%%i.tigerbeetle
+    if exist "!ZIG_FILE!" DEL /F "!ZIG_FILE!"
+    .\tigerbeetle.exe init --directory=. --cluster=0 --replica=%%i > benchmark.log 2>&1
+)
+
+for /l %%i in (0, 1, 0) do (
+    echo Starting replica %%i
+    start /B "tigerbeetle_%%i" .\tigerbeetle.exe start --directory=. --cluster=0 --addresses=3001 --replica=%%i > benchmark.log 2>&1
+)
+
+rem Wait for replicas to start, listen and connect:
+timeout /t 2
+
+echo.
+echo Benchmarking...
+zig\zig.exe run -OReleaseSafe src\benchmark.zig
+exit /b %errorlevel%

package/src/tigerbeetle/scripts/install_zig.bat

@@ -1,109 +1,109 @@
-@echo off
-
-set ZIG_RELEASE_DEFAULT=0.9.1
-
-:: Determine the Zig build:
-if "%~1"=="" (
-    set ZIG_RELEASE=%ZIG_RELEASE_DEFAULT%
-) else if "%~1"=="latest" (
-    set ZIG_RELEASE=builds
-) else (
-    set ZIG_RELEASE=%~1
-)
-
-:: Checks format of release version.
-echo.%ZIG_RELEASE% | findstr /b /r /c:"builds" /c:"^[0-9][0-9]*.[0-9][0-9]*.[0-9][0-9]*">nul || (echo.Unexpected release format. && exit 1)
-
-set ZIG_OS=windows
-set ZIG_ARCH=x86_64
-
-set ZIG_TARGET=zig-%ZIG_OS%-%ZIG_ARCH%
-
-:: Determine the build, split the JSON line on whitespace and extract the 2nd field:
-for /f "tokens=2" %%a in ('curl --silent https://ziglang.org/download/index.json ^| findstr %ZIG_TARGET% ^| findstr %ZIG_RELEASE%' ) do (
-  set ZIG_URL=%%a
-)
-
-:: Then remove quotes and commas:
-for /f %%b in ("%ZIG_URL:,=%") do (
-    set ZIG_URL=%%~b
-)
-
-:: Checks the ZIG_URL variable follows the expected format.
-echo.%ZIG_URL% | findstr /b /r /c:"https://ziglang.org/builds/" /c:"https://ziglang.org/download/%ZIG_RELEASE%">nul || (echo.Unexpected release URL format. && exit 1)
-
-if "%ZIG_RELEASE%"=="builds" (
-    echo Installing Zig latest build...
-) else (
-    echo Installing Zig %ZIG_RELEASE% release build...
-)
-
-:: Using variable modifiers to determine the directory and filename from the URL:
-:: %%~ni Expands %%i to a file name only and %%~xi Expands %%i to a file name extension only.
-for /f %%i in ("%ZIG_URL%") do (
-    set ZIG_DIRECTORY=%%~ni
-    set ZIG_TARBALL=%%~nxi
-)
-
-:: Checks the ZIG_DIRECTORY variable follows the expected format.
-echo.%ZIG_DIRECTORY% | findstr /b /r /c:"zig-win64-" /c:"zig-windows-x86_64-">nul || (echo.Unexpected zip directory name format. && exit 1)
-
-:: Making sure we download to the same output document, without wget adding "-1" etc. if the file was previously partially downloaded:
-if exist %ZIG_TARBALL% (
-  del /q %ZIG_TARBALL%
-  if exist %ZIG_TARBALL% (
-    echo Failed to delete %ZIG_TARBALL%.
-    exit 1
-  )
-)
-
-echo Downloading %ZIG_URL%...
-curl --silent --progress-bar --output %ZIG_TARBALL% %ZIG_URL%
-if not exist  %ZIG_TARBALL% (
-  echo Failed to download Zig zip file.
-  exit 1
-)
-
-:: Replace any existing Zig installation so that we can install or upgrade:
-echo Removing any existing 'zig' and %ZIG_DIRECTORY% folders before extracting.
-if exist zig\ (
-  rd /s /q zig\
-  :: Ensure the directory has been deleted.
-  if exist zig\ (
-    echo The ‘zig’ directory could not be deleted.
-    exit 1
-  )
-)
-
-if exist %ZIG_DIRECTORY%\ (
-  rd /s /q %ZIG_DIRECTORY%
-  :: Ensure the directory has been deleted.
-  if exist %ZIG_DIRECTORY% (
-    echo The %ZIG_DIRECTORY% directory could not be deleted.
-    exit 1
-  )
-)
-
-:: Extract and then remove the downloaded tarball:
-echo Extracting %ZIG_TARBALL%...
-powershell -Command "Expand-Archive %ZIG_TARBALL% -DestinationPath ."
-if not exist %ZIG_TARBALL% (
-  echo Failed to extract zip file.
-  exit 1
-)
-
-echo Installing %ZIG_DIRECTORY% to 'zig' in current working directory...
-ren %ZIG_DIRECTORY% zig
-if exist %ZIG_DIRECTORY% (
-  echo Failed to rename %ZIG_DIRECTORY% to zig.
-  exit 1
-)
-
-:: Removes the zip file
-del /q %ZIG_TARBALL%
-if exist %ZIG_TARBALL% (
-  echo Failed to delete %ZIG_TARBALL% file.
-  exit 1
-)
-
-echo "Congratulations, you have successfully installed Zig version %ZIG_RELEASE%. Enjoy!"
+@echo off
+
+set ZIG_RELEASE_DEFAULT=0.9.1
+
+:: Determine the Zig build:
+if "%~1"=="" (
+    set ZIG_RELEASE=%ZIG_RELEASE_DEFAULT%
+) else if "%~1"=="latest" (
+    set ZIG_RELEASE=builds
+) else (
+    set ZIG_RELEASE=%~1
+)
+
+:: Checks format of release version.
+echo.%ZIG_RELEASE% | findstr /b /r /c:"builds" /c:"^[0-9][0-9]*.[0-9][0-9]*.[0-9][0-9]*">nul || (echo.Unexpected release format. && exit 1)
+
+set ZIG_OS=windows
+set ZIG_ARCH=x86_64
+
+set ZIG_TARGET=zig-%ZIG_OS%-%ZIG_ARCH%
+
+:: Determine the build, split the JSON line on whitespace and extract the 2nd field:
+for /f "tokens=2" %%a in ('curl --silent https://ziglang.org/download/index.json ^| findstr %ZIG_TARGET% ^| findstr %ZIG_RELEASE%' ) do (
+  set ZIG_URL=%%a
+)
+
+:: Then remove quotes and commas:
+for /f %%b in ("%ZIG_URL:,=%") do (
+    set ZIG_URL=%%~b
+)
+
+:: Checks the ZIG_URL variable follows the expected format.
+echo.%ZIG_URL% | findstr /b /r /c:"https://ziglang.org/builds/" /c:"https://ziglang.org/download/%ZIG_RELEASE%">nul || (echo.Unexpected release URL format. && exit 1)
+
+if "%ZIG_RELEASE%"=="builds" (
+    echo Installing Zig latest build...
+) else (
+    echo Installing Zig %ZIG_RELEASE% release build...
+)
+
+:: Using variable modifiers to determine the directory and filename from the URL:
+:: %%~ni Expands %%i to a file name only and %%~xi Expands %%i to a file name extension only.
+for /f %%i in ("%ZIG_URL%") do (
+    set ZIG_DIRECTORY=%%~ni
+    set ZIG_TARBALL=%%~nxi
+)
+
+:: Checks the ZIG_DIRECTORY variable follows the expected format.
+echo.%ZIG_DIRECTORY% | findstr /b /r /c:"zig-win64-" /c:"zig-windows-x86_64-">nul || (echo.Unexpected zip directory name format. && exit 1)
+
+:: Making sure we download to the same output document, without wget adding "-1" etc. if the file was previously partially downloaded:
+if exist %ZIG_TARBALL% (
+  del /q %ZIG_TARBALL%
+  if exist %ZIG_TARBALL% (
+    echo Failed to delete %ZIG_TARBALL%.
+    exit 1
+  )
+)
+
+echo Downloading %ZIG_URL%...
+curl --silent --progress-bar --output %ZIG_TARBALL% %ZIG_URL%
+if not exist  %ZIG_TARBALL% (
+  echo Failed to download Zig zip file.
+  exit 1
+)
+
+:: Replace any existing Zig installation so that we can install or upgrade:
+echo Removing any existing 'zig' and %ZIG_DIRECTORY% folders before extracting.
+if exist zig\ (
+  rd /s /q zig\
+  :: Ensure the directory has been deleted.
+  if exist zig\ (
+    echo The ‘zig’ directory could not be deleted.
+    exit 1
+  )
+)
+
+if exist %ZIG_DIRECTORY%\ (
+  rd /s /q %ZIG_DIRECTORY%
+  :: Ensure the directory has been deleted.
+  if exist %ZIG_DIRECTORY% (
+    echo The %ZIG_DIRECTORY% directory could not be deleted.
+    exit 1
+  )
+)
+
+:: Extract and then remove the downloaded tarball:
+echo Extracting %ZIG_TARBALL%...
+powershell -Command "Expand-Archive %ZIG_TARBALL% -DestinationPath ."
+if not exist %ZIG_TARBALL% (
+  echo Failed to extract zip file.
+  exit 1
+)
+
+echo Installing %ZIG_DIRECTORY% to 'zig' in current working directory...
+ren %ZIG_DIRECTORY% zig
+if exist %ZIG_DIRECTORY% (
+  echo Failed to rename %ZIG_DIRECTORY% to zig.
+  exit 1
+)
+
+:: Removes the zip file
+del /q %ZIG_TARBALL%
+if exist %ZIG_TARBALL% (
+  echo Failed to delete %ZIG_TARBALL% file.
+  exit 1
+)
+
+echo "Congratulations, you have successfully installed Zig version %ZIG_RELEASE%. Enjoy!"

package/src/tigerbeetle/scripts/install_zig.sh

@@ -40,7 +40,9 @@ ZIG_TARGET="zig-$ZIG_OS-$ZIG_ARCH"
 
 # Determine the build, split the JSON line on whitespace and extract the 2nd field, then remove quotes and commas:
 if command -v wget &> /dev/null; then
-    ZIG_URL=`wget --quiet -O - https://ziglang.org/download/index.json | grep -F "$ZIG_TARGET" | grep -F "$ZIG_RELEASE" | awk '{print $2}' | sed 's/[",]//g'`
+    # -4 forces `wget` to connect to ipv4 addresses, as ipv6 fails to resolve on certain distros.
+    # Only A records (for ipv4) are used in DNS:
+    ZIG_URL=`wget -4 --quiet -O - https://ziglang.org/download/index.json | grep -F "$ZIG_TARGET" | grep -F "$ZIG_RELEASE" | awk '{print $2}' | sed 's/[",]//g'`
 else
     ZIG_URL=`curl --silent https://ziglang.org/download/index.json | grep -F "$ZIG_TARGET" | grep -F "$ZIG_RELEASE" | awk '{print $2}' | sed 's/[",]//g'`
 fi
@@ -58,7 +60,9 @@ ZIG_DIRECTORY=`basename "$ZIG_TARBALL" .tar.xz`
 # Download, making sure we download to the same output document, without wget adding "-1" etc. if the file was previously partially downloaded:
 echo "Downloading $ZIG_URL..."
 if command -v wget &> /dev/null; then
-    wget --quiet --show-progress --output-document=$ZIG_TARBALL $ZIG_URL
+    # -4 forces `wget` to connect to ipv4 addresses, as ipv6 fails to resolve on certain distros.
+    # Only A records (for ipv4) are used in DNS:
+    wget -4 --quiet --show-progress --output-document=$ZIG_TARBALL $ZIG_URL
 else
     curl --silent --progress-bar --output $ZIG_TARBALL $ZIG_URL
 fi

package/src/tigerbeetle/scripts/vopr.bat

@@ -1,48 +1,48 @@
-:: Installs Zig if needed and runs the VOPR
-@echo off
-
-:: Install Zig if a zig folder does not already exist:
-if not exist zig\ (
-    :: Installs the latest version of Zig
-    call scripts\install_zig.bat
-    :: Checks that the Zig folder now exists
-    if not exist zig\ (
-        echo The Zig installation failed.
-        exit 1
-    )
-    echo Running the TigerBeetle VOPR for the first time...
-    echo Visit https://www.tigerbeetle.com
-)
-
-:: If a seed is provided as an argument then replay the seed, otherwise test 1,000 seeds:
-if not "%~1"=="" (
-    :: Build in fast ReleaseSafe mode if required, useful where you don't need debug logging:
-    if "%~2"=="-OReleaseSafe" (
-        echo Replaying seed %~1 in ReleaseSafe mode...
-        call zig\zig run src\simulator.zig -OReleaseSafe -- %~1
-        if not %ERRORLEVEL%==0 (
-            echo Cannot replay the %~1 seed using the VOPR.
-            exit 1
-        )
-    ) else (
-        echo Replaying seed %~1 in Debug mode with full debug logging enabled...
-        call zig\zig run src\simulator.zig -ODebug -- %~1
-        if not %ERRORLEVEL%==0 (
-            echo Cannot run the VOPR.
-            exit 1
-        )
-    )
-) else (
-    call zig\zig build-exe src\simulator.zig -OReleaseSafe
-        if not %ERRORLEVEL%==0 (
-            echo Cannot run the VOPR.
-            exit 1
-        )
-    for %%i in (1,1,1000) do (
-        call simulator
-        if not %ERRORLEVEL%==0 (
-            echo Cannot run a seed using the VOPR.
-            exit 1
-        )
-    )
+:: Installs Zig if needed and runs the VOPR
+@echo off
+
+:: Install Zig if a zig folder does not already exist:
+if not exist zig\ (
+    :: Installs the latest version of Zig
+    call scripts\install_zig.bat
+    :: Checks that the Zig folder now exists
+    if not exist zig\ (
+        echo The Zig installation failed.
+        exit 1
+    )
+    echo Running the TigerBeetle VOPR for the first time...
+    echo Visit https://www.tigerbeetle.com
+)
+
+:: If a seed is provided as an argument then replay the seed, otherwise test 1,000 seeds:
+if not "%~1"=="" (
+    :: Build in fast ReleaseSafe mode if required, useful where you don't need debug logging:
+    if "%~2"=="-OReleaseSafe" (
+        echo Replaying seed %~1 in ReleaseSafe mode...
+        call zig\zig run src\simulator.zig -OReleaseSafe -- %~1
+        if not %ERRORLEVEL%==0 (
+            echo Cannot replay the %~1 seed using the VOPR.
+            exit 1
+        )
+    ) else (
+        echo Replaying seed %~1 in Debug mode with full debug logging enabled...
+        call zig\zig run src\simulator.zig -ODebug -- %~1
+        if not %ERRORLEVEL%==0 (
+            echo Cannot run the VOPR.
+            exit 1
+        )
+    )
+) else (
+    call zig\zig build-exe src\simulator.zig -OReleaseSafe
+        if not %ERRORLEVEL%==0 (
+            echo Cannot run the VOPR.
+            exit 1
+        )
+    for %%i in (1,1,1000) do (
+        call simulator
+        if not %ERRORLEVEL%==0 (
+            echo Cannot run a seed using the VOPR.
+            exit 1
+        )
+    )
 )

package/src/tigerbeetle/src/config.zig

@@ -57,25 +57,23 @@ pub const transfers_max = switch (deployment_environment) {
 /// This impacts the amount of memory allocated at initialization by the server.
 pub const transfers_pending_max = transfers_max;
 
-/// The maximum size of the journal file:
-/// This is pre-allocated and zeroed for performance when initialized.
-/// Writes within this file never extend the filesystem inode size reducing the cost of fdatasync().
-/// This enables static allocation of disk space so that appends cannot fail with ENOSPC.
-/// This also enables us to detect filesystem inode corruption that would change the journal size.
-pub const journal_size_max = switch (deployment_environment) {
-    .production => 128 * 1024 * 1024 * 1024,
-    else => 128 * 1024 * 1024,
-};
-
 /// The maximum number of batch entries in the journal file:
 /// A batch entry may contain many transfers, so this is not a limit on the number of transfers.
 /// We need this limit to allocate space for copies of batch headers at the start of the journal.
 /// These header copies enable us to disentangle corruption from crashes and recover accordingly.
-pub const journal_headers_max = switch (deployment_environment) {
-    .production => 1024 * 1024,
-    else => 16384,
+pub const journal_slot_count = switch (deployment_environment) {
+    .production => 1024,
+    else => 128,
 };
 
+/// The maximum size of the journal file:
+/// This is pre-allocated and zeroed for performance when initialized.
+/// Writes within this file never extend the filesystem inode size reducing the cost of fdatasync().
+/// This enables static allocation of disk space so that appends cannot fail with ENOSPC.
+/// This also enables us to detect filesystem inode corruption that would change the journal size.
+// TODO remove this; just allocate a part of the total storage for the journal
+pub const journal_size_max = journal_slot_count * (128 + message_size_max);
+
 /// The maximum number of connections that can be held open by the server at any time:
 pub const connections_max = replicas_max + clients_max;
 
@@ -224,6 +222,10 @@ pub const clock_synchronization_window_min_ms = 2000;
 /// If a window expires because of this then it is likely that the clock epoch will also be expired.
 pub const clock_synchronization_window_max_ms = 20000;
 
+// TODO Move these to a separate "internal computed constants" file.
+pub const journal_size_headers = journal_slot_count * 128; // 128 == @sizeOf(Header)
+pub const journal_size_prepares = journal_slot_count * message_size_max;
+
 comptime {
     // vsr.parse_address assumes that config.address/config.port are valid.
     _ = std.net.Address.parseIp4(address, 0) catch unreachable;
@@ -232,4 +234,6 @@ comptime {
     // Avoid latency issues from setting sndbuf too high:
     assert(tcp_sndbuf_replica <= 16 * 1024 * 1024);
     assert(tcp_sndbuf_client <= 16 * 1024 * 1024);
+
+    assert(journal_size_max == journal_size_headers + journal_size_prepares);
 }

package/src/tigerbeetle/src/demo.zig

@@ -31,7 +31,7 @@ pub fn request(
 ) !void {
     const allocator = std.heap.page_allocator;
     const client_id = std.crypto.random.int(u128);
-    const cluster_id: u32 = 0;
+    const cluster_id: u32 = 1;
     var addresses = [_]std.net.Address{try std.net.Address.parseIp4("127.0.0.1", config.port)};
 
     var io = try IO.init(32, 0);
@@ -51,7 +51,7 @@ pub fn request(
 
     message_bus.set_on_message(*Client, &client, Client.on_message);
 
-    var message = client.get_message();
+    const message = client.get_message();
     defer client.unref(message);
 
     const body = std.mem.asBytes(&batch);

package/src/tigerbeetle/src/demo_03_create_transfers.zig

@@ -6,15 +6,15 @@ const Transfer = tb.Transfer;
 pub fn main() !void {
     const transfers = [_]Transfer{
         Transfer{
-            .id = 1000,
+            .id = 1,
             .debit_account_id = 1,
             .credit_account_id = 2,
             .user_data = 0,
             .reserved = 0,
             .pending_id = 0,
-            .ledger = 0,
             .timeout = 0,
-            .code = 0,
+            .ledger = 710, // Let's use the ISO-4217 Code Number for ZAR
+            .code = 1,
             .flags = .{},
             .amount = 1000,
         },