float_sto

Conceptos

Números de punto flotante (XFL) Objetos serializados

Comportamiento

C

• Lee un número de punto flotante XFL y opcionalmente un código de campo y código de moneda
• Escribe una cantidad serializada en write_ptr según los parámetros proporcionados

JavaScript

• Almacena una representación flotante en un campo específico.
• Devuelve un código de error o el valor actualizado como un array de números.

Definición

C

int64_t float_sto (
    uint32_t write_ptr,
    uint32_t write_len,
    uint32_t cread_ptr,
    uint32_t cread_len,
    uint32_t iread_ptr,
    uint32_t iread_len,
    int64_t float1,
    uint32_t field_code
);

JavaScript

function float_sto(
    currency: ByteArray | HexString | undefined,
    issuer: ByteArray | HexString | undefined,
    f1: bigint,
    field_code: number
  ): ErrorCode | ByteArray

Ejemplo

C

#define SBUF(str) (uint32_t)(str), sizeof(str)
uint8_t amt_out[48];
if (float_sto(SBUF(amt_out),
    SBUF(currency), SBUF(hook_accid), pusd_to_send, -1) < 0)
        rollback(SBUF("Peggy: No se pudo serializar la cantidad pusd"), 1);

JavaScript

const amt_out = float_sto(currency, hook_accid, pusd_to_send, -1)
if (typeof amt_out === 'number')
        rollback("Peggy: No se pudo serializar la cantidad pusd", 1)

Parámetros

C

Nombre	Tipo	Descripción
write_ptr	uint32_t	Puntero a un buffer de tamaño adecuado para almacenar el campo serializado. Se recomiendan al menos 48 bytes.
write_len	uint32_t	Longitud del buffer de salida.
cread_ptr	uint32_t	Puntero a un buffer que contiene el código de moneda a serializar. Puede ser null.
cread_len	uint32_t	Longitud del código de moneda. Debe ser 20, 3 o 0 (null).
iread_ptr	uint32_t	Puntero a un buffer que contiene el Account ID del emisor. Puede ser null.
iread_len	uint32_t	Longitud del Account ID del emisor. Debe ser 20 o 0 (null).
float1	int64_t	Número XFL a serializar.
field_code	uint32_t	Código de campo sf para prefijar la cantidad serializada (ej. sfAmount). Si es 0xFFFFFFFFU (o (uint32_t)(-1)) no se añade código de campo ni moneda/emisor, pero se serializa como flotante. Si es 0, tampoco se añade código de campo ni moneda/emisor, pero se serializa como cantidad nativa XRP.

Consejo

Para generar una cantidad XAH, rellena previamente el código de campo en el buffer de salida y pasa el buffer desplazado junto con 0 como field_code.

JavaScript

Nombre	Tipo	Descripción
currency	ByteArray | HexString | undefined	Valor de moneda a almacenar
issuer	ByteArray | HexString | undefined	Emisor a almacenar
f1	bigint	Número flotante XFL
field_code	number	Código de campo donde almacenar el valor

Código de retorno

C

Tipo	Descripción
int64_t	Número de bytes escritos en el buffer. Si es negativo, error: INVALID_FLOAT - el número no es un XFL válido OUT_OF_BOUNDS - punteros fuera de memoria del hook INVALID_ARGUMENT - parámetros incorrectos para modo XRP o sin field code TOO_SMALL - buffer demasiado pequeño XFL_OVERFLOW - desbordamiento al normalizar

JavaScript

Tipo	Descripción
ErrorCode | ByteArray	Código de error o array con el valor serializado