Class Secp256k1PublicKey

Represents a Secp256k1 ECDSA public key.

Hierarchy (view full)

PublicKey
- Secp256k1PublicKey

Index

Constructors

Methods

bcsToBytes bcsToHex deserialize serialize toString toStringWithoutPrefix toUint8Array verifySignature deserialize isInstance isPublicKey

Properties

COMPRESSED_LENGTH LENGTH

Constructors

constructor

new Secp256k1PublicKey(hexInput): Secp256k1PublicKey
Create a new PublicKey instance from a HexInput, which can be a string or Uint8Array. This constructor validates the length of the provided signature data.
Parameters
- hexInput: HexInput
  A HexInput (string or Uint8Array) representing the signature data.
Returns Secp256k1PublicKey
Throws
Error if the length of the signature data is not equal to Secp256k1Signature.LENGTH.
Overrides PublicKey.constructor
- Defined in src/core/crypto/secp256k1.ts:39

Methods

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 PublicKey.bcsToBytes
- Defined in src/bcs/serializer.ts:29

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 PublicKey.bcsToHex
- Defined in src/bcs/serializer.ts:40

deserialize

deserialize(deserializer): Secp256k1Signature
Deserializes a Secp256k1Signature from the provided deserializer. This function allows you to reconstruct a Secp256k1Signature object from its serialized byte representation.
Parameters
- deserializer: Deserializer
  The deserializer instance used to read the serialized data.
Returns Secp256k1Signature
- Defined in src/core/crypto/secp256k1.ts:105

serialize

serialize(serializer): void
Serializes the data into a byte array using the provided serializer. This function is essential for converting data into a format suitable for transmission or storage.
Parameters
- serializer: Serializer
  The serializer instance used to convert the data.
Returns void
Overrides PublicKey.serialize
- Defined in src/core/crypto/secp256k1.ts:94

toString

toString(): string
Get the public key as a hex string with a 0x prefix.

Returns string
The public key in hex format.
Inherited from PublicKey.toString
- Defined in src/core/crypto/publicKey.ts:44

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 PublicKey.toStringWithoutPrefix
- Defined in src/bcs/serializer.ts:49

toUint8Array

toUint8Array(): Uint8Array
Get the data as a Uint8Array representation.

Returns Uint8Array
Uint8Array representation of the data.
Overrides PublicKey.toUint8Array
- Defined in src/core/crypto/secp256k1.ts:80

verifySignature

verifySignature(args): boolean
Verifies a Secp256k1 signature against the public key.

This function checks the validity of a signature for a given message, ensuring that the signature is canonical as a malleability check.
Parameters
- args: VerifySignatureArgs
  The arguments for verifying the signature.
Returns boolean
Overrides PublicKey.verifySignature
- Defined in src/core/crypto/secp256k1.ts:66

`Static`deserialize

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

`Static`isInstance

isInstance(publicKey): publicKey is Secp256k1PublicKey
Determines if the provided public key is a valid instance of a Secp256k1 public key. This function checks for the presence of a "key" property and validates the length of the key data.
Parameters
- publicKey: PublicKey
  The public key to validate.
Returns publicKey is Secp256k1PublicKey
A boolean indicating whether the public key is a valid Secp256k1 public key.
- Defined in src/core/crypto/secp256k1.ts:134

`Static`isPublicKey

isPublicKey(publicKey): publicKey is Secp256k1PublicKey
Determine if the provided public key is an instance of Secp256k1PublicKey.
Parameters
- publicKey: PublicKey
  The public key to check.
Returns publicKey is Secp256k1PublicKey
Deprecated
use instanceof Secp256k1PublicKey instead
- Defined in src/core/crypto/secp256k1.ts:123

Properties

`Static` `Readonly`COMPRESSED_LENGTH

COMPRESSED_LENGTH: number = 33

`Static` `Readonly`LENGTH

LENGTH: number = 65

The length of the Secp256k1 public key in bytes.

Class Secp256k1PublicKey

Hierarchy (view full)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Secp256k1PublicKey

Throws

Methods

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

deserialize

Parameters

Returns Secp256k1Signature

serialize

Parameters

Returns void

toString

Returns string

toStringWithoutPrefix

Returns string

toUint8Array

Returns Uint8Array

verifySignature

Parameters

Returns boolean

Staticdeserialize

Parameters

Returns Secp256k1PublicKey

StaticisInstance

Parameters

Returns publicKey is Secp256k1PublicKey

StaticisPublicKey

Parameters

Returns publicKey is Secp256k1PublicKey

Deprecated

Properties

Static ReadonlyCOMPRESSED_LENGTH

Static ReadonlyLENGTH

Settings

On This Page

`Static`deserialize

`Static`isInstance

`Static`isPublicKey

`Static` `Readonly`COMPRESSED_LENGTH

`Static` `Readonly`LENGTH