sto_emplace

Conceptos

Comportamiento

C
JavaScript

Parsea un STObject S (objeto origen) apuntado por sread_ptr
Parsea un STObject F (campo a insertar/incrustar) apuntado por fread_ptr
Escribe un nuevo STObject en write_ptr que inserta F dentro de S en la posición canónica field_id

Recibe el objeto STO mediante el parámetro sto
Recibe los bytes del campo a añadir mediante field_bytes
Recibe el identificador del campo mediante field_id
Devuelve el objeto STO actualizado en formato binario de datos del ledger, o un error si falla

int64_t sto_emplace (
    uint32_t write_ptr,
    uint32_t write_len,
    uint32_t sread_ptr,
    uint32_t sread_len,
    uint32_t fread_ptr,
    uint32_t fread_len,
    uint32_t field_id
);

function sto_emplace(
    sto: ByteArray | HexString,
    field_bytes: ByteArray | HexString,
    field_id: number
  ): ErrorCode | ByteArray

Ejemplo

C
JavaScript

uint8_t tx_out[1024];

int64_t tx_len =
sto_emplace(tx_out, sizeof(tx_out),
tx_in, tx_len,
sequence_field, 5, sfSequence);

if (tx_len <= 0)
rollback("Emplacing failed.", 17, 1);

const tx_out = sto_emplace(tx_in, sequence_field, sfSequence)
if (typeof tx_out === 'number')
    rollback("Emplacing failed.", 1)

Parámetros

C
JavaScript

Nombre	Tipo	Descripción
write_ptr	uint32_t	Buffer donde se escribirá el STObject modificado
write_len	uint32_t	Longitud del buffer de salida
sread_ptr	uint32_t	Buffer que contiene el STObject origen
sread_len	uint32_t	Longitud del objeto origen
fread_ptr	uint32_t	Buffer que contiene el campo a insertar
fread_len	uint32_t	Longitud del campo a insertar
field_id	uint32_t	Código `sf` donde insertar el campo. Si ya existe, se sobrescribe; si no, se inserta

Nombre	Tipo	Descripción
sto	ByteArray \| HexString	Objeto STO (datos binarios del ledger) donde se insertará el campo
field_bytes	ByteArray \| HexString	Bytes del campo a añadir
field_id	number	Identificador del campo a añadir

Código de retorno

C
JavaScript

Tipo	Descripción
int64_t	Número de bytes escritos en `write_ptr` Si es negativo, error: `OUT_OF_BOUNDS` - punteros fuera de la memoria del hook `TOO_SMALL` - buffer insuficiente (debe cubrir objeto + campo) `TOO_BIG` - el campo es demasiado grande `PARSE_ERROR` - el STObject es inválido o mal formado