state_set

Comportamiento

C

• Lee una clave de Hook State de 32 bytes desde kread_ptr
• Lee una cantidad arbitraria de datos desde read_ptr (el valor)
• Actualiza la clave de Hook State con el valor

JavaScript

• Establece el Hook State con el valor y la clave especificados
• Devuelve el número de bytes escritos en el Hook State (longitud de los datos), negativo en caso de error

Definición

C

int64_t state_set (
    uint32_t read_ptr,
    uint32_t read_len,
    uint32_t kread_ptr,
    uint32_t kread_len
);

JavaScript

function state_set(
    value: ByteArray | HexString | undefined | null,
    key: ByteArray | HexString
  ): ErrorCode | number

Ejemplo

C

#define SBUF(str) (uint32_t)(str), sizeof(str)
if (state_set(SBUF(vault), SBUF(vault_key)) < 0)
    rollback(SBUF("Error: no se pudo establecer el estado!"), 1);

Consejo

Para eliminar el estado usa state_set(0, 0, SBUF(key));.

JavaScript

const result = state_set(vault, vault_key)
if (result < 0)
    rollback("Error: no se pudo establecer el estado!", 1);

Consejo

Para eliminar el estado usa state_set(null, key);.

Parámetros

C

Nombre	Tipo	Descripción
read_ptr	uint32_t	Puntero a los datos (valor) a escribir en el Hook State. Si es 0 (null), se elimina el dato en esa clave. Puede ser null.
read_len	uint32_t	Longitud de los datos. Si es 0 (null), se elimina el dato en esa clave. Puede ser null.
kread_ptr	uint32_t	Puntero a la clave de Hook State donde almacenar el valor
kread_len	uint32_t	Longitud de la clave (debe ser siempre 32)

Precaución

Xahaud establece internamente un tamaño máximo de datos para Hooks. En el momento de escribir esto y en mainnet, está fijado en 256 bytes, aunque en el futuro será un valor votable por los validadores.

JavaScript

Nombre	Tipo	Descripción
value	ByteArray o HexString	El valor de los datos a almacenar
key	ByteArray o HexString	La clave del Hook State donde guardar el valor

Código de retorno

C

Tipo	Descripción
int64_t	Número de bytes escritos en el Hook State (longitud de los datos) Si es negativo, error: OUT_OF_BOUNDS - punteros fuera de la memoria del hook TOO_BIG - kread_len mayor que 32 o - read_len mayor que el tamaño máximo permitido TOO_SMALL - kread_len es 0

JavaScript

Tipo	Descripción
number o ErrorCode	Devuelve el número de bytes escritos o un error (negativo en caso de fallo)