float_sto

Conceitos

Números de Ponto Flutuante (XFL) Objetos Serializados

Comportamento

C

• Lê um número de ponto flutuante XFL e, opcionalmente, um código de campo e um código de moeda
• Escreve um valor (amount) serializado em write_ptr conforme os parâmetros fornecidos

JavaScript

• Armazena uma representação de float em um campo especificado.
• Retorna um código de erro ou o valor atualizado como um array de números.

Definição

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

Exemplo

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: Could not dump pusd amount into sto"), 1);

JavaScript

const amt_out = float_sto(currency, hook_accid, pusd_to_send, -1)
if (typeof amt_out === 'number')
        rollback("Peggy: Could not dump pusd amount into sto", 1)

Parâmetros

C

Nome	Tipo	Descrição
write_ptr	uint32_t	Ponteiro para um buffer de tamanho adequado para armazenar o campo de valor (amount) serializado. Recomenda-se pelo menos 48 bytes.
write_len	uint32_t	O tamanho do buffer de saída.
cread_ptr	uint32_t	Ponteiro para um buffer contendo o código de moeda a ser serializado na saída. Pode ser nulo.
cread_len	uint32_t	O tamanho do código de moeda. Deve ser 20 ou 3 ou 0 (nulo).
iread_ptr	uint32_t	Ponteiro para um buffer contendo o Account ID do emissor a ser serializado na saída. Pode ser nulo.
iread_len	uint32_t	O tamanho do Account ID do emissor. Deve ser 20 ou 0 (nulo).
float1	int64_t	Um número de ponto flutuante de envoltório XFL a ser serializado.
field_code	uint32_t	O código de campo sf a ser usado como prefixo do valor (amount) serializado. Ex.: sfAmount. Se este campo for 0xFFFFFFFFU (ou seja, (uint32_t)(-1)), então nenhum código de campo é antecedido à saída, e nenhum emissor ou código de moeda é anexado, mas a serialização ocorre como um valor (amount) de ponto flutuante. Se este campo for 0, nenhum código de campo é antecedido à saída, e nenhum emissor ou código de moeda é anexado, mas a serialização ocorre como se o valor (amount) fosse um valor nativo de XRP em vez de um ponto flutuante.

Dica

Para gerar um valor (amount) em XAH, pré-popule o código de campo no buffer de saída e, em seguida, passe o buffer de saída incrementado para o novo início e 0 como field_code

JavaScript

Nome	Tipo	Descrição
currency	ByteArray | HexString | undefined	O valor atual no qual armazenar.
issuer	ByteArray | HexString | undefined	O valor a ser armazenado.
f1	bigint	O código de campo indicando onde armazenar o float.
field_code	number	Um código de erro ou o valor atualizado como um array de números.

Código de Retorno

C

Tipo

Descrição

int64_t

O número de bytes escritos no buffer de saída. Se negativo, um erro: INVALID_FLOAT - o float fornecido não era um número de envoltório XFL válido OUT_OF_BOUNDS - ponteiros/tamanhos especificados fora da memória do hook. INVALID_ARGUMENT - Se instruído a gerar a saída como XRP ou sem field code, então todos os ponteiros e tamanhos que não sejam de escrita devem ser 0 (nulo). TOO_SMALL - O buffer de saída era pequeno demais para receber o objeto serializado. XFL_OVERFLOW - Expressar a saída causou um overflow durante a normalização.

JavaScript

Tipo	Descrição
ErrorCode | ByteArray	Retorna um código de erro ou o valor atualizado como um array de números.