Blockchain interface

Hierarchy

Blockchain

Methods

abn128PscMult

abn128PscMult(keyName: string, x: string | Buffer, y: string | Buffer, neg?: boolean): Promise<Buffer>
Description
Multiplies a scalar by the private key.

Returns
Returns a buffer with the calculated point.

Throws
If any of the parameters entered are invalid.

Throws
InvalidParameterError If any parameter entered is invalid.

Throws
HsmError If an error occurs in the operation.
Parameters
- keyName: string
  
  Name of the key that will be used for the operation.
- x: string | Buffer
  
  Point X which can be a buffer of ABN128_XY_BUFF_LEN bytes or a hexadecimal string of ABN128_XY_HEX_LEN characters.
- y: string | Buffer
  
  Y point which can be a buffer of ABN128_XY_BUFF_LEN bytes or a hexadecimal string of ABN128_XY_HEX_LEN characters.
- Optional neg: boolean
  
  Whether the private key should be negated.
Returns Promise<Buffer>

abn128RndCtxGetPt

abn128RndCtxGetPt(x: string | Buffer, y: string | Buffer): Promise<Buffer>
Description
Calculates a point from another point and a random context.

Returns
Returns a buffer with the calculated point.

Throws
If any of the parameters entered are invalid.

Throws
InvalidParameterError If any parameter entered is invalid.

Throws
HsmError If an error occurs in the operation.
Parameters
- x: string | Buffer
  
  Point X which can be a buffer of ABN128_XY_BUFF_LEN bytes or a hexadecimal string of ABN128_XY_HEX_LEN characters.
- y: string | Buffer
  
  Y point which can be a buffer of ABN128_XY_BUFF_LEN bytes or a hexadecimal string of ABN128_XY_HEX_LEN characters.
Returns Promise<Buffer>

abn128RndCtxMultAdd

abn128RndCtxMultAdd(keyName: string, scalar: string | Buffer): Promise<Buffer>
Description
Multiplies a scalar by the private key and adds a random scalar.

Returns
Returns a buffer with the result of the operation.

Throws
If the key name is invalid.

Throws
InvalidParameterError If any parameter entered is invalid.

Throws
HsmError If an error occurs in the operation.
Parameters
- keyName: string
  
  Name of the key that will be used for the operation.
- scalar: string | Buffer
  
  Scalar that can be a buffer of ABN128_XY_BUFF_LEN bytes or a hexadecimal string of ABN128_XY_HEX_LEN characters.
Returns Promise<Buffer>

abn128RndCtxRefresh

abn128RndCtxRefresh(x: string | Buffer, y: string | Buffer): Promise<Buffer>
Description
Updates the random context.

Returns
Returns a buffer with the calculated point.

Throws
If any of the parameters entered are invalid.

Throws
InvalidParameterError If any parameter entered is invalid.

Throws
HsmError If an error occurs in the operation.
Parameters
- x: string | Buffer
  
  Point X which can be a buffer of ABN128_XY_BUFF_LEN bytes or a hexadecimal string of ABN128_XY_HEX_LEN characters.
- y: string | Buffer
  
  Y point which can be a buffer of ABN128_XY_BUFF_LEN bytes or a hexadecimal string of ABN128_XY_HEX_LEN characters.
Returns Promise<Buffer>

abn128RndSc

abn128RndSc(): Promise<Buffer>
Description
Returns a random scalar.

Returns
Returns a buffer with the random scalar.

Throws
HsmError If an error occurs in the operation.

Returns Promise<Buffer>

abn128RndScs

abn128RndScs(): Promise<Buffer[]>
Description
Returns four random scalars.

Returns
Returns an array of buffers with random scalars.

Throws
HsmError If an error occurs in the operation.

Returns Promise<Buffer[]>

block

block(name: string): Promise<boolean>
Description
Locks a key in the HSM.

Returns
Returns true if the key was successfully locked.

Throws
If the key name is invalid.

Throws
In the event of an error when deleting the key.
Parameters
- name: string
  
  Key name.
Returns Promise<boolean>

create

create(name: string, type: BLOCKCHAIN_KEYS, exportable: booleantemporary: boolean, version?: null | VERSION_OPTIONS, seed?: null | string, passphrase?: null | string): Promise<boolean>
Description
Creates an Extended Private Key (XPrv) for the blockchain in the BIP32 standard.

Returns
Key created.

Throws
HsmError If it is not possible to create the key or there is an error in the operation.
Parameters
- name: string
  
  Name of the key in the HSM.
- type: BLOCKCHAIN_KEYS
  
  Type of key generation.
- exportable: boolean
  
  If the key is exportable.
- temporary: boolean
  
  If the key is temporary.
- Optional version: null | VERSION_OPTIONS
  
  Key version that must be passed according to the type option
- Optional seed: null | string
  
  Buffer containing the data needed to generate the key. The input data must be passed according to the BLOCKCHAIN_KEYS type option.
- Optional passphrase: null | string
Returns Promise<boolean>

createBip32ChildKeyDerivation

createBip32ChildKeyDerivation(version: VERSION_OPTIONS, index: number, exportable: booleantemporary: boolean, parentKeyName: string, childKeyName: string): Promise<KeyInfo>
Description
Performs a Child Key Derivation (CKD) operation. Derives an Extended Private Key (XPrv) for the blockchain in the BIP32 standard.

Returns
Information on the derived key.

Throws
HsmError If the key cannot be derived or an error occurs in the operation.
Parameters
- version: VERSION_OPTIONS
  
  Key version.
- index: number
  
  Index of the key to be derived. Non-hardened keys use an index from 0 to^231-1 and hardened (unrestrictedly secure) keys use indexes from²³¹ to^232-1, as specified in the BIP32 standard. It is highly recommended to generate hardened keys.
- exportable: boolean
  
  If the key is exportable.
- temporary: boolean
  
  If the key is temporary.
- parentKeyName: string
  
  Name of the parent key in the HSM. It must be an XPrv key.
- childKeyName: string
  
  Name of the key that will be derived in the HSM.
Returns Promise<KeyInfo>

delete

delete(name: string): Promise<boolean>
Description
Deletes a key stored in the HSM.

Returns
Returns true if the key was successfully deleted.

Throws
If the key name is invalid.

Throws
In the event of an error when deleting the key.
Parameters
- name: string
  
  Key name.
Returns Promise<boolean>
delete(name: string): Promise<boolean>
Description
Deletes a key stored in the HSM.

Returns
Returns true if the key was successfully deleted.

Throws
If the key name is invalid.

Throws
In the event of an error when deleting the key.
Parameters
- name: string
  
  Key name.
Returns Promise<boolean>

edDsaSign

edDsaSign(type: BLOCKCHAIN_EdDSA_TYPE, privKeyName: string, date: Buffer): Promise<Buffer>
Description
Generates an EdDSA signature using the blockchain module.

Returns
Signature generated.

Throws
HsmError If it is not possible to sign the data or there is an error in the operation.
Parameters
- type: BLOCKCHAIN_EdDSA_TYPE
  
  Type of signature to be generated.
- privKeyName: string
  
  Name of the private key.
- date: Buffer
  
  Data that will be signed.
Returns Promise<Buffer>

edDsaVerify

edDsaVerify(type: BLOCKCHAIN_EdDSA_TYPE, pubKeyType: BLOCKCHAIN_PUB_KEY_TYPE, pubKey: Buffer, signature: Buffer, date: Buffer): Promise<boolean>
Description
Verifies an EdDSA signature using the blockchain module.

Returns
True if the signature is valid, false otherwise.

Throws
HsmError If an error occurs in the operation.
Parameters
- type: BLOCKCHAIN_EdDSA_TYPE
  
  Type of signature to be verified.
- pubKeyType: BLOCKCHAIN_PUB_KEY_TYPE
  
  Type of public key.
- pubKey: Buffer
  
  Public key. This must be a valid public key returned by the Blockchain.getPubKey method.
- signature: Buffer
  
  Signature to be verified. Must be a valid signature returned by the Blockchain.edDsaSign method.
- date: Buffer
  
  Data that has been signed. It must be a valid hash returned by the Blockchain.hashData method.
Returns Promise<boolean>

export

export(format: IMPORT_EXPORT_FORMAT, version: BLOCKCHAIN_EXPORT_VERSION, compressed: boolean, name: string): Promise<Buffer>
Description
Export a private key using the blockchain module.

Returns
Buffer with the private key.

Throws
HsmError If an error occurs in the operation.
Parameters
- format: IMPORT_EXPORT_FORMAT
  
  Format of the key to be exported.
- version: BLOCKCHAIN_EXPORT_VERSION
  
  Key version.
- compressed: boolean
  
  If the key is to be returned compressed.
- name: string
  
  Name of the private key.
Returns Promise<Buffer>

getAddress

getAddress(type: ADDRESS_TYPE, version: ADDRESS_VERSION, hrp: ADDRESS_HRP, pk: string): Promise<Buffer>
Description
Retrieves the address of a key using the blockchain module.

Returns
Returns the address.

Throws
HsmError If the address cannot be retrieved or an error occurs in the operation.
Parameters
- type: ADDRESS_TYPE
  
  Type of address to be generated.
- version: ADDRESS_VERSION
  
  Address version.
- hrp: ADDRESS_HRP
  
  HRP (Human Readable Part) of the key.
- pk: string
  
  Private key from which the address or script-hash will be generated.
Returns Promise<Buffer>

getKeyInfo

getKeyInfo(name: string): Promise<KeyInfo>
Description
Retrieves the properties of a key using the blockchain module.

Returns
Returns an object with the key's blockchain data.

Throws
HsmError If the address cannot be retrieved or an error occurs in the operation.
Parameters
- name: string
  
  Name of the private key.
Returns Promise<KeyInfo>

getPubKey

getPubKey(type: BLOCKCHAIN_GET_PUB_KEY_TYPE, privKeyName: string): Promise<Buffer>
Description
Recover a public key from a private key using the blockchain module.

Returns
Public key.

Throws
HsmError If the private key is not found or there is an error in the operation.
Parameters
- type: BLOCKCHAIN_GET_PUB_KEY_TYPE
  
  Format of the public key to be exported.
- privKeyName: string
  
  Name of the private key.
Returns Promise<Buffer>

hashDate

hashDate(hashMode: BLOCKCHAIN_HASH_MODE, date: Buffer): Promise<Buffer>
Description
Calculates a hash using the blockchain module.

Returns
Calculated hash.

Throws
HsmError If the hash cannot be calculated or an error occurs in the operation.
Parameters
- hashMode: BLOCKCHAIN_HASH_MODE
  
  Hash mode.
- date: Buffer
  
  Data to be processed. Maximum size of BLOCKCHAIN_MAX_DATA_LEN.
Returns Promise<Buffer>

import

import(format: IMPORT_EXPORT_FORMAT, exportable: booleantemporary: boolean, name: string, date: string): Promise<boolean>
Description
Import a private key using the blockchain_interfaces module.

Returns
True if the import was carried out or an exception otherwise.

Throws
HsmError If an error occurs in the operation.
Parameters
- format: IMPORT_EXPORT_FORMAT
  
  Format of the key to be imported.
- exportable: boolean
  
  If the key is exportable.
- temporary: boolean
  
  If the key is temporary.
- name: string
  
  Name of the private key.
- date: string
  
  Private key in the format specified in IMPORT_EXPORT_FORMAT.
Returns Promise<boolean>

pubKeyRecovery

pubKeyRecovery(sigType: BLOCKCHAIN_SIG_TYPE, hashMode: BLOCKCHAIN_HASH_MODE, hashData: Buffer, signature: Buffer): Promise<Buffer>
Description
Retrieves a public key (PBK) from an ECDSA-type signature.

Returns
Returns a buffer with the public key.

Throws
HsmError If an error occurs in the operation.
Parameters
- sigType: BLOCKCHAIN_SIG_TYPE
  
  Type of signature to be generated.
- hashMode: BLOCKCHAIN_HASH_MODE
  
  Hash mode.
- hashData: Buffer
  
  Hash calculated as entered in hashData.
- signature: Buffer
  
  Signature as entered in sigType(BLOCKCHAIN_SIG_TYPE).
Returns Promise<Buffer>

sign

sign(type: BLOCKCHAIN_SIG_TYPE, hashMode: BLOCKCHAIN_HASH_MODE, hash: Buffer, pk: string): Promise<Buffer>
Description
Sign a hash using the blockchain module.

Throws
HsmError If it is not possible to sign the data or there is an error in the operation.
Parameters
- type: BLOCKCHAIN_SIG_TYPE
  
  Type of signature to be made.
- hashMode: BLOCKCHAIN_HASH_MODE
  
  Hash mode.
- hash: Buffer
  
  Hash calculated according to what is entered in hashMode(BLOCKCHAIN_HASH_MODE).
- pk: string
  
  Name of the private key.
Returns Promise<Buffer>

unblock

unblock(name: string): Promise<boolean>
Description
Unlocks a key in the HSM.

Returns
Returns true if the key was successfully unlocked.

Throws
If the key name is invalid.

Throws
In the event of an error when deleting the key.
Parameters
- name: string
  
  Key name.
Returns Promise<boolean>

check

check(sigType: BLOCKCHAIN_SIG_TYPE, hashMode: BLOCKCHAIN_HASH_MODE, hashData: Buffer, signature: Buffer, pubKeyType: BLOCKCHAIN_SIG_VERIFY_PUB_KEY_TYPE, pubSignature: Buffer): Promise<boolean>
Description
Verifies a signature using the blockchain module.

Returns
True if the signature is valid, false otherwise.

Throws
HsmError If an error occurs in the operation.
Parameters
- sigType: BLOCKCHAIN_SIG_TYPE
  
  Type of signature made.
- hashMode: BLOCKCHAIN_HASH_MODE
  
  Hash mode.
- hashData: Buffer
  
  Hash calculated as entered in hashData.
- signature: Buffer
  
  Signature as entered in sigType(BLOCKCHAIN_SIG_TYPE).
- pubKeyType: BLOCKCHAIN_SIG_VERIFY_PUB_KEY_TYPE
  
  Type of public key.
- pubSignature: Buffer
  
  Public key as entered in pubKeyType.
Returns Promise<boolean>

Blockchain interface

Hierarchy

Index

Methods

Methods

abn128PscMult

Description

Returns

Throws

Throws

Throws

Parameters

keyName: string

x: string | Buffer

y: string | Buffer

Optional neg: boolean

Returns Promise<Buffer>

abn128RndCtxGetPt

Description

Returns

Throws

Throws

Throws

Parameters

x: string | Buffer

y: string | Buffer

Returns Promise<Buffer>

abn128RndCtxMultAdd

Description

Returns

Throws

Throws

Throws

Parameters

keyName: string

scalar: string | Buffer

Returns Promise<Buffer>

abn128RndCtxRefresh

Description

Returns

Throws

Throws

Throws

Parameters

x: string | Buffer

y: string | Buffer

Returns Promise<Buffer>

abn128RndSc

Description

Returns

Throws

Returns Promise<Buffer>

abn128RndScs

Description

Returns

Throws

Returns Promise<Buffer[]>

block

Description

Returns

Throws

Throws

Parameters

name: string

Returns Promise<boolean>

create

Description

Returns

Throws

Parameters

name: string

type: BLOCKCHAIN_KEYS

exportable: boolean

temporary: boolean

Optional version: null | VERSION_OPTIONS

Optional seed: null | string

Optional passphrase: null | string

Returns Promise<boolean>

createBip32ChildKeyDerivation

Description

`Optional` neg: boolean

`Optional` version: null | VERSION_OPTIONS

`Optional` seed: null | string

`Optional` passphrase: null | string