Parâmetros

Parâmetros

Os desenvolvedores de Hooks podem optar por usar parâmetros de tempo de instalação (chamados Parâmetros de Hook) em seu Hook. Isso permite que instaladores subsequentes do Hook alterem certos comportamentos definidos pelo programador sem recompilar ou re-enviar o Hook (assumindo que pelo menos uma conta ainda referencie a definição de Hook existente).

Os Parâmetros de Hook são um conjunto de pares Chave-Valor definidos durante a Transação SetHook e recuperáveis pelo Hook durante a execução. Tanto a chave ParameterName quanto o ParameterValue são definidos como blobs hex, com comprimento máximo de 32 bytes e 256 bytes, respectivamente.

Uma Transação SetHook pode definir até 16 Parâmetros de Hook por Hook instalado.

Definindo Parâmetros

O array HookParameters é opcionalmente definido dentro de cada Hook no array Hooks conforme mostrado abaixo:

TransactionType: "SetHook",
Hooks:
[
    {
        Hook: {
            ...,
            HookParameters:
            [
                {
                    HookParameter:
                    {
                        HookParameterName:  "ABCDEF12",
                        HookParameterValue: "12345678"
                    }
                },
                ...  // opcionalmente até mais 15 Parâmetros de Hook
            ]
        }
    }
],
...

Parâmetros Padrão

O primeiro usuário a definir um novo Hook pode definir Parâmetros de Hook que então se tornam os Parâmetros Padrão para aquele Hook. Isso significa que qualquer usuário subsequente que referenciar a mesma HookDefinition receberá esses Parâmetros de Hook originalmente definidos por padrão.

O usuário subsequente pode especificar seus próprios Parâmetros, substituindo os Parâmetros Padrão para sua instalação.

Para apagar um Parâmetro em uma instalação subsequente, especifique a chave ParameterName sem especificar uma chave ParameterValue.

Usando Parâmetros em Hooks

Os parâmetros podem ser lidos pelos Hooks nos quais estão definidos usando hook_param.

Se mais de um Hook estiver instalado em uma Cadeia de Hooks, então hook_param_set pode ser usado em circunstâncias limitadas para modificar os Parâmetros de Hook de um Hook mais adiante na cadeia na mesma conta.

Parâmetros de Tempo de Execução

No Xahau e na testnet Xahau, os HookParameters também podem ser incluídos no nível superior de qualquer tipo de transação de acordo com as regras e limites de tamanho anteriores. Esses parâmetros podem ser acessados dentro de um hook usando a API otxn_param.