@ethercast/calculate-signature

This module provides the utility methods used by Ethercast to sign messages.

You can use this in a javascript or typescript project to easily validate message signature validity.

Index

Enumerations

SignatureVersion

Functions

Functions

calculateMessageSignature

calculateMessageSignature(messageBody: string, subscriptionSecret: string, version?: SignatureVersion): string

- Defined in calculate-signature.ts:15
Calculate the signature for a message body using the subscription secret

Parameters
- messageBody: string
  
  body of the message
- subscriptionSecret: string
  
  secret of the subscription
- Default value version: SignatureVersion = SignatureVersion.sha512
  
  the version of the message signature (optional, defaults to sha512)
Returns string

the message signature

isValidSignature

isValidSignature(messageBody: string, subscriptionSecret: string, signature: string, version?: SignatureVersion): boolean

- Defined in calculate-signature.ts:33
Returns true if the message body and secret return a matching signature

Parameters
- messageBody: string
  
  body of the message
- subscriptionSecret: string
  
  subscription secret
- signature: string
- Default value version: SignatureVersion = SignatureVersion.sha512
  
  the version of the message signature (optional, defaults to sha512)
Returns boolean

true if the message is valid, false otherwise

Generated using TypeDoc