Signing

interface signing.Signing

Message signing functions.

Supports key generation and signing.

Performs ECDSA operations with @bookmoons/bitcore-message-cash 2.0.0 default configuration.

signing.Signing.address()

Get Bitcoin Cash address of key pair.

Generate or restore key pair prior to use.

Throws:MissingValueError – If key pair has not been generated or restored. Returns:CashAddr – Bitcoin Cash address.

signing.Signing.exportPrivateKey()

Export private key as hex string.

Generate or restore key pair prior to use.

Throws:MissingValueError – If key pair has not been generated or restored. Returns:HexString – Private key.

signing.Signing.exportPublicKey()

Export public key as hex string.

Generate or restore key pair prior to use.

Throws:MissingValueError – If key pair has not been generated or restored. Returns:HexString – Public key.

signing.Signing.generateKeyPair(network="<mainnet>")

Generate ECDSA key pair for message signing.

Generated key pair is saved internally and used for subsequent operations. No return value. Subsequent calls discard and replace old key pair.

Arguments:

• network – Network to generate for. Type implementation defined.

signing.Signing.restoreKeyPair(privateKeyString, network="<mainnet>")

Restore key pair from private key hex string.

Arguments:

• privateKeyString (HexString) – Private key.
• network – Network to restore for. Type implementation defined.

signing.Signing.sign(message)

Sign message with active key pair.

Generate or restore key pair prior to use.

Arguments:

• message (string) – Message to sign.

Throws:

MissingValueError – If key pair has not been generated or restored.

Returns:

Base64 – Detached message signature.