@meshsdk/core-cst 1.9.0-beta.32 → 1.9.0-beta.35

package/dist/index.d.cts

@@ -254,7 +254,13 @@ type Signer = {
     key: Ed25519PrivateKey;
 };
 
-/** @param address - Optional Bech32 string of a stake, stake_test1, addr, or addr_test1 address. If provided, this function will validate the signer's address against this value. */
+/**
+ * Check the signature of a given data string
+ * @param data The data string to verify the signature against
+ * @param {key, signature} The signature obtained by `signData`
+ * @param address Optional Bech32 string of a stake, stake_test1, addr, or addr_test1 address. If provided, this function will validate the signer's address against this value.
+ * @returns boolean
+ */
 declare const checkSignature: (data: string, { key, signature }: DataSignature, address?: string) => Promise<boolean>;
 
 declare class CoseSign1 {
@@ -284,8 +290,20 @@ declare class CoseSign1 {
 declare const getPublicKeyFromCoseKey: (cbor: string) => Buffer$1;
 declare const getCoseKeyFromPublicKey: (cbor: string) => Buffer$1;
 
+/**
+ * Generate a nonce string
+ * @param label The label to prepend to the nonce
+ * @param length The length of the nonce
+ * @returns The generated nonce in hex format
+ */
 declare const generateNonce: (label?: string, length?: number) => string;
 
+/**
+ * Sign the data string using the provided signer
+ * @param data The data string to sign
+ * @param signer The signer object containing the key and address
+ * @returns DataSignature for verification
+ */
 declare const signData: (data: string, signer: Signer) => DataSignature;
 
 declare const resolveDataHash: (rawData: BuilderData["content"], type?: PlutusDataType) => string;

package/dist/index.d.ts

@@ -254,7 +254,13 @@ type Signer = {
     key: Ed25519PrivateKey;
 };
 
-/** @param address - Optional Bech32 string of a stake, stake_test1, addr, or addr_test1 address. If provided, this function will validate the signer's address against this value. */
+/**
+ * Check the signature of a given data string
+ * @param data The data string to verify the signature against
+ * @param {key, signature} The signature obtained by `signData`
+ * @param address Optional Bech32 string of a stake, stake_test1, addr, or addr_test1 address. If provided, this function will validate the signer's address against this value.
+ * @returns boolean
+ */
 declare const checkSignature: (data: string, { key, signature }: DataSignature, address?: string) => Promise<boolean>;
 
 declare class CoseSign1 {
@@ -284,8 +290,20 @@ declare class CoseSign1 {
 declare const getPublicKeyFromCoseKey: (cbor: string) => Buffer$1;
 declare const getCoseKeyFromPublicKey: (cbor: string) => Buffer$1;
 
+/**
+ * Generate a nonce string
+ * @param label The label to prepend to the nonce
+ * @param length The length of the nonce
+ * @returns The generated nonce in hex format
+ */
 declare const generateNonce: (label?: string, length?: number) => string;
 
+/**
+ * Sign the data string using the provided signer
+ * @param data The data string to sign
+ * @param signer The signer object containing the key and address
+ * @returns DataSignature for verification
+ */
 declare const signData: (data: string, signer: Signer) => DataSignature;
 
 declare const resolveDataHash: (rawData: BuilderData["content"], type?: PlutusDataType) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meshsdk/core-cst",
-  "version": "1.9.0-beta.32",
+  "version": "1.9.0-beta.35",
   "description": "Types and utilities functions between Mesh and cardano-js-sdk",
   "main": "./dist/index.cjs",
   "browser": "./dist/index.js",
@@ -44,7 +44,7 @@
     "@harmoniclabs/plutus-data": "1.2.4",
     "@harmoniclabs/uplc": "1.2.4",
     "@harmoniclabs/pair": "^1.0.0",
-    "@meshsdk/common": "1.9.0-beta.32",
+    "@meshsdk/common": "1.9.0-beta.35",
     "@types/base32-encoding": "^1.0.2",
     "base32-encoding": "^1.0.0",
     "bech32": "^2.0.0",