From 4944e736eeca87f34d144219481e7e7522f88c26 Mon Sep 17 00:00:00 2001
From: willclarktech <willclarktech@users.noreply.github.com>
Date: Tue, 13 Oct 2020 13:02:38 +0200
Subject: [PATCH] Update docs for convenience hash functions

---
 CHANGELOG.md                      | 5 +++++
 packages/crypto/src/keccak.ts     | 1 +
 packages/crypto/src/ripemd.ts     | 1 +
 packages/crypto/src/sha.ts        | 3 +++
 packages/crypto/types/keccak.d.ts | 1 +
 packages/crypto/types/ripemd.d.ts | 1 +
 packages/crypto/types/sha.d.ts    | 3 +++
 7 files changed, 15 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 29e6e3f8..7b4772c1 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 0.23.1 (unreleased)
+
+- @cosmjs/crypto: Export new convenience functions `keccak256`, `ripemd160`,
+  `sha1`, `sha256` and `sha512`.
+
 ## 0.23.0 (2020-10-09)
 
 - @cosmjs/cli: Expose `HdPath` type.
diff --git a/packages/crypto/src/keccak.ts b/packages/crypto/src/keccak.ts
index a2f5c88e..ea4e7fc3 100644
--- a/packages/crypto/src/keccak.ts
+++ b/packages/crypto/src/keccak.ts
@@ -25,6 +25,7 @@ export class Keccak256 implements HashFunction {
   }
 }
 
+/** Convenience function equivalent to `new Keccak256(data).digest()` */
 export function keccak256(data: Uint8Array): Uint8Array {
   return new Keccak256(data).digest();
 }
diff --git a/packages/crypto/src/ripemd.ts b/packages/crypto/src/ripemd.ts
index 08d819a3..258a43e0 100644
--- a/packages/crypto/src/ripemd.ts
+++ b/packages/crypto/src/ripemd.ts
@@ -23,6 +23,7 @@ export class Ripemd160 implements HashFunction {
   }
 }
 
+/** Convenience function equivalent to `new Ripemd160(data).digest()` */
 export function ripemd160(data: Uint8Array): Uint8Array {
   return new Ripemd160(data).digest();
 }
diff --git a/packages/crypto/src/sha.ts b/packages/crypto/src/sha.ts
index 0380b23e..319633c3 100644
--- a/packages/crypto/src/sha.ts
+++ b/packages/crypto/src/sha.ts
@@ -26,6 +26,7 @@ export class Sha1 implements HashFunction {
   }
 }
 
+/** Convenience function equivalent to `new Sha1(data).digest()` */
 export function sha1(data: Uint8Array): Uint8Array {
   return new Sha1(data).digest();
 }
@@ -53,6 +54,7 @@ export class Sha256 implements HashFunction {
   }
 }
 
+/** Convenience function equivalent to `new Sha256(data).digest()` */
 export function sha256(data: Uint8Array): Uint8Array {
   return new Sha256(data).digest();
 }
@@ -80,6 +82,7 @@ export class Sha512 implements HashFunction {
   }
 }
 
+/** Convenience function equivalent to `new Sha512(data).digest()` */
 export function sha512(data: Uint8Array): Uint8Array {
   return new Sha512(data).digest();
 }
diff --git a/packages/crypto/types/keccak.d.ts b/packages/crypto/types/keccak.d.ts
index 1aec50c8..a8538463 100644
--- a/packages/crypto/types/keccak.d.ts
+++ b/packages/crypto/types/keccak.d.ts
@@ -6,4 +6,5 @@ export declare class Keccak256 implements HashFunction {
   update(data: Uint8Array): Keccak256;
   digest(): Uint8Array;
 }
+/** Convenience function equivalent to `new Keccak256(data).digest()` */
 export declare function keccak256(data: Uint8Array): Uint8Array;
diff --git a/packages/crypto/types/ripemd.d.ts b/packages/crypto/types/ripemd.d.ts
index a2396ec8..8aa19510 100644
--- a/packages/crypto/types/ripemd.d.ts
+++ b/packages/crypto/types/ripemd.d.ts
@@ -6,4 +6,5 @@ export declare class Ripemd160 implements HashFunction {
   update(data: Uint8Array): Ripemd160;
   digest(): Uint8Array;
 }
+/** Convenience function equivalent to `new Ripemd160(data).digest()` */
 export declare function ripemd160(data: Uint8Array): Uint8Array;
diff --git a/packages/crypto/types/sha.d.ts b/packages/crypto/types/sha.d.ts
index 3aed0987..a8c73543 100644
--- a/packages/crypto/types/sha.d.ts
+++ b/packages/crypto/types/sha.d.ts
@@ -6,6 +6,7 @@ export declare class Sha1 implements HashFunction {
   update(data: Uint8Array): Sha1;
   digest(): Uint8Array;
 }
+/** Convenience function equivalent to `new Sha1(data).digest()` */
 export declare function sha1(data: Uint8Array): Uint8Array;
 export declare class Sha256 implements HashFunction {
   readonly blockSize: number;
@@ -14,6 +15,7 @@ export declare class Sha256 implements HashFunction {
   update(data: Uint8Array): Sha256;
   digest(): Uint8Array;
 }
+/** Convenience function equivalent to `new Sha256(data).digest()` */
 export declare function sha256(data: Uint8Array): Uint8Array;
 export declare class Sha512 implements HashFunction {
   readonly blockSize: number;
@@ -22,4 +24,5 @@ export declare class Sha512 implements HashFunction {
   update(data: Uint8Array): Sha512;
   digest(): Uint8Array;
 }
+/** Convenience function equivalent to `new Sha512(data).digest()` */
 export declare function sha512(data: Uint8Array): Uint8Array;