Class Secp256k1PrivateKey

Represents a Secp256k1 ECDSA private key, providing functionality to create, sign messages, derive public keys, and serialize/deserialize the key.

Hierarchy (View Summary, Expand)

Serializable
- Secp256k1PrivateKey

Implements

PrivateKey

Index

Implementation - BCS

bcsToBytes

bcsToBytes(): Uint8Array
Serializes a Serializable value to its BCS representation. This function is the TypeScript SDK equivalent of bcs::to_bytes in Move.

Returns Uint8Array
the BCS representation of the Serializable instance as a byte buffer.
Inherited from Serializable.bcsToBytes
- Defined in src/bcs/serializer.ts:33

bcsToHex

bcsToHex(): Hex
Converts the BCS-serialized bytes of a value into a Hex instance. This function provides a Hex representation of the BCS-serialized data for easier handling and manipulation.

Returns Hex
A Hex instance with the BCS-serialized bytes loaded into its underlying Uint8Array.
Inherited from Serializable.bcsToHex
- Defined in src/bcs/serializer.ts:46

Implementation - Serialization

constructor

new Secp256k1PrivateKey(
hexInput: HexInput,
strict?: boolean,
): Secp256k1PrivateKey
Create a new PrivateKey instance from a Uint8Array or String.

Read about AIP-80
Parameters
- hexInput: HexInput
  A HexInput (string or Uint8Array)
- Optionalstrict: boolean
  If true, private key must AIP-80 compliant.
Returns Secp256k1PrivateKey
Overrides Serializable.constructor
- Defined in src/core/crypto/secp256k1.ts:212

`Static` `Readonly`LENGTH

LENGTH: number = 32

Length of Secp256k1 ecdsa private key

publicKey

publicKey(): Secp256k1PublicKey
Derive the Secp256k1PublicKey from this private key.

Returns Secp256k1PublicKey
Secp256k1PublicKey The derived public key.
Implementation of PrivateKey.publicKey
- Defined in src/core/crypto/secp256k1.ts:303

sign

sign(message: HexInput): Secp256k1Signature
Sign the given message with the private key. This function generates a cryptographic signature for the provided message, ensuring the signature is canonical and non-malleable.
Parameters
- message: HexInput
  A message in HexInput format to be signed.
Returns Secp256k1Signature
Signature - The generated signature for the provided message.
Implementation of PrivateKey.sign
- Defined in src/core/crypto/secp256k1.ts:288

toString

toString(): string
Get the private key as a string representation.

Returns string
string representation of the private key
Overrides Serializable.toString
- Defined in src/core/crypto/secp256k1.ts:326

toUint8Array

toUint8Array(): Uint8Array
Get the private key in bytes (Uint8Array).

Returns Uint8Array
Implementation of PrivateKey.toUint8Array
- Defined in src/core/crypto/secp256k1.ts:315

`Static`fromDerivationPath

fromDerivationPath(path: string, mnemonics: string): Secp256k1PrivateKey
Derives a private key from a mnemonic seed phrase using a specified BIP44 path.
Parameters
- path: string
  The BIP44 path to derive the key from.
- mnemonics: string
  The mnemonic seed phrase used for key generation.
Returns Secp256k1PrivateKey
The generated private key.

Throws
Error if the provided path is not a valid BIP44 path.
- Defined in src/core/crypto/secp256k1.ts:247

`Static`generate

generate(): Secp256k1PrivateKey
Generate a new random private key.

Returns Secp256k1PrivateKey
Secp256k1PrivateKey - A newly generated Secp256k1 private key.
- Defined in src/core/crypto/secp256k1.ts:230

`Static`isPrivateKey

isPrivateKey(privateKey: PrivateKey): privateKey is Secp256k1PrivateKey
Determines if the provided private key is an instance of Secp256k1PrivateKey.
Parameters
- privateKey: PrivateKey
  The private key to be checked.
Returns privateKey is Secp256k1PrivateKey
Deprecated
use instanceof Secp256k1PrivateKey instead
- Defined in src/core/crypto/secp256k1.ts:374

Methods

serialize

serialize(serializer: Serializer): void
Parameters
- serializer: Serializer
Returns void
Overrides Serializable.serialize
- Defined in src/core/crypto/secp256k1.ts:354

toAIP80String

toAIP80String(): string
Get the private key as a AIP-80 compliant hex string.

Read about AIP-80

Returns string
AIP-80 compliant string representation of the private key.
- Defined in src/core/crypto/secp256k1.ts:346

toHexString

toHexString(): string
Get the private key as a hex string with the 0x prefix.

Returns string
string representation of the private key.
- Defined in src/core/crypto/secp256k1.ts:335

toStringWithoutPrefix

toStringWithoutPrefix(): string
Returns the hex string representation of the Serializable value without the 0x prefix.

Returns string
the hex format as a string without 0x prefix.
Inherited from Serializable.toStringWithoutPrefix
- Defined in src/bcs/serializer.ts:55

`Static`deserialize

deserialize(deserializer: Deserializer): Secp256k1PrivateKey
Parameters
- deserializer: Deserializer
Returns Secp256k1PrivateKey
- Defined in src/core/crypto/secp256k1.ts:358

Class Secp256k1PrivateKey

Hierarchy (View Summary, Expand)

Implements

Index

Implementation - BCS

Implementation - Serialization

Methods

Implementation - BCS

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

Implementation - Serialization

constructor

Parameters

Returns Secp256k1PrivateKey

Static ReadonlyLENGTH

publicKey

Returns Secp256k1PublicKey

sign

Parameters

Returns Secp256k1Signature

toString

Returns string

toUint8Array

Returns Uint8Array

StaticfromDerivationPath

Parameters

Returns Secp256k1PrivateKey

Throws

Staticgenerate

Returns Secp256k1PrivateKey

StaticisPrivateKey

Parameters

Returns privateKey is Secp256k1PrivateKey

Deprecated

Methods

serialize

Parameters

Returns void

toAIP80String

Returns string

toHexString

Returns string

toStringWithoutPrefix

Returns string

Staticdeserialize

Parameters

Returns Secp256k1PrivateKey

Settings

On This Page

`Static` `Readonly`LENGTH

`Static`fromDerivationPath

`Static`generate

`Static`isPrivateKey

`Static`deserialize