tigerbeetle-node 0.5.1 → 0.8.0

package/src/index.ts

@@ -24,13 +24,13 @@ export type Account = {
   id: bigint // u128
   user_data: bigint // u128
   reserved: Buffer // [48]u8
-  unit: number // u16, unit of value
+  ledger: number // u32, ledger of value
   code: number // u16, A chart of accounts code describing the type of account (e.g. clearing, settlement)
-  flags: number // u32
-  debits_reserved: bigint // u64
-  debits_accepted: bigint // u64
-  credits_reserved: bigint // u64
-  credits_accepted: bigint // u64
+  flags: number // u16
+  debits_pending: bigint // u64
+  debits_posted: bigint // u64
+  credits_pending: bigint // u64
+  credits_posted: bigint // u64
   timestamp: bigint // u64, Set this to 0n - the actual value will be set by TigerBeetle server
 }
 
@@ -41,17 +41,33 @@ export enum AccountFlags {
 }
 
 export enum CreateAccountError {
+  // ok = 0 (No Error)
   linked_event_failed = 1,
-  exists,
-  exists_with_different_user_data,
-  exists_with_different_reserved_field,
-  exists_with_different_unit,
-  exists_with_different_code,
-  exists_with_different_flags,
+
+  reserved_flag,
+  reserved_field,
+
+  id_must_not_be_zero,
+  ledger_must_not_be_zero,
+  code_must_not_be_zero,
+
+  mutually_exclusive_flags,
+
+  overflows_debits,
+  overflows_credits,
+
   exceeds_credits,
   exceeds_debits,
-  reserved_field,
-  reserved_flag_padding,
+
+  exists_with_different_flags,
+  exists_with_different_user_data,
+  exists_with_different_ledger,
+  exists_with_different_code,
+  exists_with_different_debits_pending,
+  exists_with_different_debits_posted,
+  exists_with_different_credits_pending,
+  exists_with_different_credits_posted,
+  exists,
 }
 
 export type CreateAccountsError = {
@@ -64,102 +80,107 @@ export type Transfer = {
   debit_account_id: bigint, // u128
   credit_account_id: bigint, // u128
   user_data: bigint, // u128
-  reserved: Buffer, // [32]u8
-  timeout: bigint, // u64, in nano-seconds
-  code: number, // u32 accounting system code to describe the type of transfer (e.g. settlement)
-  flags: number, // u32
+  reserved: bigint, // u128
+  pending_id: bigint, // u128
+  timeout: bigint, // u64, In nanoseconds.
+  ledger: number // u32, The ledger of value.
+  code: number, // u16, A user-defined accounting code to describe the type of transfer (e.g. settlement).
+  flags: number, // u16
   amount: bigint, // u64,
-  timestamp: bigint, // u64, Set this to 0n - the actual value will be set by TigerBeetle server
+  timestamp: bigint, // u64, Set this to 0n - the timestamp will be set by TigerBeetle.
 }
 
 export enum TransferFlags {
   linked = (1 << 0),
-  two_phase_commit = (1 << 1),
-  condition = (1 << 2) // whether or not a condition will be supplied
+  pending = (1 << 1),
+  post_pending_transfer = (1 << 2),
+  void_pending_transfer = (1 << 3)
 }
 
 export enum CreateTransferError {
+  // ok = 0 (No Error)
   linked_event_failed = 1,
-  exists,
+
+  reserved_flag,
+  reserved_field,
+
+  id_must_not_be_zero,
+  debit_account_id_must_not_be_zero,
+  credit_account_id_must_not_be_zero,
+  accounts_must_be_different,
+
+  pending_id_must_be_zero,
+  pending_transfer_must_timeout,
+
+  ledger_must_not_be_zero,
+  code_must_not_be_zero,
+  amount_must_not_be_zero,
+
+  debit_account_not_found,
+  credit_account_not_found,
+
+  accounts_must_have_the_same_ledger,
+  transfer_must_have_the_same_ledger_as_accounts,
+
+  exists_with_different_flags,
   exists_with_different_debit_account_id,
   exists_with_different_credit_account_id,
   exists_with_different_user_data,
-  exists_with_different_reserved_field,
+  exists_with_different_pending_id,
+  exists_with_different_timeout,
   exists_with_different_code,
   exists_with_different_amount,
-  exists_with_different_timeout,
-  exists_with_different_flags,
-  exists_and_already_committed_and_accepted,
-  exists_and_already_committed_and_rejected,
-  reserved_field,
-  reserved_flag_padding,
-  debit_account_not_found,
-  credit_account_not_found,
-  accounts_are_the_same,
-  accounts_have_different_units,
-  amount_is_zero,
+  exists,
+
+  overflows_debits_pending,
+  overflows_credits_pending,
+  overflows_debits_posted,
+  overflows_credits_posted,
+  overflows_debits,
+  overflows_credits,
+
   exceeds_credits,
   exceeds_debits,
-  two_phase_commit_must_timeout,
-  timeout_reserved_for_two_phase_commit,
-}
 
-export type CreateTransfersError = {
-  index: number,
-  code: CreateTransferError,
-}
+  cannot_post_and_void_pending_transfer,
+  pending_transfer_cannot_post_or_void_another,
+  timeout_reserved_for_pending_transfer,
 
-export type Commit = {
-  id: bigint, // u128
-  reserved: Buffer, // [32]u8
-  code: number, // u32 accounting system code describing the reason for accept/reject
-  flags: number, // u32
-  timestamp: bigint, // u64, Set this to 0n - the actual value will be set by TigerBeetle server
-}
+  pending_id_must_not_be_zero,
+  pending_id_must_be_different,
 
-export enum CommitFlags {
-  linked = (1 << 0),
-  reject = (1 << 1),
-  preimage = (1 << 2) // whether or not a pre-image will be supplied
-}
+  pending_transfer_not_found,
+  pending_transfer_not_pending,
 
-export enum CommitTransferError {
-  linked_event_failed = 1,
-  reserved_field,
-  reserved_flag_padding,
-  transfer_not_found,
-  transfer_not_two_phase_commit,
-  transfer_expired,
-  already_committed,
-  already_committed_but_accepted,
-  already_committed_but_rejected,
-  debit_account_not_found,
-  credit_account_not_found,
-  debit_amount_was_not_reserved,
-  credit_amount_was_not_reserved,
-  exceeds_credits,
-  exceeds_debits,
-  condition_requires_preimage,
-  preimage_requires_condition,
-  preimage_invalid,
+  pending_transfer_has_different_debit_account_id,
+  pending_transfer_has_different_credit_account_id,
+  pending_transfer_has_different_ledger,
+  pending_transfer_has_different_code,
+
+  exceeds_pending_transfer_amount,
+  pending_transfer_has_different_amount,
+
+  pending_transfer_already_posted,
+  pending_transfer_already_voided,
+
+  pending_transfer_expired,
 }
 
-export type CommitTransfersError = {
+export type CreateTransfersError = {
   index: number,
-  code: CommitTransferError,
+  code: CreateTransferError,
 }
 
 export type AccountID = bigint // u128
 export type TransferID = bigint // u128
 
-export type Event = Account | Transfer | Commit | AccountID | TransferID
-export type Result = CreateAccountsError | CreateTransfersError | CommitTransfersError | Account | Transfer
+export type Event = Account | Transfer | AccountID | TransferID
+export type Result = CreateAccountsError | CreateTransfersError | Account | Transfer
 export type ResultCallback = (error: undefined | Error, results: Result[]) => void
 
 export enum Operation {
   CREATE_ACCOUNT = 3,
   CREATE_TRANSFER,
-  COMMIT_TRANSFER,
   ACCOUNT_LOOKUP,
   TRANSFER_LOOKUP
 }
@@ -167,7 +188,6 @@ export enum Operation {
 export interface Client {
   createAccounts: (batch: Account[]) => Promise<CreateAccountsError[]>
   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
@@ -192,13 +212,12 @@ const isSameArgs = (args: InitArgs): boolean => {
     }
   })
 
-  return args.cluster_id === _args.cluster_id &&
-          isSameReplicas
+  return args.cluster_id === _args.cluster_id && isSameReplicas
 }
 
 let _client: Client | undefined = undefined
 let _interval: NodeJS.Timeout | undefined = undefined
-// here to wait until  `ping` is sent to server so that connection is registered - temporary till client table and sessions are implemented.
+// Here to wait until  `ping` is sent to server so that connection is registered - temporary till client table and sessions are implemented.
 let _pinged = false
 // TODO: allow creation of clients if the arguments are different. Will require changes in node.zig as well.
 export function createClient (args: InitArgs): Client {
@@ -226,7 +245,7 @@ export function createClient (args: InitArgs): Client {
   }
 
   const createAccounts = async (batch: Account[]): Promise<CreateAccountsError[]> => {
-    // here to wait until  `ping` is sent to server so that connection is registered - temporary till client table and sessions are implemented.
+    // Here to wait until `ping` is sent to server so that connection is registered - temporary till client table and sessions are implemented.
     if (!_pinged) {
       await new Promise<void>(resolve => {
         setTimeout(() => {
@@ -253,7 +272,7 @@ export function createClient (args: InitArgs): Client {
   }
 
   const createTransfers = async (batch: Transfer[]): Promise<CreateTransfersError[]> => {
-    // here to wait until  `ping` is sent to server so that connection is registered - temporary till client table and sessions are implemented.
+    // Here to wait until `ping` is sent to server so that connection is registered - temporary till client table and sessions are implemented.
     if (!_pinged) {
       await new Promise<void>(resolve => {
         setTimeout(() => {
@@ -279,33 +298,6 @@ export function createClient (args: InitArgs): Client {
     })
   }
 
-  const commitTransfers = async (batch: Commit[]): Promise<CommitTransfersError[]> => {
-    // here to wait until  `ping` is sent to server so that connection is registered - temporary till client table and sessions are implemented.
-    if (!_pinged) {
-      await new Promise<void>(resolve => {
-        setTimeout(() => {
-          _pinged = true
-          resolve()
-        }, 600)
-      })
-    }
-    return new Promise((resolve, reject) => {
-      const callback = (error: undefined | Error, results: CommitTransfersError[]) => {
-        if (error) {
-          reject(error)
-          return
-        }
-        resolve(results)
-      }
-
-      try {
-        binding.request(context, Operation.COMMIT_TRANSFER, batch, callback)
-      } catch (error) {
-        reject(error)
-      }
-    })
-  }
-
   const lookupAccounts = async (batch: AccountID[]): Promise<Account[]> => {
     return new Promise((resolve, reject) => {
       const callback = (error: undefined | Error, results: Account[]) => {
@@ -353,7 +345,6 @@ export function createClient (args: InitArgs): Client {
   _client = {
     createAccounts,
     createTransfers,
-    commitTransfers,
     lookupAccounts,
     lookupTransfers,
     request,

package/src/node.zig

@@ -9,11 +9,8 @@ const Account = tb.Account;
 const AccountFlags = tb.AccountFlags;
 const Transfer = tb.Transfer;
 const TransferFlags = tb.TransferFlags;
-const Commit = tb.Commit;
-const CommitFlags = tb.CommitFlags;
 const CreateAccountsResult = tb.CreateAccountsResult;
 const CreateTransfersResult = tb.CreateTransfersResult;
-const CommitTransfersResult = tb.CommitTransfersResult;
 
 const StateMachine = @import("tigerbeetle/src/state_machine.zig").StateMachine;
 const Operation = StateMachine.Operation;
@@ -184,22 +181,17 @@ fn validate_timestamp(env: c.napi_env, object: c.napi_value) !u64 {
 
 fn decode_from_object(comptime T: type, env: c.napi_env, object: c.napi_value) !T {
     return switch (T) {
-        Commit => Commit{
-            .id = try translate.u128_from_object(env, object, "id"),
-            .reserved = try translate.bytes_from_object(env, object, 32, "reserved"),
-            .code = try translate.u32_from_object(env, object, "code"),
-            .flags = @bitCast(CommitFlags, try translate.u32_from_object(env, object, "flags")),
-            .timestamp = try validate_timestamp(env, object),
-        },
         Transfer => Transfer{
             .id = try translate.u128_from_object(env, object, "id"),
             .debit_account_id = try translate.u128_from_object(env, object, "debit_account_id"),
             .credit_account_id = try translate.u128_from_object(env, object, "credit_account_id"),
             .user_data = try translate.u128_from_object(env, object, "user_data"),
-            .reserved = try translate.bytes_from_object(env, object, 32, "reserved"),
+            .reserved = try translate.u128_from_object(env, object, "reserved"),
+            .pending_id = try translate.u128_from_object(env, object, "pending_id"),
             .timeout = try translate.u64_from_object(env, object, "timeout"),
-            .code = try translate.u32_from_object(env, object, "code"),
-            .flags = @bitCast(TransferFlags, try translate.u32_from_object(env, object, "flags")),
+            .ledger = try translate.u32_from_object(env, object, "ledger"),
+            .code = try translate.u16_from_object(env, object, "code"),
+            .flags = @bitCast(TransferFlags, try translate.u16_from_object(env, object, "flags")),
             .amount = try translate.u64_from_object(env, object, "amount"),
             .timestamp = try validate_timestamp(env, object),
         },
@@ -207,13 +199,13 @@ fn decode_from_object(comptime T: type, env: c.napi_env, object: c.napi_value) !
             .id = try translate.u128_from_object(env, object, "id"),
             .user_data = try translate.u128_from_object(env, object, "user_data"),
             .reserved = try translate.bytes_from_object(env, object, 48, "reserved"),
-            .unit = try translate.u16_from_object(env, object, "unit"),
+            .ledger = try translate.u32_from_object(env, object, "ledger"),
             .code = try translate.u16_from_object(env, object, "code"),
-            .flags = @bitCast(AccountFlags, try translate.u32_from_object(env, object, "flags")),
-            .debits_reserved = try translate.u64_from_object(env, object, "debits_reserved"),
-            .debits_accepted = try translate.u64_from_object(env, object, "debits_accepted"),
-            .credits_reserved = try translate.u64_from_object(env, object, "credits_reserved"),
-            .credits_accepted = try translate.u64_from_object(env, object, "credits_accepted"),
+            .flags = @bitCast(AccountFlags, try translate.u16_from_object(env, object, "flags")),
+            .debits_pending = try translate.u64_from_object(env, object, "debits_pending"),
+            .debits_posted = try translate.u64_from_object(env, object, "debits_posted"),
+            .credits_pending = try translate.u64_from_object(env, object, "credits_pending"),
+            .credits_posted = try translate.u64_from_object(env, object, "credits_posted"),
             .timestamp = try validate_timestamp(env, object),
         },
         u128 => try translate.u128_from_value(env, object, "lookup"),
@@ -230,7 +222,6 @@ pub fn decode_events(
     return switch (operation) {
         .create_accounts => try decode_events_from_array(env, array, Account, output),
         .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,
@@ -277,7 +268,7 @@ fn encode_napi_results_array(
     );
 
     switch (Result) {
-        CreateAccountsResult, CreateTransfersResult, CommitTransfersResult => {
+        CreateAccountsResult, CreateTransfersResult => {
             var i: u32 = 0;
             while (i < results.len) : (i += 1) {
                 const result = results[i];
@@ -347,57 +338,57 @@ fn encode_napi_results_array(
                 try translate.u32_into_object(
                     env,
                     napi_object,
-                    "unit",
-                    @intCast(u32, result.unit),
-                    "Failed to set property \"unit\" of account lookup result.",
+                    "ledger",
+                    @intCast(u32, result.ledger),
+                    "Failed to set property \"ledger\" of account lookup result.",
                 );
 
-                try translate.u32_into_object(
+                try translate.u16_into_object(
                     env,
                     napi_object,
                     "code",
-                    @intCast(u32, result.code),
+                    @intCast(u16, result.code),
                     "Failed to set property \"code\" of account lookup result.",
                 );
 
-                try translate.u32_into_object(
+                try translate.u16_into_object(
                     env,
                     napi_object,
                     "flags",
-                    @bitCast(u32, result.flags),
+                    @bitCast(u16, result.flags),
                     "Failed to set property \"flags\" of account lookup result.",
                 );
 
                 try translate.u64_into_object(
                     env,
                     napi_object,
-                    "debits_reserved",
-                    result.debits_reserved,
-                    "Failed to set property \"debits_reserved\" of account lookup result.",
+                    "debits_pending",
+                    result.debits_pending,
+                    "Failed to set property \"debits_pending\" of account lookup result.",
                 );
 
                 try translate.u64_into_object(
                     env,
                     napi_object,
-                    "debits_accepted",
-                    result.debits_accepted,
-                    "Failed to set property \"debits_accepted\" of account lookup result.",
+                    "debits_posted",
+                    result.debits_posted,
+                    "Failed to set property \"debits_posted\" of account lookup result.",
                 );
 
                 try translate.u64_into_object(
                     env,
                     napi_object,
-                    "credits_reserved",
-                    result.credits_reserved,
-                    "Failed to set property \"credits_reserved\" of account lookup result.",
+                    "credits_pending",
+                    result.credits_pending,
+                    "Failed to set property \"credits_pending\" of account lookup result.",
                 );
 
                 try translate.u64_into_object(
                     env,
                     napi_object,
-                    "credits_accepted",
-                    result.credits_accepted,
-                    "Failed to set property \"credits_accepted\" of account lookup result.",
+                    "credits_posted",
+                    result.credits_posted,
+                    "Failed to set property \"credits_posted\" of account lookup result.",
                 );
 
                 try translate.u64_into_object(
@@ -458,14 +449,22 @@ fn encode_napi_results_array(
                     "Failed to set property \"user_data\" of transfer lookup result.",
                 );
 
-                try translate.byte_slice_into_object(
+                try translate.u128_into_object(
                     env,
                     napi_object,
                     "reserved",
-                    &result.reserved,
+                    result.reserved,
                     "Failed to set property \"reserved\" of transfer lookup result.",
                 );
 
+                try translate.u128_into_object(
+                    env,
+                    napi_object,
+                    "pending_id",
+                    result.pending_id,
+                    "Failed to set property \"pending_id\" of transfer lookup result.",
+                );
+
                 try translate.u64_into_object(
                     env,
                     napi_object,
@@ -475,18 +474,26 @@ fn encode_napi_results_array(
                 );
 
                 try translate.u32_into_object(
+                    env,
+                    napi_object,
+                    "ledger",
+                    @intCast(u32, result.ledger),
+                    "Failed to set property \"ledger\" of transfer lookup result.",
+                );
+
+                try translate.u16_into_object(
                     env,
                     napi_object,
                     "code",
-                    @intCast(u32, result.code),
+                    @intCast(u16, result.code),
                     "Failed to set property \"code\" of transfer lookup result.",
                 );
 
-                try translate.u32_into_object(
+                try translate.u16_into_object(
                     env,
                     napi_object,
                     "flags",
-                    @bitCast(u32, result.flags),
+                    @bitCast(u16, result.flags),
                     "Failed to set property \"flags\" of transfer lookup result.",
                 );
 
@@ -579,12 +586,7 @@ fn request(env: c.napi_env, info: c.napi_callback_info) callconv(.C) c.napi_valu
         translate.throw(env, "Unknown operation.") catch return null;
     }
 
-    const message = context.client.get_message() orelse {
-        translate.throw(
-            env,
-            "Too many requests outstanding.",
-        ) catch return null;
-    };
+    const message = context.client.get_message();
     defer context.client.unref(message);
 
     const operation = @intToEnum(Operation, @intCast(u8, operation_int));
@@ -634,12 +636,7 @@ fn raw_request(env: c.napi_env, info: c.napi_callback_info) callconv(.C) c.napi_
     }
     const operation = @intToEnum(Operation, @intCast(u8, operation_int));
 
-    const message = context.client.get_message() orelse {
-        translate.throw(
-            env,
-            "Too many requests outstanding.",
-        ) catch return null;
-    };
+    const message = context.client.get_message();
     defer context.client.unref(message);
 
     const body_length = translate.bytes_from_buffer(
@@ -707,11 +704,6 @@ fn on_result(user_data: u128, operation: Operation, results: Client.Error![]cons
                 env,
                 value,
             ) catch return,
-            .commit_transfers => encode_napi_results_array(
-                CommitTransfersResult,
-                env,
-                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,
         };