sto_subarray

Conceitos

Objetos Serializados

Comportamento

C

• Analisa um STArray apontado por read_ptr
• Encontra o índice do array especificado por array_id
• Retorna o deslocamento (offset) em bytes e o tamanho do campo serializado dentro do STObject, se encontrado

Codificação do Field ID

As APIs sto_ aceitam um parâmetro field_id codificado da seguinte forma: (type << 16U) + field Assim, o tipo 1 campo 2 seria 0x10002U.

Neste caso, o field ID do array é array_id.

JavaScript

• Solicita o objeto STO (dados de ledger codificados em binário) do qual o subarray será extraído.
• Encontra o índice do array especificado por array_id
• Retorna um subarray de um objeto STO.

Definição

C

int64_t sto_subarray (
    uint32_t read_ptr,
    uint32_t read_len,
    uint32_t array_id
);

JavaScript

function sto_subarray(
    sto: ByteArray | HexString,
    array_id: number
  ): bigint | number

Exemplo

C

#define SUB_OFFSET(x) ((int32_t)(x >> 32))
#define SUB_LENGTH(x) ((int32_t)(x & 0xFFFFFFFFULL))

  int64_t memo_lookup =
    sto_subarray(memos, memos_len, 0);

if (memo_lookup < 0)
{
    // sfMemo was not found in the STObject pointed at by memo_ptr
}
else
{
    // 0th index of the STArray was found and its location is as follows:
    uint8_t*  memo_ptr = SUB_OFFSET(memo_lookup) + memos;
    uint32_t  memo_len = SUB_LENGTH(memo_lookup);
}

Dica

O hookmacro.h já contém as macros SUB_OFFSET e SUB_LENGTH.

JavaScript

const SUB_OFFSET = (x) => Number(x >> 32n)
const SUB_LENGTH = (x) => Number(x & 0xFFFFFFFFn)

const memo_lookup = sto_subarray(memos, 0)

if (typeof memo_lookup === 'number')
{
    // sfMemo was not found in the STObject pointed at
}
else
{
    // 0th index of the STArray was found and its location is as follows:
    const memo_start = SUB_OFFSET(memo_lookup)
    const memo_len = SUB_LENGTH(memo_lookup)
    const memo = memos.slice(memo_start, memo_len)
}

Parâmetros

C

Nome	Tipo	Descrição
read_ptr	uint32_t	Ponteiro para o buffer contendo o STArray
read_len	uint32_t	Tamanho do STArray
array_id	uint32_t	O índice da entrada dentro do STArray que você está buscando. Começa em 0.

JavaScript

Nome	Tipo	Descrição
sto	ByteArray | HexString	O objeto STO (dados de ledger codificados em binário) do qual o subarray será extraído.
array_id	number	O ID do array a ser extraído.

Código de Retorno

C

Tipo

Descrição

int64_t

A localização do campo dentro do buffer especificado: - Os 32 bits superiores são o deslocamento (offset). - Os 32 bits inferiores são o tamanho. Se negativo, um erro: OUT_OF_BOUNDS - ponteiros/tamanhos especificados fora da memória do hook. TOO_SMALL - O buffer de entrada não é grande o suficiente para possivelmente conter um STArray válido. DOESNT_EXIST - O índice buscado não está presente no STArray fornecido. PARSE_ERROR - O STArray fornecido está malformado ou não é um STArray.

JavaScript

Tipo	Descrição
bigint / ErrorCode	A localização do campo dentro do buffer especificado: - Os 32 bits superiores são o deslocamento (offset). - Os 32 bits inferiores são o tamanho. ou um código de erro se a extração falhar.