Skip to content
This repository was archived by the owner on May 11, 2026. It is now read-only.

Added small but mighty comment to generateOrderBookSummaryHash() #154

Open
Gor4 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Added small but mighty comment to generateOrderBookSummaryHash() #154

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5133998
- Added jsdoc to inform user that they must have correct properties o…
Gor4 May 24, 2025
f6174fb
Merge branch 'main' into main
Gor4 May 26, 2025
5edfe08
Merge branch 'main' into main
poly-rodr Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions src/utilities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,12 @@ export const decimalPlaces = (num: number): number => {
};

/**
* Calculates the hash for the given orderbook
* @param orderbook
* @returns
* Calculates the SHA‑1 hash for the given orderbook.
*
* @param {OrderBookSummary} orderbook
Copy link
Copy Markdown
Contributor

@poly-rodr poly-rodr Jul 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we just added some new properties

* **must** have its properties in _exactly_ this order:
* `market`, `asset_id`, `timestamp`, `hash`, `bids`, `asks`
* @returns {string} the hex‑encoded SHA‑1
*/
export const generateOrderBookSummaryHash = (orderbook: OrderBookSummary): string => {
orderbook.hash = "";
Expand Down