tigerbeetle-node 0.4.3 → 0.5.0

package/src/index.ts

@@ -130,7 +130,6 @@ export enum CommitTransferError {
   transfer_not_found,
   transfer_not_two_phase_commit,
   transfer_expired,
-  already_auto_committed,
   already_committed,
   already_committed_but_accepted,
   already_committed_but_rejected,
@@ -151,16 +150,18 @@ export type CommitTransfersError = {
 }
 
 export type AccountID = bigint // u128
+export type TransferID = bigint // u128
 
-export type Event = Account | Transfer | Commit | AccountID
-export type Result = CreateAccountsError | CreateTransfersError | CommitTransfersError | Account
+export type Event = Account | Transfer | Commit | AccountID | TransferID
+export type Result = CreateAccountsError | CreateTransfersError | CommitTransfersError | Account | Transfer
 export type ResultCallback = (error: undefined | Error, results: Result[]) => void
 
 export enum Operation {
   CREATE_ACCOUNT = 3,
   CREATE_TRANSFER,
   COMMIT_TRANSFER,
-  ACCOUNT_LOOKUP
+  ACCOUNT_LOOKUP,
+  TRANSFER_LOOKUP
 }
 
 export interface Client {
@@ -168,6 +169,7 @@ export interface Client {
   createTransfers: (batch: Transfer[]) => Promise<CreateTransfersError[]>
   commitTransfers: (batch: Commit[]) => Promise<CommitTransfersError[]>
   lookupAccounts: (batch: AccountID[]) => Promise<Account[]>
+  lookupTransfers: (batch: TransferID[]) => Promise<Transfer[]>
   request: (operation: Operation, batch: Event[], callback: ResultCallback) => void
   rawRequest: (operation: Operation, rawBatch: Buffer, callback: ResultCallback) => void
   destroy: () => void
@@ -237,6 +239,7 @@ export function createClient (args: InitArgs): Client {
       const callback = (error: undefined | Error, results: CreateAccountsError[]) => {
         if (error) {
           reject(error)
+          return
         }
         resolve(results)
       }
@@ -263,6 +266,7 @@ export function createClient (args: InitArgs): Client {
       const callback = (error: undefined | Error, results: CreateTransfersError[]) => {
         if (error) {
           reject(error)
+          return
         }
         resolve(results)
       }
@@ -289,6 +293,7 @@ export function createClient (args: InitArgs): Client {
       const callback = (error: undefined | Error, results: CommitTransfersError[]) => {
         if (error) {
           reject(error)
+          return
         }
         resolve(results)
       }
@@ -306,6 +311,7 @@ export function createClient (args: InitArgs): Client {
       const callback = (error: undefined | Error, results: Account[]) => {
         if (error) {
           reject(error)
+          return
         }
         resolve(results)
       }
@@ -318,6 +324,24 @@ export function createClient (args: InitArgs): Client {
     })
   }
 
+  const lookupTransfers = async (batch: TransferID[]): Promise<Transfer[]> => {
+    return new Promise((resolve, reject) => {
+      const callback = (error: undefined | Error, results: Transfer[]) => {
+        if (error) {
+          reject(error)
+          return
+        }
+        resolve(results)
+      }
+
+      try {
+        binding.request(context, Operation.TRANSFER_LOOKUP, batch, callback)
+      } catch (error) {
+        reject(error)
+      }
+    })
+  }
+
   const destroy = (): void => {
     binding.deinit(context)
     if (_interval){
@@ -331,6 +355,7 @@ export function createClient (args: InitArgs): Client {
     createTransfers,
     commitTransfers,
     lookupAccounts,
+    lookupTransfers,
     request,
     rawRequest,
     destroy

package/src/node.zig

@@ -213,7 +213,7 @@ fn decode_from_object(comptime T: type, env: c.napi_env, object: c.napi_value) !
             .credits_accepted = try translate.u64_from_object(env, object, "credits_accepted"),
             .timestamp = try validate_timestamp(env, object),
         },
-        u128 => try translate.u128_from_value(env, object, "Account lookup"),
+        u128 => try translate.u128_from_value(env, object, "lookup"),
         else => unreachable,
     };
 }
@@ -229,6 +229,7 @@ pub fn decode_events(
         .create_transfers => try decode_events_from_array(env, array, Transfer, output),
         .commit_transfers => try decode_events_from_array(env, array, Commit, output),
         .lookup_accounts => try decode_events_from_array(env, array, u128, output),
+        .lookup_transfers => try decode_events_from_array(env, array, u128, output),
         else => unreachable,
     };
 }
@@ -307,7 +308,7 @@ fn encode_napi_results_array(
                 );
             }
         },
-        else => {
+        Account => {
             var i: u32 = 0;
             while (i < results.len) : (i += 1) {
                 const result = results[i];
@@ -413,6 +414,105 @@ fn encode_napi_results_array(
                 );
             }
         },
+        Transfer => {
+            var i: u32 = 0;
+            while (i < results.len) : (i += 1) {
+                const result = results[i];
+                const napi_object = try translate.create_object(
+                    env,
+                    "Failed to create transfer lookup result object.",
+                );
+
+                try translate.u128_into_object(
+                    env,
+                    napi_object,
+                    "id",
+                    result.id,
+                    "Failed to set property \"id\" of transfer lookup result.",
+                );
+
+                try translate.u128_into_object(
+                    env,
+                    napi_object,
+                    "debit_account_id",
+                    result.debit_account_id,
+                    "Failed to set property \"debit_account_id\" of transfer lookup result.",
+                );
+
+                try translate.u128_into_object(
+                    env,
+                    napi_object,
+                    "credit_account_id",
+                    result.credit_account_id,
+                    "Failed to set property \"credit_account_id\" of transfer lookup result.",
+                );
+
+                try translate.u128_into_object(
+                    env,
+                    napi_object,
+                    "user_data",
+                    result.user_data,
+                    "Failed to set property \"user_data\" of transfer lookup result.",
+                );
+
+                try translate.byte_slice_into_object(
+                    env,
+                    napi_object,
+                    "reserved",
+                    &result.reserved,
+                    "Failed to set property \"reserved\" of transfer lookup result.",
+                );
+
+                try translate.u64_into_object(
+                    env,
+                    napi_object,
+                    "timeout",
+                    result.timeout,
+                    "Failed to set property \"timeout\" of transfer lookup result.",
+                );
+
+                try translate.u32_into_object(
+                    env,
+                    napi_object,
+                    "code",
+                    @intCast(u32, result.code),
+                    "Failed to set property \"code\" of transfer lookup result.",
+                );
+
+                try translate.u32_into_object(
+                    env,
+                    napi_object,
+                    "flags",
+                    @bitCast(u32, result.flags),
+                    "Failed to set property \"flags\" of transfer lookup result.",
+                );
+
+                try translate.u64_into_object(
+                    env,
+                    napi_object,
+                    "amount",
+                    result.amount,
+                    "Failed to set property \"amount\" of transfer lookup result.",
+                );
+
+                try translate.u64_into_object(
+                    env,
+                    napi_object,
+                    "timestamp",
+                    result.timestamp,
+                    "Failed to set property \"timestamp\" of transfer lookup result.",
+                );
+
+                try translate.set_array_element(
+                    env,
+                    napi_array,
+                    i,
+                    napi_object,
+                    "Failed to set element in results array.",
+                );
+            }
+        },
+        else => unreachable,
     }
 
     return napi_array;
@@ -610,6 +710,7 @@ fn on_result(user_data: u128, operation: Operation, results: Client.Error![]cons
                 value,
             ) catch return,
             .lookup_accounts => encode_napi_results_array(Account, env, value) catch return,
+            .lookup_transfers => encode_napi_results_array(Transfer, env, value) catch return,
         };
 
         argv[0] = globals.napi_undefined;

package/src/test.ts

@@ -176,6 +176,20 @@ test('can create a two-phase transfer', async (): Promise<void> => {
   assert.strictEqual(accounts[1].credits_reserved, 0n)
   assert.strictEqual(accounts[1].debits_accepted, 100n)
   assert.strictEqual(accounts[1].debits_reserved, 50n)
+
+  // Lookup the transfer
+  const transfers = await client.lookupTransfers([transfer.id])
+  assert.strictEqual(transfers.length, 1)
+  assert.strictEqual(transfers[0].id, 1n)
+  assert.strictEqual(transfers[0].debit_account_id, accountB.id)
+  assert.strictEqual(transfers[0].credit_account_id, accountA.id)
+  assert.strictEqual(transfers[0].user_data, 0n)
+  assert.notStrictEqual(transfers[0].reserved, Zeroed32Bytes)
+  assert.strictEqual(transfers[0].timeout > 0, true)
+  assert.strictEqual(transfers[0].code, 1)
+  assert.strictEqual(transfers[0].flags, 2)
+  assert.strictEqual(transfers[0].amount, 50n)
+  assert.strictEqual(transfers[0].timestamp > 0, true)
 })
 
 test('can commit a two-phase transfer', async (): Promise<void> => {

package/src/tigerbeetle/scripts/install.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 set -e
-scripts/install_zig.sh 0.8.0
+scripts/install_zig.sh 0.8.1
 echo "Building TigerBeetle..."
 zig/zig build -Dcpu=baseline -Drelease-safe
 mv zig-out/bin/tigerbeetle .

package/src/tigerbeetle/scripts/install_zig.bat

@@ -0,0 +1,109 @@
+@echo off
+
+set DEFAULT_RELEASE=0.8.1
+
+:: Determine the Zig build:
+if "%~1"=="" (
+    set ZIG_RELEASE=%DEFAULT_RELEASE%
+) 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/vopr.bat

@@ -0,0 +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
+        )
+    )
+)

package/src/tigerbeetle/src/benchmark.zig

@@ -223,7 +223,7 @@ const TimedQueue = struct {
 
         const now = std.time.milliTimestamp();
         self.start = now;
-        if (self.batches.peek_ptr()) |starting_batch| {
+        if (self.batches.head_ptr()) |starting_batch| {
             log.debug("sending first batch...", .{});
             self.batch_start = now;
             var message = self.client.get_message() orelse {
@@ -285,7 +285,7 @@ const TimedQueue = struct {
             else => unreachable,
         }
 
-        if (self.batches.peek_ptr()) |next_batch| {
+        if (self.batches.head_ptr()) |next_batch| {
             var message = self.client.get_message() orelse {
                 @panic("Client message pool has been exhausted.");
             };

package/src/tigerbeetle/src/demo.zig

@@ -81,6 +81,14 @@ pub const Demo = struct {
         print_results(Account, results);
     }
 
+    pub fn on_lookup_transfers(
+        user_data: u128,
+        operation: StateMachine.Operation,
+        results: Client.Error![]const u8,
+    ) void {
+        print_results(Transfer, results);
+    }
+
     pub fn on_create_transfers(
         user_data: u128,
         operation: StateMachine.Operation,

package/src/tigerbeetle/src/demo_07_lookup_transfers.zig

@@ -0,0 +1,8 @@
+usingnamespace @import("tigerbeetle.zig");
+usingnamespace @import("demo.zig");
+
+pub fn main() !void {
+    const ids = [_]u128{ 1000, 1001, 1002 };
+
+    try Demo.request(.lookup_transfers, ids, Demo.on_lookup_transfers);
+}

package/src/tigerbeetle/src/io.zig

@@ -1216,7 +1216,7 @@ test "accept/connect/send/receive" {
                 completion,
                 self.client,
                 &self.send_buf,
-                os.MSG_NOSIGNAL,
+                if (std.Target.current.os.tag == .linux) os.MSG_NOSIGNAL else 0,
             );
         }
 
@@ -1241,7 +1241,7 @@ test "accept/connect/send/receive" {
                 completion,
                 self.accepted_sock,
                 &self.recv_buf,
-                os.MSG_NOSIGNAL,
+                if (std.Target.current.os.tag == .linux) os.MSG_NOSIGNAL else 0,
             );
         }
 

package/src/tigerbeetle/src/io_darwin.zig

@@ -105,6 +105,7 @@ pub const IO = struct {
 
             for (events[0..new_events]) |event| {
                 const completion = @intToPtr(*Completion, event.udata);
+                completion.next = null;
                 self.completed.push(completion);
             }
         }
@@ -405,6 +406,7 @@ pub const IO = struct {
         InputOutput,
         NoSpaceLeft,
         ReadOnlyFileSystem,
+        AccessDenied,
     } || os.UnexpectedError;
 
     pub fn fsync(
@@ -455,6 +457,8 @@ pub const IO = struct {
         NoSpaceLeft,
         NotDir,
         FileLocksNotSupported,
+        BadPathName,
+        InvalidUtf8,
         WouldBlock,
     } || os.UnexpectedError;
 

package/src/tigerbeetle/src/message_bus.zig

@@ -919,7 +919,7 @@ fn MessageBusImpl(comptime process_type: ProcessType) type {
                 assert(connection.peer == .client or connection.peer == .replica);
                 assert(connection.state == .connected);
                 assert(connection.fd != -1);
-                const message = connection.send_queue.peek() orelse return;
+                const message = connection.send_queue.head() orelse return;
                 assert(!connection.send_submitted);
                 connection.send_submitted = true;
                 bus.io.send(
@@ -949,9 +949,9 @@ fn MessageBusImpl(comptime process_type: ProcessType) type {
                     connection.terminate(bus, .shutdown);
                     return;
                 };
-                assert(connection.send_progress <= connection.send_queue.peek_ptr().?.*.header.size);
+                assert(connection.send_progress <= connection.send_queue.head().?.header.size);
                 // If the message has been fully sent, move on to the next one.
-                if (connection.send_progress == connection.send_queue.peek_ptr().?.*.header.size) {
+                if (connection.send_progress == connection.send_queue.head().?.header.size) {
                     connection.send_progress = 0;
                     const message = connection.send_queue.pop().?;
                     bus.unref(message);