Expand description
Internal C bindings. Unless if you are creating something very low-level, you should not need to use this module directly.
Structs§
Constants§
- ALREADY_
SET - CANT_
RETURN_ NEGATIVE - COMPARE_
EQUAL - COMPARE_
GREATER - COMPARE_
LESS - COMPLEX_
NOT_ SUPPORTED - DEBUG
- DIVISION_
BY_ ZERO - DOESNT_
EXIST - DOES_
NOT_ MATCH - EMISSION_
FAILURE - ENCODE_
ACCOUNT_ DST_ SIZE - ENCODE_
ACCOUNT_ OWNER_ SIZE - ENCODE_
ACCOUNT_ SIZE - ENCODE_
ACCOUNT_ SRC_ SIZE - ENCODE_
DROPS_ SIZE - ENCODE_
FLAGS_ SIZE - ENCODE_
FLS_ SIZE - ENCODE_
LLS_ SIZE - ENCODE_
SEQUENCE_ SIZE - ENCODE_
SIGNING_ PUBKEY_ NULL_ SIZE - ENCODE_
SIGNING_ PUBKEY_ SIZE - ENCODE_
TAG_ DST_ SIZE - ENCODE_
TAG_ SRC_ SIZE - ENCODE_
TL_ SIZE - ENCODE_
TT_ SIZE - ENCODE_
UINT32_ COMMON_ SIZE - ENCODE_
UINT32_ UNCOMMON_ SIZE - EXPONENT_
OVERSIZED - EXPONENT_
UNDERSIZED - FEE_
TOO_ LARGE - GUARD_
VIOLATION - HOOKAPI_
INCLUDED - HOOKMACROS_
INCLUDED - INT8_
MAX - INT8_
MIN - INT16_
MAX - INT16_
MIN - INT32_
MAX - INT32_
MIN - INTERNAL_
ERROR - INTPTR_
MAX - INTPTR_
MIN - INT_
FAST8_ MAX - INT_
FAST8_ MIN - INT_
FAST16_ MAX - INT_
FAST16_ MIN - INT_
FAST32_ MAX - INT_
FAST32_ MIN - INT_
LEAS T8_ MAX - INT_
LEAS T8_ MIN - INT_
LEAS T16_ MAX - INT_
LEAS T16_ MIN - INT_
LEAS T32_ MAX - INT_
LEAS T32_ MIN - INVALID_
ACCOUNT - INVALID_
ARGUMENT - INVALID_
FIELD - INVALID_
FLOAT - INVALID_
TXN - KEYLET_
ACCOUNT - KEYLET_
AMENDMENTS - KEYLET_
CHECK - KEYLET_
CHILD - KEYLET_
DEPOSIT_ PREAUTH - KEYLET_
EMITTED - KEYLET_
EMITTED_ DIR - KEYLET_
ESCROW - KEYLET_
FEES - KEYLET_
HOOK - KEYLET_
HOOK_ DEFINITION - KEYLET_
HOOK_ STATE - KEYLET_
HOOK_ STATE_ DIR - KEYLET_
LINE - KEYLET_
NEGATIVE_ UNL - KEYLET_
NFT_ OFFER - KEYLET_
OFFER - KEYLET_
OWNER_ DIR - KEYLET_
PAGE - KEYLET_
PAYCHAN - KEYLET_
QUALITY - KEYLET_
SIGNERS - KEYLET_
SKIP - KEYLET_
TICKET - KEYLET_
UNCHECKED - KEYLET_
URITOKEN - MANTISSA_
OVERSIZED - MANTISSA_
UNDERSIZED - NOT_
AN_ AMOUNT - NOT_
AN_ ARRAY - NOT_
AN_ OBJECT - NOT_
AUTHORIZED - NOT_
IMPLEMENTED - NOT_
IOU_ AMOUNT - NO_
FREE_ SLOTS - NO_
SUCH_ KEYLET - OUT_
OF_ BOUNDS - OVERFLOW
- PARSE_
ERROR - PREPARE_
PAYMENT_ SIMPLE_ SIZE - PREPARE_
PAYMENT_ SIMPLE_ TRUSTLINE_ SIZE - PREREQUISITE_
NOT_ MET - PREVIOUS_
FAILURE_ PREVENTS_ RETRY - PTRDIFF_
MAX - PTRDIFF_
MIN - RC_
ACCEPT - RC_
ROLLBACK - RESERVE_
INSUFFICIENT - SFS_
ACCOUNT - SFS_
AMOUNT_ IOU - SFS_
AMOUNT_ XRP - SIG_
ATOMIC_ MAX - SIG_
ATOMIC_ MIN - SIZE_
MAX - SUCCESS
- TOO_BIG
- TOO_
MANY_ EMITTED_ TXN - TOO_
MANY_ NONCES - TOO_
MANY_ PARAMS - TOO_
SMALL - UINT8_
MAX - UINT16_
MAX - UINT32_
MAX - UINTPTR_
MAX - UINT_
FAST8_ MAX - UINT_
FAST16_ MAX - UINT_
FAST32_ MAX - UINT_
LEAS T8_ MAX - UINT_
LEAS T16_ MAX - UINT_
LEAS T32_ MAX - WINT_
MAX - WINT_
MIN - _ATFILE_
SOURCE - _BITS_
STDINT_ INTN_ H - _BITS_
STDINT_ UINTN_ H - _BITS_
TIME64_ H - _BITS_
TYPESIZES_ H - _BITS_
TYPES_ H - _BITS_
WCHAR_ H - _DEFAULT_
SOURCE - _FEATURES_
H - _POSIX_
C_ SOURCE - _POSIX_
SOURCE - _STDC_
PREDEF_ H - _STDINT_
H - _SYS_
CDEFS_ H - __
FD_ SETSIZE - __
GLIBC_ MINOR__ - __
GLIBC_ USE_ DEPRECATED_ GETS - __
GLIBC_ USE_ DEPRECATED_ SCANF - __
GLIBC_ USE_ IEC_ 60559_ BFP_ EXT - __
GLIBC_ USE_ IEC_ 60559_ BFP_ EXT_ C2X - __
GLIBC_ USE_ IEC_ 60559_ EXT - __
GLIBC_ USE_ IEC_ 60559_ FUNCS_ EXT - __
GLIBC_ USE_ IEC_ 60559_ FUNCS_ EXT_ C2X - __
GLIBC_ USE_ IEC_ 60559_ TYPES_ EXT - __
GLIBC_ USE_ ISOC2X - __
GLIBC_ USE_ LIB_ EXT2 - __
GLIBC__ - __
GNU_ LIBRARY__ - __
HAVE_ GENERIC_ SELECTION - __
KERNEL_ OLD_ TIMEVAL_ MATCHES_ TIMEVA L64 - __
LDOUBLE_ REDIRECTS_ TO_ FLOA T128_ ABI - __
RLIM_ T_ MATCHES_ RLIM64_ T - __
STATFS_ MATCHES_ STATF S64 - __
STDC_ IEC_ 559_ COMPLEX__ - __
STDC_ IEC_ 559__ - __
STDC_ IEC_ 60559_ BFP__ - __
STDC_ IEC_ 60559_ COMPLEX__ - __
STDC_ ISO_ 10646__ - __
TIMESIZE - __
USE_ ATFILE - __
USE_ FORTIFY_ LEVEL - __
USE_ ISOC11 - __
USE_ ISOC95 - __
USE_ ISOC99 - __
USE_ MISC - __
USE_ POSIX - __
USE_ POSI X2 - __
USE_ POSI X199309 - __
USE_ POSI X199506 - __
USE_ POSIX_ IMPLICITLY - __
USE_ XOPE N2K - __
USE_ XOPE N2K8 - __
WORDSIZE - __
WORDSIZ E32_ PTRDIFF_ LONG - __
WORDSIZ E32_ SIZE_ ULONG - __
WORDSIZE_ TIME64_ COMPA T32 - __
glibc_ c99_ flexarr_ available - amAMOUNT
- amBALANCE
- amDELIVEREDAMOUNT
- amDELIVERMIN
- amFEE
- amHIGHLIMIT
- amLIMITAMOUNT
- amLOWLIMIT
- amMINIMUMOFFER
- amRIPPLEESCROW
- amSENDMAX
- amTAKERGETS
- amTAKERPAYS
- atACCOUNT
- atAUTHORIZE
- atDESTINATION
- atISSUER
- atOWNER
- atPSEUDOCALLBACK
- atREGULARKEY
- atTARGET
- atUNAUTHORIZE
- sfAccount
- sfAccount
Hash - sfAccount
TxnID - sfAffected
Nodes - sfAmendment
- sfAmendments
- sfAmount
- sfAuthorize
- sfBalance
- sfBase
Fee - sfBlob
- sfBond
Amount - sfBook
Directory - sfBook
Node - sfBurnedNF
Tokens - sfCancel
After - sfChannel
- sfCheckID
- sfClear
Flag - sfClose
Resolution - sfClose
Time - sfCondition
- sfConsensus
Hash - sfCookie
- sfCreate
Code - sfCreated
Node - sfDeleted
Node - sfDeliver
Min - sfDelivered
Amount - sfDestination
- sfDestination
Node - sfDestination
Tag - sfDigest
- sfDisabled
Validator - sfDisabled
Validators - sfDomain
- sfEmail
Hash - sfEmit
Burden - sfEmit
Callback - sfEmit
Details - sfEmit
Generation - sfEmit
Hook Hash - sfEmit
Nonce - sfEmit
Parent TxnID - sfEmitted
Txn - sfEscrowID
- sfExchange
Rate - sfExpiration
- sfExpire
Code - sfFee
- sfFinal
Fields - sfFinish
After - sfFirst
Ledger Sequence - sfFlags
- sfFulfillment
- sfFund
Code - sfHashes
- sfHigh
Limit - sfHigh
Node - sfHigh
Quality In - sfHigh
Quality Out - sfHook
- sfHook
Account - sfHook
ApiVersion - sfHook
Callback Fee - sfHook
Definition - sfHook
Emit Count - sfHook
Execution - sfHook
Execution Index - sfHook
Executions - sfHook
Grant - sfHook
Grants - sfHook
Hash - sfHook
Instruction Count - sfHook
Namespace - sfHook
Namespaces - sfHook
On - sfHook
Parameter - sfHook
Parameter Name - sfHook
Parameter Value - sfHook
Parameters - sfHook
Result - sfHook
Return Code - sfHook
Return String - sfHook
SetTxnID - sfHook
State Change Count - sfHook
State Count - sfHook
State Data - sfHook
State Key - sfHooks
- sfIndex
Next - sfIndex
Previous - sfIndexes
- sfInvoiceID
- sfIssuer
- sfLast
Ledger Sequence - sfLedger
Entry Type - sfLedger
Hash - sfLedger
Index - sfLedger
Sequence - sfLimit
Amount - sfLoad
Fee - sfLock
Count - sfLocked
Balance - sfLow
Limit - sfLow
Node - sfLow
Quality In - sfLow
Quality Out - sfMajorities
- sfMajority
- sfMaster
Signature - sfMemo
- sfMemo
Data - sfMemo
Format - sfMemo
Type - sfMemos
- sfMessage
Key - sfMethod
- sfMinimum
Offer - sfMintedNF
Tokens - sfModified
Node - sfNF
Token - sfNF
Token Broker Fee - sfNF
Token BuyOffer - sfNF
TokenID - sfNF
Token Minter - sfNF
Token Offer Node - sfNF
Token Offers - sfNF
Token Sell Offer - sfNF
Token Taxon - sfNF
Tokens - sfNecessary
- sfNetworkID
- sfNew
Fields - sfNext
Page Min - sfNickname
- sfOfferID
- sfOffer
Sequence - sfOperation
Limit - sfOwner
- sfOwner
Count - sfOwner
Node - sfParent
Close Time - sfParent
Hash - sfPaths
- sfPrevious
Fields - sfPrevious
Page Min - sfPrevious
TxnID - sfPrevious
TxnLgr Seq - sfPublic
Key - sfQuality
In - sfQuality
Out - sfReference
Count - sfReference
FeeUnits - sfRegular
Key - sfRemove
Code - sfReserve
Base - sfReserve
Increment - sfReward
Accumulator - sfReward
LgrFirst - sfReward
LgrLast - sfReward
Time - sfRipple
Escrow - sfRoot
Index - sfSend
Max - sfSequence
- sfServer
Version - sfSet
Flag - sfSettle
Delay - sfSignature
- sfSigner
- sfSigner
Entries - sfSigner
Entry - sfSigner
ListID - sfSigner
Quorum - sfSigner
Weight - sfSigners
- sfSigning
PubKey - sfSigning
Time - sfSource
Tag - sfStamp
Escrow - sfSufficient
- sfTaker
Gets - sfTaker
Gets Currency - sfTaker
Gets Issuer - sfTaker
Pays - sfTaker
Pays Currency - sfTaker
Pays Issuer - sfTemplate
- sfTemplate
Entry - sfTick
Size - sfTicket
Count - sfTicket
Sequence - sfTransaction
Hash - sfTransaction
Index - sfTransaction
Meta Data - sfTransaction
Result - sfTransaction
Type - sfTransfer
Fee - sfTransfer
Rate - sfTxn
Signature - sfUNL
Modify Disabling - sfUNL
Modify Validator - sfURI
- sfURI
TokenID - sfUnauthorize
- sfValidated
Hash - sfValidator
ToDisable - sfValidator
ToRe Enable - sfVersion
- sfWallet
Locator - sfWallet
Size - tfCANONICAL
- ttACCOUNT_
DELETE - ttACCOUNT_
SET - ttAMENDMENT
- ttCHECK_
CANCEL - ttCHECK_
CASH - ttCHECK_
CREATE - ttCLAIM_
REWARD - ttDEPOSIT_
PREAUTH - ttEMIT_
FAILURE - ttESCROW_
CANCEL - ttESCROW_
CREATE - ttESCROW_
FINISH - ttFEE
- ttIMPORT
- ttINVOKE
- ttNFTOKEN_
ACCEPT_ OFFER - ttNFTOKEN_
BURN - ttNFTOKEN_
CANCEL_ OFFER - ttNFTOKEN_
CREATE_ OFFER - ttNFTOKEN_
MINT - ttOFFER_
CANCEL - ttOFFER_
CREATE - ttPAYCHAN_
CLAIM - ttPAYCHAN_
CREATE - ttPAYCHAN_
FUND - ttPAYMENT
- ttREGULAR_
KEY_ SET - ttSET_
HOOK - ttSIGNER_
LIST_ SET - ttTICKET_
CREATE - ttTRUST_
SET - ttUNL_
MODIFY - ttURITOKEN_
BURN - ttURITOKEN_
BUY - ttURITOKEN_
CANCEL_ SELL_ OFFER - ttURITOKEN_
CREATE_ SELL_ OFFER - ttURITOKEN_
MINT
Functions§
- _g⚠
- accept⚠
- emit⚠
- etxn_
burden ⚠ - etxn_
details ⚠ - etxn_
fee_ ⚠base - etxn_
generation ⚠ - etxn_
nonce ⚠ - etxn_
reserve ⚠ - fee_
base ⚠ - float_
compare ⚠ - float_
divide ⚠ - float_
int ⚠ - float_
invert ⚠ - float_
log ⚠ - float_
mantissa ⚠ - float_
mantissa_ ⚠set - float_
mulratio ⚠ - float_
multiply ⚠ - float_
negate ⚠ - float_
one ⚠ - float_
root ⚠ - float_
set ⚠ - float_
sign ⚠ - float_
sign_ ⚠set - float_
sto ⚠ - float_
sto_ ⚠set - float_
sum ⚠ - hook_
account ⚠ - hook_
again ⚠ - hook_
hash ⚠ - hook_
param ⚠ - hook_
param_ ⚠set - hook_
pos ⚠ - hook_
skip ⚠ - ledger_
keylet ⚠ - ledger_
last_ ⚠hash - ledger_
last_ ⚠time - ledger_
nonce ⚠ - ledger_
seq ⚠ - meta_
slot ⚠ - otxn_
burden ⚠ - otxn_
field ⚠ - otxn_
field_ ⚠txt - otxn_
generation ⚠ - otxn_id⚠
- otxn_
param ⚠ - otxn_
slot ⚠ - otxn_
type ⚠ - rollback⚠
- slot⚠
- slot_
clear ⚠ - slot_
count ⚠ - slot_
float ⚠ - slot_id⚠
- slot_
set ⚠ - slot_
size ⚠ - slot_
subarray ⚠ - slot_
subfield ⚠ - slot_
type ⚠ - state⚠
- state_
foreign ⚠ - state_
foreign_ ⚠set - state_
set ⚠ - sto_
emplace ⚠ - sto_
erase ⚠ - sto_
subarray ⚠ - sto_
subfield ⚠ - sto_
validate ⚠ - trace⚠
- trace_
float ⚠ - trace_
num ⚠ - trace_
slot ⚠ - util_
accid ⚠ - util_
keylet ⚠ - util_
raddr ⚠ - util_
sha512h ⚠ - util_
verify ⚠
Type Aliases§
- __
blkcnt64_ t - __
blkcnt_ t - __
blksize_ t - __
caddr_ t - __
clock_ t - __
clockid_ t - __
daddr_ t - __dev_t
- __
fsblkcnt64_ t - __
fsblkcnt_ t - __
fsfilcnt64_ t - __
fsfilcnt_ t - __
fsword_ t - __gid_t
- __id_t
- __
ino64_ t - __ino_t
- __
int8_ t - __
int16_ t - __
int32_ t - __
int64_ t - __
int_ least8_ t - __
int_ least16_ t - __
int_ least32_ t - __
int_ least64_ t - __
intmax_ t - __
intptr_ t - __key_t
- __
loff_ t - __
mode_ t - __
nlink_ t - __
off64_ t - __off_t
- __pid_t
- __
quad_ t - __
rlim64_ t - __
rlim_ t - __
sig_ atomic_ t - __
socklen_ t - __
ssize_ t - __
suseconds64_ t - __
suseconds_ t - __
syscall_ slong_ t - __
syscall_ ulong_ t - __
time64_ t - __
time_ t - __
timer_ t - __
u_ char - __u_int
- __
u_ long - __
u_ quad_ t - __
u_ short - __uid_t
- __
uint8_ t - __
uint16_ t - __
uint32_ t - __
uint64_ t - __
uint_ least8_ t - __
uint_ least16_ t - __
uint_ least32_ t - __
uint_ least64_ t - __
uintmax_ t - __
useconds_ t - int_
fast8_ t - int_
fast16_ t - int_
fast32_ t - int_
fast64_ t - int_
least8_ t - int_
least16_ t - int_
least32_ t - int_
least64_ t - intmax_
t - uint_
fast8_ t - uint_
fast16_ t - uint_
fast32_ t - uint_
fast64_ t - uint_
least8_ t - uint_
least16_ t - uint_
least32_ t - uint_
least64_ t - uintmax_
t