otxn_field

Comportamento

C

• Localiza o campo sf especificado na transação de origem
• Escreve a versão serializada do campo no buffer de saída

JavaScript

• Recupera o valor de um campo específico da transação de origem.
• Retorna o valor do campo especificado como um array de números, ou um ErrorCode caso a busca falhe.

Definição

C

int64_t otxn_field (
    uint32_t write_ptr,
    uint32_t write_len,
    uint32_t field_id
);

JavaScript

function otxn_field(field_id: number): ErrorCode | ByteArray

Exemplo

C

int64_t account_field_len =
    otxn_field(account_field, 20, sfAccount);

JavaScript

const account_field = otxn_field(sfAccount)

Parâmetros

C

Nome	Tipo	Descrição
write_ptr	uint32_t	Ponteiro para um buffer de tamanho adequado para armazenar a saída.
write_len	uint32_t	Tamanho do buffer de saída.
field_id	uint32_t	O código sf do campo que você está procurando. Para calcular isso manualmente, pegue o type serializado e desloque-o para os 16 bits mais altos do uint32_t, depois pegue o field e coloque-o nos 16 bits mais baixos. Por exemplo: sfEmitNonce tem type 5 e field 11, portanto seu valor é 0x050BU

Importante

O código do campo não é escrito no buffer de saída, apenas o conteúdo (payload) do campo é.

No momento em que este texto foi escrito, para a Hooks Public Testnet, campos STI_ACCOUNT como sfAccount são retornados sem o byte inicial de comprimento variável.

JavaScript

Nome	Tipo	Descrição
field_id	number	Retorna o valor do campo especificado como um array de números, caso a busca falhe.

Código de Retorno

C

Tipo	Descrição
int64_t	O número de bytes escritos Se negativo, um erro: OUT_OF_BOUNDS - ponteiros/tamanhos especificados fora da memória do hook. TOO_SMALL - o buffer de saída não era grande o suficiente para conter o campo serializado INVALID_FIELD - o field_id sf era inválido DOESNT_EXIST - o campo não foi encontrado na transação de origem

JavaScript

Tipo	Descrição
ByteArray ou ErrorCode	Retorna o valor do campo especificado como um array de números, ou um ErrorCode caso a busca falhe.