Interface Blockchain

interface Blockchain {
    create(
        name: string,
        type: BLOCKCHAIN_KEYS,
        exportable: boolean,
        temporary: boolean,
        version?: null | VERSION_OPTIONS,
        seed?: null | string,
        passphrase?: null | string,
    ): Promise<boolean>;
    delete(name: string): Promise<boolean>;
    block(name: string): Promise<boolean>;
    unblock(name: string): Promise<boolean>;
    createBip32ChildKeyDerivation(
        version: VERSION_OPTIONS,
        index: number,
        exportable: boolean,
        temporary: boolean,
        parentKeyName: string,
        childKeyName: string,
    ): Promise<KeyInfo>;
    hashData(
        hashMode: BLOCKCHAIN_HASH_MODE,
        data: Buffer,
    ): Promise<Buffer<ArrayBufferLike>>;
    edDsaSign(
        type: BLOCKCHAIN_EdDSA_TYPE,
        privKeyName: string,
        data: Buffer,
    ): Promise<Buffer<ArrayBufferLike>>;
    getPubKey(
        type: BLOCKCHAIN_GET_PUB_KEY_TYPE,
        privKeyName: string,
    ): Promise<Buffer<ArrayBufferLike>>;
    edDsaVerify(
        type: BLOCKCHAIN_EdDSA_TYPE,
        pubKeyType: BLOCKCHAIN_PUB_KEY_TYPE,
        pubKey: Buffer,
        signature: Buffer,
        data: Buffer,
    ): Promise<boolean>;
    getAddress(
        type: ADDRESS_TYPE,
        version: ADDRESS_VERSION,
        hrp: ADDRESS_HRP,
        pk: string,
    ): Promise<Buffer<ArrayBufferLike>>;
    sign(
        type: BLOCKCHAIN_SIG_TYPE,
        hashMode: BLOCKCHAIN_HASH_MODE,
        hash: Buffer,
        pk: string,
    ): Promise<Buffer<ArrayBufferLike>>;
    getKeyInfo(name: string): Promise<KeyInfo>;
    import(
        format: IMPORT_EXPORT_FORMAT,
        exportable: boolean,
        temporary: boolean,
        name: string,
        data: string,
    ): Promise<boolean>;
    export(
        format: IMPORT_EXPORT_FORMAT,
        version: BLOCKCHAIN_EXPORT_VERSION,
        compressed: boolean,
        name: string,
    ): Promise<Buffer<ArrayBufferLike>>;
    verify(
        sigType: BLOCKCHAIN_SIG_TYPE,
        hashMode: BLOCKCHAIN_HASH_MODE,
        hashData: Buffer,
        signature: Buffer,
        pubKeyType: BLOCKCHAIN_SIG_VERIFY_PUB_KEY_TYPE,
        pubSignature: Buffer,
    ): Promise<boolean>;
    pubKeyRecovery(
        sigType: BLOCKCHAIN_SIG_TYPE,
        hashMode: BLOCKCHAIN_HASH_MODE,
        hashData: Buffer,
        signature: Buffer,
    ): Promise<Buffer<ArrayBufferLike>>;
    abn128RndCtxGetPt(
        x: string | Buffer<ArrayBufferLike>,
        y: string | Buffer<ArrayBufferLike>,
    ): Promise<Buffer<ArrayBufferLike>>;
    abn128RndCtxMultAdd(
        keyName: string,
        scalar: string | Buffer<ArrayBufferLike>,
    ): Promise<Buffer<ArrayBufferLike>>;
    abn128RndScs(): Promise<Buffer<ArrayBufferLike>[]>;
    abn128RndSc(): Promise<Buffer<ArrayBufferLike>>;
    abn128RndCtxRefresh(
        x: string | Buffer<ArrayBufferLike>,
        y: string | Buffer<ArrayBufferLike>,
    ): Promise<Buffer<ArrayBufferLike>>;
    abn128PscMult(
        keyName: string,
        x: string | Buffer<ArrayBufferLike>,
        y: string | Buffer<ArrayBufferLike>,
        neg?: boolean,
    ): Promise<Buffer<ArrayBufferLike>>;
}

Methods

create

create(
    name: string,
    type: BLOCKCHAIN_KEYS,
    exportable: boolean,
    temporary: boolean,
    version?: null | VERSION_OPTIONS,
    seed?: null | string,
    passphrase?: null | string,
): Promise<boolean>
Cria uma chave Extended Private Key (XPrv) para a blockchain no padrão BIP32.
Parameters
- name: string
  Nome da chave no HSM.
- type: BLOCKCHAIN_KEYS
  Tipo de geração da chave.
- exportable: boolean
  Se a chave será exportável.
- temporary: boolean
  Se a chave será temporária.
- Optionalversion: null | VERSION_OPTIONS
  Versão da chave que deve ser passado de acordo com a opção do tipo
- Optionalseed: null | string
  Buffer contendo os dados necessários para a geração da chave. Os dados de entrada devem ser passados de acordo com a opção do type de enums.BLOCKCHAIN_KEYS.
- Optionalpassphrase: null | string
Returns Promise<boolean>
Chave criada.

Throws
exceptions.HsmError Caso não seja possível criar a chave ou ocorra algum erro na operação.

See
Código de exemplo: Criando uma chave blockchain

delete

delete(name: string): Promise<boolean>
Deleta uma chave armazenada no HSM.
Parameters
- name: string
  Nome da chave.
Returns Promise<boolean>
Retorna true se a chave foi deletada com sucesso.

Throws
Caso o nome da chave seja inválido.

Throws
Caso ocorra algum erro na deleção da chave.

See
Código de exemplo: Excluindo uma chave blockchain

block

block(name: string): Promise<boolean>
Bloqueia uma chave no HSM.
Parameters
- name: string
  Nome da chave.
Returns Promise<boolean>
Retorna true se a chave foi bloqueada com sucesso.

Throws
Caso o nome da chave seja inválido.

Throws
Caso ocorra algum erro na deleção da chave.

See
Código de exemplo: Bloqueando uma chave blockchain

unblock

unblock(name: string): Promise<boolean>
Desbloqueia uma chave no HSM.
Parameters
- name: string
  Nome da chave.
Returns Promise<boolean>
Retorna true se a chave foi desbloqueada com sucesso.

Throws
Caso o nome da chave seja inválido.

Throws
Caso ocorra algum erro na deleção da chave.

See
Código de exemplo: Desbloqueando uma chave blockchain

createBip32ChildKeyDerivation

createBip32ChildKeyDerivation(
    version: VERSION_OPTIONS,
    index: number,
    exportable: boolean,
    temporary: boolean,
    parentKeyName: string,
    childKeyName: string,
): Promise<KeyInfo>
Faz uma operação de Child Key Derivation (CKD). Deriva uma chave Extended Private Key (XPrv) para a blockchain no padrão BIP32.
Parameters
- version: VERSION_OPTIONS
  Versão da chave.
- index: number
  Índice da chave que será derivada. Chaves non hardened usam índice de 0 a 2³¹-1 e chaves hardened (irrestritamente seguras) usam índices de 2³¹ a 2³²-1, como especificado no padrão BIP32. É altamente recomendado gerar chaves hardened.
- exportable: boolean
  Se a chave será exportável.
- temporary: boolean
  Se a chave será temporária.
- parentKeyName: string
  Nome da chave pai no HSM. Deve ser uma chave XPrv.
- childKeyName: string
  Nome da chave que será derivada no HSM.
Returns Promise<KeyInfo>
Informações da chave derivada.

Throws
exceptions.HsmError Caso não seja possível derivar a chave ou ocorra algum erro na operação.

See
Código de exemplo: Criando chave blockchain bip32 derivada

hashData

hashData(
hashMode: BLOCKCHAIN_HASH_MODE,
data: Buffer,
): Promise<Buffer<ArrayBufferLike>>
Calcula um hash usando o módulo blockchain.
Parameters
- hashMode: BLOCKCHAIN_HASH_MODE
  Modo do hash.
- data: Buffer
  Dados que serão processados. Tamanho máximo de constants.BLOCKCHAIN_MAX_DATA_LEN.
Returns Promise<Buffer<ArrayBufferLike>>
Hash calculado.

Throws
exceptions.HsmError Caso não seja possível calcular o hash ou ocorra algum erro na operação.

See
Código de exemplo: Gerando hash de dados

edDsaSign

edDsaSign(
    type: BLOCKCHAIN_EdDSA_TYPE,
    privKeyName: string,
    data: Buffer,
): Promise<Buffer<ArrayBufferLike>>
Gera uma assinatura EdDSA usando o módulo blockchain.
Parameters
- type: BLOCKCHAIN_EdDSA_TYPE
  Tipo da assinatura a ser gerada.
- privKeyName: string
  Nome da chave privada.
- data: Buffer
  Dados que serão assinados.
Returns Promise<Buffer<ArrayBufferLike>>
Assinatura gerada.

Throws
exceptions.HsmError Caso não seja possível assinar os dados ou ocorra algum erro na operação.

See
Código de exemplo: Assinando hash com chave EdDSA blockchain

getPubKey

getPubKey(
type: BLOCKCHAIN_GET_PUB_KEY_TYPE,
privKeyName: string,
): Promise<Buffer<ArrayBufferLike>>
Recupera uma chave pública a partir de uma chave privada usando o módulo blockchain.
Parameters
- type: BLOCKCHAIN_GET_PUB_KEY_TYPE
  Formato da chave pública a ser exportada.
- privKeyName: string
  Nome da chave privada.
Returns Promise<Buffer<ArrayBufferLike>>
Chave pública.

Throws
exceptions.HsmError Caso a chave privada não seja encontrada ou ocorra algum erro na operação.

See
Código de exemplo: Recuperando uma chave pública blockchain

edDsaVerify

edDsaVerify(
    type: BLOCKCHAIN_EdDSA_TYPE,
    pubKeyType: BLOCKCHAIN_PUB_KEY_TYPE,
    pubKey: Buffer,
    signature: Buffer,
    data: Buffer,
): Promise<boolean>
Verifica uma assinatura EdDSA usando o módulo blockchain.
Parameters
- type: BLOCKCHAIN_EdDSA_TYPE
  Tipo da assinatura a ser verificada.
- pubKeyType: BLOCKCHAIN_PUB_KEY_TYPE
  Tipo da chave pública.
- pubKey: Buffer
  Chave pública. Deve ser uma chave pública válida retornada pelo método Blockchain.getPubKey.
- signature: Buffer
  Assinatura a ser verificada. Deve ser uma assinatura válida retornada pelo método Blockchain.edDsaSign.
- data: Buffer
  Dados que foram assinados. Deve ser uma hash válida retornada pelo método Blockchain.hashData.
Returns Promise<boolean>
True se a assinatura for válida, false caso contrário.

Throws
exceptions.HsmError Caso ocorra algum erro na operação.

See
Código de exemplo: Verificando assinatura de hash com EdDSA blockchain

getAddress

getAddress(
    type: ADDRESS_TYPE,
    version: ADDRESS_VERSION,
    hrp: ADDRESS_HRP,
    pk: string,
): Promise<Buffer<ArrayBufferLike>>
Recupera o endereço de uma chave usando o módulo blockchain.
Parameters
- type: ADDRESS_TYPE
  Tipo do endereço a ser gerado.
- version: ADDRESS_VERSION
  Versão do endereço.
- hrp: ADDRESS_HRP
  HRP (Human Readable Part) da chave.
- pk: string
  Chave privada da qual será gerado o endereço ou o script-hash.
Returns Promise<Buffer<ArrayBufferLike>>
Retorna o endereço.

Throws
exceptions.HsmError Caso não seja possível recuperar o endereço ou ocorra algum erro na operação.

See
Código de exemplo: Obtendo o endereço blockchain a partir da chave privada

ATENÇÃO
Endereços P2TR (sem tweak de chave) devem ser usados com assinaturas BIP340/Schnorr apenas em cenários de single-key-setting (assinatura única).

sign

sign(
    type: BLOCKCHAIN_SIG_TYPE,
    hashMode: BLOCKCHAIN_HASH_MODE,
    hash: Buffer,
    pk: string,
): Promise<Buffer<ArrayBufferLike>>
Assina um hash usando o módulo blockchain.
Parameters
- type: BLOCKCHAIN_SIG_TYPE
  Tipo da assinatura a ser realizada.
- hashMode: BLOCKCHAIN_HASH_MODE
  Modo do hash.
- hash: Buffer
  Hash calculado de acordo com o informado em hashMode (enums.BLOCKCHAIN_HASH_MODE).
- pk: string
  Nome da chave privada.
Returns Promise<Buffer<ArrayBufferLike>>
Throws
exceptions.HsmError Caso não seja possível assinar os dados ou ocorra algum erro na operação.

See
Código de exemplo: Assinando hash com chave ECDSA blockchain

getKeyInfo

getKeyInfo(name: string): Promise<KeyInfo>
Recupera as propriedades de uma chave usando o módulo blockchain.
Parameters
- name: string
  Nome da chave privada.
Returns Promise<KeyInfo>
Retorna um objeto com os dados de blockchain da chave.

Throws
exceptions.HsmError Caso não seja possível recuperar o endereço ou ocorra algum erro na operação.

See
Código de exemplo: Obtendo informações de uma chave blockchain

import

import(
    format: IMPORT_EXPORT_FORMAT,
    exportable: boolean,
    temporary: boolean,
    name: string,
    data: string,
): Promise<boolean>
Importa uma chave privada usando o módulo blockchain_interfaces.
Parameters
- format: IMPORT_EXPORT_FORMAT
  Formato da chave a ser importada.
- exportable: boolean
  Se a chave será exportável.
- temporary: boolean
  Se a chave será temporária.
- name: string
  Nome da chave privada.
- data: string
  Chave privada no formato especificado em enums.IMPORT_EXPORT_FORMAT.
Returns Promise<boolean>
True se a importação foi efetuada ou uma exceção caso o contrário.

Throws
exceptions.HsmError Caso ocorra algum erro na operação.

See
Código de exemplo: Importando chave privada blockchain

export

export(
    format: IMPORT_EXPORT_FORMAT,
    version: BLOCKCHAIN_EXPORT_VERSION,
    compressed: boolean,
    name: string,
): Promise<Buffer<ArrayBufferLike>>
Exporta uma chave privada usando o módulo blockchain.
Parameters
- format: IMPORT_EXPORT_FORMAT
  Formato da chave a ser exportada.
- version: BLOCKCHAIN_EXPORT_VERSION
  Versão da chave.
- compressed: boolean
  Se a chave deve ser retornada comprimida.
- name: string
  Nome da chave privada.
Returns Promise<Buffer<ArrayBufferLike>>
Buffer com a chave privada.

Throws
exceptions.HsmError Caso ocorra algum erro na operação.

See
Código de exemplo: Exportando chave privada blockchain

verify

verify(
    sigType: BLOCKCHAIN_SIG_TYPE,
    hashMode: BLOCKCHAIN_HASH_MODE,
    hashData: Buffer,
    signature: Buffer,
    pubKeyType: BLOCKCHAIN_SIG_VERIFY_PUB_KEY_TYPE,
    pubSignature: Buffer,
): Promise<boolean>
Verifica uma assinatura usando o módulo blockchain.
Parameters
- sigType: BLOCKCHAIN_SIG_TYPE
  Tipo da assinatura que foi realizada.
- hashMode: BLOCKCHAIN_HASH_MODE
  Modo do hash.
- hashData: Buffer
  Hash calculado conforme o informado em hashData.
- signature: Buffer
  Assinatura conforme o informado em sigType (enums.BLOCKCHAIN_SIG_TYPE).
- pubKeyType: BLOCKCHAIN_SIG_VERIFY_PUB_KEY_TYPE
  Tipo da chave pública.
- pubSignature: Buffer
  Chave pública conforme o informado em pubKeyType.
Returns Promise<boolean>
True se a assinatura for válida, false caso contrário.

Throws
exceptions.HsmError Caso ocorra algum erro na operação.

See
Código de exemplo: Verificando assinatura ECDSA blockchain

pubKeyRecovery

pubKeyRecovery(
    sigType: BLOCKCHAIN_SIG_TYPE,
    hashMode: BLOCKCHAIN_HASH_MODE,
    hashData: Buffer,
    signature: Buffer,
): Promise<Buffer<ArrayBufferLike>>
Recupera uma chave pública (PBK) a partir de uma assinatura do tipo ECDSA.
Parameters
- sigType: BLOCKCHAIN_SIG_TYPE
  Tipo da assinatura a ser gerada.
- hashMode: BLOCKCHAIN_HASH_MODE
  Modo do hash.
- hashData: Buffer
  Hash calculado conforme o informado em hashData.
- signature: Buffer
  Assinatura conforme o informado em sigType (enums.BLOCKCHAIN_SIG_TYPE).
Returns Promise<Buffer<ArrayBufferLike>>
Retorna um buffer com a chave pública.

Throws
exceptions.HsmError Caso ocorra algum erro na operação.

See
Código de exemplo: Recuperando chave pública a partir de assinatura

abn128RndCtxGetPt

abn128RndCtxGetPt(
x: string | Buffer<ArrayBufferLike>,
y: string | Buffer<ArrayBufferLike>,
): Promise<Buffer<ArrayBufferLike>>
Calcula um ponto a partir de outro ponto e um contexto randómico.
Parameters
- x: string | Buffer<ArrayBufferLike>
  Ponto X que pode ser um buffer de constants.ABN128_XY_BUFF_LEN bytes ou uma string hexadecimal de constants.ABN128_XY_HEX_LEN caracteres.
- y: string | Buffer<ArrayBufferLike>
  Ponto Y que pode ser um buffer de constants.ABN128_XY_BUFF_LEN bytes ou uma string hexadecimal de constants.ABN128_XY_HEX_LEN caracteres.
Returns Promise<Buffer<ArrayBufferLike>>
Retorna um buffer com o ponto calculado.

Throws
Caso algum parâmetro informado seja invalido.

Throws
exceptions.InvalidParameterError Caso algum parâmetro informado seja invalido.

Throws
exceptions.HsmError Caso ocorra algum erro na operação.

abn128RndCtxMultAdd

abn128RndCtxMultAdd(
keyName: string,
scalar: string | Buffer<ArrayBufferLike>,
): Promise<Buffer<ArrayBufferLike>>
Multiplica um escalar pela chave privada e soma um escalar randômico.
Parameters
- keyName: string
  Nome da chave que será usada para a operação.
- scalar: string | Buffer<ArrayBufferLike>
  Escalar que pode ser um buffer de constants.ABN128_XY_BUFF_LEN bytes ou uma string hexadecimal de constants.ABN128_XY_HEX_LEN caracteres.
Returns Promise<Buffer<ArrayBufferLike>>
Retorna um buffer com o resultado da operação.

Throws
Caso o nome da chave seja inválido.

Throws
exceptions.InvalidParameterError Caso algum parâmetro informado seja invalido.

Throws
exceptions.HsmError Caso ocorra algum erro na operação.

abn128RndScs

abn128RndScs(): Promise<Buffer<ArrayBufferLike>[]>
Retrona quatro escalares randômicos.

Returns Promise<Buffer<ArrayBufferLike>[]>
Retorna um array de bufferes com os escalares randômicos.

Throws
exceptions.HsmError Caso ocorra algum erro na operação.

abn128RndSc

abn128RndSc(): Promise<Buffer<ArrayBufferLike>>
Retrona um escalar randômico.

Returns Promise<Buffer<ArrayBufferLike>>
Retorna um buffer com o escalare randômico.

Throws
exceptions.HsmError Caso ocorra algum erro na operação.

abn128RndCtxRefresh

abn128RndCtxRefresh(
x: string | Buffer<ArrayBufferLike>,
y: string | Buffer<ArrayBufferLike>,
): Promise<Buffer<ArrayBufferLike>>
Atualiza o contexto randômico.
Parameters
- x: string | Buffer<ArrayBufferLike>
  Ponto X que pode ser um buffer de constants.ABN128_XY_BUFF_LEN bytes ou uma string hexadecimal de constants.ABN128_XY_HEX_LEN caracteres.
- y: string | Buffer<ArrayBufferLike>
  Ponto Y que pode ser um buffer de constants.ABN128_XY_BUFF_LEN bytes ou uma string hexadecimal de constants.ABN128_XY_HEX_LEN caracteres.
Returns Promise<Buffer<ArrayBufferLike>>
Retorna um buffer com o ponto calculado.

Throws
Caso algum parâmetro informado seja invalido.

Throws
exceptions.InvalidParameterError Caso algum parâmetro informado seja invalido.

Throws
exceptions.HsmError Caso ocorra algum erro na operação.

abn128PscMult

abn128PscMult(
    keyName: string,
    x: string | Buffer<ArrayBufferLike>,
    y: string | Buffer<ArrayBufferLike>,
    neg?: boolean,
): Promise<Buffer<ArrayBufferLike>>
Multiplica um escalar pela chave privada.
Parameters
- keyName: string
  Nome da chave que será usada para a operação.
- x: string | Buffer<ArrayBufferLike>
  Ponto X que pode ser um buffer de constants.ABN128_XY_BUFF_LEN bytes ou uma string hexadecimal de constants.ABN128_XY_HEX_LEN caracteres.
- y: string | Buffer<ArrayBufferLike>
  Ponto Y que pode ser um buffer de constants.ABN128_XY_BUFF_LEN bytes ou uma string hexadecimal de constants.ABN128_XY_HEX_LEN caracteres.
- Optionalneg: boolean
  Se a chave privada deve ser negativada.
Returns Promise<Buffer<ArrayBufferLike>>
Retorna um buffer com o ponto calculado.

Throws
Caso algum parâmetro informado seja invalido.

Throws
exceptions.InvalidParameterError Caso algum parâmetro informado seja invalido.

Throws
exceptions.HsmError Caso ocorra algum erro na operação.

Interface Blockchain

Index

Methods

Methods

create

Parameters

Returns Promise<boolean>

Throws

See

delete

Parameters

Returns Promise<boolean>

Throws

Throws

See

block

Parameters

Returns Promise<boolean>

Throws

Throws

See

unblock

Parameters

Returns Promise<boolean>

Throws

Throws

See

createBip32ChildKeyDerivation

Parameters

Returns Promise<KeyInfo>

Throws

See

hashData

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

Throws

See

edDsaSign

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

Throws

See

getPubKey

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

Throws

See

edDsaVerify

Parameters

Returns Promise<boolean>

Throws

See

getAddress

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

Throws

See

ATENÇÃO

sign

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

Throws

See

getKeyInfo

Parameters

Returns Promise<KeyInfo>

Throws

See

import

Parameters

Returns Promise<boolean>

Throws

See

export

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

Throws

See

verify

Parameters