tigerbeetle-node 0.8.1 → 0.9.143

package/src/index.ts

@@ -1,4 +1,69 @@
-const binding: Binding = require('./client.node')
+export * from './bindings'
+import {
+  Account,
+  Transfer,
+  CreateAccountsError,
+  CreateTransfersError,
+  Operation,
+} from './bindings'
+
+function getBinding (): Binding {
+  const { arch, platform } = process
+
+  const archMap = {
+    "arm64": "aarch64",
+    "x64": "x86_64"
+  }
+
+  const platformMap = {
+    "linux": "linux",
+    "darwin": "macos",
+    "win32" : "windows",
+  }
+
+  if (! (arch in archMap)) {
+    throw new Error(`Unsupported arch: ${arch}`)
+  }
+
+  if (! (platform in platformMap)) {
+    throw new Error(`Unsupported platform: ${platform}`)
+  }
+
+  let extra = ''
+
+  /**
+   * We need to detect during runtime which libc we're running on to load the correct NAPI.
+   * binary.
+   *
+   * Rationale: The /proc/self/map_files/ subdirectory contains entries corresponding to
+   * memory-mapped files loaded by Node.
+   * https://man7.org/linux/man-pages/man5/proc.5.html: We detect a musl-based distro by
+   * checking if any library contains the name "musl".
+   *
+   * Prior art: https://github.com/xerial/sqlite-jdbc/issues/623
+   */
+
+  const fs = require('fs')
+  const path = require('path')
+
+  if (platform === 'linux') {
+    extra = '-gnu'
+
+    for (const file of fs.readdirSync("/proc/self/map_files/")) {
+      const realPath = fs.readlinkSync(path.join("/proc/self/map_files/", file))
+      if (realPath.includes('musl')) {
+        extra = '-musl'
+        break
+      }
+    }
+  }
+
+  const filename = `./bin/${archMap[arch]}-${platformMap[platform]}${extra}/client.node`
+  return require(filename)
+}
+
+const binding = getBinding()
+
 interface Binding {
   init: (args: BindingInitArgs) => Context
   request: (context: Context, operation: Operation, batch: Event[], result: ResultCallback) => void
@@ -20,171 +85,14 @@ export interface InitArgs {
 
 export type Context = object
 
-export type Account = {
-  id: bigint // u128
-  user_data: bigint // u128
-  reserved: Buffer // [48]u8
-  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 // 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
-}
-
-export enum AccountFlags {
-  linked = (1 << 0),
-  debits_must_not_exceed_credits = (1 << 1),
-  credits_must_not_exceed_debits = (1 << 2)
-}
-
-export enum CreateAccountError {
-  // ok = 0 (No Error)
-  linked_event_failed = 1,
-
-  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,
-
-  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 = {
-  index: number,
-  code: CreateAccountError,
-}
-
-export type Transfer = {
-  id: bigint, // u128
-  debit_account_id: bigint, // u128
-  credit_account_id: bigint, // u128
-  user_data: bigint, // u128
-  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 timestamp will be set by TigerBeetle.
-}
-
-export enum TransferFlags {
-  linked = (1 << 0),
-  pending = (1 << 1),
-  post_pending_transfer = (1 << 2),
-  void_pending_transfer = (1 << 3)
-}
-
-export enum CreateTransferError {
-  // ok = 0 (No Error)
-  linked_event_failed = 1,
-
-  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_pending_id,
-  exists_with_different_timeout,
-  exists_with_different_code,
-  exists_with_different_amount,
-  exists,
-
-  overflows_debits_pending,
-  overflows_credits_pending,
-  overflows_debits_posted,
-  overflows_credits_posted,
-  overflows_debits,
-  overflows_credits,
-
-  exceeds_credits,
-  exceeds_debits,
-
-  cannot_post_and_void_pending_transfer,
-  pending_transfer_cannot_post_or_void_another,
-  timeout_reserved_for_pending_transfer,
-
-  pending_id_must_not_be_zero,
-  pending_id_must_be_different,
-
-  pending_transfer_not_found,
-  pending_transfer_not_pending,
-
-  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 CreateTransfersError = {
-  index: number,
-  code: CreateTransferError,
-}
-
 export type AccountID = bigint // u128
 export type TransferID = bigint // u128
 
 export type Event = Account | Transfer | AccountID | TransferID
 export type Result = CreateAccountsError | CreateTransfersError | Account | Transfer
+// Note: as of #990, the error is always `undefined` here.
 export type ResultCallback = (error: undefined | Error, results: Result[]) => void
 
-export enum Operation {
-  CREATE_ACCOUNT = 3,
-  CREATE_TRANSFER,
-  ACCOUNT_LOOKUP,
-  TRANSFER_LOOKUP
-}
-
 export interface Client {
   createAccounts: (batch: Account[]) => Promise<CreateAccountsError[]>
   createTransfers: (batch: Transfer[]) => Promise<CreateTransfersError[]>
@@ -264,7 +172,7 @@ export function createClient (args: InitArgs): Client {
       }
 
       try {
-        binding.request(context, Operation.CREATE_ACCOUNT, batch, callback)
+        binding.request(context, Operation.create_accounts, batch, callback)
       } catch (error) {
         reject(error)
       }
@@ -291,7 +199,7 @@ export function createClient (args: InitArgs): Client {
       }
 
       try {
-        binding.request(context, Operation.CREATE_TRANSFER, batch, callback)
+        binding.request(context, Operation.create_transfers, batch, callback)
       } catch (error) {
         reject(error)
       }
@@ -309,7 +217,7 @@ export function createClient (args: InitArgs): Client {
       }
 
       try {
-        binding.request(context, Operation.ACCOUNT_LOOKUP, batch, callback)
+        binding.request(context, Operation.lookup_accounts, batch, callback)
       } catch (error) {
         reject(error)
       }
@@ -327,7 +235,7 @@ export function createClient (args: InitArgs): Client {
       }
 
       try {
-        binding.request(context, Operation.TRANSFER_LOOKUP, batch, callback)
+        binding.request(context, Operation.lookup_transfers, batch, callback)
       } catch (error) {
         reject(error)
       }