Class Secp256k1

Class containing SECP256K1 related utility methods.

Index

Constructors

Methods

deriveChildPrivateKey derivePrivateKey derivePublicKey generateKeyPair generateKeyPairRaw getPublicJwk getPublicKey privateJwkToBytes privateKeyToJwk publicJwkToBytes publicKeyToJwk sign validateKey verify

Constructors

constructor

new Secp256k1(): Secp256k1
Returns Secp256k1

Methods

`Static` deriveChildPrivateKey

deriveChildPrivateKey(privateKey, derivationPathSegment): Promise<Uint8Array>
Derives a child private key using the given derivation path segment.
Parameters
- privateKey: Uint8Array
- derivationPathSegment: Uint8Array
Returns Promise<Uint8Array>
- Defined in src/utils/secp256k1.ts:187

`Static` derivePrivateKey

derivePrivateKey(privateKey, relativePath): Promise<Uint8Array>
Derives a hardened hierarchical deterministic private key.
Parameters
- privateKey: Uint8Array
- relativePath: string[]
Returns Promise<Uint8Array>
- Defined in src/utils/secp256k1.ts:172

`Static` derivePublicKey

derivePublicKey(privateKey, relativePath): Promise<Uint8Array>
Derives a hardened hierarchical deterministic public key.
Parameters
- privateKey: Uint8Array
- relativePath: string[]
Returns Promise<Uint8Array>
uncompressed public key
- Defined in src/utils/secp256k1.ts:160

`Static` generateKeyPair

generateKeyPair(): Promise<{
privateJwk: PrivateJwk;
publicJwk: PublicJwk;
}>
Generates a random key pair in JWK format.

Returns Promise<{
privateJwk: PrivateJwk;
publicJwk: PublicJwk;
}>
- Defined in src/utils/secp256k1.ts:118

`Static` generateKeyPairRaw

generateKeyPairRaw(): Promise<{
privateKey: Uint8Array;
publicKey: Uint8Array;
}>
Generates key pair in raw bytes, where the publicKey is compressed.

Returns Promise<{
privateKey: Uint8Array;
publicKey: Uint8Array;
}>
- Defined in src/utils/secp256k1.ts:132

`Static` getPublicJwk

getPublicJwk(privateKeyJwk): Promise<PublicJwk>
Gets the public JWK of the given private JWK.
Parameters
- privateKeyJwk: PrivateJwk
Returns Promise<PublicJwk>
- Defined in src/utils/secp256k1.ts:150

`Static` getPublicKey

getPublicKey(privateKey): Promise<Uint8Array>
Gets the compressed public key of the given private key.
Parameters
- privateKey: Uint8Array
Returns Promise<Uint8Array>
- Defined in src/utils/secp256k1.ts:142

`Static` privateJwkToBytes

privateJwkToBytes(privateJwk): Uint8Array
Creates a private key in raw bytes from the given SECP256K1 JWK.
Parameters
- privateJwk: PrivateJwk
Returns Uint8Array
- Defined in src/utils/secp256k1.ts:84

`Static` privateKeyToJwk

privateKeyToJwk(privateKeyBytes): Promise<PrivateJwk>
Converts a private key in bytes into a JWK.
Parameters
- privateKeyBytes: Uint8Array
Returns Promise<PrivateJwk>
- Defined in src/utils/secp256k1.ts:59

`Static` publicJwkToBytes

publicJwkToBytes(publicJwk): Uint8Array
Creates a compressed key in raw bytes from the given SECP256K1 JWK.
Parameters
- publicJwk: PublicJwk
Returns Uint8Array
- Defined in src/utils/secp256k1.ts:71

`Static` publicKeyToJwk

publicKeyToJwk(publicKeyBytes): Promise<PublicJwk>
Converts a public key in bytes into a JWK.
Parameters
- publicKeyBytes: Uint8Array
Returns Promise<PublicJwk>
- Defined in src/utils/secp256k1.ts:26

`Static` sign

sign(content, privateJwk): Promise<Uint8Array>
Signs the provided content using the provided JWK.
Parameters
- content: Uint8Array
- privateJwk: PrivateJwk
Returns Promise<Uint8Array>
- Defined in src/utils/secp256k1.ts:92

`Static` validateKey

validateKey(jwk): void
Validates the given JWK is a SECP256K1 key.
Parameters
- jwk: PublicJwk | PrivateJwk
Returns void
Throws
if fails validation.
- Defined in src/utils/secp256k1.ts:17

`Static` verify

verify(content, signature, publicJwk): Promise<boolean>
Verifies a signature against the provided payload hash and public key.
Parameters
- content: Uint8Array
- signature: Uint8Array
- publicJwk: PublicJwk
Returns Promise<boolean>
a boolean indicating whether the signature is valid.
- Defined in src/utils/secp256k1.ts:107