Module: TBClient

Extended by:

FFI::Library

Defined in:

lib/tb_client.rb,
lib/tb_client/shared_lib.rb

Defined Under Namespace

Modules: SharedLib Classes: Account, AccountBalance, AccountFilter, Client, CreateAccountsResult, CreateTransfersResult, Packet, QueryFilter, Transfer, UInt128

Constant Summary

InitStatus =

enum(FFI::Type::UINT8, [
:SUCCESS, 0,
:UNEXPECTED,
:OUT_OF_MEMORY,
:ADDRESS_INVALID,
:ADDRESS_LIMIT_EXCEEDED,
:SYSTEM_RESOURCES,
:NETWORK_SUBSYSTEM])

ClientStatus =

enum(FFI::Type::UINT8, [
:OK, 0,
:INVALID])

PacketStatus =

enum(FFI::Type::UINT8, [
:OK, 0,
:TOO_MUCH_DATA,
:CLIENT_EVICTED,
:CLIENT_RELEASE_TOO_LOW,
:CLIENT_RELEASE_TOO_HIGH,
:CLIENT_SHUTDOWN,
:INVALID_OPERATION,
:INVALID_DATA_SIZE])

RegisterLogCallbackStatus =

enum(FFI::Type::UINT8, [
:SUCCESS, 0,
:ALREADY_REGISTERED,
:NOT_REGISTERED])

Operation =

enum(FFI::Type::UINT8, [
:PULSE, 128,
:GET_EVENTS, 137,
:CREATE_ACCOUNTS, 138,
:CREATE_TRANSFERS, 139,
:LOOKUP_ACCOUNTS, 140,
:LOOKUP_TRANSFERS, 141,
:GET_ACCOUNT_TRANSFERS, 142,
:GET_ACCOUNT_BALANCES, 143,
:QUERY_ACCOUNTS, 144,
:QUERY_TRANSFERS, 145])

CreateAccountResult =

enum(FFI::Type::UINT32, [
:OK, 0,
:LINKED_EVENT_FAILED, 1,
:LINKED_EVENT_CHAIN_OPEN, 2,
:IMPORTED_EVENT_EXPECTED, 22,
:IMPORTED_EVENT_NOT_EXPECTED, 23,
:TIMESTAMP_MUST_BE_ZERO, 3,
:IMPORTED_EVENT_TIMESTAMP_OUT_OF_RANGE, 24,
:IMPORTED_EVENT_TIMESTAMP_MUST_NOT_ADVANCE, 25,
:RESERVED_FIELD, 4,
:RESERVED_FLAG, 5,
:ID_MUST_NOT_BE_ZERO, 6,
:ID_MUST_NOT_BE_INT_MAX, 7,
:EXISTS_WITH_DIFFERENT_FLAGS, 15,
:EXISTS_WITH_DIFFERENT_USER_DATA_128, 16,
:EXISTS_WITH_DIFFERENT_USER_DATA_64, 17,
:EXISTS_WITH_DIFFERENT_USER_DATA_32, 18,
:EXISTS_WITH_DIFFERENT_LEDGER, 19,
:EXISTS_WITH_DIFFERENT_CODE, 20,
:EXISTS, 21,
:FLAGS_ARE_MUTUALLY_EXCLUSIVE, 8,
:DEBITS_PENDING_MUST_BE_ZERO, 9,
:DEBITS_POSTED_MUST_BE_ZERO, 10,
:CREDITS_PENDING_MUST_BE_ZERO, 11,
:CREDITS_POSTED_MUST_BE_ZERO, 12,
:LEDGER_MUST_NOT_BE_ZERO, 13,
:CODE_MUST_NOT_BE_ZERO, 14,
:IMPORTED_EVENT_TIMESTAMP_MUST_NOT_REGRESS, 26])

CreateTransferResult =

enum(FFI::Type::UINT32, [
:OK, 0,
:LINKED_EVENT_FAILED, 1,
:LINKED_EVENT_CHAIN_OPEN, 2,
:IMPORTED_EVENT_EXPECTED, 56,
:IMPORTED_EVENT_NOT_EXPECTED, 57,
:TIMESTAMP_MUST_BE_ZERO, 3,
:IMPORTED_EVENT_TIMESTAMP_OUT_OF_RANGE, 58,
:IMPORTED_EVENT_TIMESTAMP_MUST_NOT_ADVANCE, 59,
:RESERVED_FLAG, 4,
:ID_MUST_NOT_BE_ZERO, 5,
:ID_MUST_NOT_BE_INT_MAX, 6,
:EXISTS_WITH_DIFFERENT_FLAGS, 36,
:EXISTS_WITH_DIFFERENT_PENDING_ID, 40,
:EXISTS_WITH_DIFFERENT_TIMEOUT, 44,
:EXISTS_WITH_DIFFERENT_DEBIT_ACCOUNT_ID, 37,
:EXISTS_WITH_DIFFERENT_CREDIT_ACCOUNT_ID, 38,
:EXISTS_WITH_DIFFERENT_AMOUNT, 39,
:EXISTS_WITH_DIFFERENT_USER_DATA_128, 41,
:EXISTS_WITH_DIFFERENT_USER_DATA_64, 42,
:EXISTS_WITH_DIFFERENT_USER_DATA_32, 43,
:EXISTS_WITH_DIFFERENT_LEDGER, 67,
:EXISTS_WITH_DIFFERENT_CODE, 45,
:EXISTS, 46,
:ID_ALREADY_FAILED, 68,
:FLAGS_ARE_MUTUALLY_EXCLUSIVE, 7,
:DEBIT_ACCOUNT_ID_MUST_NOT_BE_ZERO, 8,
:DEBIT_ACCOUNT_ID_MUST_NOT_BE_INT_MAX, 9,
:CREDIT_ACCOUNT_ID_MUST_NOT_BE_ZERO, 10,
:CREDIT_ACCOUNT_ID_MUST_NOT_BE_INT_MAX, 11,
:ACCOUNTS_MUST_BE_DIFFERENT, 12,
:PENDING_ID_MUST_BE_ZERO, 13,
:PENDING_ID_MUST_NOT_BE_ZERO, 14,
:PENDING_ID_MUST_NOT_BE_INT_MAX, 15,
:PENDING_ID_MUST_BE_DIFFERENT, 16,
:TIMEOUT_RESERVED_FOR_PENDING_TRANSFER, 17,
:CLOSING_TRANSFER_MUST_BE_PENDING, 64,
:LEDGER_MUST_NOT_BE_ZERO, 19,
:CODE_MUST_NOT_BE_ZERO, 20,
:DEBIT_ACCOUNT_NOT_FOUND, 21,
:CREDIT_ACCOUNT_NOT_FOUND, 22,
:ACCOUNTS_MUST_HAVE_THE_SAME_LEDGER, 23,
:TRANSFER_MUST_HAVE_THE_SAME_LEDGER_AS_ACCOUNTS, 24,
:PENDING_TRANSFER_NOT_FOUND, 25,
:PENDING_TRANSFER_NOT_PENDING, 26,
:PENDING_TRANSFER_HAS_DIFFERENT_DEBIT_ACCOUNT_ID, 27,
:PENDING_TRANSFER_HAS_DIFFERENT_CREDIT_ACCOUNT_ID, 28,
:PENDING_TRANSFER_HAS_DIFFERENT_LEDGER, 29,
:PENDING_TRANSFER_HAS_DIFFERENT_CODE, 30,
:EXCEEDS_PENDING_TRANSFER_AMOUNT, 31,
:PENDING_TRANSFER_HAS_DIFFERENT_AMOUNT, 32,
:PENDING_TRANSFER_ALREADY_POSTED, 33,
:PENDING_TRANSFER_ALREADY_VOIDED, 34,
:PENDING_TRANSFER_EXPIRED, 35,
:IMPORTED_EVENT_TIMESTAMP_MUST_NOT_REGRESS, 60,
:IMPORTED_EVENT_TIMESTAMP_MUST_POSTDATE_DEBIT_ACCOUNT, 61,
:IMPORTED_EVENT_TIMESTAMP_MUST_POSTDATE_CREDIT_ACCOUNT, 62,
:IMPORTED_EVENT_TIMEOUT_MUST_BE_ZERO, 63,
:DEBIT_ACCOUNT_ALREADY_CLOSED, 65,
:CREDIT_ACCOUNT_ALREADY_CLOSED, 66,
:OVERFLOWS_DEBITS_PENDING, 47,
:OVERFLOWS_CREDITS_PENDING, 48,
:OVERFLOWS_DEBITS_POSTED, 49,
:OVERFLOWS_CREDITS_POSTED, 50,
:OVERFLOWS_DEBITS, 51,
:OVERFLOWS_CREDITS, 52,
:OVERFLOWS_TIMEOUT, 53,
:EXCEEDS_CREDITS, 54,
:EXCEEDS_DEBITS, 55])

LogLevel =

enum(FFI::Type::UINT8, [
:ERR, 0,
:WARN,
:INFO,
:DEBUG])

AccountFlags =

bitmask(FFI::Type::UINT16, [
  :LINKED,
  :DEBITS_MUST_NOT_EXCEED_CREDITS,
  :CREDITS_MUST_NOT_EXCEED_DEBITS,
  :HISTORY,
  :IMPORTED,
  :CLOSED]
)

TransferFlags =

bitmask(FFI::Type::UINT16, [
  :LINKED,
  :PENDING,
  :POST_PENDING_TRANSFER,
  :VOID_PENDING_TRANSFER,
  :BALANCING_DEBIT,
  :BALANCING_CREDIT,
  :CLOSING_DEBIT,
  :CLOSING_CREDIT,
  :IMPORTED]
)

AccountFilterFlags =

bitmask(FFI::Type::UINT32, [:DEBITS, :CREDITS, :REVERSED])

QueryFilterFlags =

bitmask(FFI::Type::UINT32, [:REVERSED])